Simulador (Intervalo Score: Min-Máx)


A calculadora é uma consulta das taxas de juros, custo efetivo total (CET) e valor da parcela mensal contendo valor mínimo e máximo em relação ao número de parcelas.

Importante ressaltar que:

  • Este endpoint não cria uma solicitação de empréstimo na Creditas, apenas calcula as taxas e valores. Para solicitação de empréstimo, 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 de empréstimo com veículo em garantia


Request HTTP GET

Tipo da RequisiçãoURLExemplo
GET{{url_base}}/simulationshttps://stg-api.creditas.io/b2b/simulations

Request Header

Para utilizar essa versão do simulador é necessário adaptar o header seguindo a informação abaixo.

HeaderValor
Acceptapplication/vnd.creditas.v2+json
Content-TypeAuthorization
AuthorizationBearer {{AUTHENTICATION_TOKEN}}

Request Params

Campo

Tipo

Obrigatório

Descrição

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).
Aceitamos veículos como garantia com até 15 anos.
Ex: 2016

loanTerms

integer

Sim

Número de parcelas em meses. Pode ser enviado um ou mais valores. Caso seja enviado mais de um valor eles devem ser separados por vírgula. Ex.: 24,60

Opções: 18, 24, 30, 36, 42, 48, 54, 60.

intendedCredit

double

Sim

Valor de empréstimo solicitado pelo cliente(O valor deve ser entre 5000 e 150000)
Ex: 40000.00

monthlyIncome

double

Sim

Renda mensal informada pelo cliente (O valor mínimo é 4000.00)
Ex: 10000.00

professionalStatus

string

Sim

Status profissional.
Opções: CLT, SELF_EMPLOYED, FREELANCER, BUSINESSMAN, CIVIL_SERVANT, RETIRED

productType

string

Sim

Tipo do Produto
Fixo: AUTO_REFI

uf

string

Sim

Tipo de UF(UFs não aceito para Auto: AC, AM, RR, PA, AP, TO, MA, PI, PB, RO)
Ex: SP, RJ

cpf

string

Sim

CPF do cliente (sem caracteres especiais)
Ex: 83714492089


Response

Campo

Tipo

Descrição

term

integer

Número de parcelas
Ex: 18, 24, 30, 36, 42, 48, 54, 60

installment

object

Dados das parcelas calculadas com o valor mínimo, máximo e total com relação ao número de parcelas.
Consulte o objeto do installment

interestRate

object

Dados da taxa de juros.
Consulte o objeto do interestRate

cet

object

Dados do custo efetivo total da simulação de empréstimo.
Consulte o objeto do cet

loanAmount

object

Dados do montante da simulação de empréstimo.
Consulte o objeto do loanAmount


Exemplo de Request e Response

'curl --location --request GET '{{url_base}}/simulations?zipCode=04620000&value=4000000000&manufacturingYear=2016&intendedCredit=10000.00&monthlyIncome=10000.00&score=800&professionalStatus=SELF_EMPLOYED&productType=AUTO_REFI&uf=SP&loanTerms=24,36&cpf=83714492089' \
--header 'Accept: application/vnd.creditas.v2+json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{your_access_token}}'
{
    "items": [
        {
            "term": 24,
            "installment": {
                "min": {
                    "initial": 531.92,
                    "final": 531.86,
                    "total": 12766.02
                },
                "max": {
                    "initial": 794.42,
                    "final": 794.35,
                    "total": 19066.00
                }
            },
            "interestRate": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.62,
                    "monthly": 0.05
                }
            },
            "cet": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.62,
                    "monthly": 0.05
                }
            },
            "loanAmount": {
                "min": {
                    "feeValue": 600.00,
                    "additionalCostsValue": 175.16,
                    "taxValue": 317.32,
                    "availableValue": 10000.00,
                    "total": 11092.47
                },
                "max": {
                    "feeValue": 600.00,
                    "additionalCostsValue": 175.16,
                    "taxValue": 301.83,
                    "availableValue": 10000.00,
                    "total": 11076.98
                }
            }
        },
        {
            "term": 36,
            "installment": {
                "min": {
                    "initial": 531.92,
                    "final": 531.86,
                    "total": 12766.02
                },
                "max": {
                    "initial": 794.42,
                    "final": 794.35,
                    "total": 19066.00
                }
            },
            "interestRate": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.62,
                    "monthly": 0.05
                }
            },
            "cet": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.62,
                    "monthly": 0.05
                }
            },
            "loanAmount": {
                "min": {
                    "feeValue": 600.00,
                    "additionalCostsValue": 175.16,
                    "taxValue": 317.32,
                    "availableValue": 10000.00,
                    "total": 11092.47
                },
                "max": {
                    "feeValue": 600.00,
                    "additionalCostsValue": 175.16,
                    "taxValue": 301.83,
                    "availableValue": 10000.00,
                    "total": 11076.98
                }
            }
        }
    ]
}


Possíveis Erros

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