Referência de status e webhooks CLT
Esta página resume os eventos e status usados no acompanhamento do fluxo de Crédito Privado CLT.
Webhook de consulta/margem
Cadastre a URL de retorno na página Webhooks usando o endpoint de webhook de consulta/margem:
POST /user/webhook/private-consignment/consult
Eventos de validação documentados:
|
Evento |
Quando ocorre |
Como tratar |
|---|---|---|
|
|
Validação da URL cadastrada |
Responder HTTP |
|
|
Webhook registrado com sucesso |
Registrar que a URL está pronta |
Status de consentimento e margem
A documentação atual apresenta os seguintes status:
|
Status |
Uso no fluxo |
|---|---|
|
|
Aguardando aceite do cliente |
|
|
Consentimento aprovado |
|
|
Aguardando consulta |
|
|
Aguardando análise de crédito |
|
|
Consulta concluída com sucesso |
|
|
Consulta encerrada com falha |
|
|
Consulta rejeitada |
Quando o status for SUCCESS, a margem retornada pode ser usada para seguir o fluxo de simulação.
Webhook de operação
Cadastre a URL de retorno usando:
POST /user/webhook/private-consignment/operation
Eventos documentados:
|
Evento |
Quando ocorre |
Como tratar |
|---|---|---|
|
|
Operação criada |
Armazenar o ID e iniciar acompanhamento |
|
|
Operação atualizada |
Consultar detalhe quando precisar confirmar o estado completo |
Status de operação
A listagem de operações CLT permite acompanhar status como:
-
formalization -
analysis -
manual_analysis -
awaiting_call -
processing -
paid -
canceled -
pending -
refunded
Use esses status para atualizar a jornada do usuário e acionar rotinas de pendência, cancelamento ou conciliação.
