Check Your Balance Via API
Start building for free

Balance API

Hellio's Balance API allows you to retrieve your total balance and balance information from your account, such as currency and type of payment (prepaid, postpaid). You can use the Balance API to expose this information in one of your app or internal dashboards, as well as to send notifications.

The Balance API uses HTTP verbs and a RESTful endpoint structure with an access key that is used as the API Authorization framework. Request and response payloads are formatted as JSON—although we provide a GET alternative for requests—using UTF-8 encoding and URL encoded values.


Account Balance Main Endpoint:

https://api.helliomessaging.com/v1/credit-balance?


Request Method: MATCH (Either POST or GET)


Content-Type: application/json


Request Parameters

Parameter Type Description Required
Username String Your Hellio username Required
Password String Your Hellio password Required
startDate Date Start daterange e.g. 2019-10-01 Optional
endDate Date End daterange e.g. 2020-10-26 Optional

PHP Snippet


        $baseUrl = 'https://api.helliomessaging.com/v1/credit-balance?';

        $username = 'YOUR-HELLIO-MESSAGING-USERNAME';
        $password = 'YOUR-HELLIO-MESSAGING-PASSWORD';

        $params = array(
            'username' => $username,
            'password' => $password
        );

        // Send through CURL
        $ch = curl_init($baseUrl);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        // Process your response here
          $result = curl_exec($ch);
          echo var_export($result, true);
         curl_close($ch);
        


Response Object


        {
        "responseCode": 200,
        "message": [
            {
                "credited": "100",
                "currency": "GHC",
                "status": "paid",
                "created_at": "2020-10-20 16:07:35"
            },
            {
                "credited": "100",
                "currency": "GHC",
                "status": "paid",
                "created_at": "2020-10-06 15:15:24"
            }
        ],
        "status": "success"
        }