TransactionResponse

referencestring

Example: PLS-9KQ2M7P3XR

clientReferencestring

The clientReference you sent when creating this purchase.

Example: order-1001

servicestring

Possible values: [Data, Airtime, CableTv, Electricity, Education, Broadband]

statusstring

Possible values: [Success, Failed, Processing]

networkstring

Example: MTN

planstringnullable

Plan name for data purchases; null for airtime.

Example: 1.0GB

mobileNumberstring

Example: 08030000000

priceChargedinteger<int64>

In kobo.

Example: 27000

providerReferencestringnullable

createdOnstring<date-time>

completedOnstring<date-time>nullable

When the purchase reached a terminal state; null while Processing.

tokenstringnullable

Provider-delivered token/PIN for services that vend one (electricity prepaid token, education PIN). Null for data, airtime and cable TV.

deliveredDetails objectnullable

What the upstream disco or biller reported it delivered, beyond the token: the meter/account holder's name and address, the units credited, and the utility's own receipt number. These are the fields a customer expects on a power receipt.

Every field is optional, and the whole object is null when nothing was reported: every data and airtime purchase, any purchase still Processing, and any biller that does not report them. Reported today for prepaid electricity.

customerNamestringnullable

The meter or account holder's name, exactly as the disco holds it.

Example: Muraina Tamilola .

customerAddressstringnullable

The service address the disco holds for this meter.

Example: NO 9, ROAD 19 BASHORUN HOUSING ESTATE AKOBO ESTATE IBADAN OYO,

unitsnumbernullable

Units credited by this vend (kWh for electricity). Fractional.

Example: 2.3

utilityReceiptstringnullable

The utility's own receipt number for this vend, for disputes raised directly with the disco.

Example: 110-0000079801709

failureReasonstringnullable

Mirrors the purchase response's failureReason (the durable copy, like token): on a Failed transaction, the human-readable reason it failed - e.g. a below-minimum electricity vend refusal naming the meter's minimum. Null otherwise.

Example: This meter requires a minimum purchase of NGN22,521.25, but NGN10,000.00 was requested.

TransactionResponse

{
  "reference": "PLS-9KQ2M7P3XR",
  "clientReference": "order-1001",
  "service": "Data",
  "status": "Success",
  "network": "MTN",
  "plan": "1.0GB",
  "mobileNumber": "08030000000",
  "priceCharged": 27000,
  "providerReference": "string",
  "createdOn": "2024-07-29T15:51:28.071Z",
  "completedOn": "2024-07-29T15:51:28.071Z",
  "token": "string",
  "deliveredDetails": {
    "customerName": "Muraina Tamilola .",
    "customerAddress": "NO 9, ROAD 19 BASHORUN HOUSING ESTATE AKOBO ESTATE IBADAN OYO,",
    "units": 2.3,
    "utilityReceipt": "110-0000079801709"
  },
  "failureReason": "This meter requires a minimum purchase of NGN22,521.25, but NGN10,000.00 was requested."
}