Simulação Fria

Esta seção descreve a Simulação Fria (GET /simulations): um cálculo rápido de condições de crédito — taxas, parcela, CET e a composição do valor — a partir de dados básicos do cliente e da garantia. Ela apenas calcula; não cria uma solicitação/oferta na Creditas.

Endpoint

GET /simulations

Parâmetros (query)

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
`productType`	string	Sim	Tipo do produto (`AUTO_REFI` ou `HOME_REFI`).	`AUTO_REFI`
`intendedCredit`	double	Sim	Valor de empréstimo solicitado pelo cliente.	`40000.00`
`value`	double	Sim	Valor da garantia.	`21000.87`
`monthlyIncome`	double	Sim	Renda mensal do cliente.	`10000`
`loanTerm`	integer	Não	Número de parcelas em meses (12, 24, 36, 48, 60).	`48`
`manufacturingYear`	integer	Não	Ano de fabricação do veículo (garantia Auto).	`2015`
`professionalStatus`	string	Não	Situação profissional.	`CLT`
`score`	integer	Não	Score fornecido pelo parceiro.	`900`
`zipCode`	string	Não	CEP (8 dígitos).	`11000000`
`uf`	string	Não	UF (2 letras).	`MG`
`cpf`	string	Não	CPF do cliente (somente números).	`77136437024`
`amortization`	string	Não	Tabela de amortização.	`PRICE`

Exemplo de requisição

GET /simulations?productType=AUTO_REFI&intendedCredit=40000.00&value=21000.87&monthlyIncome=10000&loanTerm=48&manufacturingYear=2015

Response Body

A resposta é um único objeto com as condições calculadas para o prazo solicitado — a mesma estrutura do objeto Offer.

Exemplo (empréstimo de R$ 30.000,00 líquidos, 48×, 1,99% a.m.):

{
    "loanTerm": 48,
    "monthlyInterestRate": 0.0199,
    "totalEffectiveCost": 0.0231,
    "installmentAmount": 1041.14,
    "loanAmount": 30000.00,
    "feeValue": 800.00,
    "additionalCostsValue": 186.00,
    "iof": 1014.00,
    "total": 32000.00
}

Campo	Tipo	Descrição	Observações
`loanTerm`	integer	Número de parcelas. Ex: `48`	18, 24, 30, 36, 42, 48, 54, 60
`monthlyInterestRate`	double	Taxa mensal de juros. Ex: `0.0199`	Pode ter até 5 casas
`totalEffectiveCost`	double	CET — considera todos os encargos e despesas incidentes na operação. Ex: `0.0231`	Pode ter até 5 casas
`installmentAmount`	double	Valor calculado para cada parcela. Ex: `1041.14`	Pode ter até 2 casas
`loanAmount`	double	Valor líquido liberado ao cliente (creditado em conta). Não inclui juros, encargos nem IOF. Ex: `30000.00`	Pode ter até 2 casas
`feeValue`	double	Tarifas cobradas na operação. Ex: `800.00`	Pode ter até 2 casas
`additionalCostsValue`	double	Custos adicionais incidentes na operação. Ex: `186.00`	Pode ter até 2 casas
`iof`	double	Valor do IOF (Imposto sobre Operações Financeiras) incidente na operação. Ex: `1014.00`	Pode ter até 2 casas
`total`	double	Valor total financiado (loanAmount + feeValue + additionalCostsValue + iof). Ex: `32000.00`	Pode ter até 2 casas

📘
Fria x Quente
A Simulação Fria (GET /simulations) retorna um único objeto no nível raiz e não cria oferta. A Simulação Quente/Assertiva (GET /offers/{id}) usa a mesma estrutura de campos, mas dentro de um envelope com id, scoreFixed, approvedStatus e uma lista offers[].
Veja Offer e Simulação Quente (Assertiva).