Respond to an inbound portability leilão solicitação

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "dataHoraValidadeProposta": "2030-01-01T10:00:00Z",
  "dataHoraValidadeSolicitacao": "2025-10-30T23:45:29Z",
  "numeroParcelas": 12,
  "numeroProposta": "7K9M2P4R6T8V3W5X2Y4Z",
  "temGarantias": false,
  "valorCETAnual": "11.00",
  "valorCETMensal": "0.90",
  "valorEmprestimo": "2160.00",
  "valorParcela": "180.00",
  "valorTaxaAnual": "10.00",
  "valorTaxaMensal": "0.80",
  "contatos": [
    {
      "contato": "bidder@example.com",
      "tipo": 3
    }
  ],
  "percVerbaRescisoriaGarantia": "15.00",
  "valorMultaRescisoriaGarantiaFgts": "300.00",
  "valorSaldoDisponivelGarantiaFgts": "600.00"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas"

payload = {
    "dataHoraValidadeProposta": "2030-01-01T10:00:00Z",
    "dataHoraValidadeSolicitacao": "2025-10-30T23:45:29Z",
    "numeroParcelas": 12,
    "numeroProposta": "7K9M2P4R6T8V3W5X2Y4Z",
    "temGarantias": False,
    "valorCETAnual": "11.00",
    "valorCETMensal": "0.90",
    "valorEmprestimo": "2160.00",
    "valorParcela": "180.00",
    "valorTaxaAnual": "10.00",
    "valorTaxaMensal": "0.80",
    "contatos": [
        {
            "contato": "bidder@example.com",
            "tipo": 3
        }
    ],
    "percVerbaRescisoriaGarantia": "15.00",
    "valorMultaRescisoriaGarantiaFgts": "300.00",
    "valorSaldoDisponivelGarantiaFgts": "600.00"
}
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({
    dataHoraValidadeProposta: '2030-01-01T10:00:00Z',
    dataHoraValidadeSolicitacao: '2025-10-30T23:45:29Z',
    numeroParcelas: 12,
    numeroProposta: '7K9M2P4R6T8V3W5X2Y4Z',
    temGarantias: false,
    valorCETAnual: '11.00',
    valorCETMensal: '0.90',
    valorEmprestimo: '2160.00',
    valorParcela: '180.00',
    valorTaxaAnual: '10.00',
    valorTaxaMensal: '0.80',
    contatos: [{contato: 'bidder@example.com', tipo: 3}],
    percVerbaRescisoriaGarantia: '15.00',
    valorMultaRescisoriaGarantiaFgts: '300.00',
    valorSaldoDisponivelGarantiaFgts: '600.00'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas', 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/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas",
  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([
    'dataHoraValidadeProposta' => '2030-01-01T10:00:00Z',
    'dataHoraValidadeSolicitacao' => '2025-10-30T23:45:29Z',
    'numeroParcelas' => 12,
    'numeroProposta' => '7K9M2P4R6T8V3W5X2Y4Z',
    'temGarantias' => false,
    'valorCETAnual' => '11.00',
    'valorCETMensal' => '0.90',
    'valorEmprestimo' => '2160.00',
    'valorParcela' => '180.00',
    'valorTaxaAnual' => '10.00',
    'valorTaxaMensal' => '0.80',
    'contatos' => [
        [
                'contato' => 'bidder@example.com',
                'tipo' => 3
        ]
    ],
    'percVerbaRescisoriaGarantia' => '15.00',
    'valorMultaRescisoriaGarantiaFgts' => '300.00',
    'valorSaldoDisponivelGarantiaFgts' => '600.00'
  ]),
  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/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas"

	payload := strings.NewReader("{\n  \"dataHoraValidadeProposta\": \"2030-01-01T10:00:00Z\",\n  \"dataHoraValidadeSolicitacao\": \"2025-10-30T23:45:29Z\",\n  \"numeroParcelas\": 12,\n  \"numeroProposta\": \"7K9M2P4R6T8V3W5X2Y4Z\",\n  \"temGarantias\": false,\n  \"valorCETAnual\": \"11.00\",\n  \"valorCETMensal\": \"0.90\",\n  \"valorEmprestimo\": \"2160.00\",\n  \"valorParcela\": \"180.00\",\n  \"valorTaxaAnual\": \"10.00\",\n  \"valorTaxaMensal\": \"0.80\",\n  \"contatos\": [\n    {\n      \"contato\": \"bidder@example.com\",\n      \"tipo\": 3\n    }\n  ],\n  \"percVerbaRescisoriaGarantia\": \"15.00\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"300.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"600.00\"\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/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataHoraValidadeProposta\": \"2030-01-01T10:00:00Z\",\n  \"dataHoraValidadeSolicitacao\": \"2025-10-30T23:45:29Z\",\n  \"numeroParcelas\": 12,\n  \"numeroProposta\": \"7K9M2P4R6T8V3W5X2Y4Z\",\n  \"temGarantias\": false,\n  \"valorCETAnual\": \"11.00\",\n  \"valorCETMensal\": \"0.90\",\n  \"valorEmprestimo\": \"2160.00\",\n  \"valorParcela\": \"180.00\",\n  \"valorTaxaAnual\": \"10.00\",\n  \"valorTaxaMensal\": \"0.80\",\n  \"contatos\": [\n    {\n      \"contato\": \"bidder@example.com\",\n      \"tipo\": 3\n    }\n  ],\n  \"percVerbaRescisoriaGarantia\": \"15.00\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"300.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"600.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas")

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  \"dataHoraValidadeProposta\": \"2030-01-01T10:00:00Z\",\n  \"dataHoraValidadeSolicitacao\": \"2025-10-30T23:45:29Z\",\n  \"numeroParcelas\": 12,\n  \"numeroProposta\": \"7K9M2P4R6T8V3W5X2Y4Z\",\n  \"temGarantias\": false,\n  \"valorCETAnual\": \"11.00\",\n  \"valorCETMensal\": \"0.90\",\n  \"valorEmprestimo\": \"2160.00\",\n  \"valorParcela\": \"180.00\",\n  \"valorTaxaAnual\": \"10.00\",\n  \"valorTaxaMensal\": \"0.80\",\n  \"contatos\": [\n    {\n      \"contato\": \"bidder@example.com\",\n      \"tipo\": 3\n    }\n  ],\n  \"percVerbaRescisoriaGarantia\": \"15.00\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"300.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"600.00\"\n}"

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

{
  "accepted": true,
  "codigo": "BD",
  "dataHoraValidadeProposta": "2030-01-01T10:00:00Z",
  "idSolicitacaoProposta": "221",
  "numeroProposta": "7K9M2P4R6T8V3W5X2Y4Z",
  "submittedAt": "2025-10-28T00:00:00Z",
  "hashOperacao": "34027710"
}

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

Respond to an inbound portability leilão solicitação

Submits one proposal through inclusao-garantias (Manual 011 v1.6 §3.2) in response to a portability auction request obtained through the client’s integration. The catalog defines consignado.portability_proposal.received for this workflow, but develop has no production producer for that fact yet. Unlike the M001 bid operation, this endpoint accepts one proposal per call: a request that permits a second proposal, with or without FGTS collateral, requires two separate calls rather than an array.

dataHoraValidadeSolicitacao is the same field that the cataloged initiating fact is designed to carry. It is response-side data from Manual 011 §3.1.3 and is not sent to Dataprev in this request. The client echoes it so the gateway can reject a response to an expired record before calling the rail. Expiration is evaluated per record without consulting a calendar.

Manual 011 uses two spellings for this operation’s path: §2.2 omits an accent, while §3.2.3.1 includes one. Because M011 publishes no Swagger path to resolve the discrepancy, the configured path spelling must be validated during homologation. The request and response otherwise follow Manual 011 §3.2.1 and §3.2.2.

X-Idempotency is the mandatory transport replay key. A retry with the same key returns the stored response instead of resubmitting to the rail, as on the averbação and CCB attachment routes. This endpoint does not yet have durable PostgreSQL-backed replay storage, so the guarantee does not survive a Redis eviction or service restart.

POST

consignado

leilao

portabilidade

solicitacoes

{id_solicitacao_proposta}

propostas

Respond to an inbound portability leilão solicitação

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "dataHoraValidadeProposta": "2030-01-01T10:00:00Z",
  "dataHoraValidadeSolicitacao": "2025-10-30T23:45:29Z",
  "numeroParcelas": 12,
  "numeroProposta": "7K9M2P4R6T8V3W5X2Y4Z",
  "temGarantias": false,
  "valorCETAnual": "11.00",
  "valorCETMensal": "0.90",
  "valorEmprestimo": "2160.00",
  "valorParcela": "180.00",
  "valorTaxaAnual": "10.00",
  "valorTaxaMensal": "0.80",
  "contatos": [
    {
      "contato": "bidder@example.com",
      "tipo": 3
    }
  ],
  "percVerbaRescisoriaGarantia": "15.00",
  "valorMultaRescisoriaGarantiaFgts": "300.00",
  "valorSaldoDisponivelGarantiaFgts": "600.00"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas"

payload = {
    "dataHoraValidadeProposta": "2030-01-01T10:00:00Z",
    "dataHoraValidadeSolicitacao": "2025-10-30T23:45:29Z",
    "numeroParcelas": 12,
    "numeroProposta": "7K9M2P4R6T8V3W5X2Y4Z",
    "temGarantias": False,
    "valorCETAnual": "11.00",
    "valorCETMensal": "0.90",
    "valorEmprestimo": "2160.00",
    "valorParcela": "180.00",
    "valorTaxaAnual": "10.00",
    "valorTaxaMensal": "0.80",
    "contatos": [
        {
            "contato": "bidder@example.com",
            "tipo": 3
        }
    ],
    "percVerbaRescisoriaGarantia": "15.00",
    "valorMultaRescisoriaGarantiaFgts": "300.00",
    "valorSaldoDisponivelGarantiaFgts": "600.00"
}
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({
    dataHoraValidadeProposta: '2030-01-01T10:00:00Z',
    dataHoraValidadeSolicitacao: '2025-10-30T23:45:29Z',
    numeroParcelas: 12,
    numeroProposta: '7K9M2P4R6T8V3W5X2Y4Z',
    temGarantias: false,
    valorCETAnual: '11.00',
    valorCETMensal: '0.90',
    valorEmprestimo: '2160.00',
    valorParcela: '180.00',
    valorTaxaAnual: '10.00',
    valorTaxaMensal: '0.80',
    contatos: [{contato: 'bidder@example.com', tipo: 3}],
    percVerbaRescisoriaGarantia: '15.00',
    valorMultaRescisoriaGarantiaFgts: '300.00',
    valorSaldoDisponivelGarantiaFgts: '600.00'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas', 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/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas",
  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([
    'dataHoraValidadeProposta' => '2030-01-01T10:00:00Z',
    'dataHoraValidadeSolicitacao' => '2025-10-30T23:45:29Z',
    'numeroParcelas' => 12,
    'numeroProposta' => '7K9M2P4R6T8V3W5X2Y4Z',
    'temGarantias' => false,
    'valorCETAnual' => '11.00',
    'valorCETMensal' => '0.90',
    'valorEmprestimo' => '2160.00',
    'valorParcela' => '180.00',
    'valorTaxaAnual' => '10.00',
    'valorTaxaMensal' => '0.80',
    'contatos' => [
        [
                'contato' => 'bidder@example.com',
                'tipo' => 3
        ]
    ],
    'percVerbaRescisoriaGarantia' => '15.00',
    'valorMultaRescisoriaGarantiaFgts' => '300.00',
    'valorSaldoDisponivelGarantiaFgts' => '600.00'
  ]),
  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/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas"

	payload := strings.NewReader("{\n  \"dataHoraValidadeProposta\": \"2030-01-01T10:00:00Z\",\n  \"dataHoraValidadeSolicitacao\": \"2025-10-30T23:45:29Z\",\n  \"numeroParcelas\": 12,\n  \"numeroProposta\": \"7K9M2P4R6T8V3W5X2Y4Z\",\n  \"temGarantias\": false,\n  \"valorCETAnual\": \"11.00\",\n  \"valorCETMensal\": \"0.90\",\n  \"valorEmprestimo\": \"2160.00\",\n  \"valorParcela\": \"180.00\",\n  \"valorTaxaAnual\": \"10.00\",\n  \"valorTaxaMensal\": \"0.80\",\n  \"contatos\": [\n    {\n      \"contato\": \"bidder@example.com\",\n      \"tipo\": 3\n    }\n  ],\n  \"percVerbaRescisoriaGarantia\": \"15.00\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"300.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"600.00\"\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/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataHoraValidadeProposta\": \"2030-01-01T10:00:00Z\",\n  \"dataHoraValidadeSolicitacao\": \"2025-10-30T23:45:29Z\",\n  \"numeroParcelas\": 12,\n  \"numeroProposta\": \"7K9M2P4R6T8V3W5X2Y4Z\",\n  \"temGarantias\": false,\n  \"valorCETAnual\": \"11.00\",\n  \"valorCETMensal\": \"0.90\",\n  \"valorEmprestimo\": \"2160.00\",\n  \"valorParcela\": \"180.00\",\n  \"valorTaxaAnual\": \"10.00\",\n  \"valorTaxaMensal\": \"0.80\",\n  \"contatos\": [\n    {\n      \"contato\": \"bidder@example.com\",\n      \"tipo\": 3\n    }\n  ],\n  \"percVerbaRescisoriaGarantia\": \"15.00\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"300.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"600.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas")

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  \"dataHoraValidadeProposta\": \"2030-01-01T10:00:00Z\",\n  \"dataHoraValidadeSolicitacao\": \"2025-10-30T23:45:29Z\",\n  \"numeroParcelas\": 12,\n  \"numeroProposta\": \"7K9M2P4R6T8V3W5X2Y4Z\",\n  \"temGarantias\": false,\n  \"valorCETAnual\": \"11.00\",\n  \"valorCETMensal\": \"0.90\",\n  \"valorEmprestimo\": \"2160.00\",\n  \"valorParcela\": \"180.00\",\n  \"valorTaxaAnual\": \"10.00\",\n  \"valorTaxaMensal\": \"0.80\",\n  \"contatos\": [\n    {\n      \"contato\": \"bidder@example.com\",\n      \"tipo\": 3\n    }\n  ],\n  \"percVerbaRescisoriaGarantia\": \"15.00\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"300.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"600.00\"\n}"

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

{
  "accepted": true,
  "codigo": "BD",
  "dataHoraValidadeProposta": "2030-01-01T10:00:00Z",
  "idSolicitacaoProposta": "221",
  "numeroProposta": "7K9M2P4R6T8V3W5X2Y4Z",
  "submittedAt": "2025-10-28T00:00:00Z",
  "hashOperacao": "34027710"
}

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

string

required

Required transport replay key, scoped by authenticated tenant.

Required string length: 1 - 128

Example:

"idem-portability-2026-08-10-0001"

Path Parameters

id_solicitacao_proposta

string

required

Portability solicitação identity, echoed from the initiating fact. A digit string — Manual 011 v1.6 §3.2.1 publishes 32 algarismos, which overflows an int64.

Required string length: 1 - 32

Pattern: ^[0-9]{1,32}$

Example:

"221"

Body

application/json

dataHoraValidadeProposta

string<date-time>

required

This proposal's own validity instant — a SEPARATE validity from dataHoraValidadeSolicitacao above, informed by the client (Manual 011 v1.6 §3.2.1).

Example:

"2030-01-01T10:00:00Z"

dataHoraValidadeSolicitacao

string<date-time>

required

The portability solicitação's own validity instant from Manual 011 v1.6 §3.1.3. The cataloged consignado.portability_proposal.received fact is designed to carry this value, but that fact has no production producer on develop yet. The value is authoritative per record and is judged against the gateway's clock before the rail is called.

Example:

"2025-10-30T23:45:29Z"

numeroParcelas

integer<int64>

required

Number of instalments.

Required range: 1 <= x <= 999

Example:

12

numeroProposta

string

required

Proposal identifier this gateway mints.

Required string length: 1 - 20

Example:

"7K9M2P4R6T8V3W5X2Y4Z"

temGarantias

boolean

required

Whether this proposal pledges FGTS collateral.

Example:

false

valorCETAnual

string

required

Annual total effective cost in percent.

Maximum string length: 10

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

Example:

"11.00"

valorCETMensal

string

required

Monthly total effective cost in percent.

Maximum string length: 10

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

Example:

"0.90"

valorEmprestimo

string

required

Principal plus financed costs as an exact decimal string.

Maximum string length: 13

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

Example:

"2160.00"

valorParcela

string

required

Instalment amount as an exact decimal string.

Maximum string length: 13

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

Example:

"180.00"

valorTaxaAnual

string

required

Annual interest rate in percent.

Maximum string length: 10

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

Example:

"10.00"

valorTaxaMensal

string

required

Monthly interest rate in percent.

Maximum string length: 10

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

Example:

"0.80"

contatos

object[] | null

Client contacts.

Maximum array length: 4

Show child attributes

percVerbaRescisoriaGarantia

string

Optional severance-pay percentage pledged as collateral.

Maximum string length: 6

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

Example:

"15.00"

valorMultaRescisoriaGarantiaFgts

string

Optional rescission-penalty amount pledged as collateral.

Maximum string length: 13

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

Example:

"300.00"

valorSaldoDisponivelGarantiaFgts

string

Optional consignable FGTS balance pledged as collateral.

Maximum string length: 13

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

Example:

"600.00"

Response

accepted

boolean

required

True only when the rail's codigo equalled the observed success code.

Example:

true

codigo

string

required

Bounded rail outcome code, relayed verbatim. Free-form provider text is never returned.

Maximum string length: 32

Pattern: ^[A-Za-z0-9_-]*$

Example:

"BD"

dataHoraValidadeProposta

string<date-time>

required

Proposal validity echoed by Dataprev.

Example:

"2030-01-01T10:00:00Z"

idSolicitacaoProposta

string

required

The solicitação identity addressed by this response.

Example:

"221"

numeroProposta

string

required

Proposal identifier echoed by Dataprev.

Example:

"7K9M2P4R6T8V3W5X2Y4Z"

submittedAt

string<date-time>

required

UTC instant the gateway submitted this proposal.

Example:

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

hashOperacao

string

Opaque rail audit identifier, when published.

Example:

"34027710"

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado — Dataprev

Respond to an inbound portability leilão solicitação

Authorizations

Headers

Path Parameters

Body

Response