Developer Platform & REST APIs v1.0

API & Developer Documentation

Integrate high-speed Bill Payments, Airtime, Data Bundles, Electricity Tokens, Bulk SMS, USSD Menus, and Statements directly into your software.

Generate API Keys
Production:https://backend.cbivas.com/api/v1
Core VAS

Bill Payments & Digital VAS

Disburse Airtime, Internet Data bundles, Electricity meter tokens, Cable TV subscriptions, and Education exam registration PINs (WAEC, JAMB, NECO) with sub-second fulfillment.

Architecture & Integration Guidelines:
  • Workflow: 1. Get Categories -> 2. Get Billers -> 3. Fetch Packages -> 4. Verify Customer -> 5. Purchase with PIN & Idempotency Key.
  • Automated Refunds: If a transaction fails, the system automatically rolls back and refunds your wallet immediately.
  • Tokens & PINs: Electricity prepaid tokens and WAEC/JAMB PINs are returned immediately in the purchase response.
DocsBill Payments & Digital VAS4. Verify Meter / Smartcard
POST/api/v1/services/verify-customer

4. Verify Meter / Smartcard

Validate electricity meter numbers or smartcard IUC numbers and return registered customer name and address.

Request Headers
Header
Value
Authorization
Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
application/json
X-Channel
api
Request Body
{
  "service_type": "ikeja-electric",
  "customer_id": "1111111111111",
  "check_type": "prepaid"
}
Code Execution Playground
Request Snippet (CURL)
curl -X POST "https://backend.cbivas.com/api/v1/services/verify-customer" \
  -H "Authorization: Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"service_type":"ikeja-electric","customer_id":"1111111111111","check_type":"prepaid"}'
Success Response (200 OK)
{
  "customer_name": "OBAFEMI AWOLOWO",
  "customer_id": "1111111111111",
  "status": "verified",
  "address": "Plot 12, Commercial Avenue, Ikeja, Lagos",
  "metadata": {
    "min_purchase": 1000,
    "meter_type": "prepaid"
  }
}