Skip to main content

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 TypeStatusDocumentação
debtsignature_finishedEmissão — Webhooks
debtdisbursedEmissão — Webhooks
debtcanceledEmissão — Webhooks
debtsettledEmissão — Webhooks
debtcanceled_permanentlyEmissão — Webhooks
installment.status_change—Emissão — Webhooks
debtcanceled (estorno)Estorno — Webhooks
transaction_reversal.transaction_reversal_status_changepaidEstorno — Webhooks
laas.devolution.refund_receiptrefundedEstorno — Webhooks
renegotiation.proposalpaidRenegociação — Webhooks
renegotiation.batch_proposalpaidRenegociação — Webhooks
renegotiation.batch_proposalrejectedRenegociação — Webhooks

Consultando Eventos para Reenvio​

ENDPOINT
/notification/events
MÉTODO
GET

Query Parameters​

ParâmetroTipoDescrição
event_typestringTipo do evento (ex: debt_disbursed)
callback_statusstringStatus do callback (ex: failed, sent)
origin_keyuuidChave única do recurso de origem
start_datetimestringData/hora inicial (formato YYYY-MM-DDTHH:mm:ssZ, UTC)
end_datetimestringData/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}/retry
MÉTODO
PATCH

Path Parameters​

ParâmetroTipoDescrição
event_keyuuidChave do evento (obtida na listagem)
callback_keyuuidChave 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.