Skip to main content
POST
/
GiftCards
/
redeem
POST /GiftCards/redeem
curl --request POST \
  --url https://{base_url}/GiftCards/redeem \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "cardNumber": "<string>",
  "amount": 123,
  "issuedToEmail": "<string>",
  "notes": "<string>"
}
'
Redeem a gift card in full or partially. Pass an amount less than the remaining balance for a partial redemption.
​
X-API-KEY
string
required
Your API key
​
Content-Type
string
required
Must be application/json
​
cardNumber
string
required
Gift card number. Format: XXXXX-XXXXXXXX-XXXX
​
amount
number
required
Amount to redeem. Pass less than the remaining balance for partial redemption.
​
issuedToEmail
string
Email address for verification
​
notes
string
Notes for this redemption
curl --location '[BASE_URL]/GiftCards/redeem' \
--header 'X-API-KEY: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{ "cardNumber": "ABCDE-12345678-WXYZ", "amount": 25.00 }'
200 OK is returned even for business-level failures. Always check isSuccess in the response body.
Response fields
FieldTypeDescription
cardNumberstringThe redeemed card number
amountRedeemednumberAmount that was redeemed
statusstringActive, Redeemed, or Error
isSuccessbooleanWhether the redemption succeeded
errorMessagestringError detail if isSuccess is false
Example 200 — Success 
{ "cardNumber": "ABCDE-12345678-WXYZ", "amountRedeemed": 25.00, "status": "Active", "isSuccess": true, "errorMessage": null }
Example 200 — Failure 
{ "cardNumber": "ABCDE-12345678-WXYZ", "amountRedeemed": 0.00, "status": "Error", "isSuccess": false, "errorMessage": "Card already redeemed." }
StatusDescription
200See isSuccess in response body
400Card: {cardNumber} invalid redeem amount. — amount is 0 or negative
400No Venue Subscribed to your App.
401X-API-KEY missing or invalid
404CardNumber — Card not found
500Failed to retrieve card details.