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

Object Index

You are viewing an old version of the API
Refund

Represents a refund processed for a Square transaction.

Properties

Name Description
id
string

Required

The refund's unique ID.

Max Length 255
location_id
string

Required

The ID of the refund's associated location.

Max Length 50
transaction_id
string

Required

The ID of the transaction that the refunded tender is part of.

Max Length 192
tender_id
string

Required

The ID of the refunded tender.

Max Length 192
created_at
string

Read only The timestamp for when the refund was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length 32
reason
string

Required

The reason for the refund being issued.

Max Length 192
amount_money
Money

Required

The amount of money refunded to the buyer.

status
string

Required

The current status of the refund (PENDING, APPROVED, REJECTED, or FAILED).

processing_fee_money
Money

The amount of Square processing fee money refunded to the merchant.

additional_recipients
AdditionalRecipient [ ]

Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.

Share Feedback

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