Object Index
You are viewing an old version of the API
TerminalRefund
Object Index
Represents a payment refund processed by the Square Terminal.
Only supports Interac (Canadian debit network) payment refunds.
Properties
Name | Description |
---|---|
id
|
Read only A unique ID for this |
refund_
|
Read only The reference to the payment refund created by completing this |
payment_
Required
|
The unique ID of the payment being refunded. |
order_
|
Read only The reference to the Square order ID for the payment identified by the |
amount_
Required
|
The amount of money, inclusive of |
reason
Required
|
A description of the reason for the refund. |
device_
Required
|
The unique ID of the device intended for this |
deadline_
|
The RFC 3339 duration, after which the refund is automatically canceled.
A Default: 5 minutes from creation. Maximum: 5 minutes Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S |
status
|
Read only The status of the |
cancel_
|
Read only Present if the status is |
created_
|
Read only The time when the 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 time when the 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 |
app_
|
Read only The ID of the application that created the refund. |
location_
|
Read only The location of the device where the |