Skip to main content
GET
/
v0
/
disputes
List
curl --request GET \
  --url https://api.paygentic.io/v0/disputes \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "disp_s5t6u7v8w9x0y1z2",
      "object": "dispute",
      "createdAt": "2024-03-15T10:20:00Z",
      "customer": {
        "id": "cust_i1j2k3l4m5n6o7p8",
        "email": "[email protected]",
        "name": "TechCorp"
      },
      "customerId": "cust_i1j2k3l4m5n6o7p8",
      "customerMessage": "Storage charges don't match actual usage",
      "disputedAmount": "15.00",
      "merchantId": "org_q9r0s1t2u3v4w5x6",
      "merchantMessage": null,
      "resolvedAt": null,
      "status": "pending",
      "updatedAt": "2024-03-15T10:20:00Z",
      "usageEventId": "usg_a3b4c5d6e7f8g9h0"
    }
  ],
  "pagination": {
    "hasMore": false,
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
consumerId
string

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

​
customerId
string

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

​
limit
integer
default:10

Number of disputes to return

Required range: 1 <= x <= 100
​
merchantId
string

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

​
offset
integer
default:0

Number of disputes to skip

Required range: x >= 0
​
status
enum<string>

Filter by dispute status

Available options:
pending,
accepted,
declined

Response

Disputes retrieved successfully

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
pagination
object
required