Webhooks

Welcome
Payments
Payouts
Postman

Webhooks

The webhooks/callback url provide real-time notifications after successfully consuming the API. These events could range from a successful transaction to a failed transaction.

🌐
The webhook/callback url should be valid for your system to get a response. If your server or webhook is not reachable, we try a maximum of 4 times, every 120 seconds to reach the webhook.

Some examples of events that you could be notified of include:

  • When you receive a payment transaction.
  • When you performed a successful payout transaction.
  • When you performed a failed transaction.

example webhook response on successful payment:

{
    "amount":"60",
    "currency":"KES",
    "message":"Payout Successful",
    "payout_fee":"0.3",
    "reference_id":"12345678901345644",
    "status":"Success",
    "transaction_id":"5083312",
    "wallet_balance":"10000.55"
}

Some examples of things you could do with our webhooks include :

  • Update your database when the status of a pending payment is successful.
  • Notify a customer when payment is successful or unsuccessful etc.

example webhook response on failed payment:

{
    "amount":"60",
    "currency":"KES",
    "message":"Payout Failed",
    "reference_id":"12345678901345644",
    "status":"Failed",
    "transaction_id":"5083312",
    "wallet_balance":"10000.55"
}