Object Index

You are viewing an old version of the API

2023-01-19

Version 2023-01-19

• All Versions

GiftCardActivity

Read only The Square-assigned ID of the gift card activity.

The type of gift card activity.

The ID of the business location where 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. When creating a gift card activity, gift_card_id is not required if gift_card_gan is specified.

The gift card account number (GAN). When creating a gift card activity, gift_card_gan is not required if gift_card_id is specified.

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

Additional details about a LOAD activity, which is used to reload money onto a gift card.

Additional details about an ACTIVATE activity, which is used to activate a gift card with an initial balance.

Additional details about a REDEEM activity, which is used to redeem a gift card for a purchase.

For applications that process payments using the Square Payments API, Square creates a REDEEM activity that updates the gift card balance after the corresponding CreatePayment request is completed. Applications that use a custom payment processing system must call CreateGiftCardActivity to create the REDEEM activity.

Additional details about a CLEAR_BALANCE activity, which is used to set the balance of a gift card to zero.

Additional details about a DEACTIVATE activity, which is used to deactivate a gift card.

Additional details about an ADJUST_INCREMENT activity, which is used to add money to a gift card outside of a typical ACTIVATE, LOAD, or REFUND activity flow.

Additional details about an ADJUST_DECREMENT activity, which is used to deduct money from a gift card outside of a typical REDEEM activity flow.

Additional details about a REFUND activity, which is used to add money to a gift card when refunding a payment.

For applications that process payments using the Square Payments API, Square creates a REFUND activity that updates the gift card balance after the corresponding RefundPayment request is completed. Applications that use a custom payment processing system must call CreateGiftCardActivity to create the REFUND activity.

Additional details about an UNLINKED_ACTIVITY_REFUND activity. This activity is used to add money to a gift card when refunding a payment that was processed using a custom payment processing system and not linked to the gift card.

Read only Additional details about an IMPORT activity, which Square uses to import a third-party gift card with a balance.

Read only Additional details about a BLOCK activity, which Square uses to temporarily block a gift card.

Read only Additional details about an UNBLOCK activity, which Square uses to unblock a gift card.

Read only Additional details about an IMPORT_REVERSAL activity, which Square uses to reverse the import of a third-party gift card.

Read only Additional details about a TRANSFER_BALANCE_TO activity, which Square uses to add money to a gift card as the result of a transfer from another gift card.

Read only Additional details about a TRANSFER_BALANCE_FROM activity, which Square uses to deduct money from a gift as the result of a transfer to another gift card.