Listen to Credo events
A webhook URL is an endpoint on your server where you can receive notifications about such events. When an event occurs, we'll make a POST request to that endpoint, with a JSON body containing the details about the event, including the type of event and the data associated with it.
Webhooks allow Credo to notify your application when certain events occur, eliminating the need for the application to poll the API for updates. We notify you via your webhook endpoint for events such as a successful payment or a failed transaction.
Important : To receive webhook notifications, you must first register the Callback URL where the webhook should be sent, token to be utilized for authentication and the triggering event on the Settings module of your Credo dashboard.. When the event occurs, the API will send an HTTP request containing the notification to the specified URL.
We currently send hookdeck notifications for 3 events.
| Event Name | Description | Status Code |
|---|---|---|
| transaction.failed | Customer payment declined-possible issues with payment method or insufficient funds. | 7 |
| transaction.successful | The payment made by the customer was successfully processed and accepted by the payment system. | 0 |
| transaction.settlement.success | Merchants settlement from a transaction have been made. | 5 |
Important: Each webhook sent from credo is authenticated using a X - Credo-Signature which is passed in the header of the request. The X - Credo-Signature is calculated by doing a SHA512 (Token + Business code)