Eventos

O exemplo abaixo ilustra a jornada (caminho feliz) de uma proposta ponta a ponta na esteira da Creditas:

Evento Recebido	Desdobramento
-	A proposta é criada e automaticamente está na etapa inicial `PRE_QUALIFICATION`
PREQUALIFIED	Andamento da proposta na esteira:(`PRE_QUALIFICATION` → `PROCESSING`)
PROCESSED	Andamento da proposta na esteira: (`PROCESSING` → `LOAN_PROPOSAL_ANALYSIS`)
CREDIT_ANALYSED	Andamento da proposta na esteira: (`LOAN_PROPOSAL_ANALYSIS` → `DOCUMENTS`)
DOCUMENTS_REVIEWED	Andamento da proposta na esteira: (`DOCUMENTS` → `CONTRACT`)
PAID	O recurso foi liberado na conta do cliente: (`CONTRACT` → `LOAN_PAYMENT`)

No caso de haver rejeição da proposta em alguma etapa (ex: rejeição na etapa LOAN_PROPOSAL_ANALYSIS) a jornada ficaria da seguinte maneira:

Evento Recebido	Desdobramento
-	A proposta é criada e automaticamente está na etapa inicial `PRE_QUALIFICATION`
PREQUALIFIED	Andamento da proposta na esteira:(`PRE_QUALIFICATION` → `PROCESSING`)
PROCESSED	Andamento da proposta na esteira: (`PROCESSING` → `LOAN_PROPOSAL_ANALYSIS`)
REJECTED	A proposta foi reprovada na etapa `LOAN_PROPOSAL_ANALYSIS`

Para saber mais sobre a esteira do produto, consulte a página de Fluxo de Automóvel em Garantia

🚧
Ambiente de Staging
Para conseguir testar ambos os cenários foi criada uma regra em ambiente de staging, onde:

Propostas com CPF começando com 2 terão a oferta automaticamente negada.
Exemplo: 2XXXXXXXXXX

Propostas com CPF começando com 7 terão a oferta automaticamente aprovada.
Exemplo: 7XXXXXXXXXX

Propostas sem o campo pricingDetail não serão processadas

Certifique-se de seguir essas regras no ambiente de testes (staging) para validar corretamente a integração.

PREQUALIFIED

Proposta pré-qualificada

Este evento é disparado uma única vez, após a realização de algumas validações iniciais do cliente e do carro, para pré-qualificar a proposta

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "PREQUALIFIED"
}

REJECTED

Proposta rejeitada

O evento REJECTED pode ser enviado em qualquer momento da esteira e indica que a proposta foi rejeitada na etapa atual.

Indepentende da etapa o título do evento se mantém o mesmo REJECTED e o campo (data → rejectionReason) detalha o motivo da rejeição, podendo ser qualquer um listado em motivos de recusa

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "REJECTED",
  "data": {
    "rejectionReason": "AGE_RESTRICTION"
  }
}

PROCESSED

Proposta processada

Este evento é disparado uma única vez, após a Creditas coletar mais informações necessárias da ficha para a análise de crédito

{
	"id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
	"name": "PROCESSED"
}

CREDIT_ANALYSED

Proposta com análise de crédito finalizada

Este evento é disparado uma única vez, após a análise que considera o perfil de crédito do cliente + condições de empréstimo desejadas. O resultado das condições comerciais do empréstimo pode variar após a vistoria ou se houver troca do carro, uma vez que o valor do carro poderá ser alterado - este caso será notificado em outro evento.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "CREDIT_ANALYSED",
  "data": {
    "approvedAt": "2022-08-19",
    "application": {
      "installment": {
        "value": {
          "currency": "BRL",
          "amount": 647.68
        },
        "maturity": 12
      },
      "approvedCredit": {
        "currency": "BRL",
        "amount": 5000.0
      },
      "netValues": {
        "currency": "BRL",
        "amount": 7772.16
      },
      "iof": {
        "currency": "BRL",
        "amount": 139.58
      },
      "registrationFee": {
        "currency": "BRL",
        "amount": 600.0
      },
      "cet": {
        "monthlyPercentage": 6.28,
        "yearlyPercentage": 0.0
      },
      "interestRate": {
        "monthlyPercentage": 3.65,
        "yearlyPercentage": 53.76
      }
    }
  }
}

DOCUMENTS_REVIEWED

Proposta com análise de documentos finalizada

Este evento é disparado uma única vez, após a análise dos documentos do cliente e da vistoria do veículo. A vistoria é feita por uma empresa terceira e, geralmente, ocorre digitalmente.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "DOCUMENTS_REVIEWED"
}

PAID

Proposta paga

Este evento é disparado uma única vez, após a liberação do recurso na conta do cliente

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "PAID",
  "data": {
    "loan": {
      "installment": {
        "value": {
          "currency": "BRL",
          "amount": 414.05
        },
        "maturity": 12
      },
      "paidValue": {
        "currency": "BRL",
        "amount": 5000.0
      },
      "netValues": {
        "currency": "BRL",
        "amount": 4968.5996
      },
      "iof": {
        "currency": "BRL",
        "amount": 469.74
      },
      "registrationFee": {
        "currency": "BRL",
        "amount": 600.0
      },
      "cet": {
        "monthlyPercentage": 1.74
      },
      "interestRate": {
        "monthlyPercentage": 3.65
      }
    }
  }
}

CREDIT_UPDATED

Proposta com análise de crédito atualizada

Ao longo da esteira pode ser que as condições de crédito escolhida pelo cliente se alterem. Este evento tem o intuito de notificar esse comportamento, sendo disparado sempre que houver uma reanálise de crédito e condições do cliente.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "CREDIT_UPDATED",
  "data": {
    "approvedAt": "2022-08-21",
    "application": {
      "installment": {
        "value": {
          "currency": "BRL",
          "amount": 900.68
        },
        "maturity": 12
      },
      "approvedCredit": {
        "currency": "BRL",
        "amount": 15000.0
      },
      "netValues": {
        "currency": "BRL",
        "amount": 8772.16
      },
      "iof": {
        "currency": "BRL",
        "amount": 139.58
      },
      "registrationFee": {
        "currency": "BRL",
        "amount": 600.0
      },
      "cet": {
        "monthlyPercentage": 6.28,
        "yearlyPercentage": 0.0
      },
      "interestRate": {
        "monthlyPercentage": 3.65,
        "yearlyPercentage": 53.76
      }
    }
  }
}

INSPECTION_STARTED

Proposta com inspeção iniciada

Este evento é disparado após o inicio dos procedimentos de inspeção de veículos.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "INSPECTION_STARTED"
}

INSPECTION_FINALIZED

Proposta com inspeção finalizada

Este evento é disparado após fim dos procedimentos de inspeção de veículos.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "INSPECTION_FINALIZED"
}

INSPECTION_PERFORMED

Proposta com inspeção realizada

Este evento é disparado logo após a realização inspeção de veículos.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "INSPECTION_PERFORMED"
}

🚧Ambiente de Staging