Skip to main content
POST
Responder a una solicitud entrante de subasta de portabilidad

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Required transport replay key, scoped by authenticated tenant.

Required string length: 1 - 128
Ejemplo:

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

Parámetros de ruta

id_solicitacao_proposta
string
requerido

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}$
Ejemplo:

"221"

Cuerpo

application/json
dataHoraValidadeProposta
string<date-time>
requerido

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

Ejemplo:

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

dataHoraValidadeSolicitacao
string<date-time>
requerido

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.

Ejemplo:

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

numeroParcelas
integer<int64>
requerido

Number of instalments.

Rango requerido: 1 <= x <= 999
Ejemplo:

12

numeroProposta
string
requerido

Proposal identifier this gateway mints.

Required string length: 1 - 20
Ejemplo:

"7K9M2P4R6T8V3W5X2Y4Z"

temGarantias
boolean
requerido

Whether this proposal pledges FGTS collateral.

Ejemplo:

false

valorCETAnual
string
requerido

Annual total effective cost in percent.

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

"11.00"

valorCETMensal
string
requerido

Monthly total effective cost in percent.

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

"0.90"

valorEmprestimo
string
requerido

Principal plus financed costs as an exact decimal string.

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

"2160.00"

valorParcela
string
requerido

Instalment amount as an exact decimal string.

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

"180.00"

valorTaxaAnual
string
requerido

Annual interest rate in percent.

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

"10.00"

valorTaxaMensal
string
requerido

Monthly interest rate in percent.

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

"0.80"

contatos
object[] | null

Client contacts.

Maximum array length: 4
percVerbaRescisoriaGarantia
string

Optional severance-pay percentage pledged as collateral.

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

"15.00"

valorMultaRescisoriaGarantiaFgts
string

Optional rescission-penalty amount pledged as collateral.

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

"300.00"

valorSaldoDisponivelGarantiaFgts
string

Optional consignable FGTS balance pledged as collateral.

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

"600.00"

Respuesta

OK

accepted
boolean
requerido

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

Ejemplo:

true

codigo
string
requerido

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

Maximum string length: 32
Pattern: ^[A-Za-z0-9_-]*$
Ejemplo:

"BD"

dataHoraValidadeProposta
string<date-time>
requerido

Proposal validity echoed by Dataprev.

Ejemplo:

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

idSolicitacaoProposta
string
requerido

The solicitação identity addressed by this response.

Ejemplo:

"221"

numeroProposta
string
requerido

Proposal identifier echoed by Dataprev.

Ejemplo:

"7K9M2P4R6T8V3W5X2Y4Z"

submittedAt
string<date-time>
requerido

UTC instant the gateway submitted this proposal.

Ejemplo:

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

hashOperacao
string

Opaque rail audit identifier, when published.

Ejemplo:

"34027710"