API Reference

Welcome to the AyGlobal Data API. Our RESTful architecture allows you to seamlessly integrate VTU purchases, bill payments, KYC verifications, and business registrations directly into your applications.

The API relies on standard HTTP methods, accepts application/json request bodies, and returns JSON-encoded responses.

Base URL

Production: https://ayglobaldata.com
Response Example (Success) 
{
  "status": "success",
  "transaction_ref": "DAT_171000",
  "amount_paid": 280,
  "previous_balance": 5000,
  "new_balance": 4720
}

Authentication

Authenticate your API requests by including your secret API key in the HTTP headers. You can retrieve your API key from the developer section of your dashboard.

Never share your API key publicly or commit it to client-side code (like frontend JavaScript).

HTTP Headers 
Authorization: Token YOUR_API_KEY_HERE
Content-Type: application/json

User Details & Balance

Retrieve your account profile and verify your current wallet balance before making transactions.

GET https://ayglobaldata.com/api/app/auth/userdata.php

Requires your API token in the Authorization header. Returns the user profile, wallet balance, referral bonus and the most recent transactions in one request.

ParameterDescription
Header: Authorization ReqToken YOUR_API_KEY
200 Response 
{
  "status": "success",
  "data": {
    "user": {
      "fname": "John",
      "email": "john@example.com",
      "phone": "08012345678",
      "balance": "5000.00",
      "bonus": "200.00",
      "welcome_bonus": "1"
    },
    "transactions": [
      { "servicename": "Data", "amount": 700, "status": "Success" }
    ]
  }
}

Pricing & Product List

Fetch available products and prices per service. Each endpoint returns the networks, bundles and plan IDs you will use in purchase requests.

All list endpoints require your API token in the Authorization header.

ServiceEndpoint (GET)
Data Plans (MTN, Airtel, Glo, 9mobile, Smile, Alpha, Kirani)/api/app/list/data.php
Airtime Networks & Discounts/api/app/list/airtime.php
Cable TV (DSTV, GOtv, Startimes)/api/app/list/cable.php
Electricity Discos & Packages/api/app/list/electric.php
Exam Pins (WAEC, NECO, JAMB, NABTEB)/api/app/list/exam.php
Bulk SMS Rates & Senders/api/app/list/sms.php
NIN / BVN Verification Packages/api/app/list/verify.php
CAC Registration Plans/api/app/list/cacplan.php
200 Response (Data Plans - Simplified)
{
  "network": [
    {
      "id": 1,
      "name": "MTN",
      "icon": "https://ayglobaldata.com/assets/img/mtn.png",
      "plans": [
        { "pId": 101, "name": "MTN 1.0GB SME 7 Days", "price": 390 }
      ]
    }
  ]
}

Buy Airtime

Top up airtime for any phone number across all networks in Nigeria.

POST https://ayglobaldata.com/api/airtime/
Compatibility: also available at /api/topup/. Also accepts mobile_number and Ported_number as aliases for phone and ported_number, for compatibility with common 3rd-party VTU API formats.
ParameterDescription
network Req Network ID.
1=MTN, 2=GLO, 3=9MOBILE, 4=AIRTEL, 5=SMILE
phone Req 11-digit phone number.
amount Req Amount to top-up (e.g. 100).
ref Req Your unique transaction reference.
ported_number Opt Set to "true" if number is ported. Default is "false".
Payload (PHP) 
$payload = json_encode([
  "network" => "1", 
  "phone" => "08012345678",
  "amount" => 100, 
  "ref" => "AIR_" . time()
]);
200 Response 
{
  "status": "success",
  "amount_paid": 98.00,
  "transaction_ref": "AIR_171000"
}

Buy Data

Purchase SME, Corporate Gifting, or Direct Data instantly.

POST https://ayglobaldata.com/api/data/
Compatibility: also accepts mobile_number, plan, and Ported_number as aliases for phone, data_plan, and ported_number.
ParameterDescription
network Req Network ID (e.g. 1 for MTN).
phone Req 11-digit phone number.
data_plan Req The specific Plan ID (e.g. 10044). Retrieve from Pricing endpoint.
ref Req Your unique transaction reference.
Payload (PHP) 
$payload = json_encode([
  "network" => "1", 
  "phone" => "08012345678",
  "data_plan" => "10044", 
  "ref" => "DAT_" . time()
]);
200 Response 
{
  "status": "success",
  "amount_paid": 280.00,
  "transaction_ref": "DAT_171000"
}

