Webhook
All
collection
anddisbursement
transactions notification updates will be sent asPOST
to the URL set as thewebhook url
under your merchant account API tokens.Only,
https
URLs can be set or notified.You will need to acknowledge receipt of the notification by responding with the HTTP status code
200
. Otherwise, we might keep calling your webhook URL at an interval of 10 minutes for 2 days.To ensure that the notification data sent to your
webhook URL
comes from our servers, set awebhook hash
under theApi Tokens
.We will include a header called,
webhook-hash
in the request sent to thewebhook URL
. e.g webhook-hash: WH-***"
Responding to webhooks
We will stop sending notification to your webhook URL if it responds with the following โHTTP status codesโ below;
Code
Description
200
- OK
400
- Bad Request
401
- Unauthorised
403
- Forbidden
422
- Unprocessable entity.
Rejecting webhook notification
In a scenario where the transaction cannot be processed 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 service to the customer.
{
"id": "383737927636356536773773",
"request_amount": 0.4,
"request_currency": "USD",
"account_amount": 1462.53,
"account_currency": "UGX",
"transaction_fee": 42.23,
"total_credit": 1420.30,
"customer_charged": false,
"provider": "mtn_ug",
"merchant_reference": "88736jh-kkas87-mmn736-9n873ms-6636h",
"kitegateway_reference": "PL-KMSSD-30000",
"transaction_status": "COMPLETED",
"transaction_type": "collection",
"message": "Transaction Completed Successfully",
"account_number": "Optional - 256777111222",
"account_name": "Optional",
"institution_name": "Optional - MTN Mobile Money Uganda"
}
Last updated