Skip to main content
POST
Criar uma nova simulação de financiamento
Calcula as condições de financiamento e retorna uma opção para cada prazo elegível, cada uma com o seu id_simulacao. Exemplo:
O cliente precisa estar cadastrado e o cnpjLoja vinculado ao seu cadastro de parceiro.
valorEntrada pode ser 0 e precisa deixar ao menos 10% de valorVeiculo para financiar. Só voltam os prazos cuja entrada mínima foi atingida — consulte a faixa financiável. Se nenhum prazo servir, a API retorna 422 com Proposal.DownPaymentInvalid.
Veja como ler cada campo da resposta na referência de simulação.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Headers

Idempotency-Key
string

Chave opcional (1 a 200 caracteres) para repetir a requisição com segurança. Reenviar a mesma chave com o mesmo conteúdo devolve o resultado original sem duplicar o registro; reutilizá-la com outro conteúdo retorna erro.

Maximum string length: 200
Example:

"6f1c9a2e-3b7d-4e2a-9c51-0d8f3a7b2e10"

Body

application/json
cpf
string
required

CPF do cliente, com ou sem pontuação (11 dígitos). Os dígitos verificadores são validados.

Minimum string length: 11
Example:

"12345678909"

placa
string
required

Placa do veículo no padrão antigo (ABC-1234) ou Mercosul (ABC1D23)

Example:

"ABC1D23"

valorVeiculo
number<double>
required

Valor total do veículo, em reais. Deve ser maior que zero.

Example:

45000

valorEntrada
number<double>
required

Valor de entrada, em reais. Informe zero quando não houver entrada; deve ser menor que o valor do veículo.

Example:

5000

uf
string
required

UF do registro do veículo, com 2 letras (ex. SP, RJ, MG).

Example:

"SP"

isVeiculoZeroKm
boolean
required

Indica se o veículo é zero quilômetro. true para novo, false para usado.

Example:

false

cnpjLoja
string
required

CNPJ da loja de integração vinculada ao parceiro, formatado ou apenas números.

Example:

"11.222.333/0001-81"

Response

Simulação criada com sucesso

simulacoes
object[]

Uma simulação por prazo disponível