Skip to main content
GET
/
GiftCards
/
{cardNumber}
GET /GiftCards/{cardNumber}
curl --request GET \
  --url https://{base_url}/GiftCards/{cardNumber} \
  --header 'X-API-KEY: <x-api-key>'
Retrieve a single gift card by its card number.
​
X-API-KEY
string
required
Your API key
​
cardNumber
string
required
Gift card number. Format: XXXXX-XXXXXXXX-XXXX
curl --location '[BASE_URL]/GiftCards/ABCDE-12345678-WXYZ' \
--header 'X-API-KEY: your_api_key_here'
Returns a single GiftCard object. See GET /GiftCards for full field descriptions. Example 200 Response 
{
  "cardNumber": "ABCDE-12345678-WXYZ",
  "issuedDate": "2024-01-10T09:00:00Z",
  "expiryDate": "2025-01-10T09:00:00Z",
  "amount": 100.00,
  "remainingAmount": 75.00,
  "status": "Active",
  "paymentType": "Online",
  "cardFormat": "EGiftCard",
  "purchaserFirstName": "John",
  "purchaserLastName": "Doe",
  "purchaserEmail": "john.doe@example.com",
  "recipientFirstName": "Jane",
  "recipientLastName": "Doe",
  "recipientEmail": "jane.doe@example.com"
}
StatusDescription
200Gift card returned
400loggedInAppId
400No Venue Subscribed to your App.
401X-API-KEY missing or invalid
404cardNumber — Card not found for this venue
404gift card '{cardNumber}' not found.
500Failed to retrieve card '{cardNumber}' details.