Solicitação de proposta de crédito
Como solicitar uma proposta de crédito
Após simular seu empréstimo algumas vezes, o consumidor enfim encontrou as condições que satisfazem suas necessidades e agora quer uma proposta. Este é o momento em que o correspondente solicita a geração da proposta.
No corpo da requisição ao endpoint de geração de proposta devem ser informados os mesmos parâmetros fornecidos na simulação cujas condições satisfizeram o consumidor e o motivaram a solicitar a proposta. É necessário fornecer ainda o identificador do tomador e do beneficiário do empréstimo - cujas contas já devem estar criadas e aprovadas pelo compliance, o identificador da instituição responsável por financiar a operação, bem como do produto de crédito que o tomador deseja contratar. Abaixo são detalhados os parâmetros esperados no corpo da chamada ao endpoint de solicitação de proposta de empréstimo.
| Campo | Requerido | Tipo | Descrição |
|---|---|---|---|
| product | sim | Texto | Identificador do produto de crédito |
| related_accounts | sim | Array de objetos do tipo Account | Lista de contas associadas à proposta |
| conditions | sim | Objeto do tipo Conditions | Condições da proposta |
Account
| Campo | Requerido | Tipo | Descrição |
|---|---|---|---|
| id | sim | Texto | Identificador único da conta |
| relationship | sim | Enum Role [borrower, beneficiary, lender] | Papel do dono da conta |
Condition
| Campo | Requerido | Tipo | Descrição |
|---|---|---|---|
| amount | sim | Decimal com duas casas de precisão | Valor do empréstimo |
| loan_release_date | sim | Texto | Data de liberação do empréstimo no formato yyyy-MM-dd |
| first_installment_due_date | sim | Texto | Data de vencimento da primeira parcela do empréstimo no formato yyyy-MM-dd |
| number_of_installments | sim | Número | Número de parcelas do empréstimo |
| fees | sim | Array de objetos do tipo Fee | Taxas que incidem na operação. |
Fee
| Campo | Requerido | Tipo | Descrição |
|---|---|---|---|
| type | sim | Enum FeeType [escrow, iof, fintech, financial, rate_month] | Tipo da taxa |
| amount | não | Decimal com duas casas de precisão | Valor (percentual) da taxa |
| embedded | não | Booleano | Define se o valor da taxa deve ser embutido nas parcelas |
Na resposta da requisição ao endpoint é retornado o identificador da proposta na plataforma (ver exemplo abaixo), o qual deve ser utilizado para assinar a proposta e consultar seus detalhes.
Exemplo de resposta
{
"request_id": "0a49471d-1cff-4805-829b-e2409969c111"
}
Dica
Uma alternativa ao uso do identificador retornado na resposta é fornecer o seu próprio. O identificador externo da proposta deve ser enviado no cabeçalho da requisição de criação e pode ser usado em lugar do identificador interno para assinar e consultar os detalhes da proposta. Mais detalhes podem ser obtidos na documentação da API.
Após a criação da proposta, é verificado se as condições da operação e os dados do tomador estão em conformidade com as regras do produto de crédito e da instituição responsável por financiar a operação. Caso o resultado da análise seja positivo, a proposta é atualizada para o estado Compliant (200), a CCB(1) é gerada e um token para assinatura da proposta é gerado e enviado diretamente ao tomador via SMS. No entanto, caso o resultado da análise seja negativo (não conforme), a proposta é cancelada. Em ambos os casos o correspondente é notificado.
(1) A Cédula de Crédito Bancário (CCB) é um título de crédito emitido por pessoa física ou jurídica em favor de uma instituição financeira ou de entidade que se assemelhe. Esse título representa a promessa de pagamento em dinheiro decorrente de uma operação de crédito.
Importante!
O token - um código de seis caracteres alfanuméricos - expira 24 horas após sua geração.
O mesmo identificador retornado na resposta da requisição é referenciado nas notificações enviadas pela plataforma para informar sobre uma mudança de estado da proposta. A estrutura da notificação é detalhada abaixo.
| Campo | Requerido | Tipo | Descrição |
|---|---|---|---|
| event | sim | Enum ResourceType [proposal, ccb, lot, account] | Tipo do recurso ao qual o evento se refere |
| request_id | sim | Texto | Identificador da proposta na plataforma |
| proposal_token | sim | Texto | Identificador externo da proposta |
| status | sim | Enum ProposalStatus [100, 200, 300, 400, 500, 600, 700, 000] | Situação do recurso no momento do envio da notificação |
| message | sim | Texto | Descrição da situação da proposta |
| errors | não | Array de objetos do tipo Error | Detalhes dos erros que impediram que a proposta evoluísse como esperado |
Error
| Campo | Requerido | Tipo | Descrição |
|---|---|---|---|
| code | sim | Número | Código do erro |
| message | sim | Texto | Descrição do erro |
Máquina de estados da proposta
A proposta de empréstimo pode assumir diferentes estados durante seu ciclo de vida, representado no diagrama abaixo.
O propósito / significado de cada estado é descrito na tabela abaixo.
| Estado | Descrição |
|---|---|
| Created (100) | A proposta foi criada |
| Compliant (200) | A proposta está em conformidade com as regras / restrições do produto e da instituição responsável por financiar a operação. |
| Signed (300) | A proposta e o contrato de crédito foram assinados |
| Guarantee Blocked (310) | A garantia foi bloqueada junto ao provedor externo. |
| Payment Sent (400) | O pagamento do empréstimo está em processamento |
| Payment Confirmed (500) | O pagamento do empréstimo foi liquidado |
| Endorsed (600) | O contrato de crédito foi cedido à instituição responsável por financiar a operação |
| Closed (700) | O contrato foi encerrado e baixado da carteira de crédito da Parati |
| Cancelled (000) | A proposta e o contrato foram cancelados |
Updated over 3 years ago