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

Enum

You are viewing an old version of the API

GiftCardActivityType

Indicates the type of gift card activity.

Values

ACTIVATE

Activated a gift card with a balance. When a gift card is activated, Square changes the gift card state from PENDING to ACTIVE. A gift card must be in the ACTIVE state to be used for other balance-changing activities.

LOAD

Loaded a gift card with additional funds.

REDEEM

Redeemed a gift card for a purchase.

CLEAR_BALANCE

Set the balance of a gift card to zero.

DEACTIVATE

Permanently blocked a gift card from balance-changing activities.

ADJUST_INCREMENT

Added money to a gift card outside of a typical ACTIVATE, LOAD, or REFUND activity flow.

ADJUST_DECREMENT

Deducted money from a gift card outside of a typical REDEEM activity flow.

REFUND

Added money to a gift card from a refunded transaction. The refund might be linked to a Square payment, depending on how the payment and refund are processed. For example:

  • A gift card payment processed by Square can be refunded to the same gift card.
  • A cross-tender payment processed by Square can be refunded to a gift card. The cross-tender payment source can be a credit card or different gift card.
  • A payment processed with a custom processing system (instead of the Square Payments API) can be refunded to a gift card.
UNLINKED_ACTIVITY_REFUND

Added money to a gift card from a refunded transaction that is not linked to the gift card.

This activity type is included for backward compatibility and should not be used to create a refund. Instead, use the REFUND activity type.

IMPORT

Imported a third-party gift card with a balance. IMPORT activities are managed by Square and cannot be created using the Gift Card Activities API.

BLOCK

Temporarily blocked a gift card from balance-changing activities. BLOCK activities are managed by Square and cannot be created using the Gift Card Activities API.

UNBLOCK

Unblocked a gift card, which enables it to resume balance-changing activities. UNBLOCK activities are managed by Square and cannot be created using the Gift Card Activities API.

IMPORT_REVERSAL

Reversed the import of a third-party gift card, which sets the gift card state to PENDING and clears the balance. IMPORT_REVERSAL activities are managed by Square and cannot be created using the Gift Card Activities API.