Skip to main content
POST
Open a dispute

Authorizations

Authorization
string
header
required

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

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency
string

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.

Path Parameters

exceptionId
string<uuid>
required

Exception ID Exception ID (UUID)

Example:

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

Body

application/json

Open dispute payload

category
string
required

Category of the dispute

Required string length: 1 - 255
Example:

"AMOUNT_MISMATCH"

description
string
required

Detailed description of the dispute

Required string length: 1 - 5000
Example:

"Transaction amount differs from invoice"

Response

Indicates that the resource was successfully created.

category
enum<string>
required

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

Available options:
BANK_FEE_ERROR,
UNRECOGNIZED_CHARGE,
DUPLICATE_TRANSACTION,
AMOUNT_MISMATCH,
OTHER
Example:

"BANK_FEE_ERROR"

createdAt
string
required

Creation timestamp as an RFC 3339 timestamp

Example:

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

description
string
required

Description of the dispute

Example:

"Transaction amount differs from expected"

exceptionId
string
required

Identifier of the exception this dispute is for (UUID)

Example:

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

id
string
required

Unique identifier for the dispute (UUID)

Example:

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

openedBy
string
required

User who opened the dispute

Example:

"user@example.com"

state
enum<string>
required

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

Available options:
DRAFT,
OPEN,
PENDING_EVIDENCE,
WON,
LOST
Example:

"OPEN"

updatedAt
string
required

Last update timestamp as an RFC 3339 timestamp

Example:

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

evidence
object[] | null

Evidence items submitted for this dispute (max 50)

Maximum array length: 50
reopenReason
string

Reason recorded when the dispute was reopened

Example:

"New evidence discovered"

resolution
string

Resolution description recorded when the dispute was closed

Example:

"Counterparty confirmed error"