Simulação de empréstimo

Como simular as condições e taxas de um empréstimo

É esperado que o consumidor interessado em contratar um empréstimo simule uma ou mais vezes a operação, fornecendo diferentes parâmetros (valor desejado, número de parcelas e carência), até chegar às condições que mais lhe agradem, antes de solicitar uma proposta de crédito. É exatamente esse o propósito desta feature.

Além dos parâmetros fornecidos pelo consumidor, é necessário que sejam informados na requisição ao simulador as taxas da operação, incluindo a comissão do originador. Abaixo são detalhados os parâmetros esperados no corpo da requisição ao endpoint de simulação de empréstimo.

CampoRqueridoTipoDescrição
amountsimTextoValor do empréstimo
loan_release_datenãoTextoData de liberação do empréstimo no formato yyyy-MM-dd. Caso não seja informada é assumida a data corrente
first_installment_due_datesimTextoData de vencimento da primeira parcela do empréstimo no formato yyyy-MM-dd
number_of_installmentssimNúmeroNúmero de parcelas do empréstimo
feessimArray de objetos do tipo FeeTaxas que incidem na operação. Importante: as taxas dos tipos iof e rate_month são obrigatórias

Fee

CampoRequeridoTipoDescrição
typesimEnum FeeType [escrow,
iof,
fintech, financial,
rate_month]
Tipo da taxa
amountnãoDecimal com até duas casas de precisãoValor (percentual) da taxa
embeddedsimBooleanoDefine se o valor da taxa deve ser embutido nas parcelas
calculation_basisnãoDecimal com até duas casas de precisãoBase de cálculo da taxa

Exemplo

{
   "amount": 5000.00,
   "loan_release_date": "2019-09-15",
   "number_of_installments": 10,
   "first_installment_due_date": "2021-09-10",
   "fees": [
       {
           "type": "iof",
           "embedded": true
       },
       {
           "type": "rate_month",
           "amount": 1.5,
           "embedded": true
       }
   ]
}

O simulador fará o cálculo do valor das parcelas com base nos parâmetros informados e retornará (as parcelas) juntamente com as demais condições da operação, conforme exemplo abaixo.

{
   "loan_release_date": "2021-12-01",
   "net_amount": 500,
   "total_cost_monthly": 1.99,
   "total_cost_yerly": 28.00,
   "installments_amount_sum": 1266.49,
   "installments": [
       {
           "due_date": "2023-12-01",
           "amount": 206.49
       },
       {
           "due_date": "2024-12-01",
           "amount": 206.49
       },
       {
           "due_date": "2025-12-01",
           "amount": 206.49
       },
       {
           "due_date": "2026-12-01",
           "amount": 247.5
       },
       {
           "due_date": "2027-12-01",
           "amount": 296.64
       }
   ]
}

Abaixo são detalhadas as propriedades do objeto JSON retornado na resposta do endpoint de simulação de empréstimo.

CampoRequeridoTipoDescrição
loan_release_datesimTextoData de liberação do empréstimo no formato yyyy-MM-dd
net_amountsimDecimal com duas casas de precisãoValor líquido do empréstimo
total_cost_monthlysimDecimal com duas casas de precisãoCusto Efetivo Total Mensal da operação
total_cost_yerlysimDecimal com duas casas de precisãoCusto Efetivo Total Anual da operação
installments_amount_sumnãoDecimal com duas casas de precisãoSoma das parcelas do empréstimo
installmentsnãoArray de objetos do tipo InstallmentParcelas do empréstimo

Installment

CampoRequeridoTipoDescrição
due_datesimTextoData de vencimento da parcela no formato yyyy-MM-dd
amountsimDecimal com duas casas de precisãoValor da parcela

🚧

Importante!

A simulação foi citada como primeiro passo do fluxo de contratação de empréstimo apenas para reforçar que não é necessário que o consumidor esteja cadastrado na plataforma para acessar a feature. Portanto, nada impede que consumidores já cadastrados tenham acesso à mesma.


What’s Next