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

Object Index

You are viewing an old version of the API
GiftCardActivityLoad BETA

Present only when GiftCardActivityType is LOAD.

Properties

Name Description
amount_money
Money

The amount of money to be added or removed, depending on the activity. The value of the field is always positive. This is not needed if order_id and line_item_id are provided.

order_id
string

The order_id of the order associated with the activity. It is populated along with line_item_uid and is required if using the Square Orders API.

line_item_uid
string

The line_item_uid of the gift card’s line item in the order associated with the activity. It is populated along with order_id and is required if using the Square Orders API.

reference_id
string

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.

buyer_payment_instrument_ids
string [ ]

If you are not using the Orders API, this field is required because it is used to identify a buyer to perform compliance checks.

Share feedback

Thanks for visiting the Square API documentation. What's on your mind?