Fund customer balance

post

https://api.getansa.com/v1/fund-customer-balance

Adds funds to a customer's balance using a promotional account as the source of the transaction.

The fund customer balance operation is useful for self-managed promotions, concessions for customer support, or refunding a transaction from another payment system into the customer's wallet. This transaction is completely closed-loop, and will not effect external systems or payment methods.

Authorization Scope

Only the merchant secret key is authorized to call this endpoint.

Body Params

amount

int32

required

Amount to add to the customer's balance.

currency

string

required

Three-letter ISO currency code.

customerId

string

required

The Id of the customer to add funds to.

reason

string

Optional descriptor for the transaction.

promotionalAccountId

string

Designate which promotional account should be the source of funds. Required if you have more than one promotional account.

label

string

A string reference that can be attached to this transaction for future discoverability.

metadata

json

JSON object of string key-value pairs that you can attach to the created transaction.

additionalInfo

object

Additional structured information about this transaction. Does not impact transaction behavior.

expirationMetadata

object

Object that represents when funds will expire from customer's balance

Responses

Authorization Scope

200200

400400

500500