Skip to main content
POST
Reverter um refinanciamento dentro de sua janela de 7 dias úteis

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default.

Exemplo:

"idem-reversao-0001"

Parâmetros de caminho

numero_contrato
string
obrigatório

The NEW contract minted by the refinanciamento this call reverses.

Required string length: 2 - 15
Exemplo:

"99999999999ARN1"

Corpo

application/json
motivoReversao
integer<int64>
obrigatório

Reversal reason (Manual 008 v1.10 §3.2.1, regra RG): 1 Desistência, 2 Óbito, 3 Fraude. Closed set — no 4th value exists.

Intervalo obrigatório: 1 <= x <= 3
Exemplo:

1

dataRefinanciamento
string<date-time>

The refinancing's own booking date, RFC 3339 UTC. Optional: enables the gateway's local 7-business-day window pre-check. Omitted, the request is submitted straight to the rail.

Exemplo:

"2026-08-04T09:00:00Z"

parcelasContratosQuitados
string[] | null

Instalment amounts of every contract this refinancing quitou, decimal strings (BRL). Optional; enables the margemReservada notice on the response.

Exemplo:
valorParcelaNovoContrato
string

The new (now-reversed) contract's own instalment amount, decimal string (BRL). Optional; enables the margemReservada notice on the response.

Exemplo:

"310.00"

Resposta

OK

competenciaReversao
string
obrigatório

Payroll competência the reversal took effect in, yyyyMM.

Exemplo:

"202507"

hashOperacao
string
obrigatório

The rail's own identity for this operation.

Exemplo:

"34006311"

listaContratosTrabalhadorReativados
object[] | null
obrigatório

Every quitado contract the reversal returned to ativo.

Exemplo:
mensagem
string
obrigatório

The rail's own message.

Exemplo:

"Reversao realizada com sucesso"

numeroContratoExcluido
string
obrigatório

The new contract, now excluded by the reversal.

Exemplo:

"99999999999ARN1"

margemReservada
string

The margin that was held reserved during the reversal window (Manual 008 v1.10 §3.2): the greater of the quitados' summed instalments and the new contract's own. Present only when the caller supplied enough context to compute it — a courtesy figure, not a rail field.

Exemplo:

"310.00"