Webhooks

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;

Rejecting webhook

• In a scenario where the transaction cannot be processed or you cannot give value, respond with HTTP codes below;

{
    "id": 226,
    "request_amount": 0.2,
    "request_currency": "USD",
    "account_amount": 737.9934,
    "account_currency": "UGX",
    "transaction_fee": 21.4018,
    "total_credit": 716.5916,
    "customer_charged": false,
    "provider_id": "mtn_ug",
    "merchant_reference": "76859aae-f148-48c5-9901-2e474cf19b71",
    "internal_reference": "DUSUPAY405GZM1G5JXGA71IK",
    "transaction_status": "COMPLETED",
    "transaction_type": "collection",
    "message": "Transaction Completed Successfully",
    "account_number": "256777111786 - Optional",
    "account_name": "- Optional",
    "institution_name": "MTN Mobile Money - Optional"
}

{
    "id": 226,
    "request_amount": 0.2,
    "request_currency": "USD",
    "account_amount": 737.9934,
    "account_currency": "UGX",
    "transaction_fee": 21.4018,
    "total_debit": 716.5916,
    "provider_id": "mtn_ug",
    "merchant_reference": "76859aae-f148-48c5-9901-2e474cf19b71",
    "internal_reference": "DUSUPAY405GZM1G5JXGA71IK",
    "transaction_status": "COMPLETED",
    "transaction_type": "payout",
    "message": "Transaction Completed Successfully",
    "account_number": "256777111786 - Optional",
    "account_name": "- Optional",
    "institution_name": "MTN Mobile Money - Optional"
}

{
    "id": 65205,
    "refund_amount": 1054,
    "refund_currency": "UGX",
    "transaction_fee": 0,
    "total_debit": 1054,
    "provider_id": "international_ugx",
    "collection_reference": "DUSUPAYXYXYXYXYXYXYXYXYX",
    "internal_reference": "RFD-DUSUPAYXYXYXYXYXYXYXYXYX-3486003",
    "transaction_type": "refund",
    "transaction_status": "COMPLETED",
    "account_number": "4860610032773134",
    "message": "Refund Processed Successfully"
}