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.

Campo

Rquerido

Tipo

Descrição

amount

sim

Texto

Valor do empréstimo

loan_release_date

não

Texto

Data de liberação do empréstimo no formato yyyy-MM-dd. Caso não seja informada é assumida a data corrente

first_installment_due_date

sim

Texto

Data de vencimento da primeira parcela do empréstimo no formato yyyy-MM-dd

number_of_installments

sim

Número

Número de parcelas do empréstimo

fees

sim

Array de objetos do tipo Fee

Taxas que incidem na operação. Importante: as taxas dos tipos iof e rate_month são obrigatórias

Fee

Campo

Requerido

Tipo

Descrição

type

sim

Enum FeeType [escrow,
iof,
fintech, financial,
rate_month]

Tipo da taxa

amount

não

Decimal com até duas casas de precisão

Valor (percentual) da taxa

embedded

sim

Booleano

Define se o valor da taxa deve ser embutido nas parcelas

calculation_basis

não

Decimal com até duas casas de precisão

Base 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.

Campo

Requerido

Tipo

Descrição

loan_release_date

sim

Texto

Data de liberação do empréstimo no formato yyyy-MM-dd

net_amount

sim

Decimal com duas casas de precisão

Valor líquido do empréstimo

total_cost_monthly

sim

Decimal com duas casas de precisão

Custo Efetivo Total Mensal da operação

total_cost_yerly

sim

Decimal com duas casas de precisão

Custo Efetivo Total Anual da operação

installments_amount_sum

não

Decimal com duas casas de precisão

Soma das parcelas do empréstimo

installments

não

Array de objetos do tipo Installment

Parcelas do empréstimo

Installment

Campo

Requerido

Tipo

Descrição

due_date

sim

Texto

Data de vencimento da parcela no formato yyyy-MM-dd

amount

sim

Decimal com duas casas de precisão

Valor 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
Did this page help you?