customer-manager-public/dev.ansa.customer/CustomerManager

CustomerManager

interface CustomerManager

Interface for accessing and modifying a Customer and its associated data. All requests are returned in an ApiResult for safe-accessing of the data or the error.

Functions

Link copied to clipboard
abstract suspend fun addBalance(request: AddBalanceRequest, idempotencyKey: IdempotencyKey? = null): ApiResult<BalanceUpdate>

Add funds to a Customer balance by charging a provided PaymentMethod.

Link copied to clipboard
abstract suspend fun addPaymentMethod(customerId: String, paymentMethodType: AddPaymentMethodType, idempotencyKey: IdempotencyKey? = null): ApiResult<PaymentMethod>

Adds a payment method of AddPaymentMethodType to a Customer

Link copied to clipboard
abstract suspend fun createVirtualCard(customerId: String, idempotencyKey: IdempotencyKey? = null): ApiResult<VirtualCard>

Create a VirtualCard for on device provisioning via provisionVirtualCard.

Link copied to clipboard
abstract suspend fun deletePaymentMethod(customerId: String, paymentMethodId: String, idempotencyKey: IdempotencyKey? = null): ApiResult<Unit>

Deletes a payment method from a Customer

Link copied to clipboard
abstract suspend fun get(customerId: String): ApiResult<Customer>

Retrieves a Customer using the specified customer ID.

Link copied to clipboard
abstract suspend fun getAppReloadConfig(customerId: String): ApiResult<UserReloadConfiguration>

Gets the details for the merchant reload options for a specific customer

Link copied to clipboard
abstract suspend fun getAutoReloadConfiguration(customerId: String): ApiResult<AutoReloadConfiguration>

Gets the auto reload configuration for a specific customer

Link copied to clipboard
abstract suspend fun getPaymentMethods(customerId: String): ApiResult<List<PaymentMethod>>

Gets any payment methods for a specific customer

Link copied to clipboard
abstract suspend fun getTransactions(customerId: String, cursor: String? = null): ApiResult<TransactionResult>

Retrieves a list of Transactions for the specified customer. Also returns a string cursor if there is more than one page of results. Each page contains at most 50 results unless a lower limit is specified.

Link copied to clipboard
abstract fun observe(customerId: String): Flow<Customer?>

Observes the Customer associated by the ID specified.

Link copied to clipboard
abstract suspend fun provisionVirtualCard(request: ProvisioningRequest, idempotencyKey: IdempotencyKey? = null): ApiResult<Provisioning>

Facilitates the exchange of information to provision a virtual card into a user's digital wallet.

Link copied to clipboard
abstract suspend fun setAutoReloadConfiguration(request: AutoReloadConfigurationRequest): ApiResult<AutoReloadConfiguration>

Sets the auto reload configuration for a specific customer

Link copied to clipboard
abstract suspend fun useBalance(request: UseBalanceRequest, idempotencyKey: IdempotencyKey? = null): ApiResult<BalanceUpdate>

Spend funds from a Customer balance for a purchase.