Get Gift Card

curl https://api.thanxsandbox.com/gift_cards/abc123def456 \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}"

{
  "gift_card": {
    "id": "abc123def456",
    "provider_id": "prov123merchant",
    "card_number": "1234567890123456",
    "pin": "1234",
    "last4": "3456",
    "balance": 50.00,
    "state": "active",
    "expires_at": "2026-12-31T23:59:59Z",
    "created_at": "2024-12-15T10:00:00Z"
  }
}

{
  "error": {
    "message": "Could not fetch balance"
  }
}

GET

gift_cards

{id}

curl https://api.thanxsandbox.com/gift_cards/abc123def456 \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}"

{
  "gift_card": {
    "id": "abc123def456",
    "provider_id": "prov123merchant",
    "card_number": "1234567890123456",
    "pin": "1234",
    "last4": "3456",
    "balance": 50.00,
    "state": "active",
    "expires_at": "2026-12-31T23:59:59Z",
    "created_at": "2024-12-15T10:00:00Z"
  }
}

{
  "error": {
    "message": "Could not fetch balance"
  }
}

This endpoint retrieves details for a specific gift card, including the current balance fetched in real-time from the gift card provider.

Please review proper request headers here.

Parameters

string

required

The gift card ID

Response

string

Gift card ID

provider_id

string

Provider merchant ID

card_number

string

Full gift card number

string

PIN code (if required by provider)

last4

string

Last 4 digits of the card number

balance

number

Current balance on the gift card (fetched in real-time from provider). May be null in list responses if provider is unavailable.

state

enum

Gift card state (active, archived)

expires_at

string

Expiration date in ISO8601 format (nullable)

created_at

string

Time the gift card was added in ISO8601 format

curl https://api.thanxsandbox.com/gift_cards/abc123def456 \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}"

{
  "gift_card": {
    "id": "abc123def456",
    "provider_id": "prov123merchant",
    "card_number": "1234567890123456",
    "pin": "1234",
    "last4": "3456",
    "balance": 50.00,
    "state": "active",
    "expires_at": "2026-12-31T23:59:59Z",
    "created_at": "2024-12-15T10:00:00Z"
  }
}

{
  "error": {
    "message": "Could not fetch balance"
  }
}

Create Gift Card Delete Gift Card

⌘I

Consumer API

Reference

Get Gift Card

Parameters

Response

​Parameters

​Response

Parameters

Response