Back to Home

API Testing Console

Test your API endpoints in real-time

Quick Start Guide

  1. If you don't have an API key, use the Generate API Key endpoint with your login credentials
  2. Copy your API key and paste it in the API Authentication field above
  3. Test different endpoints by clicking on them and filling in the required parameters
  4. View the response in real-time with proper formatting

Base URL:

API Authentication

Enter your API key to start testing. You can generate an API key from your dashboard or use the endpoint below.

POST/api/generate-key

Generate a new API key using your email and password credentials.

Response

GET/api/balance

Retrieve your current account balance. Requires API key authentication.

Response

POST/api/purchase

Purchase a single data bundle for one recipient. For multiple recipients in one request, use /api/bulk-purchase below.

Response

POST /api/bulk-purchase — Up to 100 orders

Bulk Purchase — Send up to 100 data bundle orders in a single API call. Invalid orders (wrong phone, no matching bundle, duplicates, blacklisted numbers) are automatically skipped and returned in the skipped[] array. Only valid orders are charged. The total cost is deducted atomically.

Orders: 0
Networks: —
{ "orders": [] }
Response

POST /api/ishare — AirtelTigo iShare

iShare uses your MB balance, not your GHS wallet. The deduction comes from your AirtelTigo iShare MB pool. Minimum transfer is 50 MB. Check your available MB balance on the dashboard before testing.

10-digit Ghana number starting with 0
Minimum 50 MB. Enter in MB (e.g. 1000 = 1 GB, 2000 = 2 GB)
{
  "recipient":  "0XXXXXXXXX",
  "volume_mb":  1000
}
Response

GET /api/ishare-status — AirtelTigo iShare

Check the delivery status of an iShare order using its reference. References start with ISHARE_API_

The reference returned when you placed the iShare order
Response

POST/api/afa

Register a user for AFA Calltime Package. All fields are required. Requires API key authentication.

Name as it appears on Ghana Card
10-digit Ghana number starting with 0
Format: GHA-XXXXXXXXX-X
Current residential address
Response

GET/api/afa-status

Check the status of a single AFA registration order.

Enter the AFA order reference (starts with AFA_)
Response

POST/api/afa-status-bulk

Check the status of multiple AFA registration orders at once (up to 50). Enter one reference per line.

Enter up to 50 AFA references (one per line)
Response

GET/api/orders

Get details of a specific order by reference. Requires API key authentication.

Response

GET/api/transactions

Get a paginated list of all your API transactions. Requires API key authentication.

Response