Skip to main content
PATCH
/
GiftCards
/
cancel
PATCH /GiftCards/cancel
curl --request PATCH \
  --url https://{base_url}/GiftCards/cancel \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "cardNumber": "<string>"
}
'
Cancel a gift card by its card number. Fully redeemed cards cannot be cancelled.
​
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
curl --location --request PATCH '[BASE_URL]/GiftCards/cancel' \
--header 'X-API-KEY: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{ "cardNumber": "ABCDE-12345678-WXYZ" }'
StatusDescription
200Card cancelled
304Card {cardNumber} is cancelled. — already cancelled
400Card: {cardNumber} is fully redeemed and cannot be cancelled.
400No Venue Subscribed to your App.
401X-API-KEY missing or invalid
404CardNumber — Card not found
500Failed to retrieve card details.