v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

List disputes

Use this endpoint to retrieve all disputes. Supports filtering by state, category, and date range with cursor-based pagination.

get/v1/disputes

Query parameters

limitinteger

The maximum number of items to include in the response.

cursorstring

The cursor value for retrieving the next page of results.

state'DRAFT' | 'OPEN' | 'PENDING_EVIDENCE' | 'WON' | 'LOST'

Filter by dispute state

category'BANK_FEE_ERROR' | 'UNRECOGNIZED_CHARGE' | 'DUPLICATE_TRANSACTION' | 'OTHER'

Filter by dispute category

date_fromstring date-time

Start date filter (RFC 3339 format)

date_tostring date-time

End date filter (RFC 3339 format)

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

List of disputes with cursor pagination

nextCursorstring

Cursor for the next page of results

prevCursorstring

Cursor for the previous page of results

limitinteger

Maximum items per page

hasMoreboolean

Whether more results are available

Example response

{
  "items": [
    {
      "category": "BANK_FEE_ERROR",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "description": "Transaction amount differs from expected",
      "evidence": [
        {
          "comment": "Bank statement attached",
          "disputeId": "019c96a0-10d2-7193-8841-0d7347efd09a",
          "fileUrl": "https://storage.example.com/evidence/doc123.pdf",
          "id": "019c96a0-0c0d-7915-84b9-e497bfee9916",
          "submittedAt": "2025-01-15T10:30:00.000Z",
          "submittedBy": "user@example.com"
        }
      ],
      "exceptionId": "019c96a0-10d2-7134-ba5f-664142ee7052",
      "id": "019c96a0-10d2-7193-8841-0d7347efd09a",
      "openedBy": "user@example.com",
      "reopenReason": "New evidence discovered",
      "resolution": "Counterparty confirmed error",
      "state": "OPEN",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "limit": 20
}