API Explorer

You are viewing an old version of the API

All Versions

Create gift card activity

Beta

- POST /v2/gift-cards/activities

Creates a gift card activity to manage the balance or state of a gift card.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

gift_card_activity

An activity to create on the gift card. This includes the type of gift card activity and corresponding activity details.

GiftCardActivity

location_id

The ID of the location at which the activity occurred.

string

type

The type of the gift card activity.

string

Select type

REDEEM Redeemed a gift card.

activate_activity_details

Gift card activity data for activating a gift card. This data is present only when the type is ACTIVATE.

GiftCardActivityActivate

adjust_decrement_activity_details

Gift card activity data for manually decreasing the balance of a gift card. Present only when type is ADJUST_DECREMENT

GiftCardActivityAdjustDecrement

adjust_increment_activity_details

Gift card activity data for manually increasing the balance of a gift card. Present only when type is ADJUST_INCREMENT

GiftCardActivityAdjustIncrement

clear_balance_activity_details

Gift card activity data for clearing the balance on a gift card. Present only when type is CLEAR_BALANCE

GiftCardActivityClearBalance

deactivate_activity_details

Gift card activity data for deactivating a gift card. Present only when type is DEACTIVATE

GiftCardActivityDeactivate

gift_card_gan

The gift card GAN. The GAN is not required if gift_card_id is present.

string

gift_card_id

The gift card ID. The ID is not required if a GAN is present.

string

load_activity_details

Gift card activity data for adding value to the gift card. This data is present only when the type is LOAD.

GiftCardActivityLoad

redeem_activity_details

Gift card activity data for redeeming a gift card. This data is present only when the type is REDEEM.

GiftCardActivityRedeem

amount_money

The amount of money to be added or removed, depending on the activity. The value of the field is always positive.

Money

amount

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.

integer

currency

The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.

string

Select currency

USD United States dollar

reference_id

A client-specified ID to associate an entity, in another system, with this gift card activity. This can be used to track the order or payment related information when the Square Orders API is not being used.

string