Creates a request to refund an Interac payment completed on a Square Terminal.
Open in API Reference
A unique string that identifies this CreateRefund request. Keys can be any valid string but must be unique for every CreateRefund request.
CreateRefund
See Idempotency keys for more information.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The refund to create.
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.
tax_money
TerminalRefund
The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.
currency
USD
amount
The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
The unique ID of the device intended for this TerminalRefund. The Id can be retrieved from /v2/devices api.
The unique ID of the payment being refunded.
A description of the reason for the refund.
The RFC 3339 duration, after which the refund is automatically canceled. A TerminalRefund that is PENDING is automatically CANCELED and has a cancellation reason of TIMED_OUT.
PENDING
CANCELED
TIMED_OUT
Default: 5 minutes from creation.
Maximum: 5 minutes
Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S
// No response received yet.