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

Object Index

You are viewing an old version of the API
GiftCardActivity

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

A gift card activity contains information about a specific activity type. For example, a REDEEM activity includes a redeem_activity_details field that contains information about the redemption.

Properties

Name Description
id
string

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

type
string

Required

The type of gift card activity.

location_id
string

Required

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

gift_card_gan
string

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

gift_card_balance_money
Money

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

load_activity_details
GiftCardActivityLoad

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

activate_activity_details
GiftCardActivityActivate

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

redeem_activity_details
GiftCardActivityRedeem

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.

clear_balance_activity_details
GiftCardActivityClearBalance

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

deactivate_activity_details
GiftCardActivityDeactivate

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

adjust_increment_activity_details
GiftCardActivityAdjustIncrement

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.

adjust_decrement_activity_details
GiftCardActivityAdjustDecrement

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

refund_activity_details
GiftCardActivityRefund

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.

unlinked_activity_refund_activity_details
GiftCardActivityUnlinkedActivityRefund

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.

import_activity_details
GiftCardActivityImport

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

block_activity_details
GiftCardActivityBlock

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

unblock_activity_details
GiftCardActivityUnblock

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

import_reversal_activity_details
GiftCardActivityImportReversal

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