Get Gift Card Details

GET 
/openapi/2022-01/gift_cards/:id

Retrieves details of a specific gift card by its ID.

Request

Path Parameters

id stringrequired

Gift card's ID

Responses

200

200

application/json

Schema

Schema

gift_card object
idstring
Example: 377026890382183978
last_charactersstring
Example: 218p
balancestring
Example: 100.00
initial_valuestring
Example: 100.00
notestring
Example: note
expires_on
disabled_at
enabledboolean
Default value: true
Example: true
created_atstring
Example: 2024-05-06T10:12:05Z
updated_atstring
Example: 2024-05-06T10:12:05Z
statusstring
Example: enable
currencystring
Example: USD
line_item_id
order_id
user_idstring
Example: cba51e16-ac53-43d8-a7a3-161c5b1ecd8e
template_suffix
customer_idstring
Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae

Example

{
  "gift_card": {
    "id": "377026890382183978",
    "last_characters": "218p",
    "balance": "100.00",
    "initial_value": "100.00",
    "note": "note",
    "expires_on": {},
    "disabled_at": {},
    "enabled": true,
    "created_at": "2024-05-06T10:12:05Z",
    "updated_at": "2024-05-06T10:12:05Z",
    "status": "enable",
    "currency": "USD",
    "line_item_id": {},
    "order_id": {},
    "user_id": "cba51e16-ac53-43d8-a7a3-161c5b1ecd8e",
    "template_suffix": {},
    "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae"
  }
}

Result

{
  "gift_card": {
    "id": "377026890382183978",
    "last_characters": "218p",
    "balance": "100.00",
    "initial_value": "100.00",
    "note": "note",
    "expires_on": null,
    "disabled_at": null,
    "enabled": true,
    "created_at": "2024-05-06T10:12:05Z",
    "updated_at": "2024-05-06T10:12:05Z",
    "status": "enable",
    "currency": "USD",
    "line_item_id": null,
    "order_id": null,
    "user_id": "cba51e16-ac53-43d8-a7a3-161c5b1ecd8e",
    "template_suffix": null,
    "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae"
  }
}