1.2. Conceitos¶

Especificação — em construção

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

Produto: EP e CDC¶

A API cobre dois produtos de crédito, que compartilham a mesma jornada e o mesmo contrato:

Produto	Sigla	Descrição	Diferença
Crédito Pessoal	EP	Empréstimo pessoal ao tomador	O desembolso vai sempre para a conta do tomador
Crédito Direto ao Consumidor	CDC	Crédito para aquisição de bem ou serviço	Pode ser configurado para desembolsar na conta do parceiro originador (lojista)

Todo o resto — cadastro do tomador, simulação, documentos, análise de crédito, assinatura, parcelas — é idêntico. Você não escolhe o produto na chamada: ele vem da esteira.

Esteira¶

A esteira é a configuração comercial e operacional de um produto para o seu grupo econômico. Ela define:

o produto (EP ou CDC);
as faixas de valor (mínimo e máximo) e de prazo (em meses);
as faixas de taxa (mínima, máxima e padrão);
os custos default da operação (taxa de cadastro, seguro, outras despesas, outros serviços);
qual tipo de pessoa é aceito (física, jurídica ou ambos);
se a operação passa por análise de crédito;
para quem vai o desembolso (só no CDC);
se a cobrança é gerada pela plataforma ou por você;
a plataforma e a modalidade de assinatura.

O idEsteira é o identificador que aparece na rota dos serviços que iniciam uma operação. Consulte 3.1. Esteiras e 3.2. Parâmetros da Esteira.

A esteira é a autoridade sobre a política. Não replique as faixas no seu código: leia-as antes de simular. Elas mudam sem aviso de versão da API.

Simulação, Proposta e Contrato¶

Três coisas distintas, frequentemente confundidas:

Conceito	O que é	Persiste?
Simulação avulsa	Um cálculo. Você informa valor, prazo e taxa e recebe o fluxo de parcelas, CET e IOF	Não. Nada é criado
Proposta	A operação em construção: tomador, dados de desembolso, documentos, análise de crédito	Sim. Tem `idProposta` e um status que evolui
Contrato	A operação formalizada, com CCB emitida e parcelas geradas	Sim. Tem `idContrato` e parcelas cobráveis

A proposta vira contrato quando é registrada na bancarizadora e a formalização se conclui. Até lá, ela pode ser alterada, resimulada ou cancelada.

Use a simulação avulsa para negociar com o cliente — é síncrona, barata de iterar e não deixa rastro. Só crie a proposta quando o cliente aceitar as condições.

Tomador¶

A pessoa — física ou jurídica — que recebe o crédito e assume a dívida. Em pessoa jurídica, os sócios e representantes legais também são cadastrados, porque são eles que assinam.

Um mesmo tomador pode ter várias propostas. Ao consultá-lo por documento (4.1) você reaproveita o cadastro e os documentos ainda válidos, em vez de pedir tudo de novo ao cliente.

Situação de renda¶

Como o tomador pessoa física comprova renda. Determina quais campos do vínculo empregatício são obrigatórios:

Situação	Significado
Com vínculo empregatício	Assalariado. Empregador, admissão, cargo e salário são exigidos
Sem vínculo empregatício	Autônomo, informal ou profissional liberal
Sem renda	Não declara renda própria

Ver 4.2. Pessoa Física e Situação de Renda.

Parceiro originador¶

No CDC, o lojista que originou a venda. Quando a esteira está configurada com desembolso ao parceiro, é para a conta bancária dele que o valor da operação é liberado — e não para a conta do tomador.

Nesse caso a proposta precisa registrar qual parceiro está envolvido, informado em 6.3. Desembolso ao Parceiro.

O parceiro originador não assina a CCB. Quem assina é o tomador (ou os representantes legais, se pessoa jurídica).

Bancarizadora¶

A instituição financeira que registra a operação, emite a CCB e conduz a formalização. Ela é a origem do cálculo: a simulação, o motor de crédito e o registro da proposta são executados por ela, com o VeTrust orquestrando.

Duas consequências práticas para você:

As operações que dependem da bancarizadora são assíncronas — ver 1.3. Operações Assíncronas.
Mensagens de erro de política de crédito (prazo inválido para o produto, valor acima do limite) vêm dela e são repassadas no campo erros da proposta.

Motor de crédito¶

A análise automatizada que decide se a proposta é aprovada. É executada pela bancarizadora e o resultado volta de forma assíncrona.

Resultado	Significado	Permite enviar a proposta?
Aprovado	Operação liberada	Sim
Aprovado com alteração	Liberada com condições ajustadas	Sim
Pendente	Em análise ou requer intervenção manual	Não
Recusado	Reprovada	Não
Cancelado	Análise cancelada	Não

Se a esteira exige análise (enviarParaAnaliseCredito), o envio da proposta é recusado enquanto o resultado não for aprovado. Ver 6.7. Análise de Crédito e 6.8. Envio da Proposta.

Documentos¶

A lista de documentos exigidos é definida pela plataforma, não por você. Ela é montada quando a proposta é criada, e varia por tipo de pessoa e papel (tomador, sócio, representante legal).

Você consulta a lista, envia cada arquivo e acompanha o que falta. Documentos do mesmo tomador ainda dentro da validade são reaproveitados entre propostas — então uma proposta nova pode já nascer com documentos marcados como enviados. Ver 6.6. Documentos.

Avalista e Garantia¶

Duas coisas diferentes, ambas opcionais:

Conceito	O que é	Onde
Avalista	Pessoa física que garante a dívida	6.4. Avalistas
Garantia	Bem ou direito dado em garantia (veículo, imóvel, estoque)	6.5. Garantias

Nenhum dos dois assina a CCB no fluxo atual.

CCB¶

Cédula de Crédito Bancário — o instrumento que formaliza a dívida. É emitida pela bancarizadora quando a proposta é registrada, assinada pelo tomador e fica arquivada na plataforma.

O PDF só está disponível depois que a operação é finalizada. Ver 6.9. Assinantes e CCB.

Parcela, cobrança e liquidação¶

Conceito	O que é
Parcela	Uma prestação do contrato, com vencimento, valor, amortização, juros e saldo devedor
Cobrança	O instrumento de recebimento (boleto, PIX) emitido para uma parcela
Liquidação	O registro de que a parcela foi paga

A distinção importa: quem emite a cobrança depende da esteira. Se a cobrança é externa, você emite pelos seus meios e apenas informa a liquidação à plataforma. Se é interna, você pode pedir que a plataforma gere o boleto ou o PIX.

Em qualquer configuração, informar a liquidação é sempre possível — é o que mantém a carteira correta. Ver 7.3. Liquidar Parcela e 7.4. Cobrança.

Tabela de amortização e fluxo¶

Conceito	Situação nesta API
PRICE	Único sistema de amortização suportado. Parcelas de valor constante
SAC	Não disponível em EP/CDC
Fluxo regular	Parcelas espaçadas mensalmente
Fluxo irregular	Parcelas espaçadas por um intervalo uniforme em dias que você define
Carência	Não disponível

Ver 5.2. Fluxo Regular e Irregular.