Airtime and Data Vending

Make airtime purchases via parent account

Changed on

Deprecated. This endpoint is deprecated and will be removed in a future release. Use POST /v2/bill/topup instead.

post/v1/bill/topup

Request

  • Base URL
    https://api.nomba.com
  • URL
    https://api.nomba.com/v1/bill/topup
  • Auth
    HTTP bearer

Headers

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

The parent accountId of the business.

Request body

amountnumber double required

The airtime amount to be purchased

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)

This is an idempotency key and must be unique per transaction.

senderNamestring

A name to describe the sender of the airtime

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": "SUCCESS",
    "id": "API-TOPUP-A6950-8c060b7c-4155-4e33-a846-101b49229c33"
  }
}

Changes

    • warning

      added the new PROCESSING enum value to the / response property for the response status

    • warning

      added the new SUCCESS enum value to the / response property for the response status

    • info

      endpoint deprecated

    • info

      added the optional property / to the response with the status