GiftCardActivityType enum

Inheritance

• Object
• Enum
• GiftCardActivityType

Constructors

GiftCardActivityType()

const

Values

activate → const GiftCardActivityType

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 → const GiftCardActivityType

Loaded a gift card with additional funds.

redeem → const GiftCardActivityType

Redeemed a gift card for a purchase.

clearBalance → const GiftCardActivityType

Set the balance of a gift card to zero.

deactivate → const GiftCardActivityType

Permanently blocked a gift card from balance-changing activities.

adjustIncrement → const GiftCardActivityType

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

adjustDecrement → const GiftCardActivityType

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

refund → const GiftCardActivityType

Added money to a gift card from a refunded transaction. A `REFUND activity 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 using Square Point of Sale, the Square Seller Dashboard, or the Refunds API.
• A cross-tender payment processed by Square can be refunded to a gift card using Square Point of Sale or the Square Seller Dashboard. The payment source might be a credit card or different gift card.
• A payment processed using a custom payment processing system can be refunded to the same gift card.

unlinkedActivityRefund → const GiftCardActivityType

Added money to a gift card from a refunded transaction that was processed using a custom payment processing system and not linked to the gift card.

import → const GiftCardActivityType

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 → const GiftCardActivityType

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 → const GiftCardActivityType

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.

importReversal → const GiftCardActivityType

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.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<GiftCardActivityType>

A constant List of the values in this enum, in order of their declaration.