Renegotiate one or more legado loans into a new contract

Proxies renegociar-emprestimo-legado-trabalhador (Manual 007 v1.4 §3.3): folds every contract named in contratosLegados into a single new Plataforma contract. codigoTipoRenegociacao selects Padrão (1) or Portabilidade (2); this gateway proves the structural half of the Portabilidade rules before the rail is called — numeroUnico populated only under Portabilidade, at least one item carrying it, and no two items sharing the same one — while whether the requester actually holds each legado contract, whether an existing folha (tipoContrato=2) contract was included, and whether the new rate undercuts the original are left to the rail’s own judgment (Dataprev performs no documental validation of legado contracts, §2.2.1.3). On Portabilidade (§2.2.1.3): the ported contract itself is NOT excluded automatically — exclusion is the origin bank’s own responsibility; every contract of the REQUESTER that carries no numeroUnico is excluded automatically once the operation completes; and any troco (change) is only permitted when every contract INVOLVED in the operation — including the ported one itself — is fully settled (§2.2.1.3). A SUCCESSFUL round trip is codigo SUCESSO with a non-empty numeroContrato: read codigo and errosContratosPortados in the response body — the rail can report per-legado-contract failures inside that same 200 while the new contract still averbates; any other codigo means no new contract was minted and surfaces as a 422 naming the rail’s own code. X-Idempotency is required; this operation names no idempotency pair of its own, so a retry is refused by the rail on its own terms.

POST /v1/consignado/legacy-contracts/renegociacao

Renegotiate one or more legado loans into a new contract

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/legacy-contracts/renegociacao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "codigoTipoRenegociacao": 1,
  "contratosLegados": [
    {
      "codigoIF": "999",
      "numeroContrato": "99999999999AL1"
    }
  ],
  "cpfTrabalhador": "99999999999",
  "dataFimContrato": "2026-06-23T00:00:00Z",
  "dataInicioContrato": "2025-04-03T00:00:00Z",
  "dataPrimeiroDesconto": "2025-04-23T00:00:00Z",
  "matricula": "99999999999-A",
  "nomeTrabalhador": "Trabalhador 99999999999",
  "numeroContrato": "99999999999AN1",
  "numeroInscricaoEmpregador": "42422253000101",
  "numeroParcelas": 15,
  "valorCETAnual": "4.91",
  "valorCETMensal": "0.4",
  "valorEmprestimo": "12000.00",
  "valorIOF": "0.00",
  "valorLiberado": "12000.00",
  "valorParcela": "825.10",
  "valorTaxaAnual": "4.91",
  "valorTaxaMensal": "0.4",
  "cnpjOperador": "99999999999962",
  "competenciaInicioDesconto": "202504"
}
'

200

{
  "codigo": "SUCESSO",
  "competenciaInicioDesconto": "202504",
  "mensagem": "Renegociacao efetuada com sucesso",
  "numeroContrato": "99999999999AN1",
  "erros": [
    {
      "codigo": "RC",
      "mensagem": "Vinculo nao permite renegociacao de legado"
    }
  ],
  "errosContratosPortados": [
    {
      "codigoIF": "999",
      "erros": [
        {
          "codigo": "RC",
          "mensagem": "Vinculo nao permite renegociacao de legado"
        }
      ],
      "numeroContrato": "99999999999AL1"
    }
  ]
}

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-legado-renegociar-0001"

Cuerpo

application/json

codigoInscricaoEmpregador · enum<string> · requerido

Employer inscription type: 1 CNPJ, 2 CPF.

Opciones disponibles: 1, 2

Ejemplo:

"1"

codigoTipoRenegociacao · enum<integer> · requerido

1 = Padrão; 2 = Portabilidade. Portabilidade requires at least one contratoLegado carrying numeroUnico; Padrão forbids numeroUnico on every item.

Opciones disponibles: 1, 2

Ejemplo:

1

contratosLegados · object[] | null · requerido

Every legado contract folded into this renegociação (§3.3.1, Obrigatório=Sim).

Minimum array length: 1

Show child attributes

Ejemplo:

[
  {
    "codigoIF": "999",
    "numeroContrato": "99999999999AL1"
  }
]

cpfTrabalhador · string · requerido

Worker CPF, exactly 11 digits.

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

Ejemplo:

"99999999999"

dataFimContrato · string<date-time> · requerido

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

Ejemplo:

