GET /v2/locations/{location_id}/refunds
Lists refunds for one of a business's locations.
In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications.
Refunds with a status of PENDING are not currently included in this
endpoint's response.
Max results per page: 50
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | Yes |
The ID of the location to list refunds for. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
begin_time |
String | No |
The beginning of the requested reporting period, in RFC 3339 format. See Date ranges for details on date inclusivity/exclusivity. Default value: The current time minus one year. |
sort_order |
String | No |
The order in which results are listed in the response ( Default value: |
cursor |
String | No |
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See Paginating results for more information. |
end_time |
String | No |
The end of the requested reporting period, in RFC 3339 format. See Date ranges for details on date inclusivity/exclusivity. Default value: The current time. |
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.