Pular para o conteúdo principal
POST
Acionar uma execução de conciliaçã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

contextId
string
obrigatório

The unique identifier of the reconciliation context.

Corpo

application/json

Payload de execução de conciliação

mode
enum<string>
obrigatório
Opções disponíveis:
DRY_RUN,
COMMIT
Exemplo:

"DRY_RUN"

Resposta

Indica que a requisição foi aceita para processamento.

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.

runId
string<uuid>
Exemplo:

"019c96a0-0b88-7725-b825-efff420e20e0"

status
enum<string>
Opções disponíveis:
PROCESSING,
COMPLETED,
FAILED
Exemplo:

"PROCESSING"