Registrar un préstamo preexistente (legado)

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoTipoContrato": 2,
  "cpfTrabalhador": "99999999999",
  "dataFimContrato": "2025-12-23T00:00:00Z",
  "dataInicioContrato": "2024-09-03T00:00:00Z",
  "numeroContrato": "99999999999AL1",
  "numeroParcelas": 15,
  "qtdParcelasPagas": 7,
  "valorCETMensal": "0.5",
  "valorEmprestimo": "12000.00",
  "valorParcela": "831.34",
  "valorSaldoDevedor": "6512.46",
  "valorTaxaMensal": "0.5",
  "codigoInscricaoEmpregador": "1",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "42422253000101"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts"

payload = {
    "codigoTipoContrato": 2,
    "cpfTrabalhador": "99999999999",
    "dataFimContrato": "2025-12-23T00:00:00Z",
    "dataInicioContrato": "2024-09-03T00:00:00Z",
    "numeroContrato": "99999999999AL1",
    "numeroParcelas": 15,
    "qtdParcelasPagas": 7,
    "valorCETMensal": "0.5",
    "valorEmprestimo": "12000.00",
    "valorParcela": "831.34",
    "valorSaldoDevedor": "6512.46",
    "valorTaxaMensal": "0.5",
    "codigoInscricaoEmpregador": "1",
    "matricula": "99999999999-A",
    "numeroInscricaoEmpregador": "42422253000101"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoTipoContrato: 2,
    cpfTrabalhador: '99999999999',
    dataFimContrato: '2025-12-23T00:00:00Z',
    dataInicioContrato: '2024-09-03T00:00:00Z',
    numeroContrato: '99999999999AL1',
    numeroParcelas: 15,
    qtdParcelasPagas: 7,
    valorCETMensal: '0.5',
    valorEmprestimo: '12000.00',
    valorParcela: '831.34',
    valorSaldoDevedor: '6512.46',
    valorTaxaMensal: '0.5',
    codigoInscricaoEmpregador: '1',
    matricula: '99999999999-A',
    numeroInscricaoEmpregador: '42422253000101'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoTipoContrato' => 2,
    'cpfTrabalhador' => '99999999999',
    'dataFimContrato' => '2025-12-23T00:00:00Z',
    'dataInicioContrato' => '2024-09-03T00:00:00Z',
    'numeroContrato' => '99999999999AL1',
    'numeroParcelas' => 15,
    'qtdParcelasPagas' => 7,
    'valorCETMensal' => '0.5',
    'valorEmprestimo' => '12000.00',
    'valorParcela' => '831.34',
    'valorSaldoDevedor' => '6512.46',
    'valorTaxaMensal' => '0.5',
    'codigoInscricaoEmpregador' => '1',
    'matricula' => '99999999999-A',
    'numeroInscricaoEmpregador' => '42422253000101'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts"

	payload := strings.NewReader("{\n  \"codigoTipoContrato\": 2,\n  \"cpfTrabalhador\": \"99999999999\",\n  \"dataFimContrato\": \"2025-12-23T00:00:00Z\",\n  \"dataInicioContrato\": \"2024-09-03T00:00:00Z\",\n  \"numeroContrato\": \"99999999999AL1\",\n  \"numeroParcelas\": 15,\n  \"qtdParcelasPagas\": 7,\n  \"valorCETMensal\": \"0.5\",\n  \"valorEmprestimo\": \"12000.00\",\n  \"valorParcela\": \"831.34\",\n  \"valorSaldoDevedor\": \"6512.46\",\n  \"valorTaxaMensal\": \"0.5\",\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoTipoContrato\": 2,\n  \"cpfTrabalhador\": \"99999999999\",\n  \"dataFimContrato\": \"2025-12-23T00:00:00Z\",\n  \"dataInicioContrato\": \"2024-09-03T00:00:00Z\",\n  \"numeroContrato\": \"99999999999AL1\",\n  \"numeroParcelas\": 15,\n  \"qtdParcelasPagas\": 7,\n  \"valorCETMensal\": \"0.5\",\n  \"valorEmprestimo\": \"12000.00\",\n  \"valorParcela\": \"831.34\",\n  \"valorSaldoDevedor\": \"6512.46\",\n  \"valorTaxaMensal\": \"0.5\",\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoTipoContrato\": 2,\n  \"cpfTrabalhador\": \"99999999999\",\n  \"dataFimContrato\": \"2025-12-23T00:00:00Z\",\n  \"dataInicioContrato\": \"2024-09-03T00:00:00Z\",\n  \"numeroContrato\": \"99999999999AL1\",\n  \"numeroParcelas\": 15,\n  \"qtdParcelasPagas\": 7,\n  \"valorCETMensal\": \"0.5\",\n  \"valorEmprestimo\": \"12000.00\",\n  \"valorParcela\": \"831.34\",\n  \"valorSaldoDevedor\": \"6512.46\",\n  \"valorTaxaMensal\": \"0.5\",\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}"

response = http.request(request)
puts response.read_body

{
  "idempotent": false,
  "mensagem": "Emprestimo legado incluido com sucesso",
  "numeroContrato": "99999999999AL1"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Registrar un préstamo preexistente (legado)

Esta operación actúa como proxy de incluir-emprestimo-legado-trabalhador (Manual 007 v1.4 §3.1): registra un contrato que el tenant celebró antes de que existiera el modelo de esta red. El trabajador deja de ser elegible para una nueva contratación en esta red hasta que el contrato legado sea excluido o renegociado. Dataprev no realiza validación documental de los contratos legados (§2.2.1.3); la veracidad de lo enviado es responsabilidad de la institución. Cuando codigoTipoContrato es 2 (folha), codigoInscricaoEmpregador, numeroInscricaoEmpregador y matricula pasan a ser obligatorios; esta pasarela demuestra esa condición antes de llamar a la red, ya que ni la red ni el Swagger oficial la aplican. Se requiere X-Idempotency. Una solicitud reintentada que llega al propio HX de la red (“empréstimo já cadastrado”) responde correctamente en lugar de rechazarla.

POST

consignado

legacy-contracts

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoTipoContrato": 2,
  "cpfTrabalhador": "99999999999",
  "dataFimContrato": "2025-12-23T00:00:00Z",
  "dataInicioContrato": "2024-09-03T00:00:00Z",
  "numeroContrato": "99999999999AL1",
  "numeroParcelas": 15,
  "qtdParcelasPagas": 7,
  "valorCETMensal": "0.5",
  "valorEmprestimo": "12000.00",
  "valorParcela": "831.34",
  "valorSaldoDevedor": "6512.46",
  "valorTaxaMensal": "0.5",
  "codigoInscricaoEmpregador": "1",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "42422253000101"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts"

payload = {
    "codigoTipoContrato": 2,
    "cpfTrabalhador": "99999999999",
    "dataFimContrato": "2025-12-23T00:00:00Z",
    "dataInicioContrato": "2024-09-03T00:00:00Z",
    "numeroContrato": "99999999999AL1",
    "numeroParcelas": 15,
    "qtdParcelasPagas": 7,
    "valorCETMensal": "0.5",
    "valorEmprestimo": "12000.00",
    "valorParcela": "831.34",
    "valorSaldoDevedor": "6512.46",
    "valorTaxaMensal": "0.5",
    "codigoInscricaoEmpregador": "1",
    "matricula": "99999999999-A",
    "numeroInscricaoEmpregador": "42422253000101"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoTipoContrato: 2,
    cpfTrabalhador: '99999999999',
    dataFimContrato: '2025-12-23T00:00:00Z',
    dataInicioContrato: '2024-09-03T00:00:00Z',
    numeroContrato: '99999999999AL1',
    numeroParcelas: 15,
    qtdParcelasPagas: 7,
    valorCETMensal: '0.5',
    valorEmprestimo: '12000.00',
    valorParcela: '831.34',
    valorSaldoDevedor: '6512.46',
    valorTaxaMensal: '0.5',
    codigoInscricaoEmpregador: '1',
    matricula: '99999999999-A',
    numeroInscricaoEmpregador: '42422253000101'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoTipoContrato' => 2,
    'cpfTrabalhador' => '99999999999',
    'dataFimContrato' => '2025-12-23T00:00:00Z',
    'dataInicioContrato' => '2024-09-03T00:00:00Z',
    'numeroContrato' => '99999999999AL1',
    'numeroParcelas' => 15,
    'qtdParcelasPagas' => 7,
    'valorCETMensal' => '0.5',
    'valorEmprestimo' => '12000.00',
    'valorParcela' => '831.34',
    'valorSaldoDevedor' => '6512.46',
    'valorTaxaMensal' => '0.5',
    'codigoInscricaoEmpregador' => '1',
    'matricula' => '99999999999-A',
    'numeroInscricaoEmpregador' => '42422253000101'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts"

	payload := strings.NewReader("{\n  \"codigoTipoContrato\": 2,\n  \"cpfTrabalhador\": \"99999999999\",\n  \"dataFimContrato\": \"2025-12-23T00:00:00Z\",\n  \"dataInicioContrato\": \"2024-09-03T00:00:00Z\",\n  \"numeroContrato\": \"99999999999AL1\",\n  \"numeroParcelas\": 15,\n  \"qtdParcelasPagas\": 7,\n  \"valorCETMensal\": \"0.5\",\n  \"valorEmprestimo\": \"12000.00\",\n  \"valorParcela\": \"831.34\",\n  \"valorSaldoDevedor\": \"6512.46\",\n  \"valorTaxaMensal\": \"0.5\",\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoTipoContrato\": 2,\n  \"cpfTrabalhador\": \"99999999999\",\n  \"dataFimContrato\": \"2025-12-23T00:00:00Z\",\n  \"dataInicioContrato\": \"2024-09-03T00:00:00Z\",\n  \"numeroContrato\": \"99999999999AL1\",\n  \"numeroParcelas\": 15,\n  \"qtdParcelasPagas\": 7,\n  \"valorCETMensal\": \"0.5\",\n  \"valorEmprestimo\": \"12000.00\",\n  \"valorParcela\": \"831.34\",\n  \"valorSaldoDevedor\": \"6512.46\",\n  \"valorTaxaMensal\": \"0.5\",\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/legacy-contracts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoTipoContrato\": 2,\n  \"cpfTrabalhador\": \"99999999999\",\n  \"dataFimContrato\": \"2025-12-23T00:00:00Z\",\n  \"dataInicioContrato\": \"2024-09-03T00:00:00Z\",\n  \"numeroContrato\": \"99999999999AL1\",\n  \"numeroParcelas\": 15,\n  \"qtdParcelasPagas\": 7,\n  \"valorCETMensal\": \"0.5\",\n  \"valorEmprestimo\": \"12000.00\",\n  \"valorParcela\": \"831.34\",\n  \"valorSaldoDevedor\": \"6512.46\",\n  \"valorTaxaMensal\": \"0.5\",\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}"

response = http.request(request)
puts response.read_body

{
  "idempotent": false,
  "mensagem": "Emprestimo legado incluido com sucesso",
  "numeroContrato": "99999999999AL1"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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.

Ejemplo:

"idem-legado-incluir-0001"

Cuerpo

application/json

codigoTipoContrato

enum<integer>

requerido

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

Opciones disponibles:

1,

2

Ejemplo:

2

cpfTrabalhador

string

requerido

Worker CPF, exactly 11 digits.

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

Ejemplo:

"99999999999"

dataFimContrato

string<date-time>

requerido

End date of the legado contract, RFC 3339 UTC.

Ejemplo:

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

dataInicioContrato

string<date-time>

requerido

Start date of the legado contract, RFC 3339 UTC.

Ejemplo:

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

numeroContrato

string

requerido

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

Required string length: 1 - 20

Ejemplo:

"99999999999AL1"

numeroParcelas

integer<int64>

requerido

Total number of instalments of the legado loan.

Rango requerido: 1 <= x <= 999

Ejemplo:

15

qtdParcelasPagas

integer<int64>

requerido

Number of instalments already paid.

Rango requerido: 0 <= x <= 999

Ejemplo:

7

valorCETMensal

string

requerido

valorCETMensal — Custo Efetivo Total, monthly percent decimal string.

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

Ejemplo:

"0.5"

valorEmprestimo

string

requerido

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

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

Ejemplo:

"12000.00"

valorParcela

string

requerido

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

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

Ejemplo:

"831.34"

valorSaldoDevedor

string

requerido

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

Ejemplo:

"6512.46"

valorTaxaMensal

string

requerido

valorTaxaMensal — monthly interest rate, percent decimal string.

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

Ejemplo:

"0.5"

codigoInscricaoEmpregador

enum<string>

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

Opciones disponibles:

1,

2

Ejemplo:

"1"

matricula

string

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

Maximum string length: 30

Ejemplo:

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

Ejemplo:

"42422253000101"

Respuesta

idempotent

boolean

requerido

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.

Ejemplo:

false

mensagem

string

requerido

The rail's own message.

Ejemplo:

"Emprestimo legado incluido com sucesso"

numeroContrato

string

requerido

The contract number the rail confirmed the operation against.

Ejemplo:

"99999999999AL1"

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado — Dataprev

Registrar un préstamo preexistente (legado)

Autorizaciones

Encabezados

Cuerpo

Respuesta