Checking Account Balance

In order to check user account balance, user may request a HTTP GET from the following URL:

https://api.onfonmedia.co.ke/v1/sms/Balance?ApiKey={ApiKey}&ClientId={ClientId}

HTTP request parameters :

Parameter Name	Description	Type
ApiKey	Used for authentication purpose and pass this parameter in URL encoded format.	String
ClientId	Used for authentication purpose and pass this parameter in URL encoded format.	String

Headers

Parameter Name
Content-Type: application/json
AccessKey: xxxxxxxxxxxxxxxx

HTTP Response

Successful response:

{
    "ErrorCode": 0,
    "ErrorDescription": "Success",
    "Data": [
        {
            "PluginType": "SMS",
            "Credits": "KSh7578560.8000"
        }
    ]
}

Examples

Here is an example of how to check balance:

import requests
import urllib

url = "https://api.onfonmedia.co.ke/v1/sms/Balance"
querystring = {"ApiKey":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx","ClientId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"}
payload = ""
headers = {
    'AccessKey': "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
    'Content-Type': "application/json",
    }
response = requests.request("GET", url, headers=headers, params=urllib.urlencode(querystring))
print(response.text)