Skip to main content
POST
Refinance one or more active contracts into a new one

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

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

Maximum string length: 255
Example:

"idem-refinanciamento-0001"

Path Parameters

numero_contrato
string
required

The NEW contract number, minted by the CLIENT — the rail mints nothing here: 2 to 15 letters or digits.

Required string length: 2 - 15
Pattern: ^[A-Za-z0-9]+$
Example:

"99999999999ARN1"

Body

application/json
codigoInscricaoEmpregador
string
required

Employer inscription type: 1 CNPJ, 2 CPF.

Pattern: ^[12]$
Example:

"1"

cpfTrabalhador
string
required

Worker CPF, 11 digits.

Required string length: 11
Pattern: ^[0-9]{11}$
Example:

"99999999999"

dataFimContrato
string<date-time>
required

End date of the new consignado contract, RFC 3339 UTC.

Example:

"2027-07-10T00:00:00Z"

dataInicioContrato
string<date-time>
required

Start date of the new consignado contract, RFC 3339 UTC.

Example:

"2025-06-11T00:00:00Z"

dataPrimeiroDesconto
string<date-time>
required

Date of the first payroll deduction, RFC 3339 UTC.

Example:

"2025-07-10T00:00:00Z"

listaContratosQuitadosTrabalhador
object[] | null
required

Every contract this refinanciamento quits. Each must be held by this gateway for the authenticated tenant.

Minimum array length: 1
Example:
matricula
string
required

Matrícula assigned to the worker by the employer.

Maximum string length: 30
Example:

"99999999999-A"

nomeTrabalhador
string
required

Worker's full name.

Maximum string length: 90
Example:

"Trabalhador 99999999999"

numeroInscricaoEmpregador
string
required

Employer inscription number, Texto since Manual 008 v1.7 (the mirrored Swagger still types this int64).

Maximum string length: 14
Example:

"99999999999881"

numeroParcelas
integer<int64>
required

Number of instalments of the new contract, capped at the manual's own 3-digit field width (Manual 008 v1.14 §3.1.1 p.11).

Required range: 1 <= x <= 999
Example:

24

temGarantias
boolean
required

Whether FGTS collateral secures the new contract. When true, exactly one contract may be named in lista_contratos_quitados_trabalhador (regra FR) and at least one of the three garantia values below must be informed (regra FI). False with any of them is refused 422 before the rail is called: omit the values when there is no FGTS collateral, never send 0.

Example:

true

valorCETAnual
string
required

valorCETAnual — Custo Efetivo Total, annual percent decimal string.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"7.26"

valorCETMensal
string
required

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"0.59"

valorEmprestimo
string
required

valorEmprestimo — the new contract's principal (decimal string, BRL).

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"9018.54"

valorIOF
string
required

valorIOF — the IOF charged, in reais (decimal string, BRL).

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"94.95"

valorPago
string
required

valorPago — settlement amount paid to quit the original contracts (decimal string, BRL).

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"6114.50"

valorParcela
string
required

valorParcela — the new contract's instalment amount (decimal string, BRL).

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"400.00"

valorTaxaAnual
string
required

valorTaxaAnual — annual interest rate, percent decimal string.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"6.17"

valorTaxaMensal
string
required

valorTaxaMensal — monthly interest rate, percent decimal string.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"0.5"

valorTroco
string
required

valorTroco — amount delivered to the client after settling the quitados contracts (decimal string, BRL).

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"2809.09"

booking
object

OPTIONAL. The block the Lerian lender books the new contract with, never sent to Dataprev: all of its members or the object omitted. With it, competenciaInicioDesconto is required. The lender books valorPago plus valorTroco as released, so valorEmprestimo less valorIOF and origination_fee_amount must equal that sum. A booking the lender would refuse answers 422 with the averbação's codes before the rail. Present, consignado.refinanciamento.efetivado carries novo_contrato; omitted, the new contract is rail-only and no lender booking follows.

cnpjOperador
string

CNPJ of the operator (correspondent, cooperado or similar) responsible for the operation. Optional, Texto since v1.7.

Maximum string length: 14
Example:

"12345678000199"

competenciaInicioDesconto
string

Payroll competência of the first deduction, yyyyMM. Optional without the booking block, required with it.

Pattern: ^[0-9]{6}$
Example:

"202507"

percVerbaRescisoriaGarantia
string

Percentage of severance pay pledged as collateral, 0 to 35%.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"15"

valorMultaRescisoriaGarantiaFgts
string

FGTS termination-fine collateral, up to 100% of the 40% fine (decimal string, BRL). Optional individually.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"300.00"

valorSaldoDisponivelGarantiaFgts
string

FGTS balance pledged as collateral (decimal string, BRL). Optional individually; at least one of the three garantia values is required when temGarantias is true.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"600.00"

Response

OK

competenciaInicioDesconto
string
required

Payroll competência of the first deduction, yyyyMM.

Example:

"202507"

hashOperacao
string
required

The rail's own identity for this operation.

Example:

"34006311"

listaContratosQuitadosTrabalhador
object[] | null
required

Every contract the rail confirmed as quitado by this refinanciamento.

Example:
mensagem
string
required

The rail's own message.

Example:

"Refinanciamento realizado com sucesso"

numeroContrato
string
required

The new contract's number, as confirmed by the rail.

Example:

"99999999999ARN1"