Pular para o conteúdo principal
POST
/
v1
/
exceptions
/
{exceptionId}
/
disputes
Abrir uma disputa
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/disputes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "AMOUNT_MISMATCH",
  "description": "Transaction amount differs from invoice"
}
'
{
  "category": "BANK_FEE_ERROR",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "description": "Transaction amount differs from expected",
  "evidence": [
    {
      "comment": "Bank statement attached",
      "disputeId": "550e8400-e29b-41d4-a716-446655440001",
      "fileUrl": "https://storage.example.com/evidence/doc123.pdf",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "submittedAt": "2025-01-15T10:30:00.000Z",
      "submittedBy": "user@example.com"
    }
  ],
  "exceptionId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "openedBy": "user@example.com",
  "reopenReason": "New evidence discovered",
  "resolution": "Counterparty confirmed error",
  "state": "OPEN",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Autorizações

​
Authorization
string
header
obrigatório

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

Cabeçalhos

​
X-Request-Id
string

Um identificador único para rastrear a requisição entre serviços.

​
X-Idempotency-Key
string

Uma chave única para garantir novas tentativas seguras da requisição.

Parâmetros de caminho

​
exceptionId
string
obrigatório

ID da exceção

Corpo

application/json

Payload de abertura de disputa

Payload de requisição para abrir disputa

​
category
string
obrigatório

Categoria da disputa

Maximum string length: 255
Exemplo:

"AMOUNT_MISMATCH"

​
description
string
obrigatório

Descrição detalhada da disputa

Maximum string length: 5000
Exemplo:

"Transaction amount differs from invoice"

Resposta

Indica que o recurso foi criado com sucesso.

Detalhes da disputa

​
category
enum<string>

Categoria da disputa

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

"BANK_FEE_ERROR"

​
createdAt
string

Timestamp de criação no formato RFC3339

Exemplo:

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

​
description
string

Descrição da disputa

Exemplo:

"Transaction amount differs from expected"

​
evidence
object[]

Evidências enviadas para esta disputa

​
exceptionId
string

ID da exceção para a qual esta disputa se refere

Exemplo:

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

​
id
string

Identificador único da disputa

Exemplo:

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

​
openedBy
string

Usuário que abriu a disputa

Exemplo:

"user@example.com"

​
reopenReason
string

Motivo da reabertura, se reaberta

Exemplo:

"New evidence discovered"

​
resolution
string

Descrição da resolução quando fechada

Exemplo:

"Counterparty confirmed error"

​
state
enum<string>

Estado atual

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

"OPEN"

​
updatedAt
string

Timestamp da última atualização no formato RFC3339

Exemplo:

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