v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Airtime and Data Vending

Vend data bundles via parent account

You can use this endpoint to vend data via parent account

post/v1/bill/data

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

amountnumber double required

The data amount to be vended

phoneNumberstring required

Recipient phone number

network'GLO' | 'MTN' | '9MOBILE' | 'AIRTEL' required

Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.

merchantTxRefstring required

Merchant Transaction Identifier reference (Unique to merchant)

senderNamestring

A name to describe the sender of the data

Example request

{
  "amount": 200,
  "phoneNumber": "08055441122",
  "network": "GLO",
  "merchantTxRef": "3bvwhibh38220dsjakTwvb",
  "senderName": "John Doe"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "amount": 200,
    "timeCreated": "2023-09-04T07:09:06.900Z",
    "type": "topup",
    "meta": {
      "merchantTxRef": "test1116",
      "rrn": "240626232937"
    },
    "status": "Processing"
  }
}