API Documentation

 

API allows you to easily integrate all services available on the platform on your mobile or web application.

 

User Authentication

This section contains the requirement for our API integration.

 

Requirements

 

1. A Reseller Account

Before you can integrate our API into Your Website or App, You must have a reseller account with us.
All you have to do is to create an Account then Upgrade to a "Reseller".
Click Here To Upgrade Your Account.

 

2. Authentication

The API uses only API Key for Authentication.

Please use the following details for authentication

API Key: Your Gateway API Key

 Your API Key is: 
You Can Generate New APIkey Here: Create API Key

 

VTU Airtime API Integration

This section contains your RESTful API for Airtime VTU API integration.

 

Purchase products

Airtime VTU services can be purchased with the endpoint below:

Base URL: https://billsalert.com.ng/api/airtime

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng.
network R String Network as specified. These includes, mtn, airtel, glo, etisalat
phone R Number The phone number to receive the airtime
amount R Number The amount you wish to recharge
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/airtime?apikey=1234&network=mtn&phone=0803992222&amount=100&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"message":"TRANSACTION SUCCESSFUL","ref":"884666332234","amount":"100",
"transaction_date":"2020-04-17 07:04:19"
}}

SME DATA API Integration

This section contains your RESTful API for Data API integration.

 

Purchase products

SME DATA services can be purchased with the endpoint below:

Base URL: https://billsalert.com.ng/api/sme-data

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng.
service R String service as specified. These includes, 01, 02, 03, 04
MobileNumber R Number The phone number to receive the Data
DataPlan R String The Data Plan you wish to subscribe such as 500MB, 1GB, etc.
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/sme-data?apikey=1234&service=01&MobileNumber=0803992222&DataPlan=1000&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"message":"TRANSACTION SUCCESSFUL","ref":"884666332234","amount":"230","DataPlan":"1000","transaction_date":"2020-04-17 07:04:19"
}}


DataPlan Codes

 

DATAPLAN DESCRIPTION VALUE
500 SME DATA 500MB -
1000 SME DATA 1GB -
2000 SME DATA 2GB -
3000 SME DATA 3GB -
5000 SME DATA 5GB -
10000 SME DATA 10GB -

Note: The DataPlan codes are the same for MTN, GLO, AIRTEL and 9MOBILE, Only the Service codes are Different


Service Codes

MTN: 01
GLO: 02
9MOBILE: 03
AIRTEL: 04


CORPORATE DATA GIFTING API Integration

This section contains your RESTful API for Corporate Gifting API integration.

 

Purchase products

SME DATA services can be purchased with the endpoint below:

Base URL: https://billsalert.com.ng/api/sme-data/gifting.php

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng.
service R String service as specified. These includes, 05
MobileNumber R Number The phone number to receive the Data
DataPlan R String The Data Plan you wish to subscribe such as 500MB, 1GB, etc.
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/sme-data/gifting.php?apikey=1234&service=01&MobileNumber=0803992222&DataPlan=1000&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"message":"TRANSACTION SUCCESSFUL","ref":"884666332234","amount":"230","DataPlan":"1000","transaction_date":"2020-04-17 07:04:19"
}}


DataPlan Codes

 

DATAPLAN DESCRIPTION VALUE SERVICE
500 CORPORATE GIFTING 500MB 05
1000 CORPORATE GIFTING 1GB 05
2000 CORPORATE GIFTING 2GB 05
3000 CORPORATE GIFTING 3GB 05
5000 CORPORATE GIFTING 5GB 05
10000 CORPORATE GIFTING 10GB 05




Electricity Payment API Integration

This section contains your RESTful API for Electricity Payment API integration.

 

VALIDATE METER NUMBER

You can validate meter number with the following endpoint:

Base URL: https://billsalert.com.ng/api/merchant-verify/disco.php

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-electric

meterNo R Number The meter number to load the electricity token
metertype R String This is the meter type. Example: prepaid or postpaid

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/merchant-verify/disco.php?apikey=1234&service=ibadan-electric&meterNo=1022101199113&metertype=prepaid ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{
    "code": 101,
    "description": {
        "Customer": "PAUL BECKY",
        "Address": "ELEME - PORTHARCOURT",
        "MeterNumber": "1022101199113"
    }
}

 

Generate Token

This endpoint allows you to generate electricity token using meter number.

Base URL: https://billsalert.com.ng/api/electric

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, ikeja-electric, eko-electric, portharcourt-electric, jos-electric, kano-electric, ibadan-electric
meterNo R Number The meter number to load the electricity token
metertype R String This is the meter type. Example: prepaid or postpaid
amount R Number The amount of electricity token you want to buy
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE


$host ="https://billsalert.com.ng/api/electric?apikey=1234&service=ikeja-electric&meterNo=100221233&metertype=prepaid&amount=1000&ref=8284666332234";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"Status":"TRANSACTION SUCCESSFUL",
"Token":"40364652026905256691",
"Units":"500 kWh",
"meterNumber":"100221233",
"product_name":"Ikeja Electric Payment - PHCN"
	
    }
}

TV Payment API Integration

This section contains your RESTful API for TV Payment API integration.

 

 

VALIDATE SMARTCARD/IUC NUMBER

You can validate smartcard/IUC number with the following endpoint:

Base URL: https://billsalert.com.ng/api/merchant-verify/

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, dstv, gotv, startimes
smartNo R Number The smartcard or IUC number to make the subscription on

 

