Object Index

You are viewing an old version of the API

2020-12-16

Version 2020-12-16

• All Versions

TerminalRefund BETA

Read only A unique ID for this TerminalRefund

Read only The reference to the payment refund created by completing this TerminalRefund.

Unique ID of the payment being refunded.

Read only The reference to the Square order id for the payment identified by the payment_id.

The amount of money, inclusive of tax_money, that the TerminalRefund should return. This value is limited to the amount taken in the original payment minus any completed or pending refunds.

A description of the reason for the refund. Note: maximum 192 characters

The unique Id of the device intended for this TerminalRefund. The Id can be retrieved from /v2/devices api.

The duration as an RFC 3339 duration, after which the refund will be automatically canceled. TerminalRefunds that are PENDING will be automatically CANCELED and have a cancellation reason of TIMED_OUT

Default: 5 minutes from creation

Maximum: 5 minutes

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

Read only The status of the TerminalRefund. Options: PENDING, IN_PROGRESS, CANCELED, COMPLETED

Read only Present if the status is CANCELED.

Read only The time when the TerminalRefund was created as an RFC 3339 timestamp.

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

Read only The time when the TerminalRefund was last updated as an RFC 3339 timestamp.

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