Get a dispute

Use this endpoint to retrieve the details of a specific dispute by its identifier, including its current state, category, and any submitted evidence.

GET /v1/disputes/{disputeId}

Get a dispute

cURL

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

200

Example

{
  "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"
}

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 ruta

disputeId · string<uuid> · requerido

The unique identifier of the dispute. Dispute ID (UUID)

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

Respuesta

200

application/json

Successfully retrieved dispute

category · enum<string> · requerido

Dispute category: BANK_FEE_ERROR (incorrect fee), UNRECOGNIZED_CHARGE, DUPLICATE_TRANSACTION, AMOUNT_MISMATCH, or OTHER

Opciones disponibles: BANK_FEE_ERROR, UNRECOGNIZED_CHARGE, DUPLICATE_TRANSACTION, AMOUNT_MISMATCH, OTHER

Ejemplo:

"BANK_FEE_ERROR"

createdAt · string · requerido

Creation timestamp as an RFC 3339 timestamp

Ejemplo:

"2025-01-15T10:30:00Z"

description · string · requerido

Description of the dispute

Ejemplo:

"Transaction amount differs from expected"

exceptionId · string · requerido

Identifier of the exception this dispute is for (UUID)

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

id · string · requerido

Unique identifier for the dispute (UUID)

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

openedBy · string · requerido

User who opened the dispute

Ejemplo:

"[e-mail]"

state · enum<string> · requerido

Dispute state: DRAFT, OPEN, PENDING_EVIDENCE (awaiting evidence), WON, or LOST

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

Ejemplo:

"OPEN"

updatedAt · string · requerido

Last update timestamp as an RFC 3339 timestamp

Ejemplo:

"2025-01-15T10:30:00Z"

evidence · object[] | null

Evidence items submitted for this dispute (max 50)

Maximum array length: 50

Show child attributes

reopenReason · string

Reason recorded when the dispute was reopened

Ejemplo:

"New evidence discovered"

resolution · string

Resolution description recorded when the dispute was closed

Ejemplo:

"Counterparty confirmed error"