Simulador com score

A calculadora é uma consulta das taxas de juros, custo efetivo total (CET) e valor da parcela mensais, além do valor da solicitação ajustado (caso haja alguma limitação entre o valor solicitado e o que poderá ser ofertado ao solicitante).

Para uso desta simulação, você vai precisar enviar na request o valor do Serasa C2BA da pessoa solicitante. Caso você não tenha esse dado e ainda assim queira ter a simulação de taxas e valores em sua experiência, você pode nos pedir uma indicação de score médio e com isso, utilizá-lo como fixo em suas requisições.

Importante ressaltar que:

Este endpoint não cria uma solicitação de empréstimo na Creditas, apenas calcula as taxas e valores. Para envio do lead, utilize o endpoint de criação da proposta
Os valores retornados são apenas uma simulação e não significam uma oferta pré-aprovada, uma vez que depois que a solicitação de empréstimo for criada ela passará por uma análise de crédito.

Como consultar uma simulação

Request HTTP GET

Tipo da Requisição	URL	Exemplo
`GET`	{{url_base}}/simulations	https://stg-api.creditas.io/b2b/simulations

Request Params

Campo	Tipo	Obrigatório	Descrição
`zipCode`	string	Sim	CEP residencial do cliente (sem traços, apenas números) Ex: `04620000`
`value`	double	Sim	Valor do veículo usado como garantia Ex: `21000.87`
`manufacturingYear`	integer	Sim	Ano de fabricação do veículo usado como garantia (Atenção: Diferente do ano do modelo do veículo Ex: `2016`
`loanTerm`	integer	Sim	Número de parcelas em meses. Caso o valor não seja nenhuma das opções abaixo, a simulação considerará o número de parcelas mais próximo ao solicitado.) Opções: `18`, `24`, `30`, `36`, `42`, `48`, `54`, `60`.
`intendedCredit`	double	Sim	Valor de empréstimo solicitado pelo cliente O valor do empréstimo deve ser entre 5000 e 150000 Ex: `40000.00`
`monthlyIncome`	double	Sim	Renda mensal informada pelo cliente Ex: `10000.00`
`score`	integer	Sim	Score (Atualmente, nossa simulação é precificada no Score Serasa C2BA. Se você utiliza score de outros bureaus ou possui um score interno, recomendamos que realize um de/para para utilizar essa calculadora). Ex: `900`
`professionalStatus`	string	Sim	Status profissional. Opções: `CLT`, `SELF_EMPLOYED`, `FREELANCER`, `BUSINESSMAN`, `CIVIL_SERVANT`, `RETIRED`, `OTHER`
`counterProposal`	boolean	Não	Esse campo retornará uma oferta disponível no prazo mais próximo do que foi solicitado primeiramente. Isto é, será uma contraproposta caso no prazo solicitado inicialmente não tenha oferta disponível. Caso não tenha oferta disponível em nenhum prazo, não haverá retorno de oferta. Opções: `true` ou `false`

Response

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 (caso o retorno seja 0.019, a taxa é 1.9% ao mês). Ex: `0.01934`	Pode ter até 5 casas
`totalEffectiveCost`	double	Taxa que considera todos os encargos e despesas incidentes nas operações de crédito. Ex: `0.0359`	Pode ter até 5 casas
`installmentAmount`	double	Valor calculado para cada parcela. Ex: `3000.17`	Pode ter até 2 casas
`loanAmount`	double	Valor minimizado cedido para o empréstimo. Ex: `27833.46`	Pode ter até 2 casas
`iof`	double	Valor minimizado cedido para o empréstimo. Ex: `27833.46`	Pode ter até 2 casas

Exemplo de Request e Response

curl --location --request GET '{{url_base}}/simulations?zipCode=04620000&value=21000.87&manufacturingYear=2016&loanTerm=18&intendedCredit=40000.00&monthlyIncome=10000.00&score=900&professionalStatus=SELF_EMPLOYED&productType=AUTO_REFI' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'

{
    "loanTerm": 18,
    "monthlyIncome": 0.0237,
    "totalEffectiveCost": 0.03326,
    "installmentAmount": 1184.86,
    "loanAmount": 15287.01
    "iof": 155.62
}

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui.