<- Object

Object

GiftCardActivityRefund

Link to section

Properties

Link to section

redeem_activity_id

string

The ID of the refunded REDEEM gift card activity. Square populates this field if the payment_id in the corresponding RefundPayment request represents a gift card redemption.

For applications that use a custom payment processing system, this field is required when creating a REFUND activity. The provided REDEEM activity ID must be linked to the same gift card.

Link to section

amount_money

The amount added to the gift card for the refund. This value is a positive integer.

This field is required when creating a REFUND activity. The amount can represent a full or partial refund.

Link to section

reference_id

string

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

Link to section

payment_id

string

Read only The ID of the refunded payment. Square populates this field if the refund is for a payment processed by Square. This field matches the payment_id in the corresponding RefundPayment request.