Refinance one or more active contracts into a new one

Proxies realizar-refinanciamento-trabalhador (Manual 008 v1.14 §3.1): quits every contract named in listaContratosQuitadosTrabalhador and averbates the new contract that replaces them, reserving margin until the refinanciamento closes. Every quitado contract must be a live contract of the authenticated tenant (GET …/standing); anything else is 404 before the rail is called. With garantia (temGarantias=true), the refinanciamento may only relate 1:1 (regra FR, at most one quitado contract) and must inform at least one of the three garantia values (regra FI). X-Idempotency is required.

POST /v1/consignado/contracts/{numero_contrato}/refinanciamento

Refinance one or more active contracts into a new one

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/refinanciamento \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "cpfTrabalhador": "99999999999",
  "dataFimContrato": "2027-07-10T00:00:00Z",
  "dataInicioContrato": "2025-06-11T00:00:00Z",
  "dataPrimeiroDesconto": "2025-07-10T00:00:00Z",
  "listaContratosQuitadosTrabalhador": [
    {
      "numeroContrato": "99999999999AR1"
    }
  ],
  "matricula": "99999999999-A",
  "nomeTrabalhador": "Trabalhador 99999999999",
  "numeroInscricaoEmpregador": "99999999999881",
  "numeroParcelas": 24,
  "temGarantias": true,
  "valorCETAnual": "7.26",
  "valorCETMensal": "0.59",
  "valorEmprestimo": "9018.54",
  "valorIOF": "94.95",
  "valorPago": "6114.50",
  "valorParcela": "400.00",
  "valorTaxaAnual": "6.17",
  "valorTaxaMensal": "0.5",
  "valorTroco": "2809.09",
  "cnpjOperador": "12345678000199",
  "competenciaInicioDesconto": "202507",
  "percVerbaRescisoriaGarantia": "15",
  "valorMultaRescisoriaGarantiaFgts": "300.00",
  "valorSaldoDisponivelGarantiaFgts": "600.00"
}
'

200

{
  "competenciaInicioDesconto": "202507",
  "hashOperacao": "34006311",
  "listaContratosQuitadosTrabalhador": [
    {
      "numeroContrato": "99999999999AR1"
    }
  ],
  "mensagem": "Refinanciamento realizado com sucesso",
  "numeroContrato": "99999999999ARN1"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

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

Maximum string length: 255

Ejemplo:

"idem-refinanciamento-0001"

Parámetros de ruta

numero_contrato · string · requerido

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]+$

Ejemplo:

"99999999999ARN1"

Cuerpo

application/json

codigoInscricaoEmpregador · string · requerido

Employer inscription type: 1 CNPJ, 2 CPF.

Pattern: ^[12]$

Ejemplo:

"1"

cpfTrabalhador · string · requerido

Worker CPF, 11 digits.

Required string length: 11

Pattern: ^[0-9]{11}$

Ejemplo:

"99999999999"

dataFimContrato · string<date-time> · requerido

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

Ejemplo:

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

dataInicioContrato · string<date-time> · requerido

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

Ejemplo:

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

dataPrimeiroDesconto · string<date-time> · requerido

Date of the first payroll deduction, RFC 3339 UTC.

Ejemplo:

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

listaContratosQuitadosTrabalhador · object[] | null · requerido

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

Minimum array length: 1

Show child attributes

Ejemplo:

[{ "numeroContrato": "99999999999AR1" }]

matricula · string · requerido

Matrícula assigned to the worker by the employer.

Maximum string length: 30

Ejemplo:

"99999999999-A"

nomeTrabalhador · string · requerido

Worker's full name.

Maximum string length: 90

Ejemplo:

"Trabalhador 99999999999"

numeroInscricaoEmpregador · string · requerido

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

Maximum string length: 14

Ejemplo:

"99999999999881"

numeroParcelas · integer<int64> · requerido

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

Rango requerido: 1 <= x <= 999

Ejemplo:

24

temGarantias · boolean · requerido

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.

Ejemplo:

true

valorCETAnual · string · requerido

valorCETAnual — Custo Efetivo Total, annual percent decimal string.

Maximum string length: 13

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

Ejemplo:

"7.26"

valorCETMensal · string · requerido

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

Maximum string length: 13

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

Ejemplo:

"0.59"

valorEmprestimo · string · requerido

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

Maximum string length: 13

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

Ejemplo:

"9018.54"

valorIOF · string · requerido

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

Maximum string length: 13

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

Ejemplo:

"94.95"

valorPago · string · requerido

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

Maximum string length: 13

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

Ejemplo:

"6114.50"

valorParcela · string · requerido

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

Maximum string length: 13

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

Ejemplo:

"400.00"

valorTaxaAnual · string · requerido

valorTaxaAnual — annual interest rate, percent decimal string.

Maximum string length: 13

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

Ejemplo:

"6.17"

valorTaxaMensal · string · requerido

valorTaxaMensal — monthly interest rate, percent decimal string.

Maximum string length: 13

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

Ejemplo:

"0.5"

valorTroco · string · requerido

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

Ejemplo:

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

Show child attributes

cnpjOperador · string

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

Maximum string length: 14

Ejemplo:

"12345678000199"

competenciaInicioDesconto · string

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

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

Ejemplo:

"202507"

percVerbaRescisoriaGarantia · string

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

Maximum string length: 13

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

Ejemplo:

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

Ejemplo:

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

Ejemplo:

"600.00"

Respuesta

200

application/json

OK

competenciaInicioDesconto · string · requerido

Payroll competência of the first deduction, yyyyMM.

Ejemplo:

"202507"

hashOperacao · string · requerido

The rail's own identity for this operation.

Ejemplo:

"34006311"

listaContratosQuitadosTrabalhador · object[] | null · requerido

Every contract the rail confirmed as quitado by this refinanciamento.

Show child attributes

Ejemplo:

[{ "numeroContrato": "99999999999AR1" }]

mensagem · string · requerido

The rail's own message.

Ejemplo:

"Refinanciamento realizado com sucesso"

numeroContrato · string · requerido

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

Ejemplo:

"99999999999ARN1"