SAMPLE CODE


$host ="https://billsalert.com.ng/api/merchant-verify/?apikey=1234&service=gotv&smartNo=10022123";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"Customer":"PAUL BECKY",
"Due_Date":"2019-07-23T00:00:00",
"Status":"Open"
	}
}

 

Recharge Decoder

This endpoint allows you to recharge GOTV/DSTV/Startimes decoder using it’s smartcard/IUC number.

Base URL: https://billsalert.com.ng/api/paytv

Service: as specified in the fields below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM
service R String Service as specified. These includes, dstv, gotv, startimes
smartNo R Number The smartcard or IUC number to make the subscription on
vcode R String This is the Subscription Plam. Example: startimes_nova, strong>gotv_jinja, dstv_padi, etc
amount O Number The amount of the Plan you want to subscribe and it is optional.
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE


$host ="https://billsalert.com.ng/api/paytv?apikey=1234&service=gotv&smartNo=100221233&vcode=gotv_jinja&amount=3900&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"response_description":"TRANSACTION SUCCESSFUL",
"ref":"884666332234","amount":"3900",
"transaction_date":"2020-04-17 07:04:19"
}}

RECHARGE CARD PRINTING API Integration

This section contains your RESTful API for Recharge Card API integration.

 

Purchase products

The Recharge Card services can be purchased with the endpoint below:

Base URL: https://billsalert.com.ng/api/airtime-pin

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng.
network R String The Network provider as specified. These includes, mtn, airtel, glo, etisalat
quantity R Number The quantity of Recharge card Pins you want to generate.
amount R String The denomination of the recharge Card such as 100, 200, etc.
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/airtime-pin?apikey=1234&network=mtn&amount=100&quantity=1&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"message":"TRANSACTION SUCCESSFUL","ref":"884666332234","pins":"5436654266526","transaction_date":"2020-04-17 07:04:19"
}}


DATA CARD PRINTING API Integration

This section contains your RESTful API for Data Card API integration.

 

Purchase products

The Recharge Card services can be purchased with the endpoint below:

Base URL: https://billsalert.com.ng/api/data-card

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng.
network R String The Network provider as specified. These includes, mtn, airtel, glo, etisalat
DataPlan R String The Data Plan you wish to subscribe such as 500MB, 1GB, etc..
quantity R Number The quantity of Recharge card Pins you want to generate.
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/data-card?apikey=1234&network=mtn&DataPlan=1000&quantity=1&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"message":"TRANSACTION SUCCESSFUL","ref":"884666332234","pins":"5436654266526","transaction_date":"2020-04-17 07:04:19"
}}


DataPlan Codes

 

DATAPLAN DESCRIPTION VALUE AVAILABILITY
500 DATA CARD 500MB MTN, GLO, AIRTEL & 9MOBILE
1000 DATA CARD 1GB MTN, GLO, AIRTEL & 9MOBILE
1500 DATA CARD 1.5GB MTN ONLY

Note: The DataPlan codes are the same for MTN, GLO, AIRTEL and 9MOBILE, Only the Network codes are Different


Network Codes

MTN: mtn
GLO: glo
9MOBILE: airtel
AIRTEL: etisalat


RESULT CHECKER API Integration

This section contains your RESTful API for Result Checker API integration.

 

Purchase products

The Recharge Card services can be purchased with the endpoint below:

Base URL: https://billsalert.com.ng/api/exam-pin

Network: as specified in the parameters below;

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng.
service R String The Service provider as specified. These includes, waec, neco, nabteb, jamb
product_code R String This is the variation code for either Result Checking PIN or Registration PIN.
quantity R Number The quantity of Scratch Card Pins you want to generate.
ref R String This is a unique reference with which you can use to execute and query the transaction.

 

SAMPLE CODE

$host="https://billsalert.com.ng/api/exam-pin?apikey=1234&service=waec&product_code=1&quantity=1&ref=8284666332234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE

{"code":101,
"description":{"message":"TRANSACTION SUCCESSFUL","ref":"884666332234","pins":"5436654266526","transaction_date":"2020-04-17 07:04:19"
}}


Service and Product Codes

 

DESCRIPTION service product_code
WAEC Result Checking PIN waec 1
WAEC GCE Registration PIN waec 2
WAEC Verification PIN waec 3
NECO Result Checking Token neco 1
NECO GCE Registration PIN neco 2
NABTEB Result Checking PIN nabteb 1
NABTEB GCE Registration PIN nabteb 2
JAMB UTME Registration PIN jamb 1
JAMB Direct Entry Registration PIN jamb 2



Wallet Balance API

This section contains your RESTful API to get wallet balance.

 

 

GET WALLET BALANCE

This endpoint allows you to get wallet balance .

Base URL: https://billsalert.com.ng/api/balance

Service: as specified in the fields below;

 

PARAMETER Required/Optional TYPE DESCRIPTION
apikey R String The reseller gateway API key created at billsalert.com.ng . Example kDe5dbBw3AeyxnxFCCJA9c9Agl2kxxt8pCB174AC472r38BCM

 

SAMPLE CODE


$host ="https://billsalert.com.ng/api/balance?apikey=1234 ";
//Initialize cURL.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $host);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);

//Close the cURL handle.
curl_close($ch);

$response = json_decode($data);

 

EXPECTED RESPONSE


{"code":101,

"description":{"BALANCE":"45000.00",
	}

}

Account Status
Current Balance

₦0.00

Total Contacts

0