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

Object Index

You are viewing an old version of the API
GiftCardActivityRedeem

Represents details about a REDEEM gift card activity type.

Properties

Name Description
amount_money
Money

Required

The amount deducted from the gift card for the redemption. This value is a positive integer.

Applications that use a custom payment processing system must specify this amount in the CreateGiftCardActivity request.

payment_id
string

Read only The ID of the payment that represents the gift card redemption. Square populates this field if the payment was processed by Square.

reference_id
string

A client-specified ID that associates the gift card activity with an entity in another system.

Applications that use a custom payment processing system can use this field to track information related to an order or payment.

status
string

Read only The status of the gift card redemption. Gift cards redeemed from Square Point of Sale or the Square Seller Dashboard use a two-state process: PENDING to COMPLETED or PENDING to CANCELED. Gift cards redeemed using the Gift Card Activities API always have a COMPLETED status.