Network APIRefunds

List refunds

Returns a list of refunds matching the given query parameters.

This endpoint is rate limited to 100 QPS.

Scopes: REFUNDS_READ

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Query parameters

cursorstringOptional>=1 character
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.
reference_idstringOptional>=1 character<=1024 characters

Filters results to only include refunds with a reference_id matching the given value.

customer_idstringOptional>=1 character<=128 characters
Filters results to only include refunds made to a customer that matches the the given ID.
merchant_idstringOptional>=1 character<=128 characters
Filters results to only include refunds made by a merchant that matches the given ID.
limitintegerOptional>=1<=100Defaults to 50
Maximum number of refunds to return.

Response

OK
refundslist of objects
List of refunds matching the given query parameters.
cursorstring or null
The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors