10 - Simular Consignado

Realiza a simulação de consignado conforme dados informados, podendo calcular com base no valor liberado ou no valor da parcela.

Simula um empréstimo consignado.

cURL

curl --request POST \
  --url https://api.example.com/contrato/oferta-ativa/simular-consignado \
  --header 'Content-Type: application/json' \
  --data '
{
  "ValorTaxaMensal": 123,
  "ValorLiberado": 123,
  "NumeroParcelas": 123,
  "ValorParcela": 123,
  "ValorSeguro": 123
}
'

200

{
  "HasError": true,
  "Messages": [
    "<string>"
  ],
  "Pmt": {
    "Parcelas": [
      "<string>"
    ],
    "Resumo": {
      "ValorSolicitado": 123,
      "Prazo": 123,
      "IOFValor": 123,
      "IOFPercentual": 123,
      "TAC": 123,
      "ValorSeguro": 123,
      "OutrasDespesas": 123,
      "TotalFinanciado": 123,
      "JurosMensal": 123,
      "JurosAnual": 123,
      "DataContratacao": "2023-12-25",
      "DataPrimeiroVencimento": "2023-12-25",
      "DataUltimoVencimento": "2023-12-25",
      "ValorParcela": 123,
      "CETMensal": 123,
      "CETAnual": 123,
      "ValorTotalDivida": 123
    }
  }
}

Corpo

application/json

ValorTaxaMensal · number<double>

Valor da taxa de juros mensal (deve ser > 0).

ValorLiberado · number<double>

Valor do empréstimo desejado (informe se a simulação for por valor liberado).

NumeroParcelas · integer<int32>

Número de parcelas desejado (1 a 96).

ValorParcela · number<double>

Valor da parcela desejado (informe se a simulação for por valor de parcela).

ValorSeguro · number<double>

Valor do seguro (opcional, se houver, > 0).

Resposta

200

application/json

OK

HasError · boolean · obrigatório

Indica se houve erro na simulação (false = sucesso).

Messages · string[]

Mensagens de erro da simulação (preenchido se HasError = true).

Pmt · object

Show child attributes