Data APIGET
Get Data Plans
Retrieve active data plans available to your developer account.
Loading Ayax APIs...
Please wait while we prepare your page.
Please wait while we prepare your page.
Integrate Data, Airtime, Electricity, Cable, NIMC (NIN) Verification, BVN KYC and Transaction services into your website, mobile application, POS system or reseller platform.
curl --request GET \
--url "https://api.ayaxapis.com/api/v1/api/v1/data/plans" \
--header "accept: application/json" \
--header "x-api-key: ayax_live_your_key"One secure platform for integrating digital services into your applications.
Ayax APIs provide standardized endpoints that allow developers and businesses to integrate supported digital services without connecting directly to multiple upstream providers.
Purchase internet data bundles for supported mobile networks.
Send airtime top-up to supported mobile phone numbers.
Validate meter numbers and purchase electricity tokens.
Validate smartcard details and renew television subscriptions.
Verify National Identity Numbers, download slip profiles, and resolve validation issues.
Access instant Bank Verification Number (BVN) validation and KYC matching.
Track transaction status using your unique reference.
Documented Endpoints
16+
Authentication
API Key
Response Format
JSON
Develop safely in Sandbox before moving your application to Production.
Use Sandbox credentials while developing and testing your integration.
Base URL
https://api.ayaxapis.com/api/v1/sandbox
Key Prefix
ayax_test_...
Use Production credentials only from a secure backend server.
Base URL
https://api.ayaxapis.com/api/v1
Key Prefix
ayax_live_...
Every protected request must contain a valid API key.
Send your secret key through the x-api-key request header. The key determines your environment, permissions and applicable rate limits.
Request Headers
x-api-key: ayax_live_your_api_key_here
Content-Type: application/json
Accept: application/jsonDo not include a secret API key in React, Next.js client components, mobile app source code or any public repository. Route API requests through your protected backend server.
Your wallet funds successful service transactions.
Each service request is priced according to the active API plan assigned to your developer account. Ayax verifies your wallet balance before submitting a paid transaction.
Fund your developer wallet before sending live paid requests.
The active API plan determines the price charged for each service.
Every debit and API transaction is recorded in your dashboard.
Important
Balance validation, service price and wallet deduction are managed by the Ayax backend. Never calculate or deduct wallet funds from frontend code.
Review request parameters, responses and integration examples.
Retrieve active data plans available to your developer account.
Purchase a data bundle using an active plan ID and unique reference.
Send airtime to a supported mobile network phone number.
Validate a meter number before purchasing an electricity token.
Purchase an electricity token for a validated meter number.
Validate a cable television smartcard or IUC number.
Verify an 11-digit NIN and generate slips. Supported slipType: 'Standard Slip', 'Regular Slip', 'Premium Slip', 'VNIN Slip'.
Look up NIN profile details and generate slips using an 11-digit linked mobile phone number. Supported slipType: 'Standard Slip', 'Regular Slip', 'Premium Slip', 'VNIN Slip'.
Submit an issue resolution request for manual processing. Allowed errorType values: 'no_record', 'simbank_validation', 'modification', 'photo_error'.
Query the real-time status of a submitted NIN validation using either ticketId or transactionId.
Submit an enrolment tracking ID (1-20 alphanumeric characters) for Identity Protection Eligibility (IPE) clearance.
Track the progress of a previously submitted IPE clearance request using its trackingID.
Submit a NIN personalization request using a unique 15-character NIN tracking ID.
Poll the status of an ongoing NIN personalization request using the trackingId.
Query Bank Verification Number (BVN) to validate identity, date of birth, photo, and banking profile data. Supported slipType: 'Standard Slip', 'Premium Slip'.
Retrieve the latest state of a transaction using its reference.
Ayax APIs use a predictable JSON response structure.
Successful Response
{
"success": true,
"message": "Transaction submitted successfully",
"data": {
"reference": "AYAX-2026-0001",
"status": "PROCESSING",
"service": "DATA",
"amount": 500
}
}Failed Response
{
"success": false,
"message": "Insufficient wallet balance",
"error": {
"code": "INSUFFICIENT_BALANCE"
}
}Use both the HTTP status and response error code when handling failures.
Create your developer account, fund your wallet, generate a Sandbox key and begin testing Ayax APIs.