API Documentation for Airtime Billers

Overview

This endpoint allows fintech developers to fetch the list of airtime billers available in Nigeria via MyBundlePay’s API. It provides secure access with business validations to ensure only authorized users can retrieve biller information.


GET https://mybundlepay.com/ng/api/airtime-billers/NG

HEADERS

Authorization* string

Pass your {secret_key} as a Bearer token in the request header to authorize this call

URL PARAMS

country* string

Country code for billers. Currently, only NG (Nigeria) is supported.

RESPONSE

Success response example:


{
    "status": true,
    "billers": [
        {
            "name": "Spectranet",
            "identifier": "spectranet-ng",
            "commission": 2
        },
        {
            "name": "Airtime NG",
            "identifier": "ng-airtime",
            "commission": 1
        },
        {
            "name": "9mobile",
            "identifier": "9mobile-ng",
            "commission": 1
        },
        {
            "name": "Smile",
            "identifier": "smile-ng",
            "commission": 1
        },
        {
            "name": "MTN",
            "identifier": "mtn-ng",
            "commission": 1
        },
        {
            "name": "Airtel",
            "identifier": "airtel-ng",
            "commission": 1
        },
        {
            "name": "Glo",
            "identifier": "glo-ng",
            "commission": 1
        }
    ]
}

                            

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://mybundlepay.com/ng/api/airtime-billers/NG",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer {secret_key}"
    ),
));

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

                                

const axios = require('axios');

axios.get('https://mybundlepay.com/ng/api/airtime-billers/NG', {
    headers: {
        'Authorization': 'Bearer {secret_key}'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error.response ? error.response.data : error.message);
});

ERROR RESPONSES


{
    "status": false,
    "message": "Unsupported country"
}
{
    "message": "Invalid token",
    "status": "failed"
}
{
    "message": "KYC not approved",
    "status": "failed"
}
{
    "message": "User not found",
    "status": "failed"
}