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

Object Index

You are viewing an old version of the API
GiftCardActivityActivate BETA

Describes a gift card activity of the ACTIVATE type.

Properties

Name Description
amount_money
Money

The amount of money to add to the card. This is required if your application does not use the Square Orders API.

order_id
string

The ID of the order associated with the activity. This is required if your application uses the Square Orders API.

line_item_uid
string

The line_item_uid of the gift card line item in an order. This is required if your application uses the Square Orders API.

reference_id
string

If your application does not use the Square Orders API, you can optionally use this field to associate the gift card activity with a client-side entity.

buyer_payment_instrument_ids
string [ ]

Required if your application does not use the Square Orders API. This is a list of client-provided payment instrument IDs. Square uses this information to perform compliance checks. If you use the Square Orders API, Square has the necessary instrument IDs to perform necessary compliance checks.

Share feedback

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