POST /v1/{location_id}/refunds
Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.
You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment.
Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | Yes |
The ID of the original payment's associated location. |
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 |
|---|---|---|---|
type |
String | Yes |
The type of refund (FULL or PARTIAL). |
payment_id |
String | Yes |
The ID of the payment to refund. If you are creating a |
reason |
String | Yes |
The reason for the refund. |
request_idempotence_key |
String | No |
An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once. |
refunded_money |
Object | No | |
refunded_money.currency_code |
String | No | |
refunded_money.amount |
Integer | No |
Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). |
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.