Visão geral - Credicarro

A simulação calcula as condições de crédito para um cliente, um veículo e uma loja. A resposta traz uma opção para cada prazo elegível com os valores informados, cada uma com o seu id_simulacao. A opção escolhida pelo cliente vira a proposta.

Antes de simular

Cliente cadastrado

O cliente precisa estar cadastrado. No refinanciamento, o endereço é usado para obter a UF quando a placa não a informa.

Loja vinculada

O cnpjLoja precisa estar vinculado ao seu cadastro de parceiro e não pode ter contrato de intermediação.

Endpoints

Endpoint	Para quê
`GET /v2/proposal/simulation/range/financing`	Entrada mínima por prazo de financiamento.
`GET /v2/proposal/simulation/range/refinancing`	Valor mínimo e máximo por prazo de refinanciamento.
`POST /v2/proposal/simulation/financing`	Simular um financiamento.
`POST /v2/proposal/simulation/refinancing`	Simular um refinanciamento.
`GET /v1/proposal/simulation/{simulacaoId}`	Consultar uma simulação.
`GET /v1/proposal/simulation`	Listar as simulações do parceiro.

Financiamento x refinanciamento

Campo	Financiamento	Refinanciamento
`cpf`	✓	✓
`placa`	✓	✓
`cnpjLoja`	✓	✓
`valorVeiculo`	✓
`valorEntrada`	✓ (pode ser 0; precisa deixar ao menos 10% de `valorVeiculo` para financiar)
`uf`	✓
`isVeiculoZeroKm`	✓
`valorSolicitado`		✓ (dentro da faixa refinanciável)

Resposta

{
  "simulacoes": [
    {
      "id_simulacao": "123e4567-e89b-12d3-a456-426614174000",
      "valor_solicitado": 40000,
      "prazo": 36,
      "valor_parcela": 2042.42,
      "valor_tac": 1500,
      "valor_boleto": 3.5,
      "valor_seguro": 0,
      "valor_iof": 872,
      "percentual_iof": 1.92,
      "valor_credito_total": 42722,
      "valor_divida_total": 73527.12,
      "percentual_cet_mensal": 3.75,
      "percentual_cet_anual": 55.52,
      "percentual_juros_mensal": 3.29,
      "percentual_juros_anual": 47.47
    }
  ]
}

Campo	Descrição
`id_simulacao`	Identificador da opção. Envie em `simulacaoId` ao criar a proposta.
`prazo`	Quantidade de parcelas mensais. Só voltam os prazos elegíveis: no financiamento, aqueles cuja entrada mínima foi atingida; no refinanciamento, aqueles em cuja faixa o valor cabe.
`valor_solicitado`	Valor pedido. No financiamento, `valorVeiculo` − `valorEntrada`.
`valor_parcela`	Valor de cada parcela.
`valor_tac`	Tarifa de cadastro.
`valor_boleto`	Valor do boleto.
`valor_seguro`	Valor do seguro, quando houver.
`valor_iof` / `percentual_iof`	IOF da operação.
`valor_credito_total`	Valor solicitado somado aos custos financiados (TAC, IOF e registro do contrato).
`valor_divida_total`	Soma de todas as parcelas (`prazo` × `valor_parcela`).
`percentual_juros_mensal` / `percentual_juros_anual`	Taxa de juros.
`percentual_cet_mensal` / `percentual_cet_anual`	Custo Efetivo Total.
`valor_retencao_diaria_aproximado`	Valor aproximado de retenção diária. Omitido quando não se aplica.

O CET reúne juros, tarifas e impostos. É o número certo para o cliente comparar opções. Veja Entenda os custos.

Use um id_simulacao retornado pelas simulações da integração. Uma simulação feita fora de uma loja retorna Simulation.Access.NotFromStore na criação da proposta.