Get started

     API Endpoint
 
         https://portal.embtelecoms.com/api/v1/
                 

The EMB TELECOMS API provides programmatic access to buy data, check balance, buy airtime, buy cable sub, etc.

To use this API, you need an API key. Please contact us at appsupport@embtelecoms.com to get your own API key.

get balance


 # Here is a curl example
 curl \
 -X GET https://portal.embtelecoms.com/api/v1/balance \
 -F 'api-token=your_api_key' \
 -F 'format=json' \
                 

To get balance you need to make a GET call to the following url :
https://portal.embtelecoms.com/api/v1/balance



 Result example :
 
 {
    status: 200,
    messag: "success",
    balance: 223900.0
 }
                 

QUERY PARAMETERS

Field Type Description
api-token String Your API key.
format String Enter the format "json" here.

buy airtime


 # Here is a curl example
 curl \
 -X GET https://portal.embtelecoms.com/api/v1/airtime \
 -F 'api-token=your_api_key' \
 -F 'format=json' \
 -F 'network=MTN777' \
 -F 'amount=100' \
 -F 'phone=08100000000'
                 

To buy airtime you need to make a GET call to the following url :
https://portal.embtelecoms.com/api/v1/airtime



 Result example :
 
 {
    status: 201,
    message: "success",
    details: "TransactionSuccessful"
 }
                 

QUERY PARAMETERS

Field Type Description
api-token String Your API key.
format String Enter the format "json" here.
network String The network of the number you will like to send the airtime to.
amount Integer The amount of airtime you are sending.
phone String The number you will like to send the airtime to.

buy data


 # Here is a curl example
 curl \
 -X GET https://portal.embtelecoms.com/api/v1/data \
 -F 'api-token=your_api_key' \
 -F 'format=json' \
 -F 'network=MTNCG' \
 -F 'amount=CG_05G' \
 -F 'phone=08100000000'
                 

To buy data you need to make a GET call to the following url :
https://portal.embtelecoms.com/api/v1/data



 Result example :
 
 {
    status: 201,
    message: "success",
    details: "TransactionSuccessful"
 }
                 

QUERY PARAMETERS

Field Type Description
api-token String Your API key.
format String Enter the format "json" here.
network String The network of the data.
amount String The amount of data you are sending.
phone String The number you will like to send the data to.

buy cable sub


 # Here is a curl example
 curl \
 -X GET https://portal.embtelecoms.com/api/v1/cable \
 -F 'api-token=your_api_key' \
 -F 'format=json' \
 -F 'service=gotv' \
 -F 'plan_code=CG_05G' \
 -F 'smart_no=00100000000' \
 -F 'customer_name=JOHNOKEKE' \
 -F 'customer_number=08100000000' \
 -F 'invoice=1234567' \
                 

To buy cable sub you need to make a GET call to the following url :
https://portal.embtelecoms.com/api/v1/cable



 Result example :
 
 {
    status: 201,
    message: "success",
    details: "TransactionSuccessful"
 }
                 

QUERY PARAMETERS

Field Type Description
api-token String Your API key.
format String Enter the format "json" here.
service String The Cable Provider you want to subscribe for.
plan_code String The subscibtion package you are buying.
smart_no Integer The smart card number.
invoice String InvoicefromcheckAPI.
customer_name String CustomernamefromcheckAPI.
customer_number String CustomernumberfromcheckAPI.

buy electricity


 # Here is a curl example
 curl \
 -X GET https://portal.embtelecoms.com/api/v1/electricity \
 -F 'api-token=your_api_key' \
 -F 'format=json' \
 -F 'disco= 1' \
 -F 'amount=1000' \
 -F 'meter_no=000100000000'
                 

To buy electricity you need to make a GET call to the following url :
https://portal.embtelecoms.com/api/v1/electricity



 Result example :
 
 {
   query:{
     offset: 0,
     limit: 50,
     house: [
       "Stark",
       "Bolton"
     ],
   }
 }
                 

QUERY PARAMETERS

Field Type Description
api-token String Your API key.
format String Enter the format "json" here.
disco String The Electricity provider you want to purchase from.
amount String The amount of electricity units worth you are buying.
meter_no String The meter number you are purchasing for.

Verify Cable Name


 # Here is a curl example
 curl \
 -X GET https://portal.embtelecoms.com/api/v1/check-cable-customer \
 -F 'api-token=your_api_key' \
 -F 'format=json' \
 -F 'service=gotv' \
 -F 'smart_no=00100000000'
                 

To verify cable name you need to make a GET call to the following url :
https://portal.embtelecoms.com/api/v1/check-cable-customer



 Result example :
 
 {
    customer_name: "OKEKEPETERSON",
    smart_no: 4613205690,
    status: "OPEN",
    customer_number: 275953782,
    invoice: 1,
    expire_on: "13-11-2019",
    service: "gotv"
 }
                 

QUERY PARAMETERS

Field Type Description
api-token String Your API key.
format String Enter the format "json" here.
smart_no String Your smart card number.
service String The Cable Provider you want to verify.

Errors

The Westeros API uses the following error codes:

Error Code Meaning
205 Transaction not Successful.
400 Bad Request Check Your Parameters.
403 Update your profile to proceed.
422 Insufficient Balance.