Skip to main content
POST
Registrar um empréstimo pré-existente (legado)

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

Corpo

application/json
codigoTipoContrato
enum<integer>
obrigatório

1 = empréstimo não consignado sem garantia; 2 = empréstimo com descontos em folha de pagamento. When 2, codigoInscricaoEmpregador, numeroInscricaoEmpregador and matricula become required (§3.1.1, a condition the official Swagger does not express).

Opções disponíveis:
1,
2
Exemplo:

2

cpfTrabalhador
string
obrigatório

Worker CPF, exactly 11 digits.

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

"99999999999"

dataFimContrato
string<date-time>
obrigatório

End date of the legado contract, RFC 3339 UTC.

Exemplo:

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

dataInicioContrato
string<date-time>
obrigatório

Start date of the legado contract, RFC 3339 UTC.

Exemplo:

"2024-09-03T00:00:00Z"

numeroContrato
string
obrigatório

Number of the legado contract, freely chosen by the institution.

Required string length: 1 - 20
Exemplo:

"99999999999AL1"

numeroParcelas
integer<int64>
obrigatório

Total number of instalments of the legado loan.

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

15

qtdParcelasPagas
integer<int64>
obrigatório

Number of instalments already paid.

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

7

valorCETMensal
string
obrigatório

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

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

"0.5"

valorEmprestimo
string
obrigatório

valorEmprestimo — the legado loan's principal (decimal string, BRL).

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

"12000.00"

valorParcela
string
obrigatório

valorParcela — the legado loan's instalment amount (decimal string, BRL).

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

"831.34"

valorSaldoDevedor
string
obrigatório

valorSaldoDevedor — present value of the remaining instalments, base date the day of the request (Manual 007 §3.1.1's OWN definition, not Manual 015's — decimal string, BRL).

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

"6512.46"

valorTaxaMensal
string
obrigatório

valorTaxaMensal — monthly interest rate, percent decimal string.

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

"0.5"

codigoInscricaoEmpregador
enum<string>

Employer inscription type: 1 CNPJ, 2 CPF. Required when codigoTipoContrato is 2 (folha).

Opções disponíveis:
1,
2
Exemplo:

"1"

matricula
string

Matrícula assigned to the worker by the employer. Required when codigoTipoContrato is 2 (folha).

Maximum string length: 30
Exemplo:

"99999999999-A"

numeroInscricaoEmpregador
string

Employer inscription number: 14 digits for CNPJ, 11 for CPF (matching codigoInscricaoEmpregador; §3.1.1's own '15 algarismos' is a stale maximum, see ports.ValidateNumeroInscricaoEmpregador). Required when codigoTipoContrato is 2 (folha).

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

"42422253000101"

Resposta

OK

idempotent
boolean
obrigatório

True when the rail answered its own HX (incluir)/HY (excluir) idempotency code rather than fresh confirmation. On excluir (HY) this means the contract is confirmed gone, which is sound. On incluir (HX) it means ONLY that this numeroContrato is already registered on the rail — the values THIS request carried (valorEmprestimo, valorParcela, etc.) were NOT compared against what is stored. To correct a legado registered with wrong values, exclude it (motivo 9) and include it again; do not rely on idempotent:true as proof the stored values match.

Exemplo:

false

mensagem
string
obrigatório

The rail's own message.

Exemplo:

"Emprestimo legado incluido com sucesso"

numeroContrato
string
obrigatório

The contract number the rail confirmed the operation against.

Exemplo:

"99999999999AL1"