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 that the client received on a consignado.portability_proposal.received fact. 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 initiating fact carried. 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 Dataprev answer instead of resubmitting to the rail. A rejection that the gateway issues on its own is not stored, so a corrected body under the same key is processed. A 500, 503 or 504 that may have reached Dataprev holds the key for its 7-day TTL: that response carries X-Idempotency-Fenced: true, and a resend under the same key is rejected with 422 IDEMPOTENCY_OUTCOME_UNRECORDED. A 503 whose only Dataprev code is OZ (service suspended) does not hold the key. To learn the outcome, resend the same body, with the same numeroProposta, under a new key. Dataprev rejects a proposal number it already holds with SE (Manual 011 v1.6 §3.2.1, §4.1), so a 422 whose upstream member names SE means the first proposal reached Dataprev, and an acceptance means it did not. Never change numeroProposta on that resend. The resend works only before dataHoraValidadeSolicitacao. After that instant the gateway rejects the resend before calling the rail, which proves nothing, and the Dataprev Portal is the only place to check. This endpoint does not have durable PostgreSQL-backed replay storage, so the guarantee does not survive a Redis eviction or service restart.

POST /v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas

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

cURL

curl --request POST \
  --url https://br-consignado-gw.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": "[e-mail]",
      "tipo": 3
    }
  ],
  "percVerbaRescisoriaGarantia": "15.00",
  "valorMultaRescisoriaGarantiaFgts": "300.00",
  "valorSaldoDisponivelGarantiaFgts": "600.00"
}
'

200

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

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, echoed from the consignado.portability_proposal.received fact (Manual 011 v1.6 §3.1.3). Authoritative per record; 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

200

application/json

OK

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"