3.2. Parâmetros da Esteira¶

Especificação — em construção

Os serviços descritos nesta área ainda não estão disponíveis.

🔗 Endpoint¶

Método	URL
	`/credito/esteiras/{idEsteira}/parametros`

🧾 Descrição¶

Devolve a política vigente da esteira: faixas de valor, prazo e taxa, custos default, tipo de pessoa aceito, se há análise de crédito, para quem vai o desembolso e como a cobrança é gerada.

É o serviço que evita tentativa e erro. Consulte-o antes de simular e valide a entrada do seu usuário contra estes limites — a API recusa operação fora da política, mas é melhor o seu formulário recusar primeiro.

🔹 Path Parameter¶

Parâmetro	Tipo	Descrição
idEsteira	integer	Identificador da esteira, obtido em 3.1

🧪 Exemplo de cURL¶

curl -X GET "https://api.vehub.com.br/credito/esteiras/12/parametros" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Responses¶

✅ 200 OK¶

{
  "idEsteira": 12,
  "nome": "Esteira Padrão",
  "produto": "ep",
  "operacao": {
    "valorMinimo": 1000.00,
    "valorMaximo": 50000.00,
    "prazoMinimoMeses": 6,
    "prazoMaximoMeses": 48,
    "jurosMinimo": 1.50,
    "jurosMaximo": 3.50,
    "jurosPadrao": 1.99,
    "taxaCadastro": 0.00,
    "valorSeguro": 120.00,
    "valorOutrasDespesas": 0.00,
    "valorOutrosServicos": 30.00,
    "tipoPessoaPermitida": 1,
    "enviarParaAnaliseCredito": true,
    "dadosSimplificadosAnaliseCredito": false,
    "sugerirNovaAnaliseComDados": false,
    "cobrancaExterna": false,
    "destinatarioDesembolso": null
  },
  "assinatura": {
    "idPlataformaAssinatura": 3,
    "modalidadeAssinatura": 3
  }
}

🧾 Detalhamento dos Campos — `operacao`¶

Campo	Tipo	Descrição
valorMinimo / valorMaximo	number	Faixa de valor financiado aceita
prazoMinimoMeses / prazoMaximoMeses	integer	Faixa de prazo aceita
jurosMinimo / jurosMaximo	number	Faixa de taxa mensal que você pode informar
jurosPadrao	number	Taxa sugerida quando você não tem uma negociada
taxaCadastro	number	TAC aplicada à operação
valorSeguro	number	Custo default de seguro. Pode ser sobrescrito na simulação
valorOutrasDespesas	number	Custo default. Pode ser sobrescrito na simulação
valorOutrosServicos	number	Custo default. Pode ser sobrescrito na simulação
tipoPessoaPermitida	integer	`0` ambos, `1` somente PF, `2` somente PJ
enviarParaAnaliseCredito	boolean	Quando `true`, a proposta precisa passar pelo motor e ser aprovada antes do envio
dadosSimplificadosAnaliseCredito	boolean	Quando `true`, a análise ocorre antes do restante da ficha. Altera a ordem da jornada
sugerirNovaAnaliseComDados	boolean	Quando `true`, uma recusa antecipada admite uma segunda análise com a ficha completa
cobrancaExterna	boolean	Quando `true`, você emite a cobrança; a plataforma não gera boleto nem PIX
destinatarioDesembolso	integer / null	`1` Emitente, `2` Parceiro. Sempre `null` em EP

🧾 Detalhamento dos Campos — `assinatura`¶

Campo	Tipo	Descrição
idPlataformaAssinatura	integer	Plataforma que conduz a formalização — ver 2.1
modalidadeAssinatura	integer / null	Modalidade exigida de todos os assinantes

Os quatro parâmetros que mudam o seu código¶

A maior parte dos campos é validação. Estes quatro alteram a sequência de chamadas:

Parâmetro	Se ...	Então ...
`destinatarioDesembolso`	`= 2` (Parceiro)	não chame dados bancários do tomador; chame 6.3. Desembolso ao Parceiro. As duas etapas são mutuamente exclusivas
`enviarParaAnaliseCredito`	`= false`	a proposta vai direto para o envio, sem passar pelo motor
`dadosSimplificadosAnaliseCredito`	`= true`	submeta ao motor logo após a simulação, com os dados básicos do tomador, e só complete a ficha depois da aprovação
`cobrancaExterna`	`= true`	não tente gerar cobrança pela API — ela responde `409`. Use apenas 7.3. Liquidar Parcela

Em vez de ramificar o seu código nesses quatro campos, você pode simplesmente seguir proximaEtapa e pendencias da proposta — ver 6.10. Consultar, Listar e Pendências.

⚠️ Observações¶

Os parâmetros são configuráveis pelo time de negócio e mudam sem versionamento da API. Consulte-os na inicialização da integração e recarregue periodicamente; não os replique em constantes.
O bloco de configuração de integração da esteira (credenciais, política de crédito, identificadores da bancarizadora) não é exposto nesta API.