GET
/
disputes
List disputes
curl --request GET \
  --url https://api.paygentic.io/v0/disputes \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "dispute",
      "usageEventId": "<string>",
      "customerId": "<string>",
      "merchantId": "<string>",
      "customerMessage": "<string>",
      "merchantMessage": "<string>",
      "status": "pending",
      "disputedAmount": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
merchantId
string

Filter disputes for a specific merchant. At least one of merchantId, customerId, or consumerId must be provided.

​
customerId
string

Filter disputes for a specific customer. At least one of merchantId, customerId, or consumerId must be provided.

​
consumerId
string

Filter disputes for a specific consumer. At least one of merchantId, customerId, or consumerId must be provided.

​
status
enum<string>

Filter by dispute status

Available options:
pending,
accepted,
declined
​
limit
integer
default:10

Number of disputes to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of disputes to skip

Required range: x >= 0

Response

200
application/json

List of disputes

The response is of type object.