Verify Electricity Meter

Validate customer details before purchasing electricity token.

GET https://ayglobaldata.com/api/electricity/verify/
Compatibility: also available via GET /ajax/validate_meter_number/?meternumber=&disconame=&mtype=.
ParameterDescription
provider Req Disco ID (e.g. 1 for Ikeja).
meternumber Req The physical meter number.
metertype Req Either "prepaid" or "postpaid".
Payload (PHP) 
$payload = json_encode([
  "provider" => "1", 
  "meternumber" => "12345678901",
  "metertype" => "prepaid"
]);
200 Response 
{
  "status": "success",
  "Customer_Name": "MUSA YUSUF"
}

Pay Electricity Bill

Generate electricity token for verified meters.

POST https://ayglobaldata.com/api/electricity/
Compatibility: also available at /api/billpayment/. Also accepts disco_name, meter_number, and MeterType as aliases for provider, meternumber, and metertype.
ParameterDescription
provider Req Disco ID.
meternumber Req Meter Number.
metertype Req "prepaid" or "postpaid".
amount Req Amount (Minimum usually 1000).
ref Req Unique transaction reference.
200 Response 
{
  "status": "success",
  "plan_description": "Token: 8378-9287...",
  "amount_paid": 1000
}

Verify Cable TV (IUC)

GET https://ayglobaldata.com/api/cabletv/verify/
Compatibility: also available via GET /ajax/validate_iuc/?smart_card_number=&cablename=.
ParameterDescription
provider ReqProvider ID (1=GOTV, 2=DSTV, 3=STARTIMES)
iucnumber ReqCustomer Smartcard Number
200 Response
{
  "status": "success",
  "Customer_Name": "AMINA SULEIMAN"
}

Pay Cable TV

POST https://ayglobaldata.com/api/cabletv/
Compatibility: also available at /api/cablesub/. Also accepts smart_card_number, cablename, and cableplan as aliases for iucnumber, provider, and plan.
ParameterDescription
plan ReqPlan ID (e.g. 128 for GOtv Jinja)
ref ReqUnique reference
Payload (PHP)
$payload = json_encode([
  "provider" => "1", 
  "iucnumber" => "7012345678",
  "plan" => "128", 
  "ref" => "CAB_" . time()
]);

Generate Exam Pin

POST https://ayglobaldata.com/api/exam/
ParameterDescription
provider ReqID (1=WAEC, 2=NECO, 3=NABTEB)
quantity ReqNumber of pins (Min 1, Max 10)
ref ReqUnique reference
200 Response
{
  "status": "success",
  "pin": "123456789012",
  "amount_paid": 3600.00
}

Send Bulk SMS

POST https://ayglobaldata.com/api/sms/

Submit via URL-Encoded Form or Form-Data (Uses $_POST variables).

ParameterDescription
sender_id ReqSender Name
phone_numbers ReqComma separated numbers
message_body ReqMessage content
Payload (PHP)
$post = [
  'sender_id' => 'AYGLOBAL',
  'phone_numbers' => '0801...,0902...',
  'message_body' => 'Welcome!'
];

Verify Identity (NIN/BVN)

Verify a BVN or NIN and retrieve verified customer data.

POST https://ayglobaldata.com/api/verify/
ParameterDescription
type Req"bvn" or "nin"
method Req"bvn", "nin", or "phone"
slip_type Opt"information", "standard", "premium"
value ReqThe 11-digit value
200 Response
{
  "status": "success",
  "data": {
     "firstname": "MUSA",
     "nin": "12345678901"
  }
}

CAC Registration

Submit via multipart/form-data for file uploads.

FORM https://ayglobaldata.com/api/cac/
ParameterDescription
type Req"business_name", "company_1m", "ngo"
owner_fullname ReqFull Name of Owner
passport ReqFile Upload (JPG/PNG)
cURL (PHP)
$post = [
  'type' => 'business_name',
  'owner_fullname' => 'John Doe',
  'passport' => new CURLFile('/pass.jpg')
];

Transaction History

Fetch your recent transaction history.

GET https://ayglobaldata.com/api/app/other/transactions.php
ParameterDescription
Header: Authorization ReqToken YOUR_API_KEY
200 Response (Simplified)
{
  "status": "success",
  "transactions": [
    {
      "transref": "DAT_171000",
      "servicename": "Data",
      "amount": 1000.00,
      "status": "Success",
      "date": "2026-08-01 12:00:00"
    }
  ]
}