List disputes

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

GET /v1/disputes

List disputes

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/disputes \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "hasMore": true,
  "items": [
    {
      "category": "BANK_FEE_ERROR",
      "createdAt": "2025-01-15T10:30:00Z",
      "description": "Transaction amount differs from expected",
      "exceptionId": "550e8400-e29b-41d4-a716-446655440001",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "openedBy": "[e-mail]",
      "state": "OPEN",
      "updatedAt": "2025-01-15T10:30:00Z",
      "evidence": [
        {
          "comment": "Bank statement attached",
          "disputeId": "550e8400-e29b-41d4-a716-446655440001",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "submittedAt": "2025-01-15T10:30:00Z",
          "submittedBy": "[e-mail]",
          "fileUrl": "https://storage.example.com/evidence/doc123.pdf"
        }
      ],
      "reopenReason": "New evidence discovered",
      "resolution": "Counterparty confirmed error"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de consulta

state · enum<string>

Filter by dispute state Filter by state

Opciones disponibles: DRAFT, OPEN, PENDING_EVIDENCE, WON, LOST

category · enum<string>

Filter by dispute category Filter by category

Opciones disponibles: BANK_FEE_ERROR, UNRECOGNIZED_CHARGE, DUPLICATE_TRANSACTION, OTHER

date_from · string

Start date filter (RFC 3339 format) Filter from date, inclusive lower bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date is taken at 00:00:00 UTC

Ejemplo:

"2025-01-01T00:00:00Z"

date_to · string

End date filter (RFC 3339 format) Filter to date, inclusive upper bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date covers the whole day through 23:59:59.999999999 UTC

Ejemplo:

"2025-01-31T23:59:59Z"

cursor · string

The cursor value for retrieving the next page of results. Cursor for pagination (opaque)

limit · integer<int64> · predeterminado: 20

The maximum number of items to include in the response. Maximum number of records to return

Rango requerido: 1 <= x <= 200

sort_by · enum<string>

Sort by field

Opciones disponibles: id, created_at, updated_at, state, category

sort_order · enum<string>

Sort order

Opciones disponibles: asc, desc

Respuesta

200

application/json

List of disputes with cursor pagination

hasMore · boolean · requerido

Ejemplo:

true

items · object[] | null · requerido

Page of disputes (max 200 per page)

Maximum array length: 200

Show child attributes

limit · integer<int64> · requerido

Rango requerido: 1 <= x <= 200

Ejemplo:

20

nextCursor · string

Ejemplo:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Ejemplo:

"eyJpZCI6IjEyMiJ9"