Pular para o conteúdo principal
Tipo: Síncrona
Este endpoint permite realizar a simulação de um empréstimo consignado com base em um conjunto reduzido de informações.
A simulação pode ser realizada com ou sem a definição prévia de prazo e taxa de juros, conforme as regras abaixo.

Regras de Simulação

  • Quando o prazo (número de parcelas) é informado na requisição, o retorno será uma simulação detalhada, contendo o cálculo completo da operação e o detalhamento das parcelas;
  • Quando o prazo não é informado, o retorno será uma lista de alternativas de parcelamento, com seus respectivos valores de parcela e taxas;
  • Quando a taxa de juros é informada na requisição, o cálculo será realizado com base na taxa enviada;
  • Quando a taxa de juros não é informada, o cálculo será realizado com base na taxa previamente cadastrada na BMP;
  • O onboarding do trabalhador não é obrigatório para a realização da simulação, porém é recomendado, pois permite desabilitar opções de parcelamento que excedam a margem consignável disponível do trabalhador.

Endpoint

POST /contrato/oferta-ativa/simular-consignado

Modalidades de Simulação

4.1 Simulação Detalhada (Prazo Definido)

Utilize esta modalidade quando já houver definição da quantidade de parcelas a ser ofertada ao trabalhador.
O retorno será uma lista com o detalhamento completo das parcelas da simulação.

Exemplo de Requisição — Simulação Detalhada

curl --location 'https://econsignadotrabalhador.moneyp.dev.br/contrato/oferta-ativa/simular-consignado' \
--header 'Content-type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "ValorLiberado": 3000,
  "numeroParcelas": 12,
  "ValorTaxaMensal": 2.5,
  "valorSeguro": 0
}'

Exemplo de Resposta — Simulação Detalhada

{
  "Prazo": 12,
  "VlrIOF": 67.86,
  "PercIOF": 3.00,
  "VlrParcela": 308.30,
  "PercCETAnual": 40.09560,
  "PercCETMensal": 2.84947,
  "VlrTotalDivida": 3699.60,
  "PercJurosAnual": 34.48888,
  "VlrTotalCredito": 3067.86,
  "PercJurosMensal": 2.5,
  "ValorSolicitado": 3000.0,
  "DtPrimeiroVencimento": "2025-07-23T00:00:00-03:00",
  "Parcelas": [
    {
      "Parcela": 1,
      "Dias": 64,
      "DtVencimento": "2025-07-23T00:00:00-03:00",
      "VlrSaldoDevedor": 2925.50,
      "VlrAmortizacao": 142.36,
      "VlrJuros": 58.30,
      "VlrPrestacaoTotal": 308.30
    }
  ]
}

4.2 Simulação Multiparcelamento (Prazo Aberto)

Utilize esta modalidade para apresentar ao trabalhador diferentes alternativas de parcelamento, com base no intervalo de prazo configurado para o produto do parceiro.
O retorno será uma lista de opções de empréstimo, variando conforme o número de parcelas.

Exemplo de Requisição — Simulação Multiparcelamento

curl --location 'https://econsignadotrabalhador.moneyp.dev.br/contrato/oferta-ativa/simular-consignado' \
--header 'Content-type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "ValorLiberado": 3000,
  "ValorTaxaMensal": 2.5,
  "valorSeguro": 0
}'

Exemplo de Resposta — Simulação Multiparcelamento

{
  "DtPrimeiroVencimento": "2025-07-23T00:00:00",
  "Parcelas": [
    {
      "ValorSolicitado": 3000.0,
      "Prazo": 1,
      "VlrParcela": 3190.92,
      "VlrIOF": 27.18,
      "VlrTotalCredito": 3027.18,
      "VlrTotalDivida": 3190.92
    },
    {
      "ValorSolicitado": 3000.0,
      "Prazo": 36,
      "VlrParcela": 135.68,
      "VlrIOF": 90.21,
      "VlrTotalCredito": 3090.21,
      "VlrTotalDivida": 4884.48
    }
  ]
}

4.3 Simulação por Valor de Parcela

Esta modalidade permite simular o empréstimo a partir do valor da parcela desejada pelo trabalhador.
Com base nesse valor, o sistema calcula automaticamente o valor total liberado, considerando taxa, prazo e demais encargos.
Essa abordagem é indicada para cenários em que o trabalhador tem como referência o valor máximo que pode comprometer mensalmente, alinhando-se à margem consignável disponível.

Exemplo de Requisição — Simulação por Valor de Parcela

curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/oferta-ativa/simular-consignado' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "numeroParcelas": 12,
  "ValorTaxaMensal": 2.75,
  "valorSeguro": 0,
  "valorParcela": 1234
}'

Exemplo de Resposta — Simulação por Valor de Parcela

{
  "Pmt": {
    "Resumo": {
      "VlrSolicitado": 4296.01,
      "Prazo": 4,
      "Iof": 66.92,
      "VlrTotalFinanciado": 4362.93,
      "PercJurosMensal": 2.75,
      "VlrPMT": 1234,
      "VlrTotalDivida": 4936
    }
  },
  "Msg": "OK",
  "HasError": false
}

Considerações Técnicas

  • A simulação não gera vínculo contratual;
  • Os valores retornados podem variar conforme:
    • Taxa configurada;
    • Prazo selecionado;
    • Data do primeiro vencimento;
    • Incidência de IOF e demais encargos;
  • A validação de margem consignável é mais precisa quando o onboarding do trabalhador já foi realizado.