GiftCardActivityLoadBeta

Present only when GiftCardActivityType is LOAD.

Link to section

Properties

Link to section

amount_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.

Link to section

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.

Link to section

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.

Link to section

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.

Link to section

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.