Skip to main content
POST
Redeem Gift Card
Redeem a gift card in full or partially. Pass an amount less than the remaining balance for a partial redemption.
string
required
Your API key
string
required
Must be application/json
string
required
Gift card number. Format: XXXXX-XXXXXXXX-XXXX
number
required
Amount to redeem. Pass less than the remaining balance for partial redemption.
string
Email address for verification
string
Notes for this redemption
200 OK is returned even for business-level failures. Always check isSuccess in the response body.
Response fields Example 200 — Success
Example 200 — Failure

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API Key authentication header

Body

application/json
cardNumber
string
required

The Gift Card Serial Number. Format: XXXXX-XXXXXXXX-XXXX

Minimum string length: 1
amount
number<double>
required

The Amount to redeem on Gift Card. Enter amount less than the card balance for a partial redemption.

issuedToEmail
string | null
notes
string | null

Response

OK

cardNumber
string | null
amountRedeemed
number<double>
status
string | null

Possible values: Error, Redeemed, Active

errorMessage
string | null
isSuccess
boolean