Hooks

Introduzimos nos passos da esteira o recurso denominado hooks, que pode ser compreendido como um conjunto de ações extras que ocorrem quando um passo da esteira é executado. Os hooks suportados são:

• onStart (ao iniciar)
• onFailure (em casos de falha)

As ações associadas a cada hook são pré-definidas e incluem um campo de descrição que permite comentar o motivo por trás de uma determinada ação. Quando uma ação é executada no empréstimo usando os hooks, a descrição correspondente será registrada no empréstimo, como exemplificado abaixo:

• onFailure:
  • Ação: Cancelar o empréstimo
  • Descrição: O empréstimo foi cancelado devido a uma falha na validação da assinatura

Os hooks suportados são:

onStart

• Ação: Atualizar o empréstimo para pendente (mark_loan_as_pending)
• Descrição (opcional)

onFailure

• Ação: Cancelar o empréstimo (cancel_loan)

• Descrição (opcional)

• Ação: Anular o empréstimo (void_loan)

• Descrição (opcional)

atenção

Atenção: Recomendamos o uso que resulte ou limite apenas uma ação por hook. A esteira é flexível a ponto de permitir a configuração de mais de um hook e/ou mais de uma ação por hook. Porém, o uso demasiado pode resultar em operações confusas e erros.

atenção

Atenção: Recomenda-se enfaticamente que o formato antigo seja considerado obsoleto, com um aviso claro sobre a remoção iminente do suporte ao ENUM no dia 24 de Junho de 2024. Abaixo segue o formato antigo:

onStart

• Atualizar o empréstimo para pendente (mark_loan_as_pending)

onFailure

• Cancelar o empréstimo (cancel_loan)
• Anular o empréstimo (void_loan)

Alguns exemplos de caso de uso

• Ao iniciar o desembolso, deve atualizar o empréstimo para pendente.
• Em caso de falha na validação da assinaturas, deve cancelar o empréstimo.
• Em caso de falha no etapa de desembolso, deve anular o empréstimo.