Skip to main content
POST
Refinanciar um ou mais contratos ativos em um novo

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-refinanciamento-0001"

Parâmetros de caminho

​
numero_contrato
string
obrigatório

The NEW contract number, minted by the CLIENT — the rail mints nothing here.

Required string length: 2 - 15
Exemplo:

"99999999999ARN1"

Corpo

application/json
​
codigoInscricaoEmpregador
string
obrigatório

Employer inscription type: 1 CNPJ, 2 CPF.

Pattern: ^[12]$
Exemplo:

"1"

​
cpfTrabalhador
string
obrigatório

Worker CPF, 11 digits.

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

"99999999999"

​
dataFimContrato
string<date-time>
obrigatório

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

Exemplo:

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

​
dataInicioContrato
string<date-time>
obrigatório

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

Exemplo:

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

​
dataPrimeiroDesconto
string<date-time>
obrigatório

Date of the first payroll deduction, RFC 3339 UTC.

Exemplo:

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

​
listaContratosQuitadosTrabalhador
object[] | null
obrigatório

Every contract this refinanciamento quits. Each must be an active averbação of the authenticated tenant — 'active' is the government registry's own judgment, which this gateway does not locally track.

Minimum array length: 1
Exemplo:
​
matricula
string
obrigatório

Matrícula assigned to the worker by the employer.

Maximum string length: 30
Exemplo:

"99999999999-A"

​
nomeTrabalhador
string
obrigatório

Worker's full name.

Maximum string length: 90
Exemplo:

"Trabalhador 99999999999"

​
numeroInscricaoEmpregador
string
obrigatório

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

Maximum string length: 14
Exemplo:

"99999999999881"

​
numeroParcelas
integer<int64>
obrigatório

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

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

24

​
temGarantias
boolean
obrigatório

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).

Exemplo:

true

​
valorCETAnual
string
obrigatório

valorCETAnual — Custo Efetivo Total, annual percent decimal string.

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

"7.26"

​
valorCETMensal
string
obrigatório

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

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

"0.59"

​
valorEmprestimo
string
obrigatório

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

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

"9018.54"

​
valorIOF
string
obrigatório

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

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

"94.95"

​
valorPago
string
obrigatório

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

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

"6114.50"

​
valorParcela
string
obrigatório

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

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

"400.00"

​
valorTaxaAnual
string
obrigatório

valorTaxaAnual — annual interest rate, percent decimal string.

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

"6.17"

​
valorTaxaMensal
string
obrigatório

valorTaxaMensal — monthly interest rate, percent decimal string.

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

"0.5"

​
valorTroco
string
obrigatório

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})?$
Exemplo:

"2809.09"

​
cnpjOperador
string

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

Maximum string length: 14
Exemplo:

"12345678000199"

​
competenciaInicioDesconto
string

Payroll competência of the first deduction, yyyyMM. Optional.

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

"202507"

​
percVerbaRescisoriaGarantia
string

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

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

"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})?$
Exemplo:

"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})?$
Exemplo:

"600.00"

Resposta

OK

​
competenciaInicioDesconto
string
obrigatório

Payroll competência of the first deduction, yyyyMM.

Exemplo:

"202507"

​
hashOperacao
string
obrigatório

The rail's own identity for this operation.

Exemplo:

"34006311"

​
listaContratosQuitadosTrabalhador
object[] | null
obrigatório

Every contract the rail confirmed as quitado by this refinanciamento.

Exemplo:
​
mensagem
string
obrigatório

The rail's own message.

Exemplo:

"Refinanciamento realizado com sucesso"

​
numeroContrato
string
obrigatório

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

Exemplo:

"99999999999ARN1"