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

Object Index

You are viewing an old version of the API
GiftCardActivityRedeem BETA

Present only when GiftCardActivityType is REDEEM.

Properties

Name Description
amount_money
Money

Required

The amount of money to be added or removed, depending on the activity. The value of the field is always positive.

payment_id
string

Read only When the Square Payments API is used, Redeem is not called on the Gift Cards API. However, when Square reads a Redeem activity from the Gift Cards API, developers need to know the associated payment_id.

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.

Share feedback

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