Request tracking

When you create a dispute in our system, you receive a request ID as a response. You can use this ID to know the status of the creation.

When making a request to the dispute requests endpoint using the request ID, you’ll get a response like this one:

{  
  "requestId": "cfOS9FlniYcESZg=",  
  "accountId": "dc999742-b479-4e49-8d14-99139873ce52",  
  "created": "2024-09-02T14:00:00Z",  
  "updated": "2024-09-02T14:02:32Z",  
  "status": "COMPLETED",  
  "disputes": ["9c1515f3-ba6e-4cda-a6a0-5d6b9721523a"]  
}

Field	Description	Observations
requestId	The requested ID status.
accountId	The account ID associated with the request (and API Key).
created	The date when the dispute request was created.
updated	The date when the dispute request was last updated.
status	The status of the request.	Valid states are IN_PROGRESS, COMPLETE, and FAILED.
disputes	An array of dispute IDs was created. These IDs can be used to get the dispute details in Backoffice.

When a dispute is created it has the IN_PROGRESS status. Once resolved, it can either have the COMPLETE or FAILED status. If the status is FAILED, it comes with an additional errors property, which is an array of objects with the following format:

{
  "dispute": { ... },
  "error": "...",
}

The dispute key contains the details of the dispute that was in the process of being created. The error is a string containing details about what happened.