Skip to main content
POST
Renegotiate a contract closed by employment-link termination

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.

Example:

"idem-renegociacao-0001"

Path Parameters

​
numero_contrato
string
required

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

Required string length: 1 - 15
Example:

"Qwerty123456789"

Body

application/json
​
codigoInscricaoEmpregador
string
required

Employer inscription type: 1 CNPJ, 2 CPF.

Pattern: ^[12]$
Example:

"2"

​
cpfTrabalhador
string
required

Worker CPF, 11 digits.

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

"27928255022"

​
dataFimContrato
string<date-time>
required

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

Example:

"2026-01-24T00:00:00Z"

​
dataInicioContrato
string<date-time>
required

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

Example:

"2025-01-24T00:00:00Z"

​
dataPrimeiroDesconto
string<date-time>
required

Date of the first payroll deduction, RFC 3339 UTC.

Example:

"2025-01-28T00:00:00Z"

​
matricula
string
required

Matrícula assigned to the worker by the employer.

Maximum string length: 20
Example:

"teste4243"

​
nomeTrabalhador
string
required

Worker's full name.

Maximum string length: 100
Example:

"testeead"

​
numeroContratoEncerrado
string
required

The PRIOR contract this renegociação replaces. Must be an averbação of the authenticated tenant that the rail acknowledged, and must differ from the new contract number in the path.

Required string length: 1 - 15
Example:

"Qwerty123456780"

​
numeroInscricaoEmpregador
string
required

Employer inscription number, Texto.

Maximum string length: 14
Example:

"42422253000101"

​
numeroParcelas
integer<int64>
required

Number of instalments of the new contract, capped at the manual's own published range 1 to 99 (Manual 006 §2.3.2 line 748).

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

8

​
valorCETAnual
string
required

valorCETAnual — Custo Efetivo Total, annual percent decimal string.

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

"0.20"

​
valorCETMensal
string
required

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

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

"0.10"

​
valorEmprestimo
string
required

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

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

"3000.00"

​
valorIOF
string
required

valorIOF — the IOF charged, in reais (decimal string, BRL). Obrigatório on the manual even though the mirrored Swagger's required list omits it.

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

"0.10"

​
valorLiberado
string
required

valorLiberado — amount delivered to the worker (decimal string, BRL).

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

"2000.00"

​
valorParcela
string
required

valorParcela — the new contract's instalment amount (decimal string, BRL). Must not exceed the closed contract's own instalment (regra BL) — a comparison this gateway cannot make locally and leaves to the rail.

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:

"0.30"

​
valorTaxaMensal
string
required

valorTaxaMensal — monthly interest rate, percent decimal string.

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

"0.10"

​
competenciaInicioDesconto
string

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

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

"202501"

Response

OK

​
competenciaInicioDesconto
string
required

Payroll competência of the first deduction, yyyyMM.

Example:

"202501"

​
hashOperacao
string
required

The rail's own identity for this operation.

Example:

"9598435"

​
mensagem
string
required

The rail's own message.

Example:

"Inclusão efetuada com sucesso"

​
numeroContrato
string
required

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

Example:

"Qwerty123456789"