Airtime and Data Vending

Vend data bundles via parent account

Changed on

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

post/v1/bill/data

Request

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

Headers

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

The parent accountId of the business.

Request body

productIdstring required

The unique identifier of the data plan to purchase — returned as productId by the Fetch Data Plans endpoint. Required for all new integrations: it resolves to an exact plan and amount, removing any ambiguity when multiple plans on the same network share the same price.

amountnumber double

Deprecated — do not use. amount is a legacy-only field with no guarantee of correctness: multiple plans can share the same price, so it cannot reliably identify the bundle you want. Use productId — the only supported way to select a plan.

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

{
  "productId": "mtn47",
  "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,
    "productId": "mtn47",
    "plan": "3.5GB Daily Plan",
    "timeCreated": "2023-09-04T07:09:06.900Z",
    "type": "topup",
    "meta": {
      "merchantTxRef": "test1116",
      "rrn": "240626232937"
    },
    "status": "SUCCESS",
    "id": "API-DATA-AAA1A-36dc6c70-5cf2-4592-93be-9bccc23df7f5"
  }
}

Changes

    • breaking

      added the new required request property

    • 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

      the request property became optional

    • info

      request property deprecated

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status