GiftCardActivities
Creates and lists gift card activities.
Table Specific Information
Select
The add-in uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
- Type supports the following operator: =.
- LocationId supports the following operator: =.
- GiftCardId supports the following operator: =.
- CreatedAt supports the following operator: =.
For example, the following queries are processed server-side:
SELECT * FROM GiftCardActivities WHERE LocationId = 'J1AXYEY5C0VTZ'
SELECT * FROM GiftCardActivities WHERE CreatedAt = '2025-07-08 01:41:10.0'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The Square-assigned ID of the gift card activity. |
| Type | String | False |
The type of gift card activity. The allowed values are ACTIVATE, LOAD, REDEEM, CLEAR_BALANCE, DEACTIVATE, ADJUST_INCREMENT, ADJUST_DECREMENT, REFUND, UNLINKED_ACTIVITY_REFUND, IMPORT, BLOCK, UNBLOCK, IMPORT_REVERSAL, TRANSFER_BALANCE_TO, TRANSFER_BALANCE_FROM. |
| LocationId | String | False |
The ID of the business location where the activity occurred. |
| GiftCardId | String | False |
The gift card ID. When creating a gift card activity, gift_card_id is not required if gift_card_gan is specified. |
| GiftCardAccountNumber | String | False |
The gift card account number (GAN). When creating a gift card activity, gift_card_gan is not required if gift_card_id is specified. |
| GiftCardBalanceMoneyAmount | Int64 | True |
The final balance amount on the gift card after the action is completed. |
| GiftCardBalanceMoneyCurrency | String | True |
The type of balance amount currency, in ISO 4217 format. |
| CreatedAt | Datetime | True |
The timestamp when the gift card activity was created, in RFC 3339 format. |
| GiftCardActivityLoadMoneyAmount | Int64 | False |
The amount of money added to the gift card. This value is a positive integer. |
| GiftCardActivityLoadMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityLoadOrderId | String | False |
The ID of the order that contains the GIFT_CARD line item. |
| GiftCardActivityLoadLineItemUid | String | False |
The UID of the GIFT_CARD line item in the order that represents the additional funds for the gift card. |
| GiftCardActivityLoadReferenceId | String | False |
A client-specified ID that associates the gift card activity with an entity in another system. |
| GiftCardActivityLoadBuyerPaymentInstrumentIds | String | False |
The payment instrument IDs used to process the order for the additional funds, such as a credit card ID or bank account ID. |
| GiftCardActivityActivateMoneyAmount | Int64 | False |
The amount of money added to the gift card. This value is a positive integer. |
| GiftCardActivityActivateMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityActivateOrderId | String | False |
The ID of the order that contains the GIFT_CARD line item. |
| GiftCardActivityActivateLineItemUid | String | False |
The UID of the GIFT_CARD line item in the order that represents the gift card purchase. |
| GiftCardActivityActivateReferenceId | String | False |
A client-specified ID that associates the gift card activity with an entity in another system. |
| GiftCardActivityActivateBuyerPaymentInstrumentIds | String | False |
The payment instrument IDs used to process the gift card purchase, such as a credit card ID or bank account ID. |
| GiftCardActivityRedeemMoneyAmount | Int64 | False |
The amount of money deducted from the gift card for the redemption. This value is a positive integer. |
| GiftCardActivityRedeemMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityRedeemMoneyPaymentId | String | False |
The ID of the payment that represents the gift card redemption. |
| GiftCardActivityRedeemMoneyReferenceId | String | False |
A client-specified ID that associates the gift card activity with an entity in another system. |
| GiftCardActivityRedeemMoneyStatus | String | False |
The status of the gift card redemption. The allowed values are PENDING, COMPLETED, CANCELED. |
| GiftCardActivityClearBalanceReason | String | False |
The reason the gift card balance was cleared. The allowed values are SUSPICIOUS_ACTIVITY, REUSE_GIFTCARD, UNKNOWN_REASON. |
| GiftCardActivityDeactivateReason | String | False |
The reason the gift card was deactivated. The allowed values are SUSPICIOUS_ACTIVITY, UNKNOWN_REASON, CHARGEBACK_DEACTIVATE. |
| GiftCardActivityAdjustIncrementMoneyAmount | Int64 | False |
The amount of money added to the gift card balance. This value is a positive integer. |
| GiftCardActivityAdjustIncrementMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityAdjustIncrementReason | String | False |
The reason the gift card balance was adjusted. |
| GiftCardActivityAdjustDecrementMoneyAmount | Int64 | False |
The amount of money deducted from the gift card balance. This value is a positive integer. |
| GiftCardActivityAdjustDecrementMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityAdjustDecrementReason | String | False |
The reason the gift card balance was adjusted. |
| GiftCardActivityRefundRedeemActivityId | String | False |
The ID of the refunded REDEEM gift card activity. |
| GiftCardActivityRefundMoneyAmount | Int64 | False |
The amount of money added to the gift card for the refund. This value is a positive integer. |
| GiftCardActivityRefundMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityRefundReferenceId | String | False |
A client-specified ID that associates the gift card activity with an entity in another system. |
| GiftCardActivityRefundPaymentId | String | False |
The ID of the refunded payment. |
| GiftCardActivityUnlinkedActivityRefundMoneyAmount | Int64 | False |
The amount added to the gift card for the refund. This value is a positive integer. |
| GiftCardActivityUnlinkedActivityRefundMoneyCurrency | String | False |
The type of currency, in ISO 4217 format. |
| GiftCardActivityUnlinkedActivityRefundReferenceId | String | False |
A client-specified ID that associates the gift card activity with an entity in another system. |
| GiftCardActivityUnlinkedActivityRefundPaymentId | String | False |
The ID of the refunded payment. |
| GiftCardActivityImportMoneyAmount | Int64 | True |
The balance amount on the imported gift card. |
| GiftCardActivityImportMoneyCurrency | String | True |
The type of currency, in ISO 4217 format. |
| GiftCardActivityBlockReason | String | True |
The reason the gift card was blocked. The allowed values are CHARGEBACK_BLOCK. |
| GiftCardActivityUnblockReason | String | True |
The reason the gift card was unblocked. The allowed values are CHARGEBACK_UNBLOCK. |
| GiftCardActivityImportReversalMoneyAmount | Int64 | True |
The amount of money cleared from the third-party gift card when the import was reversed. |
| GiftCardActivityImportReversalMoneyCurrency | String | True |
The type of currency, in ISO 4217 format. |
| GiftCardActivityTransferBalanceToTransferFromGiftCardId | String | True |
The ID of the gift card from which the specified amount was transferred. |
| GiftCardActivityTransferBalanceToMoneyAmount | Int64 | True |
The amount of money added to the gift card balance for the transfer. This value is a positive integer. |
| GiftCardActivityTransferBalanceToMoneyCurrency | String | True |
The type of currency, in ISO 4217 format. |
| GiftCardActivityTransferBalanceFromTransferToGiftCardId | String | True |
The ID of the gift card to which the specified amount was transferred. |
| GiftCardActivityTransferBalanceFromMoneyAmount | Int64 | True |
The amount of money deducted from the gift card for the transfer. This value is a positive integer. |
| GiftCardActivityTransferBalanceFromMoneyCurrency | String | True |
The type of currency, in ISO 4217 format. |