<- Object

Object

All versions ->

GiftCardActivityBeta

Represents an action performed on a gift card that affects its state or balance.

Link to section

Properties

Link to section

id

string

Read only The unique ID of the gift card activity.

Link to section

type

string

Required

The type of the gift card activity.

Link to section

location_id

string

Required

The ID of the location at which the activity occurred.

Link to section

created_at

string

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

Link to section

gift_card_id

string

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

Link to section

gift_card_gan

string

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

Link to section

gift_card_balance_money

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

Link to section

load_activity_details

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

Link to section

activate_activity_details

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

Link to section

redeem_activity_details

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

Link to section

clear_balance_activity_details

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

Link to section

deactivate_activity_details

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

Link to section

adjust_increment_activity_details

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

Link to section

adjust_decrement_activity_details

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

Link to section

refund_activity_details

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

Link to section

unlinked_activity_refund_activity_details

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

Link to section

import_activity_details

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.

Link to section

block_activity_details

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

Link to section

unblock_activity_details

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

Link to section

import_reversal_activity_details

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