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

Path Parameters

Example code

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. Show Attributes
gift_card GiftCard	The gift card retrieved. Show Attributes

curl https://connect.squareup.com/v2/gift-cards/gftc%3A00113070ba5745f0b2377c1b9570cb03 \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/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"
  }
}