Webhooks

Search…
Webhooks
We notify your web applications whenever transaction statuses change through web-hooks. We expect you to set your web-hook URL under your merchant account API settings by now.
NOTES
1.All collection and payout transaction callbacks will be sent to the URL set as the webhook url under your merchant account API settings.
2.A POST request with json data will be sent to your webhook url
3.We require that you provide a secure webhook url. Therefore only, https URLs can be set or notified.
4.You will need to acknowledge receipt of the callback by responding with the HTTP status code 200. Otherwise, we might keep calling your webhook URL at an interval of 10 minutes for 3 days.
5.To ensure that the callback data sent to your webhook URL comes from our servers, you need to set a callback hash under the Api Settings.
6.We will include a header called, webhook-hash in the request sent to the callback URL. e.g "webhook-hash: ***"

You should check to make sure the, webhook-hash we sent matches what was set under your merchant account before giving value to the customer.
7.Read more about webhook-hash here​
​
Responding to webhooks
We will stop calling you back if your callback URL responds with “HTTP status codes” below;
Code
Description
200
- OK
400
- Bad Request
401
- Unauthorised
403
- Forbidden
422
- Unprocessable entity.
Rejecting webhook
In a scenario where the transaction cannot be processed or you cannot give value, respond with HTTP codes below;
Code
Description
400
- Bad Request.
- e.g when there’s a missing parameter
422
- Unprocessable entity.
- e.g when the request is fine but you cannot complete it because the amount does not match what you expected.
KEYNOTE
Always verify the, amount to make sure it matches what is meant to be paid before giving value to the customer.
Sample Collection IPN Data
Sample Payout IPN Data
Sample Refund IPN Data
1
{
2
 "id": 226,
3
 "request_amount": 0.2,
4
 "request_currency": "USD",
5
 "account_amount": 737.9934,
6
 "account_currency": "UGX",
7
 "transaction_fee": 21.4018,
8
 "total_credit": 716.5916,
9
 "customer_charged": false,
10
 "provider_id": "mtn_ug",
11
 "merchant_reference": "76859aae-f148-48c5-9901-2e474cf19b71",
12
 "internal_reference": "DUSUPAY405GZM1G5JXGA71IK",
13
 "transaction_status": "COMPLETED",
14
 "transaction_type": "collection",
15
 "message": "Transaction Completed Successfully",
16
 "account_number": "256777111786 - Optional",
17
 "account_name": "- Optional",
18
 "institution_name": "MTN Mobile Money - Optional"
19
}
Copied!
1
{
2
 "id": 226,
3
 "request_amount": 0.2,
4
 "request_currency": "USD",
5
 "account_amount": 737.9934,
6
 "account_currency": "UGX",
7
 "transaction_fee": 21.4018,
8
 "total_debit": 716.5916,
9
 "provider_id": "mtn_ug",
10
 "merchant_reference": "76859aae-f148-48c5-9901-2e474cf19b71",
11
 "internal_reference": "DUSUPAY405GZM1G5JXGA71IK",
12
 "transaction_status": "COMPLETED",
13
 "transaction_type": "payout",
14
 "message": "Transaction Completed Successfully",
15
 "account_number": "256777111786 - Optional",
16
 "account_name": "- Optional",
17
 "institution_name": "MTN Mobile Money - Optional"
18
}
Copied!
1
{
2
 "id": 65205,
3
 "refund_amount": 1054,
4
 "refund_currency": "UGX",
5
 "transaction_fee": 0,
6
 "total_debit": 1054,
7
 "provider_id": "international_ugx",
8
 "collection_reference": "DUSUPAYXYXYXYXYXYXYXYXYX",
9
 "internal_reference": "RFD-DUSUPAYXYXYXYXYXYXYXYXYX-3486003",
10
 "transaction_type": "refund",
11
 "transaction_status": "COMPLETED",
12
 "account_number": "4860610032773134",
13
 "message": "Refund Processed Successfully"
14
}
Copied!
Extra Payout Parameters
Signature Verification
Last modified 10mo ago
Copy link
Contents
NOTES
Responding to webhooks
Rejecting webhook