Gift card activity updated
EVENT
gift_card.activity.updated
Published when a gift card activity is updated. Subscribe to this event to be notified about the following changes:
- An update to the
REDEEM
activity for a gift card redemption made from a Square product (such as Square Point of Sale). These redemptions are initially assigned aPENDING
state, but then change to aCOMPLETED
orCANCELED
state. - An update to the
IMPORT
activity for an imported gift card when the balance is later adjusted by Square.
Permissions
GIFTCARDS_READ
Name | Description |
---|---|
merchant_
|
The ID of the Square seller associated with the event. |
type
|
The type of event. For this event, the value is |
event_
|
The unique ID of the event, which is used for idempotency support. |
created_
|
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 |
data
|
The data associated with the event. |
Examples
Example payload
{
"merchant_id": "C337NFWQT2A6W",
"type": "gift_card.activity.updated",
"event_id": "875f2038-6015-492e-9f29-d040b3809e49",
"created_at": "2020-12-17T03:41:35.157Z",
"data": {
"type": "gift_card.activity",
"id": "gcact_c8f8cbf1f24b448d8ecf39ed03f97864",
"object": {
"gift_card_activity": {
"id": "gcact_c8f8cbf1f24b448d8ecf39ed03f97864",
"gift_card_id": "gftc:00113070ba5745f0b2377c1b9570cb03",
"gift_card_gan": "7783320007480908",
"type": "IMPORT",
"gift_card_balance_money": {
"amount": 1500,
"currency": "USD"
},
"location_id": "81FN9BNFZTKS4",
"import_activity_details": {
"amount_money": {
"amount": 1500,
"currency": "USD"
}
},
"created_at": "2020-12-17T01:41:35.157Z"
}
}
}
}