POST /v2/locations/{location_id}/transactions/{transaction_id}/refund

Initiates a refund for a previously charged tender.

You must issue a refund within 120 days of the associated payment. See this article for more information on refund behavior.

NOTE: Card-present transactions with Interac credit cards cannot be refunded using the Connect API. Interac transactions must refunded in-person (e.g., dipping the card using POS app).

Servers

https://connect.squareup.com

Path parameters

Name	Type	Required	Description
`location_id`	String	Yes	The ID of the original transaction's associated location.
`transaction_id`	String	Yes	The ID of the original transaction that includes the tender to refund.

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
`tender_id`	String	Yes	The ID of the tender to refund. A `Transaction` has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API.
`reason`	String	No	A description of the reason for the refund. Default value: `Refund via API`
`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.
`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.
`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 value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. 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.