Retrieve gift card from GAN
POST
/v2/gift-cards/from-gan
Retrieves a gift card using the gift card account number (GAN).
Permissions
GIFTCARDS_READ
Try in API Explorer
Name | Description |
---|---|
gan
Required
|
The gift card account number (GAN) of the gift card to retrieve. The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. Square-issued gift cards have 16-digit GANs. |
Response Fields
Name | Description |
---|---|
errors
|
Any errors that occurred during the request. |
gift_
|
A gift card that was fetched, if present. It returns empty if an error occurred. |
Examples
POST
/v2/gift-cards/from-gan
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/gift-cards/from-gan \
-X POST \
-H 'Square-Version: 2023-01-19' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"gan": "7783320001001635"
}'
Response JSON
{
"gift_card": {
"id": "gftc:6944163553804e439d89adb47caf806a",
"type": "DIGITAL",
"gan_source": "SQUARE",
"state": "ACTIVE",
"balance_money": {
"amount": 5000,
"currency": "USD"
},
"gan": "7783320001001635",
"created_at": "2021-05-20T22:26:54.000Z"
}
}