V1List refunds

GET

/v1/{location_id}/refunds

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range.

Date ranges cannot exceed one year in length.

Permissions:PAYMENTS_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

location_id

string

Required

The ID of the location to list refunds for.

Link to section

Query parameters

Link to section

order

string

The order in which payments are listed in the response.

Link to section

begin_time

string

The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

Link to section

end_time

string

The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

Link to section

limit

integer(32-bit)

The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.

Link to section

batch_token

string

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Link to section

Response fields

Link to section

{items}