v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

GiftCards

LinkCustomerToGiftCard

Links a customer to a gift card, which is also referred to as adding a card on file.

post/v2/gift-cards/{gift_card_id}/link-customer

Path parameters

gift_card_idstring required

The ID of the gift card to be linked.

Request body

customer_idstring required

The ID of the customer to link to the gift card.

Example request

{
  "customer_id": "GKY0FZ3V717AH8Q2D821PNT2ZW"
}

Response

Success

Example response

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