Simulação de Crédito

Como calcular condições de crédito (CET, IOF, parcelas) antes de criar uma operação, sem persistência.

O que é

POST /simulations calcula as condições de uma operação de crédito — taxa de juros, CET, IOF e cronograma de parcelas — sem criar nenhum registro. É uma chamada stateless, ideal para exibir uma simulação ao cliente antes de ele decidir contratar.

Requisição (`CreateSimulationRequest`)

Campo	Tipo	Obrigatório	Descrição
`amount`	decimal	Sim	Valor principal da operação em reais (BRL), ex: `5000.00`.
`term`	integer	Sim	Número de parcelas desejado.
`monthlyInterestRate`	decimal	Sim	Taxa de juros mensal (ex: `2.99` = 2,99% ao mês).
`productId`	uuid ou null	Não	Código do produto de crédito. Nulo usa o produto padrão do parceiro.

Resposta (`SimulationResult`)

Campo	Tipo	Descrição
`monthlyInterestRate`	decimal	Taxa de juros mensal (ex: `2.99` = 2,99% ao mês).
`annualInterestRate`	decimal	Taxa de juros anual nominal (ex: `42.50` = 42,50% ao ano).
`cet`	decimal	Custo Efetivo Total anual, incluindo todos os encargos (ex: `45.00` = 45,00%).
`iof`	decimal	Valor total do IOF incidente sobre a operação em reais (BRL).
`totalAmount`	decimal	Valor total a pagar (principal + juros + IOF) em reais (BRL).
`installmentValue`	decimal	Valor de cada parcela em reais (BRL), calculado pela tabela Price.
`installments`	array de `Installment`	Cronograma detalhado, com vencimento (`dueDate`) e valor (`amount`) de cada parcela.

Exemplo

{
  "amount": 5000.00,
  "term": 12,
  "monthlyInterestRate": 2.99,
  "productId": null
}

{
  "monthlyInterestRate": 2.99,
  "annualInterestRate": 42.50,
  "cet": 45.00,
  "iof": 128.45,
  "totalAmount": 5842.30,
  "installmentValue": 486.86,
  "installments": [
    { "number": 1, "dueDate": "2026-09-06T00:00:00Z", "amount": 486.86 },
    { "number": 2, "dueDate": "2026-10-06T00:00:00Z", "amount": 486.86 }
  ]
}

Depois da simulação

A simulação não vincula o cliente a nada — para efetivamente originar o crédito, o próximo passo é criar a operação com POST /credit-operations, usando o mesmo amount, term e productCode (ou valores ajustados) usados na simulação.

Updated 14 days ago

Did this page help you?