Object Index
You are viewing an old version of the API
GiftCardActivity
BETA
Object Index
Represents an action performed on a gift card that affects its state or balance.
Properties
Name | Description |
---|---|
id
|
Read only The unique ID of the gift card activity. |
type
Required
|
The type of the gift card activity. |
location_
Required
|
The ID of the location at which the activity occurred. |
created_
|
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 |
gift_
|
The gift card ID. The ID is not required if a GAN is present. |
gift_
|
The gift card GAN. The GAN is not required if |
gift_
|
Read only The final balance on the gift card after the action is completed. |
load_
|
Gift card activity data for adding value to the gift card. This data is present only when the type is LOAD. |
activate_
|
Gift card activity data for activating a gift card. This data is present only when the type is ACTIVATE. |
redeem_
|
Gift card activity data for redeeming a gift card. This data is present only when the type is REDEEM. |
clear_
|
Gift card activity data for clearing the balance on a gift card. Present only when type is CLEAR_BALANCE |
deactivate_
|
Gift card activity data for deactivating a gift card. Present only when type is DEACTIVATE |
adjust_
|
Gift card activity data for manually increasing the balance of a gift card. Present only when type is ADJUST_INCREMENT |
adjust_
|
Gift card activity data for manually decreasing the balance of a gift card. Present only when type is ADJUST_DECREMENT |
refund_
|
Gift card activity data for refunding an activity. This data is present only when the type is REFUND. |
unlinked_
|
Gift card activity data for refunding an unlinked activity.
Present only when type is |
import_
|
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. |
block_
|
Read only Gift card activity data for blocking a gift card. This data is present only when the type is BLOCK. |
unblock_
|
Read only Gift card activity data for unblocking a gift card. This data is present only when the type is UNBLOCK. |
import_
|
Read only Gift card activity data for reversing a third party import. Present only when type = IMPORT_REVERSAL |