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

Object Index

You are viewing an old version of the API
GiftCardActivityLoad

Represents details about a LOAD gift card activity type.

Properties

Name Description
amount_money
Money

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.

order_id
string

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 in the CreateGiftCardActivity request.

line_item_uid
string

The UID of the GIFT_CARD line item in the order that represents the additional funds for the gift card.

Applications that use the Square Orders API to process orders must specify the line item UID in the CreateGiftCardActivity request.

reference_id
string

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.

buyer_payment_instrument_ids
string [ ]

The payment instrument IDs used to process the order for the additional funds, 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.