Vend Services

Get Balance

GET https://api.awakeinterlink.ng/api/v1/vend/balance

This endpoint allows you to get your available balance.

Headers

Name	Type	Description
awake-access-apikey	string	Your API key goes here

200 Balance retrieved successfully

{
    "status": "success",
    "message": "Request was successfully processed",
    "data": {
        "balance": "50.50"
    }
}

Get available data plans

GET https://api.awakeinterlink.ng/api/v1/vend/data-plans/:network

This endpoint allows you to get all data plans available on a network

Path Parameters

Name	Type	Description
airtel	string	for AIRTEL
glo	string	for GLO
mtn	string	for MTN
9mobile	string	for 9MOBILE

Headers

Name	Type	Description
awake-access-apikey	string	Your API key goes here

200 Data plans retrieved successfully

{
    "status": "success",
    "message": "Request was successfully processed",
    "data": {
        "plans": [
            {
                "price": 100,
                "name": "DataPlan 75MB Daily",
                "tariff_type_id": 9,
                "validity": "DataPlan Daily"
            },
            {
                "price": 200,
                "name": "Data Plan 200MB 2-Day Plan",
                "tariff_type_id": 9,
                "validity": "DataPlan Daily"
            },
            {
                "price": 300,
                "name": "DataPlan 350MB",
                "tariff_type_id": 9,
                "validity": "DataPlan Weekly"
            },
            {
                "price": 500,
                "name": "Data Plan 750MB 2-Week Plan",
                "tariff_type_id": 9,
                "validity": "DataPlan Weekly"
            },
            {
                "price": 1200,
                "name": "DataPlan 2GB  Monthly",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 1000,
                "name": "DataPlan 1.5GB 1-Month Mobile",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 2000,
                "name": "DataPlan 3.5GB 1-Month All Day plan",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 3500,
                "name": "DataPlan 6.5GB",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 5000,
                "name": "DataPlan 11GB",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 10000,
                "name": "DataPlan 25GB",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 20000,
                "name": "DataPlan 60GB",
                "tariff_type_id": 9,
                "validity": "DataPlan 60Days"
            },
            {
                "price": 350,
                "name": "DataPlan 1GB",
                "tariff_type_id": 9,
                "validity": "DataPlan Daily"
            },
            {
                "price": 15000,
                "name": "DataPlan 40GB",
                "tariff_type_id": 9,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 500,
                "name": "DataPlan 2GB",
                "tariff_type_id": 9,
                "validity": "2 Days Plan"
            },
            {
                "price": 50000,
                "name": "DataPlan 120GB",
                "tariff_type_id": 9,
                "validity": "DataPlan 90Days"
            },
            {
                "price": 75000,
                "name": "DataPlan 150GB",
                "tariff_type_id": 9,
                "validity": "DataPlan 90Days"
            },
            {
                "price": 500,
                "name": "DataPlan 750MB",
                "tariff_type_id": 36,
                "validity": "DataPlan Weekly"
            },
            {
                "price": 30000,
                "name": "DataPlan 100GB",
                "tariff_type_id": 9,
                "validity": "DataPlan 60Days"
            },
            {
                "price": 1500,
                "name": "DataPlan 3GB",
                "tariff_type_id": 36,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 6000,
                "name": "DataPlan 15GB",
                "tariff_type_id": 36,
                "validity": "DataPlan Monthly"
            },
            {
                "price": 100000,
                "name": "N100000 for 325GB",
                "tariff_type_id": 9,
                "validity": "6-Months Plan"
            },
            {
                "price": 300000,
                "name": "N300000 for 1000GB",
                "tariff_type_id": 9,
                "validity": "1-Year Plan"
            },
            {
                "price": 450000,
                "name": "N450000 for 1500GB",
                "tariff_type_id": 9,
                "validity": "1-Year Plan"
            },
            {
                "price": 300,
                "name": "Xtratalk 300",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 500,
                "name": "Xtratalk 500",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 1000,
                "name": "Xtratalk 1000",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 2000,
                "name": "Xtratalk 2000",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 5000,
                "name": "Xtratalk 5000",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 10000,
                "name": "Xtratalk 10000",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 15000,
                "name": "Xtratalk 15000",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 20000,
                "name": "Xtratalk 20000",
                "tariff_type_id": 24,
                "validity": "XtraTalk"
            },
            {
                "price": 300,
                "name": "Xtradata 300",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 500,
                "name": "Xtradata 500",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 1000,
                "name": "Xtradata 1000",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 2000,
                "name": "Xtradata 2000",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 5000,
                "name": "Xtradata 5000",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 10000,
                "name": "Xtradata 10000",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 15000,
                "name": "Xtradata 15000",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 20000,
                "name": "Xtradata 20000",
                "tariff_type_id": 25,
                "validity": "XtraData"
            },
            {
                "price": 25,
                "name": "N25 @ 20MB for 1day",
                "tariff_type_id": 9,
                "validity": "Social Bundles_Daily Plan"
            },
            {
                "price": 50,
                "name": "N50 @ 50MB for 7days",
                "tariff_type_id": 9,
                "validity": "Social Bundles_Weekly Plan"
            },
            {
                "price": 150,
                "name": "N150 @ 160MB for 30days",
                "tariff_type_id": 9,
                "validity": "Social Bundles_Monthly Plan"
            },
            {
                "price": 4000,
                "name": "8.5GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 6500,
                "name": "14GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 12000,
                "name": "30GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 23500,
                "name": "60GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 37000,
                "name": "120GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 62000,
                "name": "200GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 90000,
                "name": "300GB Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 24000,
                "name": "60GB Bi-Monthly",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Monthly"
            },
            {
                "price": 140000,
                "name": "420GB Bi Annual",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Bi Annual"
            },
            {
                "price": 280000,
                "name": "840GB Annual",
                "tariff_type_id": 10,
                "validity": "HyNetFlex Bundles_Bi Annual"
            },
            {
                "price": 7500,
                "name": "10GB @ N7,500 for 30days",
                "tariff_type_id": 12,
                "validity": "SME Data Share Bundles"
            },
            {
                "price": 14000,
                "name": "20GB @ N14,000 for 30days",
                "tariff_type_id": 12,
                "validity": "SME Data Share Bundles"
            },
            {
                "price": 30000,
                "name": "50GB @ N30,000 for 60days",
                "tariff_type_id": 12,
                "validity": "SME Data Share Bundles"
            },
            {
                "price": 10000,
                "name": "22GB @ N10,000 for 30days",
                "tariff_type_id": 12,
                "validity": "SME Data Share Bundles"
            }
        ]
    }
}

