Squad API Documentation
  • Home
  • Payments
    • Initiate Payment
    • Direct API Integration
    • Squad Payment Modal
    • Verify Transaction
    • Aggregator and Sub-merchants
  • Verify Transaction
  • Webhook & Redirect URL
    • Signature validation
  • Virtual Accounts
  • Test Cards
  • Payment Link
  • Refund API
  • Squad Woo Commerce Plugin
  • Disputes & Chargebacks
  • Wallet Balance
  • Transfer API
  • Squad POS
    • Getting Started
    • API Documentation
  • VALUE ADDED SERVICES
    • AIRTIME AND DATA
    • SMS
      • BUCKET
      • TEMPLATES
      • MESSAGES
    • Utilities
      • Cable Subscription
      • Electricity Subscription
Powered by GitBook
On this page
  • Electricity Providers Nationwide
  • Account Lookup
  • Request Body
  • Sample Request
  • Sample Response
  • Electricity Purchase (Vend)
  • Sample Request
  • Sample Response

Was this helpful?

  1. VALUE ADDED SERVICES
  2. Utilities

Electricity Subscription

These Suit of APIs allow you vend electricity tokens

Electricity Providers Nationwide

Provider
Full Name
Region

IE

Ikeja Electricity

Abule Egba, Akowonjo, Ikeja, Ikorodu, Oshodi and Shomolu in Lagos

EKEDC

Eko Electricity Distribution Company

Lekki, Ibeju, Islands, Ajah, Ajele, Orile, Ijora, Apapa, Mushin, Festac, Ojo, and Agbara in Lagos

AEDC

Abuja Electricity Distribution Company

FCT Abuja, Kogi, Niger, and Nasarawa States

YEDC

Yola Electricity Distribution Company

Adamawa, Taraba, Borno, and Yobe states

BEDC

Benin Electricity Distribution Company

Delta, Edo, Ekiti, and Ondo States

IBEDC

Ibadan Electricity Distribution Company

Oyo, Ibadan, Osun, Ogun & Kwara States

KEDCO

Kano Electricity Distribution Company

Kano, Katsina, and Jigawa States

KAEDC

Kaduna Electricity Distribution Company

Kaduna, Kebbi, Sokoto and Zamfara States

PHED

Port Harcourt Electricity Distribution Company

Rivers, Bayelsa, Cross River and Akwa-Ibom States

EEDC

Enugu Electricity Distribution Company

Abia, Anambra, Ebonyi, Enugu and Imo States

Account Lookup

This API allows you to retrieve the customer’s electricity details.

POST https:{{base_url}}/v1/service/electricity/lookup

Request Body

Name
Type
Description

meter_type*

String

Customer's electricity type (prepaid or postpaid)

customer_id*

String

Customer's meter number

provider*

String

Meter Electricity provider (e.g IE, EEDC)

Sample Request

{
    "meter_type": "prepaid",
    "customer_id": "45067198783",
    "provider": "IE"
}

Sample Response

{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "reference": "IE-25030438f258e38799d424",
        "customer_name": "Adene Jonah",
        "minimum_vend": 500,
        "address": "Mr. John Doe 34 Tokai, Abuja. 7999.",
        "kct": "",
        "meter_number": "45067198783",
        "meter_type": "prepaid"
    }
}

{
    "status": 401,
    "success": false,
    "message": "Authorization failed",
    "data": {}
}

Electricity Purchase (Vend)

This API vends and generates an electricity token for the customer.

POST https:{{base_url}}/v1/service/electricity/vend

Before vending, you must have first called the Account lookup endpoint, and pass the reference generated as your reference in order to vend

Name
Type
Description

provider*

String

Meter Electricity provider (e.g, IE, EEDC)

reference*

String

Reference provided by Provider in account lookup

amount*

String

Amount of electricity to be purchased

phone_number*

String

Phone number of the customer

email*

String

Email address of the customer

Sample Request

{
    "provider": "IE",
    "reference": "IE-25030438f258e38799d424",
    "amount": 700,
    "phone_number": "08102345663",
    "email": "tamtest@squadco.com"
}

Sample Response

{
    "status": 200,
    "success": true,
    "message": "Successful",
    "data": {
        "reference": "IE-25030438f258e38799d424",
        "token": "112345678567859765456788",
        "total_units": "333.300",
        "address": "Mr. John Doe 34 Tokai, Abuja. 7999.",
        "kct": "",
        "meter_number": "45067198783",
        "meter_type": "prepaid"
    }
}

{
    "status": 404,
    "success": false,
    "message": "No transaction found with specified reference",
    "data": {}
}

PreviousCable Subscription

Last updated 2 months ago

Was this helpful?