POST /v2/terminals/refunds

Creates a request to refund an Interac payment completed on a Square Terminal.

Servers

https://connect.squareup.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`refund`	Object	No
`refund.cancel_reason`	String	No	Present if the status is `CANCELED`.
`refund.deadline_duration`	String	No	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`. Default: 5 minutes from creation. Maximum: 5 minutes
`refund.app_id`	String	No	The ID of the application that created the refund.
`refund.status`	String	No	The status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCELED`, or `COMPLETED`.
`refund.payment_id`	String	Yes	The unique ID of the payment being refunded.
`refund.updated_at`	String	No	The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp.
`refund.id`	String	No	A unique ID for this `TerminalRefund`.
`refund.location_id`	String	No	The location of the device where the `TerminalRefund` was directed.
`refund.order_id`	String	No	The reference to the Square order ID for the payment identified by the `payment_id`.
`refund.refund_id`	String	No	The reference to the payment refund created by completing this `TerminalRefund`.
`refund.device_id`	String	No	The unique ID of the device intended for this `TerminalRefund`. The Id can be retrieved from /v2/devices api.
`refund.created_at`	String	No	The time when the `TerminalRefund` was created, as an RFC 3339 timestamp.
`refund.reason`	String	No	A description of the reason for the refund. Note: maximum 192 characters
`refund.amount_money`	Object	Yes	Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
`refund.amount_money.amount`	Integer	No	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.
`refund.amount_money.currency`	String	No	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is `USD`. See Currency for possible values.
`idempotency_key`	String	Yes	A unique string that identifies this `CreateRefund` request. Keys can be any valid string but must be unique for every `CreateRefund` request. See Idempotency keys for more information.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.