Vend Airtime

POST https://api.awakeinterlink.ng/api/v1/vend/airtime/:network

Endpoint for airtime recharge

Path Parameters

Name	Type	Description
9mobile	string	for 9MOBILE
airtel	string	for AIRTEL
glo	string	for GLO
mtn	string	for MTN

Headers

Name	Type	Description
awake-access-apikey	string	Your API key goes here

Request Body

Name	Type	Description
ref_number	string	A unique reference number for each transaction
phone_number	string	Phone number to be recharged
amount	string	Amount in Naira

200

{
    "status": "success",
    "message": "Request was successfully processed",
    "data": {
        "message": "Successful",
        "status": "Success",
        "code": "SUC200",
        "txRef": "gfgfdrriO"
    }
}

Vend Data

POST https://api.awakeinterlink.ng/api/v1/vend/data/:network

Endpoint for data recharge

Path Parameters

Name	Type	Description
airtel	string	for AIRTEL
glo	string	for GLO
9mobile	string	for 9mobile
mtn	string	for MTN

Headers

Name	Type	Description
awake-access-apikey	string	Your API key goes here

Request Body

Name	Type	Description
tariff_type_id	string	The id of the tariff
ref_number	string	A unique reference number for each transaction
phone_number	string	Phone number to receive data
amount	string	Amount in Naira

200

{
    "status": "success",
    "message": "Request was successfully processed",
    "data": {
        "message": "Successful",
        "status": "Success",
        "code": "SUC200",
        "txRef": "gfgfdrriO"
    }
}

Verify Transaction

GET https://api.awakeinterlink.ng/api/v1/vend/status?reference=transaction_ref_number

Query Parameters

Name	Type	Description
reference	string	The ref_number of the transaction whose status you want to check

Headers

Name	Type	Description
access-awake-apikey	string	Your API key goes here

200

{
    "status": "success",
    "message": "Request was successfully processed",
    "data": {
        "status": {
            "tx_status": "successful",
            "phone_number": "08168205169",
            "amount": "50.00",
            "tx_ref": "uyhhuutderoolo"
        }
    }
}