Monnify supports webhooks for various events like card transactions, settlement and disbursement completion, and refunds. To implement webhooks on your Monnify integration, it is recommended to follow certain best practices such as validating transaction hash, whitelisting Monnify's IP address, checking for duplicate notifications, and processing complex logic after acknowledging receipt of the notification with a 200 HTTP status code. These practices ensure the integrity and security of the payload, prevent unauthorized requests, avoid redundant processing, and prevent time-out issues.

Monnify Webhook Events and Structure

As part of the Monnify integration, notifications are automatically sent to your system when certain actions are completed. These notifications trigger corresponding activities on your system, and you can specify URLs for certain activities on your integration. The notifications include an event-type property that indicates what action has taken place, as well as event data containing details of the event.

Supported notification event types on Monnify include

1. Successful Collection (for successful payments made on your account)
   Sample Event Notification Structure

   Copy
2. Successful Disbursement (for disbursement transactions with a successful definite status)
   Sample Event Notification Structure

   Copy
3. Failed Disbursement (for failed disbursement transactions)
   Sample Event Notification Structure

   Copy
4. Reversed Disbursement (for reversed disbursement transactions)
   Sample Event Notification Structure

   Copy
5. Successful Refund (for successfully processed initiated refunds)
   Sample Event Notification Structure

   Copy
6. Failed Refund (for failed initiated refunds)
   Sample Event Notification Structure

   Copy
7. Settlement Completion (for successfully processed settlements to your bank account or wallet)
   Sample Event Notification Structure

   Copy
8. Completed Oflline Payments
   Sample Event Notification Structure

   Copy
9. Notification for Rejected Payments
   Sample Event Notification Structure

   Copy
10. Mandate Status Change
    Sample Event Notification Structure

    Copy
11. Wallet Activity Notification
    Sample Event Notification Structure

    Copy
12. Low Balance Alert
    Sample Event Notification Structure

    Copy

Transaction Hash Computation

As a security measure, Monnify computes a hash of the request body whenever it sends a notification and includes it in the request header with the key 'monnify-signature'. To ensure the notification is valid and authorized, you should also calculate the hash and compare it to the one sent by Monnify before accepting or acting on the notification.

To calculate the hash, you can use a SHA-512 encoding of your client secret key and the object of the request body. The formula is: SHA-512(client secret key + object of request body).

Javascript, PHP, Java Sample Codes:

Sample Client Key: 91MUDL9N6U3BQRXBQ2PJ9M0PW4J22M1Y

Sample Request:

Hashed Value:

f04fb635e04d71648bd3cc7999003da6861483342c856d05ddfa9b2dafacb873b0de1d0f8f67405d0010b4348b721c49fa171d317972618debba6b638aedcd3c

Computing Hash in Nodejs

Computing Hash in PHP

Computing Hash in Java