Gift Cards API

You are viewing an old version of the API

2023-01-19

Version 2023-01-19

• All Versions

Gift Cards API

Retrieve gift card from GAN

Request Body

Example code

Name	Description
gan string 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. Min Length 1 Max Length 255

Response Fields

Name	Description
errors Error [ ]	Any errors that occurred during the request. Show Attributes
gift_card GiftCard	A gift card that was fetched, if present. It returns empty if an error occurred. Show Attributes

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"
  }'

{
  "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"
  }
}