Pular para o conteúdo principal
POST
Lançamento de ajuste para uma exceção

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Parâmetros de caminho

exceptionId
string
obrigatório

Exception ID

Corpo

application/json

Payload de lançamento de ajuste

Payload da requisição de lançamento de ajuste

amount
number
obrigatório

Valor do ajuste

Exemplo:

150.5

currency
string
obrigatório

Código de moeda (ISO 4217)

Exemplo:

"BRL"

effectiveAt
string<date-time>
obrigatório

Quando o ajuste entra em vigor

notes
string
obrigatório

Notas adicionais explicando o ajuste

Maximum string length: 1000
Exemplo:

"Correcting processing fee discrepancy"

reasonCode
string
obrigatório

Código de motivo do ajuste

Maximum string length: 255
Exemplo:

"FEE_ADJUSTMENT"

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

Consulte Retries and idempotency para mais detalhes.

Detalhes da exceção

assignedTo
string

Usuário ao qual a exceção está atribuída

Exemplo:

"user@example.com"

createdAt
string

Timestamp de criação no formato RFC3339

Exemplo:

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

dueAt
string

Prazo para resolução no formato RFC3339

Exemplo:

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

externalIssueId
string

ID do problema externo no sistema externo

Exemplo:

"RECON-1234"

externalSystem
string

Sistema externo para o qual a exceção foi despachada

Exemplo:

"JIRA"

id
string

Identificador único da exceção

Exemplo:

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

reason
string

Motivo pelo qual a exceção foi levantada

Exemplo:

"Amount mismatch detected"

resolutionNotes
string

Notas de resolução quando resolvida

Exemplo:

"Resolved via force match"

resolutionReason
string

Motivo da resolução

Exemplo:

"BUSINESS_DECISION"

resolutionType
enum<string>

Tipo de resolução aplicada

Opções disponíveis:
FORCE_MATCH,
ADJUST_ENTRY
Exemplo:

"FORCE_MATCH"

severity
enum<string>

Nível de severidade

Opções disponíveis:
LOW,
MEDIUM,
HIGH,
CRITICAL
Exemplo:

"HIGH"

status
enum<string>

Status atual

Opções disponíveis:
OPEN,
ASSIGNED,
PENDING_RESOLUTION,
RESOLVED
Exemplo:

"OPEN"

transactionId
string

ID da transação à qual esta exceção se refere

Exemplo:

"019c96a0-10ce-75fc-a273-dc799079a99c"

updatedAt
string

Timestamp da última atualização no formato RFC3339

Exemplo:

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