v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Exception

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}

Path parameters

disputeIdstring required

The unique identifier of the dispute.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Successfully retrieved dispute

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

Category of the dispute

createdAtstring

Creation timestamp in RFC3339 format

descriptionstring

Description of the dispute

exceptionIdstring

Exception ID this dispute is for

idstring

Unique identifier for the dispute

openedBystring

User who opened the dispute

reopenReasonstring

Reason for reopening if reopened

resolutionstring

Resolution description when closed

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

Current state

updatedAtstring

Last update timestamp in RFC3339 format

Example response

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