API reference

The response envelope

Every operation wraps its payload the same way, and always answers HTTP 200 — the transport succeeding says nothing about the operation. The real outcome is inside the body: check succeeded and the fields within data.

// every response, on every operation
{
  "succeeded": true,
  "code": 200,
  "message": "Successful",
  "data": "… the operation's payload …",
  "errors": []
}

Reading a result

Most products carry a response_code inside data, where “00” means success — treat anything else as a failure regardless of the 200. Bill and airtime operations nest one wrapper deeper, putting their payload in response_data.

Listing operations add a pageMeta block alongside data with pageNumber, pageSize, totalPages and totalRecords. Field names throughout the reference are the raw wire names — the docs are never friendlier than the API.