"2026-06-23T00:00:00Z"

dataInicioContrato · string<date-time> · requerido

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

Ejemplo:

"2025-04-03T00:00:00Z"

dataPrimeiroDesconto · string<date-time> · requerido

Date of the first payroll deduction of the NEW contract, RFC 3339 UTC.

Ejemplo:

"2025-04-23T00:00:00Z"

matricula · string · requerido

Matrícula assigned to the worker by the employer. Cannot be blank or whitespace-only.

Maximum string length: 30

Pattern: ^\S(.*\S)?$

Ejemplo:

"99999999999-A"

nomeTrabalhador · string · requerido

Worker's full name (Manual 007 §3.3.1 publishes 90 characters — the mirrored Swagger's 100 is not the bound this gateway enforces). Cannot be blank or whitespace-only.

Maximum string length: 90

Pattern: ^\S(.*\S)?$

Ejemplo:

"Trabalhador 99999999999"

numeroContrato · string · requerido

The NEW contract's number, minted by the CLIENT: 2 to 15 letters or digits, without spaces, accents or symbols.

Required string length: 2 - 15

Pattern: ^[A-Za-z0-9]+$

Ejemplo:

"99999999999AN1"

numeroInscricaoEmpregador · string · requerido

Employer inscription number: 8 (raiz, relayed as given) or 14 digits for CNPJ, 11 for CPF (matching codigoInscricaoEmpregador; §3.3.1's own '15 algarismos' is a stale maximum, see ports.ValidateNumeroInscricaoEmpregador).

Pattern: ^([0-9]{8}|[0-9]{11}|[0-9]{14})$

Ejemplo:

"42422253000101"

numeroParcelas · integer<int64> · requerido

Total number of instalments of the NEW contract.

Rango requerido: 1 <= x <= 999

Ejemplo:

15

valorCETAnual · string · requerido

valorCETAnual — Custo Efetivo Total, annual percent decimal string.

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

Ejemplo:

"4.91"

valorCETMensal · string · requerido

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

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

Ejemplo:

"0.4"

valorEmprestimo · string · requerido

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

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

Ejemplo:

"12000.00"

valorIOF · string · requerido

valorIOF — the IOF charged, in reais (decimal string, BRL). Required by the manual despite the mirrored Swagger's required list omitting it.

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

Ejemplo:

"0.00"

valorLiberado · string · requerido

valorLiberado — amount delivered to the worker (decimal string, BRL). Required by the manual despite the mirrored Swagger's required list omitting it.

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

Ejemplo:

"12000.00"

valorParcela · string · requerido

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

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

Ejemplo:

"825.10"

valorTaxaAnual · string · requerido

valorTaxaAnual — annual interest rate, percent decimal string. Must stay below the original legado contract's own rate — a comparison this gateway holds no local record of and leaves to the rail.

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

Ejemplo:

"4.91"

valorTaxaMensal · string · requerido

valorTaxaMensal — monthly interest rate, percent decimal string.

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

Ejemplo:

"0.4"

cnpjOperador · string

CNPJ of the operator (correspondente, cooperado or similar) responsible for the operation, exactly 14 digits, unpunctuated. Optional (§3.3.1) — omitted entirely rather than sent malformed; competenciaInicioDesconto below is the other optional field on this body. Dataprev performs no documental validation of legado data (§2.2.1.3), so this shape guard is the only one the CNPJ gets before the rail is spent.

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

Ejemplo:

"99999999999962"

competenciaInicioDesconto · string

Payroll competência of the first deduction, yyyyMM. Optional; the rail assumes the current competência when omitted.

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

Ejemplo:

"202504"

Respuesta

200

application/json

OK

codigo · string · requerido

The rail's own outcome code — a closed enum of roughly 290 values including SUCESSO. NOT redundant with the 200 status: read this field.

Ejemplo:

"SUCESSO"

competenciaInicioDesconto · string · requerido

Payroll competência of the first deduction, yyyyMM.

Ejemplo:

"202504"

mensagem · string · requerido

The rail's own message.

Ejemplo:

"Renegociacao efetuada com sucesso"

numeroContrato · string · requerido

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

Ejemplo:

"99999999999AN1"

erros · object[] | null

Top-level errors, if any.

Show child attributes

errosContratosPortados · object[] | null

Per-legado-contract failures, if any. A non-empty list here does NOT mean the new contract failed to averbate.

Show child attributes