Pular para o conteúdo principal
POST
Criar um ajuste

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 consulta

contextId
string
obrigatório

Context ID

Corpo

application/json

Payload de ajuste

amount
string
obrigatório
Exemplo:

"10.50"

currency
string
obrigatório
Exemplo:

"BRL"

direction
enum<string>
obrigatório

Direção do ajuste

Opções disponíveis:
DEBIT,
CREDIT
Exemplo:

"DEBIT"

description
string
obrigatório
Exemplo:

"Bank wire fee adjustment"

reason
string
obrigatório
Exemplo:

"Variance due to bank processing fee"

type
enum<string>
obrigatório
Opções disponíveis:
BANK_FEE,
FX_DIFFERENCE,
ROUNDING,
WRITE_OFF,
MISCELLANEOUS
Exemplo:

"BANK_FEE"

matchGroupId
string<uuid>
Exemplo:

"019c96a0-0b74-768c-8d25-2bf065dca2f8"

transactionId
string<uuid>
Exemplo:

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

Resposta

Indica que o recurso foi criado com sucesso.

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.

adjustment
object