Object Index
You are viewing an old version of the API
PaymentRefund
Object Index
Represents a refund of a payment made using Square.
Contains information about the original payment and the amount of money refunded.
Properties
Name | Description |
---|---|
id
Required
|
The unique ID for this refund, generated by Square. |
status
|
The refund's status:
|
location_
|
The location ID associated with the payment this refund is attached to. |
unlinked
|
Read only Flag indicating whether or not the refund is linked to an existing payment in Square. |
destination_
|
The destination type for this refund. Current values include |
destination_
|
Read only Contains information about the refund destination. This field is populated only if
|
amount_
Required
|
The amount of money refunded. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). |
app_
|
The amount of money the application developer contributed to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts. |
processing_
|
Processing fees and fee adjustments assessed by Square for this refund. |
payment_
|
The ID of the payment associated with this refund. |
order_
|
The ID of the order associated with the refund. |
reason
|
The reason for the refund. |
created_
|
Read only The timestamp of 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 |
updated_
|
Read only The timestamp of when the refund was last updated, 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 |
team_
|
Read only An optional ID of the team member associated with taking the payment. |