Version 1 API Overview
Reference documentation for the Click Airtime V1 API (v1.4). This API is in maintenance mode — new integrations should use the Version 2 API.
Version 1 API (v1.4) — This API is in maintenance mode and will not receive new features. New integrations should use the Version 2 API. See the Migration Guide for upgrade instructions.
The Click Airtime V1 API provides a simple interface for sending airtime top-ups, checking account balances, and retrieving transaction history. It uses header-based authentication with your account email and API token.
Base URL
https://api.clickairtime.com
Authentication
All requests require two custom headers:
X-Click-Airtime-Email: your@email.com
X-Click-Airtime-Token: your-api-token
See Authentication for full details.
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /adp/topup | Send airtime to a phone number |
GET | /adp/balances | List all account balances |
GET | /adp/balances/:account_id | Get balance for a specific account |
GET | /adp/product-catalog | List available service catalogs |
GET | /adp/products | List products for a service |
GET | /adp/products/:id | Get single product details |
GET | /adp/transactions | Search transaction history |
API Sections
Authentication
Header-based auth with email and API token
Send Top-up
POST /adp/topup — send airtime to any supported number
Products
Browse available products and service catalogs
Balances
Check account balances across all networks
Transactions
Search and retrieve transaction history
Response Codes
Complete reference of status and error codes
Response Format
The V1 API uses two response patterns depending on the endpoint:
Top-up endpoint (POST /adp/topup):
{
"message": "Descriptive message",
"statusCode": 200,
"code": 1,
"data": { ... }
}
Balance and Transaction endpoints:
{
"message": "Success",
"statusCode": 200,
"data": [ ... ]
}
| Field | Type | Description |
|---|---|---|
message | string | Human-readable description of the result |
statusCode | number | HTTP status code |
code | number | Response code (present on top-up endpoint; 1 for success, see Response Codes for error codes) |
data | object or array | Response payload (present on success) |
Ready to upgrade? The Version 2 API offers API key authentication, standardized responses, product catalog, and much more. See the Migration Guide to get started.
