Creates a gift card activity to manage the balance or state of a gift card.
Open in API Reference
The activity to create for the gift card. This activity must specify gift_card_id or gift_card_gan for the target gift card, the location_id where the activity occurred, and the activity type along with the corresponding activity details.
gift_card_id
gift_card_gan
location_id
type
The ID of the business location where the activity occurred.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The type of gift card activity.
Additional details about an ACTIVATE activity, which is used to activate a gift card with an initial balance.
ACTIVATE
The amount added to the gift card. This value is a positive integer.
Applications that use a custom order processing system must specify this amount in the CreateGiftCardActivity request.
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.
currency
USD
amount
The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
The payment instrument IDs used to process the gift card purchase, such as a credit card ID or bank account ID.
Applications that use a custom order processing system must specify payment instrument IDs in the CreateGiftCardActivity request. Square uses this information to perform compliance checks.
For applications that use the Square Orders API to process payments, Square has the necessary instrument IDs to perform compliance checks.
The UID of the GIFT_CARD line item in the order that represents the gift card purchase.
GIFT_CARD
Applications that use the Square Orders API to process orders must specify the line item UID in the CreateGiftCardActivity request.
The ID of the order that contains the GIFT_CARD line item.
Applications that use the Square Orders API to process orders must specify the order ID CreateGiftCardActivity request.
A client-specified ID that associates the gift card activity with an entity in another system.
Applications that use a custom order processing system can use this field to track information related to an order or payment.
Additional details about an ADJUST_DECREMENT activity, which is used to deduct money from a gift card outside of a typical REDEEM activity flow.
ADJUST_DECREMENT
REDEEM
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_INCREMENT
LOAD
REFUND
Additional details about a CLEAR_BALANCE activity, which is used to set the balance of a gift card to zero.
CLEAR_BALANCE
Additional details about a DEACTIVATE activity, which is used to deactivate a gift card.
DEACTIVATE
The gift card account number (GAN). When creating a gift card activity, gift_card_gan is not required if gift_card_id is specified.
The gift card ID. When creating a gift card activity, gift_card_id is not required if gift_card_gan is specified.
Additional details about a LOAD activity, which is used to reload money onto a gift card.
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.
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.
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.
UNLINKED_ACTIVITY_REFUND
A unique string that identifies the CreateGiftCardActivity request.
CreateGiftCardActivity
// No response received yet.