Developer API

Qevranoxa API Documentation

Integrate Qevranoxa into your applications with our simple REST API.

Authentication

All API requests require authentication via an API key. You can generate API keys from your Profile page.

Include your API key in one of these headers:

X-API-Key: YOUR_API_KEY

Or using Bearer token format:

Authorization: Bearer YOUR_API_KEY

Idempotency

All mutation requests (POST) require an Idempotency-Key header to prevent duplicate transactions. Use a unique string per request.

Idempotency-Key: unique-request-id-123

You may also pass the idempotency key as a body field (idempotency_key) instead of the header.

Base URL

https://qevranoxa.com.ng/api/v1

Endpoints

GET /balance

Retrieve your wallet balance, email and membership tier.

{
  "status": true,
  "data": {
    "email": "user@example.com",
    "tier": "Basic",
    "balance": 5000.00
  },
  "message": "Wallet balance retrieved."
}

GET /data

List available data plans. Optional: filter by network. price is your account's payable price; eligible paid members also receive the regular price and exact savings. The purchase debit matches price.

GET /api/v1/data?network=MTN

{
  "status": true,
  "data": [
    {
      "id": 1,
      "network": "MTN",
      "plan_type": "sme",
      "variant": "",
      "description": "1GB 30 days",
      "plan_code": "mtn-123-abc",
      "size": "1GB",
      "validity": "30 days",
      "price": "346.50",
      "regular_price": "350.00",
      "discount_amount": "3.50"
    }
  ],
  "message": "Data plans retrieved."
}

POST /data

Purchase a data bundle.

Body (JSON):

  • phone — 11-digit phone number (required)
  • plan_code — plan code from GET /data (required)
{
  "status": true,
  "data": {
    "ref": "DA-XXXXXXXXXXXX",
    "status": "success",
    "network": "MTN",
    "size": "1GB",
    "phone": "08012345678",
    "amount": 350.00,
    "message": "Data delivered."
  },
  "message": "Data purchase completed."
}

POST /airtime

Purchase airtime.

Body (JSON):

  • network — MTN, AIRTEL, GLO, 9MOBILE (required)
  • phone — 11-digit phone number (required)
  • amount — amount in Naira, min: 100, max: 50000 (required)
{
  "status": true,
  "data": {
    "ref": "AT-XXXXXXXXXXXX",
    "status": "success",
    "network": "MTN",
    "phone": "08012345678",
    "amount": 100.00,
    "fee": 0.00,
    "message": "Airtime delivered."
  },
  "message": "Airtime purchase completed."
}

GET /cable

List available cable services (DStv, GOtv, Startimes).

{
  "status": true,
  "data": [
    { "key": "dstv", "name": "DStv" },
    { "key": "gotv", "name": "GOtv" },
    { "key": "startimes", "name": "Startimes" }
  ],
  "message": "Cable services retrieved."
}

POST /cable

Subscribe to a cable plan.

Body (JSON):

  • provider — cable TV service key: dstv, gotv, or startimes (required)
  • smartcard — smartcard number, 10-15 digits (required)
  • plan_code — plan code (required)
  • amount — amount in Naira, min: 500, max: 100000 (required)
{
  "status": true,
  "data": {
    "ref": "CB-XXXXXXXXXXXX",
    "status": "success",
    "provider": "DStv",
    "smartcard": "1234567890",
    "amount": 2500.00,
    "message": "Cable subscription delivered."
  },
  "message": "Cable purchase completed."
}

POST /electricity

Buy electricity token.

Body (JSON):

  • disco — ikedc, ekedc, aedc, etc. (required)
  • meter_number — 10-15 digit meter number (required)
  • type — prepaid or postpaid (required)
  • amount — amount to credit to the meter in Naira, min: 1000, max: 100000 (required)

The returned amount is the total wallet debit.

{
  "status": true,
  "data": {
    "ref": "EL-XXXXXXXXXXXX",
    "status": "success",
    "disco": "Ikeja Electric",
    "meter_number": "1234567890",
    "type": "prepaid",
    "amount": 5600.00,
    "token": "1234-5678-9012-3456-7890",
    "message": "Electricity token delivered."
  },
  "message": "Electricity purchase completed."
}

POST /mobile/exam/quote

Get the current total price for education PINs. Use the returned amount when confirming the purchase.

Body (JSON): exam (waec, neco, nabteb), quantity (1-10)

{
  "status": true,
  "data": { "name": "WAEC", "amount": 2240.00 },
  "message": "Education quote retrieved."
}

POST /mobile/exam/purchase

Purchase education PINs using the quoted amount. Send a unique idempotency_key.

GET /transactions

List your transactions. Optional filters: type, status, per_page.

type values: data, airtime, cable, electricity, exam

status values: pending, processing, success, failed

GET /transactions/{ref}

Get a single transaction by reference number.


API Key Management

GET /api-keys

List your API keys.

POST /api-keys

Generate a new API key.

Body (JSON):

  • name — key name/label (required)

DELETE /api-keys/{id}

Revoke an API key by its ID (returned by GET /api-keys).


Error Codes

  • 401 — Missing, invalid or expired API key
  • 402 — Insufficient wallet balance
  • 409 — Duplicate request (idempotency conflict)
  • 422 — Validation error or invalid parameters
  • 502 — Service connection error
Ready to build?

Start integrating today

Generate your API key and start making requests in minutes.

Get API Key
Hi Guest! Need help?