Disputes
Operations related to disputes
All endpoints require a JWT Bearer token in the Authorization header.
GET /v1/disputes
Get a list of disputes with pagination
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| query |
| Yes | Maximum number of records to return. Starts from 1 to 1000. |
| query |
| Yes | Page number to retrieve, starting from 0. |
| query |
| No | Choose specific fields to include in the response (comma-separated). |
| query |
| No | A JSON object representing the filter criteria in MongoDB Query Language (MQL) format. |
| query |
| No | A JSON object representing the sort criteria in MongoDB Query Language (MQL) format. |
| query |
| No | Include related data in query results using a JSON object. |
Responses
Status | Description |
|---|---|
| Successfully retrieved a paginated list of disputes. |
GET /v1/disputes/{id}
Get a specific dispute by ID
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path |
| Yes | The disputeId field |
| query |
| No | Include transaction data in the response. When true, enriches the dispute with transaction data where dispute.paymentPspReference === transaction.transactionId. |
| query |
| No | Choose specific fields to include in the response (comma-separated). |
| query |
| No | Include related data in query results using a JSON object. |
Responses
Status | Description |
|---|---|
| Dispute details retrieved successfully |
PATCH /v1/disputes/{id}
Update a dispute by ID
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path |
| Yes | The disputeId field |
Request body (required)
At least one of status or defendable must be provided.
Field | Type | Required | Description |
|---|---|---|---|
|
| No | The dispute status |
|
| No | Whether the dispute is defendable |
Responses
Status | Description |
|---|---|
| Dispute updated successfully |