• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve gift card

GET /v2/gift-cards/{id}

Retrieves a gift card using the gift card ID.


Permissions
GIFTCARDS_READ
Try in API Explorer
Name Description
id
string

Required

The ID of the gift card to retrieve.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

gift_card
GiftCard

The gift card retrieved.

Examples

You are viewing an old version of the API
GET /v2/gift-cards/{id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/gift-cards/gftc%3A00113070ba5745f0b2377c1b9570cb03 \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "gift_card": {
    "id": "gftc:00113070ba5745f0b2377c1b9570cb03",
    "type": "DIGITAL",
    "gan_source": "SQUARE",
    "state": "ACTIVE",
    "balance_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "gan": "7783320001001635",
    "created_at": "2021-05-20T22:26:54.000Z"
  }
}