2. Sign in and tap the API button shown on the home screen as shown in the image to the left.

3. The enable API screen will load up and offer you a green button to enable API. Tap this button and we proceed to creating and enabling API services for your account.

Step 1 – Fill in your Information

• Name – This can be your brand or company name.
• Description – Please describe why you need the API and what you will be using it for.
• website – The URL to your website
• IPN URL – Whenever a transaction is confirmed, this is the url that will be posted to with transaction details. IPN – stands for Instant Payment Notification. You will have to provide us a callback (ipn) url to notify your system when payments are made.
• PIN – Please enter your easypay PIN to confirm enabling your API.

Using instant payment notification model, all your transactions should be marked as pending and only be marked as confirmed from this notification. It is also known as the callback url.

After you click save, your API will be enabled and live. You will be given a client Key and client Password that you will need for authenticating the API functions below.

This is the API clientId that you are given within app after you enable API. see above

password

action

provider

paybill

This method is called when a user wants to pay the actual bill in this case airtime.

POST URL: https://www.easypay.co.ug/api/

• action – This leave as ‘paybill’
• provider – This this the provider you are quering. In this case, it can be airtel, mtn, africell, smart, smile or utl.
• amount – The amount you wish to pay
• phone – This is the phone number where your token will be sent.
• reference – Your order reference. it will be returned in successful results and can be used for reconciliation later on.

Success Result

{
"details": {
"phone": "0787xxxxxx",
"amount": "500",
"reference": "12",
"easypayId": 566210,
"transferCode": "82936377",
"date": "2019-03-10 13:13:52"
},
"success": 1,
"data": "Your payment for MTN Airtime has been accepted. Tel: 078XXXXXX, Amount: UGX 500. EasypayID: TNV8543855 TransferCode: 82936377"
}

Failure Result

{
"success": 0,
"errormsg": "Insufficient balance"
}

paybillstatus

This method is called when a user wants to pay find out the current status of bill against the reference they provided above. It can be used for auto-reconciliation. In response take note of the status property. It tells you the status of order. Incase of ‘Success’ it also return order receipts.

POST URL: https://www.easypay.co.ug/api/

• action – This leave as ‘paybillstatus’
• provider –This this the provider you are quering. In this case, it can be airtel, mtn, africell, smart, smile or utl.
• reference – Your order reference.

Success Result

{
"success": 1,
"data": {
"status": "Success",
"data": {
"success": 1,
"data": {
"responseCode": "9000",
"rechargePIN": "Payment Successful : Success MTN TrxnId : 82936377",
"requestReference": "TNV8543855",
"transferCode": "82936377",
"transactionRef": "BOU|Web|3TNV8003|MTN|100319131336|00005758"
}
}
}
}}

Failure Result

{
"success": 0,
"errormsg": "Cannot find reference provided"
}

checkbalance

This method is called you want to know your current balance at easypay. You can use this method to notify you that your balance is running low. That way you can ensure you do not run out of float.

POST URL: https://www.easypay.co.ug/api/

Success Result

{
"success": 1,
"data": "14129.9",
"currencyCode": "UGX"
}

Failure Result

{
"success": 0,
"errormsg": "something went wrong"
}