Telco Balances

This resource is to pull the customer's transaction balance data, which includes main balance, aIrtime bundle, data bonuses etc.

API Reference

API Object

[
    {
        "_id": "630df07fefa85f123c84ce84",
        "name": "Main Balance",
        "type": "currency",
        "value": 7659,
        "unit": "ngn"
    },
    {
        "_id": "630df07fefa85f123c84ce85",
        "name": "Roaming Bundle",
        "type": "voice",
        "value": 300,
        "unit": "minutes"
    },
    {
        "_id": "630df07fefa85f123c84ce86",
        "name": "GoodyBag Social Bundle",
        "type": "data",
        "value": 11.15,
        "unit": "gb"
    },
    {
        "_id": "630df07fefa85f123c84ce87",
        "name": "Airtime Bonus",
        "type": "currency",
        "value": 1550000,
        "unit": "ngn"
    },
    {
        "_id": "630df07fefa85f123c84ce88",
        "name": "Data Bundle",
        "type": "data",
        "value": 16.39,
        "unit": "gb"
    }
]

Telco Verification Fields

FieldDescriptionType
_idThis returns the id of the balance information typestring
nameThis refers to the name of the telco balances informationstring
typeThis refers to the type category of the name balance format e.g currency, data and voicestring
valueThis is the current balance value of the telco balances typeinteger
unitThis refers to the unit type of the balance info e.g gb, ngn, minutesstring