Welcome to Topupbox API

Topupbox enables you to get and distribute airtime as a merchant and dealer at ease.

Get Access Token

All APIs in this documentation require an access token which serves as an authorization key which lasts for a year. Tokens can re refreshed, and re-generated on the Topupbox Dashboard.

Postman Documentation

Check out and test our postman documentation here

All Endpoints have a base url of https://api.topupbox.com

https://documenter.getpostman.com/view/19486823/2s9YJey1fd

Get Transaction Record

Get all records and transactions.

GET https://api.topupbox.com/api/v2/w1/query/page/{page}/{numPerPage}

Path Parameters

Name	Type	Description
page*	String	Page ID
numPerPage*	String	Number of parameters by page

Headers

Name	Type	Description
Authorization	String	Access Token

Javascript

// Some code

PHP

// Some code

Java

// Some code

Get Data Packages

GET https://api.topupbox.com/api/v2/w1/data-price-point/{network}

Path Parameters

Name	Type	Description
Network*	String	Network names eg MTN, AIRTEL,GLO, AIRTEL, etc.

Headers

Name	Type	Description
Authorization*	String	Access Token

Javascript

// Some code

PHP

// Some code

Java

// Some code

Get All Data Packages

GET https://api.topupbox.com/api/v2/w1/data-price-point/all

Get all Data Packages irrespective of network.

Headers

Name	Type	Description
Authorization*	String	Access Token

Javascript

// Some code

PHP

// Some code

Java

// Some code

Make your First Recharge

POST https://api.topupbox.com/api/v2/w1/recharge/{network}/{rechargeType}

Recharge Number based on Network and rechargeType

Path Parameters

Name	Type	Description
Network*	String	Network names eg MTN, AIRTEL,GLO, AIRTEL, et
rechargeType*	String	type of recharge , expected value : AIRTIME or DATA

Headers

Name	Type	Description
Authorization*	String	Access Token

Request Body

Name	Type	Description
amount*	String	Amount to be credited
beneficiary*	String	Phone Number of beneficiary
customer_reference*	String	reference number of customer
tariffTypeId*	String	TarriffTypeID for data packages