Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In

    Gift Cards

  • List gift cards

  • Create gift card

  • Retrieve gift card from GAN

  • Retrieve gift card from nonce

  • Link customer to gift card

  • Unlink customer from gift card

  • Retrieve gift card

  • Webhooks

  • gift_card.created

  • gift_card.customer_linked

  • gift_card.customer_unlinked

  • gift_card.updated

<- Gift Cards webhooks

Gift Cards webhooks

All versions ->

gift_card customer_linked

EVENT

 gift_card.customer_linked

Published when a customer is linked to a gift card.

Permissions:GIFTCARDS_READ
Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the Square seller associated with the event.

Link to section

type

string

The type of event. For this event, the value is gift_card.customer_linked.

Link to section

event_id

string

The unique ID of the event, which is used for idempotency support.

Link to section

created_at

string

Read only The timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event.

Link to section

Examples

All versions ->

Response JSON

{ "merchant_id": "C337NFWQT2A6W", "type": "gift_card.customer_linked", "event_id": "875f2038-6015-492e-9f29-d040b3809e49", "created_at": "2020-12-17T03:41:35.157Z", "data": { "type": "gift_card", "id": "gftc:00113070ba5745f0b2377c1b9570cb03", "object": { "gift_card": { "id": "gftc:00113070ba5745f0b2377c1b9570cb03", "type": "DIGITAL", "gan_source": "SQUARE", "state": "ACTIVE", "balance_money": { "amount": 1500, "currency": "USD" }, "gan": "7783320007480908", "customer_ids": [ "QPTXM8PQNX3Q726ZYHPMNP46XC" ], "created_at": "2020-12-17T01:41:35.157Z" }, "linked_customer_id": "QPTXM8PQNX3Q726ZYHPMNP46XC" } } }