Notificações - Crédito Clean
Resumo
O sistema de notificações permite consultar e reenviar webhooks de eventos do ciclo de vida da operação. Utilize estes endpoints para diagnosticar falhas de entrega e disparar retentativas.
Atenção!
Os webhooks não devem ser mapeados de forma estrita. Novos campos podem ser adicionados ao payload sem aviso prévio.
Webhooks do Crédito Clean
Os webhooks gerados pelo Crédito Clean são distribuídos pelas páginas de cada fluxo:
| Webhook Type | Status | Documentação |
|---|---|---|
debt | signature_finished | Emissão — Webhooks |
debt | disbursed | Emissão — Webhooks |
debt | canceled | Emissão — Webhooks |
debt | settled | Emissão — Webhooks |
debt | canceled_permanently | Emissão — Webhooks |
installment.status_change | — | Emissão — Webhooks |
debt | canceled (estorno) | Estorno — Webhooks |
transaction_reversal.transaction_reversal_status_change | paid | Estorno — Webhooks |
laas.devolution.refund_receipt | refunded | Estorno — Webhooks |
renegotiation.proposal | paid | Renegociação — Webhooks |
renegotiation.batch_proposal | paid | Renegociação — Webhooks |
renegotiation.batch_proposal | rejected | Renegociação — Webhooks |
Consultando Eventos para Reenvio
ENDPOINT
/notification/eventsMÉTODO
GETQuery Parameters
| Parâmetro | Tipo | Descrição |
|---|---|---|
| event_type | string | Tipo do evento (ex: debt_disbursed) |
| callback_status | string | Status do callback (ex: failed, sent) |
| origin_key | uuid | Chave única do recurso de origem |
| start_datetime | string | Data/hora inicial (formato YYYY-MM-DDTHH:mm:ssZ, UTC) |
| end_datetime | string | Data/hora final (formato YYYY-MM-DDTHH:mm:ssZ, UTC) |
Limite de janela
A janela entre start_datetime e end_datetime deve ser de no máximo 14 dias.
Response Body (200)
{
"data": [
{
"event_key": "<UUID>",
"event_type": "debt_disbursed",
"status": "processed",
"origin_enumerator": "account",
"origin_key": "<UUID>",
"callbacks": [
{
"callback_key": "<UUID>",
"callback_status": "failed"
}
]
}
],
"pagination": {
"current_page": 1,
"rows_per_page": 25
}
}
Reenviando um Callback
ENDPOINT
/notification/event/{event_key}/callback/{callback_key}/retryMÉTODO
PATCHPath Parameters
| Parâmetro | Tipo | Descrição |
|---|---|---|
| event_key | uuid | Chave do evento (obtida na listagem) |
| callback_key | uuid | Chave do callback (obtida na listagem) |
Retorna 204 No Content em caso de sucesso.
Documentação completa
Instruções detalhadas e exemplos de troubleshooting estão em Reenvio de Notificações.