Internal Services

Account Details API - Check Balance & Organization Info

Query your Statum wallet balance and organization details via API. Monitor account funds, service subscriptions, and M-Pesa top-up codes for automated dashboard integrations.

Access your Statum account details securely via our API. Retrieve organization information, available balances, and service accounts by sending an authenticated HTTP GET request to the endpoint below.

GET
https://api.statum.co.ke/api/v2/account-details

API Request

Send an HTTP GET request to the endpoint above with the standard API request headers and your API credentials for authentication.

Implementation
<?php
                $consumerKey = "568473daf6614cb196caeb5f8805985f";
                $consumerSecret = "5a07f41de16e40e4b08b4001142a5a10";
                $auth = base64_encode($consumerKey . ":" . $consumerSecret);

                $curl = curl_init();
                curl_setopt_array($curl, array(
                CURLOPT_URL => 'https://api.statum.co.ke/api/v2/account-details',
                CURLOPT_RETURNTRANSFER => true,
                CURLOPT_FOLLOWLOCATION => true,
                CURLOPT_CUSTOMREQUEST => 'GET',
                CURLOPT_HTTPHEADER => array(
                "Authorization: Basic $auth",
                "Content-Type: application/json"
                ),
                ));

                $response = curl_exec($curl);
                curl_close($curl);
                echo $response;
                ?>

Account Details API Response Format

The Statum Account API returns a comprehensive JSON payload containing your organization's real-time financial standing and active service subscriptions. This endpoint is ideal for building automated balance monitoring systems and low-balance alerts.

The response includes organization details, available balance, and service accounts:

Parameter Type Description Example
status_code Number Status of the API request 200
description String Response description Operation successful.
request_id String Unique reference ID for the request 5a45bc7b-bf99-49ae-b089-9daf5f4adbb0
organization.name String Name of the organization Statum Test
organization.details.available_balance Decimal Current available balance 695.15
organization.details.location String Organization location Nairobi - Westlands
organization.details.website String Organization website www.statum.co.ke
organization.details.office_email String Official email [email protected]
organization.details.office_mobile String Official mobile number +254722199199
organization.details.mpesa_account_top_up_code String M-Pesa account top-up code B9E573
organization.accounts Array List of service accounts associated with the organization [{"account":"Statum","service_name":"sms"}]

Sample Response Payload

Response
{
    "status_code": 200,
    "description": "Operation successful.",
    "request_id": "5a45bc7b-bf99-49ae-b089-9daf5f4adbb0",
    "organization": {
        "name": "Statum Test",
        "details": {
            "available_balance": 695.15,
            "location": "Nairobi - Westlands",
            "website": "www.statum.co.ke",
            "office_email": "[email protected]",
            "office_mobile": "+254722199199",
            "mpesa_account_top_up_code": "B9E573"
        },
        "accounts": [
            {
                "account": "Statum",
                "service_name": "sms"
            },
            {
                "account": "CONNECT",
                "service_name": "sms"
            }
        ]
    }
}