List disputes
View disputes for your account with filters and cursor pagination.
View cases for the authenticated company and environment, with filters and sorting. Use the identifier from a result to retrieve its details.
See List disputes and navigate pages for pagination and Tracking stages to interpret the progress of each case.
Query Params
Number of disputes per page. Invalid values use the default; values above the maximum use the limit.
From 1 to 100
Cursor from page.next_after in the previous response. Keep the filters and sorting; do not send together with before.
Up to 128 characters
Cursor from page.previous_before to go back. Keep the filters and sorting; do not send together with after.
Up to 128 characters
Comma-separated case stages: open, in_analysis, refund_in_analysis, closed, cancelled, rejected or failed. Closed indicates a closed review, without confirming a favorable decision or refund.
Up to 256 characters
Filter by the linked charge using its complete public identifier. A valid ID with no accessible cases returns an empty list.
Up to 100 characters
Filter by the exact disputed amount, in Brazilian real cents. This does not represent the amount currently held.
Minimum 0
Include disputes created from this instant onward, in Unix seconds in UTC. The boundary is inclusive.
From 1 to 253402300799
Include disputes created up to this instant, in Unix seconds in UTC. The boundary is inclusive and must be equal to or later than created_gte.
From 1 to 253402300799
Field used to sort the list: creation date or disputed amount.
Ascending or descending order of the selected field.
Responses
Response Body
Page of disputes matching the filters. Ordering uses the requested field and direction. An empty list means the page contains no results.
Page of disputes accessible to the key used.
Disputes on this page, in the requested order.
Full public case ID with the dp_ or med_ prefix. Use this value to retrieve the individual case.
Linked charge ID, or null when no link is available.
Case type: med for the Pix MED procedure and chargeback for the other dispute records presented by Raims.
Current stage: open, in_analysis, refund_in_analysis, closed, cancelled, rejected or failed. Closed indicates that the review has ended, without confirming a favorable decision or refund.
Reported reason, which does not confirm fraud, according to kind. For med: 1 scam, 2 compromised account, 3 coercion, 4 fraudulent access, 5 other and 6 unknown. For chargeback: 1 alleged fraud, 2 unrecognized purchase, 3 unrecognized service, 4 product or service not as described, 5 improper charge and 6 other. Null when not provided.
Disputed amount, in Brazilian real cents. It does not represent the amount currently held or confirm a refund.
Date the record was created in Raims, in Unix seconds in UTC.
Date of the latest available update, in Unix seconds in UTC.
Navigation information for the same query.
Effective number of disputes requested per page.
Indicates whether there is another page in the forward direction.
Indicates whether there is a previous page.
Cursor for after on the next page, or null when there is no next page.
Cursor for before on the previous page, or null when there is no previous page.
Response Body
A filter or cursor is invalid. Correct the fields indicated in error.details before repeating. Populated after and before are not accepted together.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
For common errors, see HTTP response codes.