post http://{{auth_server_host}}/banking/originator/applications/preview-total-amount
Esse endpoint permite a realização de uma simulação de empréstimo dado um valor total das parcelas e então será calculada as demais condições.
Veja mais detalhes em: https://developers.celcoin.com.br/docs/simulações
Parâmetros da Requisição
total_amount_owned(float): Valor total das parcelas.
interest_rate(float, obrigatório): A taxa de juros a ser aplicada na simulação em formato decimal.
tac_amount(float): Tarifa de cadastro ou outra taxa que precise ser adicionada ao valor do empréstimo.
finance_fee(float, obrigatório): Demais custos do financiamento a ser adicionado ao valor do empréstimo. Se não tiver outros custos deve enviar como "0"
iofType(string, obrigatório): Pessoa Física, Pessoas Jurídicas sob o regime de Lucro Presumido e Pessoas Jurídicas sob o regime de Lucro Real são tributadas de modo diferente sob a operação de crédito. Possíveis valores aceitos: BUSINESS,
num_payments(integer, obrigatório): Quantidade de parcelas para realização da simulação.
first_payment_date(datetime, obrigatório): Data do primeiro pagamento no formato "AAAA-MM-DD". Atenção: O intervalo entre a data de desembolso e a data do primeiro vencimento (carência) irá afetar o custo do empréstimo.
disbursement_date(datetime, obrigatório): Data desejada para o recebimento do valor do empréstimo. Os juros começam a contar a partir desta data.
borrower_type(string): O tipo da pessoa que está realizando a simulação. Posssíveis valores aceitos: PERSON.
schedule_type(string, obrigatório): A periodicidade das parcelas para a simulação. Possíveis valores aceitos: DAILY, WEEKLY e MONTHLY.
Resposta
Se a requisição for processada com sucesso será retornado um status 200 com um JSON de resposta:
total_processing_cost: Custo total de processamento da cédula para emissão do empréstimo.
annual_interest_rate": Taxa de juros calculada para o formato anual.
annual_effective_interest_rate: Custo Efetivo Total Anual (CET), em pontos percentuais decimais (1% a.m = 0.01).
monthly_effective_interest_rate: Custo Efetivo Total Mensal, em pontos percentuais decimais (1% a.m = 0.01).
iof_amount: Valor total do IOF em reais, calculado para o empréstimo.
finance_fee: Demais custos do financiamento que foram adicionados ao valor do empréstimo.
interest_rate: Taxa de juros menal da simulação.
tac_amount: Valor da TAC, tarifa de cadastro.
total_amount_owed: Valor total devido. Somatório de todas as Parcelas nas datas de vencimento.
financed_amount: Valor financiado em reais. Valor nominal (de face do empréstimo). Inclui o Valor Solicitado, Taxas de Cadastro (TAC), IOF e Demais taxas (finance_fee)
iof_daily_rate: Taxa de IOF diário. Aplicada sobre cada parcela sobre o valor amortizado composta em dias corridos.
iof_base_rate: Taxa de IOF base. Fixa, aplicada sobre o total financiado uma única vez.
requested_amount: Valor desejado para a simulação.
payment_amount: Valor da parcela.
disbursement_amount: Valor a ser desembolsado.
num_periods: Quantidade de parcelas.
first_payment_date: Data do primeiro pagamento.
issue_date: Data da realização da simulação/empréstimo.
disbursement_date: Data do desembolso, recebimento, do dinheiro.
created_at: Data da criação da simulação/empréstimo.
schedule: Objeto contendo os detalhes das parcelas.
schedule -> payment:Valor da parcela na data do vencimento.
schedule -> iof: IOF da parcela (desconsiderando IOF Base).
schedule -> balance: Saldo em aberto da parcela.
schedule -> interest: Valor de juros da parcela.
schedule -> principal: Valor do principal da parcela.
schedule -> period: Número da parcela
schedule -> running_day: Quantidade de dias corridos desde a originação até a data de vencimento da parcela
schedule -> payment_date: Data de vencimento da parcela.
schedule_type: A periodicidade das parcelas da simulação.
borrower_type: Tipo da pessoa que está simulando.
amortization_type: Tipo da tabela utilizada na memória de cálculo do empréstimo.
interest_compounding_type: Tipo do juros que será aplicado.
financed_iof: Campo boleano para indicar se o IOF será ou não financiado no empréstimo.
last_payment_date: Data de vencimento da última parcela.
Exemplo de JSON:
{
"total_processing_cost": 0.0,
"annual_interest_rate": 0.0,
"annual_effective_interest_rate": 0.0,
"monthly_effective_interest_rate": 0.0,
"iof_amount": 0.0,
"finance_fee": 0.0,
"interest_rate": 0.0,
"tac_amount": 0.0,
"total_amount_owed": 0.0,
"financed_amount": 0.0,
"iof_daily_rate": 0.0,
"iof_base_rate": 0.0,
"requested_amount": 0.0,
"payment_amount": 0.0,
"disbursement_amount": 0.0,
"num_periods": 0,
"first_payment_date": "",
"issue_date": "",
"disbursement_date": "",
"created_at": "",
"schedule": [
{
"payment": 0.0,
"iof": 0.0,
"balance": 0.0,
"interest": 0.0,
"principal": 0.0,
"period": 0,
"running_day": o,
"payment_date": ""
},
{
"payment": 0.0,
"iof": 0.0,
"balance": 0.0,
"interest": 0.0,
"principal": 0.0,
"period": 0,
"running_day": o,
"payment_date": ""
}
],
"schedule_type": "WEEKLY",
"borrower_type": "BUSINESS",
"amortization_type": "AMERICAN",
"interest_compounding_type": "SIMPLE",
"financed_iof": 0.0,
"last_payment_date": ""
}