Skip to main content
POST
Vend data bundles via parent account

Authorizations

Authorization
string
header
required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId
string<uuid>
required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Body

application/json

The request payload required to vend data bundles

productId
string
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.

Example:

"mtn47"

phoneNumber
string
required

Recipient phone number

Required string length: 11 - 13
Example:

"08055441122"

network
enum<string>
required

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

Available options:
GLO,
MTN,
9MOBILE,
AIRTEL
Minimum string length: 3
Example:

"GLO"

merchantTxRef
string
required

Merchant Transaction Identifier reference (Unique to merchant)

Example:

"3bvwhibh38220dsjakTwvb"

amount
number<double>
deprecated

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.

senderName
string

A name to describe the sender of the data

Example:

"John Doe"

Response

OK - your request was successful.

code
string
required

Response Code

Example:

"00"

description
string
required

Response description

Example:

"Success"

data
object
required