API Documentation

You can integrate our api into your own system.



How it works

-> Register on our system

-> Login into your account

-> Navigate to the api page

-> Request for an api key

You are ready to use our api.



How to use the api

All request are done using get request.


To request for balance

url: http://airtime.mindshareltd.com/api/v1/balance?ref=xxxx&token=xxxx


ref -> username

token -> api-key


To request for transaction history

url: http//airtime.mindshareltd.com/api/v1/history?ref=xxxx&token=xxxx&type=xxxx&search=xxxx


ref -> username

token -> api-key

type -> search type (not compulsory)

param -> search parameter (not compulsory)


Codes for search type

Type Code
Month M
Date D
Amount A
Network N

To topup

url: http//airtime.mindshareltd.com/api/v1/history?ref=xxxx&token=xxxx&network=xxxx&amount=xxxx&phone=xxxx


ref -> username

token -> api-key

network -> reciever's network

phone -> reciever's phone number

amount -> amount to topup


Network Codes

Network Code
Airtel 1
Etisalat 2
GLO 6
MTN 15

Status Codes

Code Meaning
250 Success
150 Invalid api key
100 Invalid api account
320 Invalid User
400 General Error