Open a dispute
Use this endpoint to open a new dispute for an exception. Disputes are used to formally challenge or investigate discrepancies with external parties.
Autorizações
Bearer token authentication (format: "Bearer {token}")
Cabeçalhos
A unique identifier for tracing the request across services.
Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.
Parâmetros de caminho
Exception ID Exception ID (UUID)
"550e8400-e29b-41d4-a716-446655440000"
Corpo
Open dispute payload
Resposta
Indicates that the resource was successfully created.
Dispute category: BANK_FEE_ERROR (incorrect fee), UNRECOGNIZED_CHARGE, DUPLICATE_TRANSACTION, AMOUNT_MISMATCH, or OTHER
BANK_FEE_ERROR, UNRECOGNIZED_CHARGE, DUPLICATE_TRANSACTION, AMOUNT_MISMATCH, OTHER "BANK_FEE_ERROR"
Creation timestamp as an RFC 3339 timestamp
"2025-01-15T10:30:00Z"
Description of the dispute
"Transaction amount differs from expected"
Identifier of the exception this dispute is for (UUID)
"550e8400-e29b-41d4-a716-446655440001"
Unique identifier for the dispute (UUID)
"550e8400-e29b-41d4-a716-446655440000"
User who opened the dispute
"user@example.com"
Dispute state: DRAFT, OPEN, PENDING_EVIDENCE (awaiting evidence), WON, or LOST
DRAFT, OPEN, PENDING_EVIDENCE, WON, LOST "OPEN"
Last update timestamp as an RFC 3339 timestamp
"2025-01-15T10:30:00Z"
Evidence items submitted for this dispute (max 50)
50Reason recorded when the dispute was reopened
"New evidence discovered"
Resolution description recorded when the dispute was closed
"Counterparty confirmed error"

