Enum GiftCardActivityType

pub enum GiftCardActivityType {
    Activate,
    Load,
    Redeem,
    ClearBalance,
    Deactivate,
    AdjustIncrement,
    AdjustDecrement,
    Refund,
    UnlinkedActivityRefund,
    Import,
    Block,
    Unblock,
    ImportReversal,
}

Indicates the type of the gift card activity.

Variants

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.

ClearBalance

Set the balance of a gift card to zero.

Deactivate

Permanently blocked a gift card from balance-changing activities.

AdjustIncrement

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

AdjustDecrement

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

Refund

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

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

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.

ImportReversal

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.

Trait Implementations

impl Clone for GiftCardActivityType

fn clone(&self) -> GiftCardActivityType

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GiftCardActivityType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GiftCardActivityType

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GiftCardActivityType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GiftCardActivityType

fn eq(&self, other: &GiftCardActivityType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GiftCardActivityType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GiftCardActivityType

impl StructuralPartialEq for GiftCardActivityType