• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
GiftCardActivity BETA

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

Properties

Name Description
id
string

Read only The unique ID of the gift card activity.

type
string

Required

The type of the gift card activity.

location_id
string

Required

The ID of the location at which the activity occurred.

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

gift_card_id
string

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

gift_card_gan
string

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

gift_card_balance_money
Money

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

load_activity_details
GiftCardActivityLoad

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

activate_activity_details
GiftCardActivityActivate

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

redeem_activity_details
GiftCardActivityRedeem

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

clear_balance_activity_details
GiftCardActivityClearBalance

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

deactivate_activity_details
GiftCardActivityDeactivate

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

adjust_increment_activity_details
GiftCardActivityAdjustIncrement

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

adjust_decrement_activity_details
GiftCardActivityAdjustDecrement

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

refund_activity_details
GiftCardActivityRefund

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

unlinked_activity_refund_activity_details
GiftCardActivityUnlinkedActivityRefund

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

import_activity_details
GiftCardActivityImport

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_activity_details
GiftCardActivityBlock

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

unblock_activity_details
GiftCardActivityUnblock

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

import_reversal_activity_details
GiftCardActivityImportReversal

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