A simulação é a avaliação inicial de uma proposta de financiamento em um ou mais bancos. Ela é composta pelas informações do cliente (lead), do vendedor, do valor dos ativos, do veículo e das condições desejadas, sendo estas (as condições) compostas pela entrada, quantidade de parcelas e valor financiado.
Se desejar, você pode visitar o passo a passo de como criar uma simulação na nossa documentação. O texto descreve o processo necessário para criar uma simulação.
Uma simulação associada à loja informada pode ser criada a partir da descrição nesse manual.
Nas requisições das simulações, é necessário adicionar o header Store-Id com o ID da loja utilizada.
Campo de nome atípico no corpo da requisição É importante observar que existe 1 campo da simulação que precisa ser informado com nome diferente no corpo da requisição. O campo é:
lead(Lead) No corpo da requisição, essa informação é enviada no seguinte campo:retrieve_lead
Simular em banco(s) específico(s) É possível chamar condição de uma simulação ou a simulação completa em um ou mais bancos. Para uma condição, basta informar o banco desejado no campobank_febraban_codeda condição (conditions.bank_febraban_code). Com isso, essa condição será simulada apenas no banco especificado.
Exemplo:
"conditions": [
{
"bank_febraban_code": "M22",
"installments": 12,
"down_payment": 510000
}
]Para realizar a simulação completa em um conjunto de bancos específicos, basta informar os bancos desejados no campo bank_febraban_code da simulação (simulation.bank_febraban_code). Com isso, essa simulação será realizada apenas nos bancos especificados.
Exemplo:
"simulation": {
"bank_febraban_codes": [
"M22",
"623",
"422",
"033",
"655",
"341",
"342",
"fontecred",
"moneyplus"
],
"process_bank_suggested_conditions": true,
"seller_cpf": "00000000000",
"retrieve_lead": {
"cpf_cnpj": "000.000.000-00"
},
"assets_value": 10000000,
"documentation_value": 100000,
"accessory_value": 100000,
"insurance_value": 100000,
"commercial": false,
"vehicle": {...},
"conditions": [...]
}Valores válidos no campo bank_febraban_code
bank_febraban_codeO campo bank_febraban_code deve conter um String com um ou mais Código dos bancos.
| Nickname | Código | Nome |
|---|---|---|
| Honda | "M22" | Banco Honda S.A. |
| Pan | "623" | Banco Pan |
| BV | "655" | Banco Votorantim S.A. |
| Bradesco | "394" | Banco Bradesco Financiamentos S.A. |
| Itaú | "341" | Itaú Unibanco S.A. |
| Creditas | "342" | Creditas Sociedade de Crédito Direto S.A. |
| Fontecred | "fontecred" | HB capital Sociedade de Crédito Direto S/A |
| Santander | "033" | Banco Santander (Brasil) S.A. |
| AutoBanking | "moneyplus" | AutoBanking |
| Safra | "422" | Banco Safra S.A. |
| C6 Bank | "336" | Banco C6 S.A. |
| Kuna Capital | "kuna" | Kuna Capital S.A.P.I. |
| Volkswagen | "M14" | Banco Volkswagen S.A. |
| Yamaha | "YHA" | Banco Yamaha Motor S.A. |
| Omni | "OMNI" | Omni Banco S.A |
Inclusão do seguro de proteção financeira na condição Para informar sobre a inclusão do seguro de proteção financeira na condição simulada (quando disponível), basta informar o campoinclude_financial_protection_insurancedentro da condição.
Exemplo:
"conditions": [
{
"include_financial_protection_insurance": true,
"installments": 12,
"down_payment": 510000
}
]Exemplo de corpo da requisição
{
"simulation": {
"process_bank_suggested_conditions": true,
"process_credere_suggested_conditions": false,
"seller_cpf": "00000000000",
"retrieve_lead": {
"cpf_cnpj": "000.000.000-00"
},
"bank_febraban_codes": [
"M22",
"623",
"422",
"033",
"655",
"341",
"342",
"fontecred",
"moneyplus"
],
"documentation_value": 100000,
"accessory_value": 100000,
"insurance_value": 100000,
"commercial": false,
"vehicle": {
"credere_vehicle_model_id": "0000",
"licensing_uf": "SP",
"licensing_city": "São Paulo",
"manufacture_year": 2022,
"model_year": 2022,
"asset_value": 10000000,
"zero_km": true
},
"conditions": [
{
"installments": 12,
"down_payment": 1000000
},
{
"installments": 24,
"down_payment": 1000000,
"bank_febraban_code": "M22"
},
{
"installments": 36,
"down_payment": 1000000,
"products_options": {
"include_capitalization_bond": true,
"include_asset_insurance": true
},
"include_financial_protection_insurance": true,
"process_credere_suggested_conditions": false
},
{
"installments": 48,
"down_payment": 1000000,
"max_return": "0",
"min_return": "5",
"return_preference": "max",
"quota_preference": "min"
}
]
}
}