Gift Cards API

You are viewing an old version of the API

2022-05-12

Version 2022-05-12

• All Versions

Gift Cards API

Link customer to gift card BETA

Path Parameters

Example code

Name	Description
gift_card_id string Required	The ID of the gift card to be linked.

Request Body

Name	Description
customer_id string Required	The ID of the customer to link to the gift card. Min Length 1 Max Length 191

Response Fields

Name	Description
errors Error [ ]	Any errors that occurred during the request. Show Attributes
gift_card GiftCard	The gift card with the ID of the linked customer listed in the customer_ids field. Show Attributes

curl https://connect.squareup.com/v2/gift-cards/gftc%3A71ea002277a34f8a945e284b04822edb/link-customer \
  -X POST \
  -H 'Square-Version: 2022-05-12' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id": "GKY0FZ3V717AH8Q2D821PNT2ZW"
  }'

{
  "gift_card": {
    "id": "gftc:71ea002277a34f8a945e284b04822edb",
    "type": "DIGITAL",
    "gan_source": "SQUARE",
    "state": "ACTIVE",
    "balance_money": {
      "amount": 2500,
      "currency": "USD"
    },
    "gan": "7783320005440920",
    "created_at": "2021-03-25T05:13:01Z",
    "customer_ids": [
      "GKY0FZ3V717AH8Q2D821PNT2ZW"
    ]
  }
}