PROTOCOL

CustomerManager¶

public protocol CustomerManager

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

Methods¶

get(customerId:)¶

func get(customerId: String) async -> Result<Customer, AnsaApiError>

Retrieves a Customer using the specified customer ID.

• Parameters:

• customerId: Unique identifier for the customer.

• Returns: A Customer or an AnsaApiError

Parameters¶

getPaymentMethods(customerId:)¶

func getPaymentMethods(customerId: String) async -> Result<PaymentMethodCollection, AnsaApiError>

Gets any payment methods for a specific customer

• Parameters:

• customerId: Unique identifier for the customer.

• Returns: A PaymentMethodCollection or an AnsaApiError

Parameters¶

addPaymentMethod(customerId:paymentMethodType:idempotencyKey:)¶

func addPaymentMethod(
  customerId: String, paymentMethodType: AddPaymentMethodType, idempotencyKey: String?
) async -> Result<PaymentMethod, AnsaApiError>

Adds a payment method of AddPaymentMethodType to a Customer

• Parameters:
• customerId: Unique identifier for the customer.
• paymentMethodType: The type of payment method to be added

• idempotencyKey: Optional idempotency key. For more details see Idempotency

• Returns: A PaymentMethodCollection or an AnsaApiError

Parameters¶

deletePaymentMethod(customerId:paymentMethodId:idempotencyKey:)¶

func deletePaymentMethod(customerId: String, paymentMethodId: String, idempotencyKey: String?) async -> Result<Void, AnsaApiError>

Deletes a payment method from a Customer

• Parameters:
• customerId: Unique identifier for the customer.
• paymentMethodId: Unique identifier for the payment method to delete.
• idempotencyKey: Optional idempotency key. For more details see Idempotency

Parameters¶

getAutoReloadConfiguration(customerId:)¶

func getAutoReloadConfiguration(customerId: String) async -> Result<AutoReloadConfiguration, AnsaApiError>

Gets the auto reload configuration for a specific customer

• Parameters:

• customerId: Unique identifier for the customer.

• Returns: The AutoReloadConfiguration or an AnsaApiError

Parameters¶

setAutoReloadConfiguration(request:idempotencyKey:)¶

func setAutoReloadConfiguration(
  request: AutoReloadConfigurationRequest, idempotencyKey: String?
)
  async -> Result<AutoReloadConfiguration, AnsaApiError>

Sets the auto reload configuration for a specific customer

• Parameters:
• request: The request for the AutoReloadConfiguration via AutoReloadConfigurationRequest

• idempotencyKey: Optional idempotency key. For more details see Idempotency

• Returns: The updated AutoReloadConfiguration or an AnsaApiError

Parameters¶

addBalance(request:idempotencyKey:)¶

func addBalance(request: AddBalanceRequest, idempotencyKey: String?) async -> Result<BalanceUpdate, AnsaApiError>

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

• Parameters:
• request: The specifics for the funds increase

• idempotencyKey: Optional idempotency key. For more details see Idempotency

• Returns: The resulting updated BalanceUpdate or an AnsaApiError

Parameters¶

useBalance(request:idempotencyKey:)¶

func useBalance(request: UseBalanceRequest, idempotencyKey: String?) async -> Result<BalanceUpdate, AnsaApiError>

Spend funds from a Customer balance for a purchase.

• Parameters:
• request: The specifics for the balance decrease

• idempotencyKey: Optional idempotency key. For more details see Idempotency

• Returns: The resulting updated BalanceUpdate or an AnsaApiError

Parameters¶

getReloadConfig(customerId:)¶

func getReloadConfig(customerId: String) async -> Result<UserReloadConfiguration, AnsaApiError>

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

• Parameters:

• customerId: Unique identifier for the customer.

• Returns: The UserReloadConfiguration or an AnsaApiError

Parameters¶

getTransactions(customerId:cursor:)¶

func getTransactions(customerId: String, cursor: String?) async -> Result<TransactionResult, AnsaApiError>

Retrieves a list of [Transaction]s 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.

• Parameters:
• customerId: Unique identifier for the customer.

• cursor: A cursor returned from a previous [getTransactions] request to fetch the next result page.

• Returns: The TransactionResult or an AnsaApiError

Parameters¶

createVirtualCard(customerId:idempotencyKey:)¶

func createVirtualCard(customerId: String, idempotencyKey: String?) async -> Result<VirtualCard, AnsaApiError>

Create a [VirtualCard] for on device provisioning via [provisionVirtualCard].

• Parameters:
• customerId Unique identifier for the customer.
• idempotencyKey: Optional idempotency key. For more details see Idempotency
• Returns: The created VirtualCard or an ApiResult.Error

provisionVirtualCard(request:idempotencyKey:)¶

func provisionVirtualCard(request: ProvisioningRequest, idempotencyKey: String?) async -> Result<Provisioning, AnsaApiError>

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

• Parameters:
• request The specifics for the provisioning

• idempotencyKey: Optional idempotency key. For more details see Idempotency

• Returns: The [Provisioning] result from adding it to the user's virtual wallet.