ListRefunds
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
Path parameters
The ID of the location to list refunds for.
Query parameters
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.
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.
The order in which results are listed in the response (ASC for oldest first, DESC for newest first).
Default value: DESC
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.
Response
Success
Example response
{
"refunds": [
{
"additional_recipients": [
{
"amount_money": {
"amount": 10,
"currency": "USD"
},
"description": "Application fees",
"location_id": "057P5VYJ4A5X1"
}
],
"amount_money": {
"amount": 100,
"currency": "USD"
},
"created_at": "2016-01-20T00:28:18Z",
"id": "b27436d1-7f8e-5610-45c6-417ef71434b4-SW",
"location_id": "18YC4JDH91E1H",
"reason": "some reason",
"status": "APPROVED",
"tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF",
"transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF"
}
]
}