List disputes
Changed onRetrieve a paginated list of disputes with optional filters. By default, returns disputes not in final status or disputes that reached final status within the last 30 days.
Request
- Base URLhttps://sandbox.api.caas.reap.global
- AuthAPI key in header x-reap-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The page number to retrieve in a paginated response. Used in combination with limit to specify the starting point for a subset of records. (default: 1, min: 1)
A limit on the number of objects to be returned. (default: 50, max: 100)
Filter by status (comma-separated values)
Filter by card ID
Filter by transaction ID
The start date for filtering the records, formatted as YYYY-MM-DD. Only records from this date onwards will be retrieved.
The end date for filtering the records, formatted as YYYY-MM-DD. Only records up to this date will be retrieved.
Headers
Specifies the API version to use for this request.
Response
Return disputes list
Example response
{
"items": [
{
"cardLast4": "4242",
"cardType": "virtual",
"transactionDate": "2024-01-10",
"transactionName": "AMAZON.COM",
"source": "API",
"refundAmount": 80,
"refundCurrency": "840"
}
]
}Changes
- breaking
the response property
//became nullable for the status - breaking
the response property
//became nullable for the status - breaking
the response property
//became optional for the status - breaking
the response property
//became optional for the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking