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 imóvel em garantia


Request HTTP GET

Tipo da Requisição

URL

Exemplo

GET

{{url_base}}/simulations

https://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.

Header

Valor

Accept

application/vnd.creditas.v2+json

Content-Type

Authorization

Authorization

Bearer {{AUTHENTICATION_TOKEN}}


Request Params

Campo

Tipo

Obrigatório

Descrição

value

double

Sim

Valor do imóvel usado como garantia(O valor deve ser superior à 150000)
Ex: 150000.00

loanTerms

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: 60, 90, 120, 150, 180, 210, 240.

intendedCredit

double

Sim

Valor de empréstimo solicitado pelo cliente
O valor do empréstimo deve ser entre 50000 e 15000000
Ex: 50000.00

monthlyIncome

double

Sim

Renda mensal informada pelo cliente
O valor do empréstimo deve ser maior ou igual a 3000
Ex: 3000.00

professionalStatus

string

Sim

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

productType

string

Sim

Tipo do Produto
Fixo: HOME_REFI

uf

string

Sim

Tipo de UF
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: 60, 90, 120, 150, 180, 210, 240.

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 valor referente à 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=210000.00&intendedCredit=15000000.00&monthlyIncome=10000.00&score=500&professionalStatus=CLT&productType=HOME_REFI&uf=SP&loanTerms=60&loanTerms=240&cpf=83714492089' \
--header 'Accept: application/vnd.creditas.v2+json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{your_access_token}}'
{
    "items": [
        {
            "term": 60,
            "installment": {
                "min": {
                    "initial": 3000.85,
                    "final": 2875.70,
                    "total": 174399.11
                },
                "max": {
                    "initial": 3119.41,
                    "final": 2993.75,
                    "total": 181512.93
                }
            },
            "interestRate": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.15,
                    "monthly": 0.02
                }
            },
            "cet": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.15,
                    "monthly": 0.02
                }
            },
            "loanAmount": {
                "min": {
                    "feeValue": 3500.00,
                    "additionalCostsValue": 3168.18,
                    "taxValue": 4124.86,
                    "availableValue": 115206.72,
                    "total": 125999.75
                },
                "max": {
                    "feeValue": 3500.00,
                    "additionalCostsValue": 3167.83,
                    "taxValue": 4138.66,
                    "availableValue": 115193.42,
                    "total": 125999.90
                }
            }
        },
        {
            "term": 240,
            "installment": {
                "min": {
                    "initial": 3000.85,
                    "final": 2875.70,
                    "total": 174399.11
                },
                "max": {
                    "initial": 3119.41,
                    "final": 2993.75,
                    "total": 181512.93
                }
            },
            "interestRate": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.15,
                    "monthly": 0.02
                }
            },
            "cet": {
                "min": {
                    "yearly": 0.13,
                    "monthly": 0.01
                },
                "max": {
                    "yearly": 0.15,
                    "monthly": 0.02
                }
            },
            "loanAmount": {
                "min": {
                    "feeValue": 3500.00,
                    "additionalCostsValue": 3168.18,
                    "taxValue": 4124.86,
                    "availableValue": 115206.72,
                    "total": 125999.75
                },
                "max": {
                    "feeValue": 3500.00,
                    "additionalCostsValue": 3167.83,
                    "taxValue": 4138.66,
                    "availableValue": 115193.42,
                    "total": 125999.90
                }
            }
        }
    ]
}

Possíveis Erros

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