Airtime USSD API

API Documentation for managing merchants, customer top-ups, dealers, and transactions[cite: 1].

Base URL: http://localhost:8131/api[cite: 1]

Create App Token

POST

Endpoint: /login[cite: 1]

Request Body (JSON)
{
  "email" : "kwesi@click-mobile.com",
  "password" : "password"
}

Merchant Login

POST

Endpoint: /merchant/login[cite: 1]

Authentication: Bearer Token[cite: 1]

Request Body (JSON)
{
  "phone_number" : "265881161942",
  "pin" : "1234"
}

Merchant Transactions

POST

Endpoint: /merchant/transactions[cite: 1]

Headers: Accept: application/json[cite: 1]

Authentication: Bearer Token[cite: 1]

Request Body (JSON)
{
  "merchant_id": 1,
  "keyword": "Baldwin",
  "start_date": "2025-07-20",
  "end_date": "2026-05-10",
  "per_page": 20
}

Customer Top Up

POST

Endpoint: /merchant/customertopup[cite: 1]

Headers: Accept: application/json[cite: 1]

Authentication: Bearer Token[cite: 1]

Request Body (JSON)
{
  "phone_number" : "265881161942",
  "amount" : "20",
  "merchant_id" : "1"
}

Dealer List

GET

Endpoint: /merchant/dealers?per_page=5[cite: 1]

Authentication: Bearer Token[cite: 1]

Merchant To Dealer Refund

POST

Endpoint: /merchant/refund[cite: 1]

Headers: Accept: application/json[cite: 1]

Authentication: Bearer Token[cite: 1]

Request Body (JSON)
{
  "dealer_id" : "40",
  "merchant_id" : "1",
  "amount" : "2",
  "reason" : "Testing Mic"
}
© {{ date('Y') }} Airtime USSD API Documentation[cite: 1]. All rights reserved.