API Reference
Portal

Redeem gift card

post
https://api.getansa.com/v1/customers//redeem-gift-card

Add funds to a customer balance by charging a provided gift card number.

Authorization Scope

Both the merchant secret key and client secret key are authorized to call this endpoint.

Error Handling

Properly handling errors related to charging a gift card can be crucial to a good user experience and a high conversion rate. See error handling for more information about the error objects returned from this endpoint.

Path Params
string
required

The id of the customer

Body Params
string
required

Gift card number to be redeemed (eg. gift card account number in Square)

string

A string identifier that can be attached to this transaction ID for future search and observability purposes.

json

Set of string key-value pairs that you can attach to a transaction. This can be useful for storing additional information about the transaction in a structured format.

additionalInfo
object

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

Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago

Did this page help you?