Yaka Umeme API Uganda

Yaka Umeme API Uganda

Yaka Umeme API Uganda – EasyPay provides an easy Restful API that makes the process of paying your electricity bills a breeze.

API stands  for application programming interface. It can be interfaced by developers of all kinds of apps or systems to pay the electricity bills within Uganda.

Open Yaka Umeme Bill Payment Requirements

  1. Easypay account; First things first, you need to register for an easypay account. registration is free and painless. Register for an easypay account. Once you have registered and signed in, you will have to enable your API from within the app, so as you can get your credentials in real time.  The process is explained in detail below.
  2. The API is very simple and live so there is no sandbox environment. This helps you get integrated in a matter of minutes,test and get the feel of the API. The Gotcha.  By default all api accounts are limited to bill payments worth 10USD/month for the purpose of testing. To remove this limitation, you will have to contact us with your company details (KYC) and fill in the API application form we provide.

 

Enable Yaka/Umeme Bill Payments API within Easypay Wallet

Enable Mobile Money API for Airtel and MTN Uganda 1. Go to https://www.easypay.co.ug/app/ or download app and create an account.

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.

 

Open Mobile Money API

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 in format eg https://www.example.com
  • IPN URL – Incase you plan on using mobile money or visa api, this will be the url on your server we notify of confirmed transactions. For bill payments you can leave it as your website url.
  • PIN – Please enter your easypay PIN to confirm enabling your API.

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.

 

Easypay Bill API Endpoint

URL – This is the url you will call to access the API. It is also known as the api entry point or end-point. https://www.easypay.co.ug/api/

Anatomy of Request

The API expects a POST request with a JSON encoded string of request. Every call to the API must have at least the format below. Some methods require extra fields depending on the call.

Payload

{
"username": "clientId",
"password": "clientSecret",
"action":"paybill",
"provider":"umeme",
"phone":"078....",
"amount":"1000",
"account":"0424....."
}

username

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

password

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

action

This is the API method being called. In this case it will always be paybill

provider

This is the service provider in this case its umeme

Anatomy of Response – Yaka Umeme API Uganda

A success response comes in the following JSON format . You have to test the success field to either 1 for success or 0 for failed.

Successful Response

{
"success": 1,
"data": string,
"details":object
}

success This is an integer describing response. 1 for success, 0 for failed transaction
data Human friendly formatted string containing transaction details.
details Object containing transaction details like receipt number, date, energy token etc

Failed Response

{
"success": 0,
"errormsg": "error message here describing failure"
}

Yaka Umeme API Uganda – Process Flow

  1. Request account number – This process involves asking the user to provide their yaka / umemepostpaid account number
  2. Validate Umeme Customer – This process checks with Umeme system if the provided account is a valid account. If successful it returns account type(prepaid/postpaid), customer name, any outstanding amounts etc. Using api you can use the paybilladvice method to return these details.
  3. Pay Bill – This process does the actual bill payment.

Yaka Umeme API Uganda – API methods

paybilladvice

This method is called when a user wants to check and validate the users provided account number.

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

Payload
{
"username": "Your clientId",
"password": "Your Secret",
"action":"paybilladvice",
"provider":"umeme",
"account":"042xxxx",
"amount":"500"
}
  • action – This leave as ‘paybilladvice’
  • provider – This this the provider you are quering. In this case, leave as umeme.
  • account – yaka (prepaid) or umeme (postpaid) account number
  • amount – When you specify this, we tell you the charge it will incur on easypay and check whether you have enough balance to pay it

Success Result

{
"success": 1,
"data": {
"outstanding": "0",
"type": "PREPAID",
"CustomerId": "042...",
"CustomerName": "Wabiga Ma.."
},
"charge": "200"
}

Failure Result

{
"success": 0,
"errormsg": "INVALID CUSTOMER REFERENCE"
}

paybill

This method is called when a user wants to pay the actual bill in this case yaka or umeme postpaid.

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

Payload
{
"username": "Your clientId",
"password": "Your Secret",
"action": "paybill",
"provider": "umeme",
"phone": "0787....",
"amount": "1000",
"account": "0424....",
"reference":"your order id"
}
  • action – This leave as ‘paybill’
  • provider – This this the provider you are quering. In this case, leave as umeme.
  • account – yaka (prepaid) or umeme (postpaid) account number
  • 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

{
"success": 1,
"details": {
"phone": "0787.....",
"account": "0424...",
"amount": "1000",
"easypayId": "5345351",
"units":"1.2",
"transferCode": "0424xxx-UMEME834561",
"energyToken": "6642 1234 4567 1234 1247",
"type": "PREPAID",
"reference":"Your order ref",
"date": "2018-10-27 13:10:28"
},
"data": "Your payment of Yaka has been accepted. Customer Ian Kantanga Account: 0424... Tel: 0787... Amount: UGX 1,000 Charge: UGX 95 etc"
}

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/

Payload
{
"username": "Your clientId",
"password": "Your Secret",
"action": "paybillstatus",
"provider": "umeme",
"reference":"your order id"
}
  • action – This leave as ‘paybillstatus’
  • provider – This this the provider you are quering. In this case, leave as umeme.
  • reference – Your order reference.

Success Result

{
"success": 1,
"data": {
"status": "Success",
"data": {
"data": "837761XX",
"yakaReceipt": "0424XXX-UMEME8463157",
"units": "2.3",
"charge": 330,
"success": 1,
"energyToken": "1344038169664616XXXX"
}
}
}

Failure Result

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

Other methods worth looking into;

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/

Payload
{
"username": "Your clientId",
"password": "Your Secret",
"action": "checkbalance"
}

Success Result

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

Failure Result

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

Yaka Umeme API Charges

The listing below is the standard Umeme payment charges. If you have sufficient volume then they can be modified on a case by case scenario.

minimum Amount (UGX) maximum Amount (UGX) Charge (UGX)
500 2500 200
2501 5000 200
5001 15000 800
15001 30000 1280
30001 45000 1600
45001 60000 2120
60001 125000 2800
125001 250000 3160
250001 500000 4040
500001 1000000 8560
1000000 2000000 16400
2000000 5000000 32000

Was this article helpful?

Related Articles

Leave A Comment?

Enter Captcha Here : *

Reload Image