Retrieve disputes status
You can request the status for a list of disputes by sending a POST
request to the /disputes/status-query
endpoint.
Important request fields
Request Field Name | Description | Required | Location |
---|---|---|---|
request-id |
Unique request identifier provided in the header by the requestor. | Y | Header |
statusInquiryParameters |
Any of:
|
Y | Body |
pageSize |
Maximum number of records that will be returned as the output for the requested page in the paginated response. | N | Body |
cursor |
Indicates the starting point for next set of data on the paginated response. When you make a request to the API and receive a response with a next page cursor, you can use that cursor in a subsequent request to retrieve the next page of results. | N | Body |
Important response fields
Response Field Name | Description |
---|---|
disputeStatus |
The label for the current stage of a case in the dispute resolution process. Allowed values:
|
outcome |
The outcome of a dispute. For chargebacks this will indicate the financial outcome for you after the dispute is solved. For retrieval requests, this will indicate whether the request have been fulfilled or not. Allowed Values:
|
financialAdjustmentIndicator |
Indicates that a recent activity or a status change has financial impact on your funded amount. Examples: a new dispute, issuer has reversed the chargeback, lost dispute, excess funds has been credited or debited, etc. This is reserved for future use. |
HTTP method: POST
Endpoint: /disputes/status-query
Scenario: Obtain the status for a list of disputes
{
"statusInquiryParameters": {
"companyIds": [],
"merchantIds": [
"446975"
],
"startDateTime": "2023-02-25T12:00:00.000Z",
"endDateTime": "2025-06-10T12:00:00.000Z"
},
"pagination": {
"pageSize": 3,
"cursor": ""
}
}
Response:
{
"requestId": "4df41777-a7b6-48d8-ad51-ccb27902a294",
"disputesStatusList": [
{
"disputeId": 297126465,
"disputeStatus": "CLOSED",
"outcome": "FULFILLED",
"disputeActionTimestamp": "2025-06-06T15:16:55.456471",
"financialAdjustmentIndicator": false,
"isReversed": false,
"relatedFinancialItems": null
},
{
"disputeId": 82368807,
"disputeStatus": "CLOSED",
"outcome": "LOST",
"disputeActionTimestamp": "2025-06-06T15:09:47.341151",
"financialAdjustmentIndicator": false,
"isReversed": false,
"relatedFinancialItems": null
},
{
"disputeId": 2468775517,
"disputeStatus": "CLOSED",
"outcome": "FULFILLED",
"disputeActionTimestamp": "2025-06-03T09:22:26.749452",
"financialAdjustmentIndicator": false,
"isReversed": false,
"relatedFinancialItems": null
}
],
"traceId": "d3823bb1-971d-42de-bc43-38bcd8e0ac9f",
"pagination": {
"cursor": "eyJjaWQiOltdLCJtaWQiOlsiNDQ2OTc1Il0sInBnIjoyLCJsdCI6Mywic3VzIjoiMjAyMy0wMi0yNVQxMjowMDowMFoiLCJzdWUiOiIyMDI1LTA2LTEwVDEyOjAwOjAwWiIsInRwZyI6NDJ9"
}
}