Skip to main content
POST
Open a dispute

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Parâmetros de caminho

exceptionId
string
obrigatório

Exception ID

Corpo

application/json

Open dispute payload

Open dispute request payload

category
string
obrigatório

Category of the dispute

Maximum string length: 255
Exemplo:

"AMOUNT_MISMATCH"

description
string
obrigatório

Detailed description of the dispute

Maximum string length: 5000
Exemplo:

"Transaction amount differs from invoice"

Resposta

Indicates that the resource was successfully created.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Dispute details

category
enum<string>

Category of the dispute

Opções disponíveis:
BANK_FEE_ERROR,
UNRECOGNIZED_CHARGE,
DUPLICATE_TRANSACTION,
OTHER
Exemplo:

"BANK_FEE_ERROR"

createdAt
string

Creation timestamp in RFC3339 format

Exemplo:

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

description
string

Description of the dispute

Exemplo:

"Transaction amount differs from expected"

evidence
object[]

Evidence submitted for this dispute

exceptionId
string

Exception ID this dispute is for

Exemplo:

"019c96a0-10d2-7134-ba5f-664142ee7052"

id
string

Unique identifier for the dispute

Exemplo:

"019c96a0-10d2-7193-8841-0d7347efd09a"

openedBy
string

User who opened the dispute

Exemplo:

"user@example.com"

reopenReason
string

Reason for reopening if reopened

Exemplo:

"New evidence discovered"

resolution
string

Resolution description when closed

Exemplo:

"Counterparty confirmed error"

state
enum<string>

Current state

Opções disponíveis:
DRAFT,
OPEN,
PENDING_EVIDENCE,
WON,
LOST
Exemplo:

"OPEN"

updatedAt
string

Last update timestamp in RFC3339 format

Exemplo:

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