Object Index

You are viewing an old version of the API

2021-07-21

Version 2021-07-21

• All Versions

GiftCardActivity BETA

Read only The unique ID of the gift card activity.

The type of the gift card activity.

The ID of the location at which the activity occurred.

Read only The timestamp when the gift card activity 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

The gift card ID. The ID is not required if a GAN is present.

The gift card GAN. The GAN is not required if gift_card_id is present.

Read only The final balance on the gift card after the action is completed.

Gift card activity data for adding value to the gift card. This data is present only when the type is LOAD.

Gift card activity data for activating a gift card. This data is present only when the type is ACTIVATE.

Gift card activity data for redeeming a gift card. This data is present only when the type is REDEEM.

Gift card activity data for clearing the balance on a gift card. Present only when type is CLEAR_BALANCE

Gift card activity data for deactivating a gift card. Present only when type is DEACTIVATE

Gift card activity data for manually increasing the balance of a gift card. Present only when type is ADJUST_INCREMENT

Gift card activity data for manually decreasing the balance of a gift card. Present only when type is ADJUST_DECREMENT

Gift card activity data for refunding an activity. This data is present only when the type is REFUND.

Gift card activity data for refunding an unlinked activity. Present only when type is UNLINKED_ACTIVITY_REFUND.

Read only Gift card activity data for when a third-party gift card is imported to Square with a balance. This data is present only when the type is IMPORT.

Read only Gift card activity data for blocking a gift card. This data is present only when the type is BLOCK.

Read only Gift card activity data for unblocking a gift card. This data is present only when the type is UNBLOCK.

Read only Gift card activity data for reversing a third party import. Present only when type = IMPORT_REVERSAL