Add incentive

Adds an incentive to a customer's balance drawing from a merchant funded promotional account as the source of funds for the transaction.

The add incentive 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.

Path Params
string
required
Body Params
int32
required

Amount to add to the customer's balance.

string
required

Three-letter ISO currency code.

string

Optional descriptor for the transaction.

string

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

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

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json