Skip to main content

Electricity Vending

These Suit of APIs allow you vend electricity tokens.​

Electricity Providers​

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

Get List of Providers​

This API allows you to retrieve the list of electricity providers.

GET
https://sandbox-api-d.squadco.com/vending/utilities/electricity/service-providers

This API retrieves list of electricity providers

Sample Request​

{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": [
        {
            "code": "EKEDC",
            "name": "Eko Electricity",
            "logo_url": "https://media.premiumtimesng.com/wp-content/files/2022/05/ekedcp_logo.jpg"
        },
        {
            "code": "IE",
            "name": "Ikeja Electricity",
            "logo_url": "https://www.insideojodu.com/wp-content/uploads/2022/11/Ikeja-Electric-Vacancy.png"
        },
        {
            "code": "PHED",
            "name": "Port Harcourt Electricity",
            "logo_url": null
        },
        {
            "code": "AEDC",
            "name": "Abuja Electricity",
            "logo_url": null
        },
        {
            "code": "JED",
            "name": "Jos Electricity",
            "logo_url": null
        }
      
    ]
}

Lookup Meter​

This Endpoint allows you to look up and retrieve the details of a meter

POST
https://sandbox-api-d.squadco.com/vending/utilities/electricity/lookup

This API does a meter number lookup

Parameters

Body

meter_no*

Integer

The meter number to be looked up

meter_type*

String

Prepaid or Postpaid

provider*

String

Electricity provider

Sample Request​

{
    "meter_type": "prepaid", 
    "meter_no": "45067198783",
    "provider":"IE"
}
{
  "status": 200,
  "success": true,
  "message": "Success",
  "data": {
      "reference": "IE-2505305db8e15f0ab62bb6",
      "customer_name": "GALADIMA SHEHU MALAMI",
      "minimum_vend": 12920.32,
      "account_type": "NMD",
      "outstanding_debt": "361257.12",
      "address": "9 ADEYEMO STREET MAFOLUKU",
      "meter_type": "prepaid",
      "provider": "IE"
  }
}

Electricity Purchase(vending)​

This endpoint generates and sells electricity tokens.

POST
https://sandbox-api-d.squadco.com/vending/utilities/electricity

This API vends electricity tokens

Parameters

Body

reference*

Integer

Reference provided by Provider in meter LOOKUP endpoint

amount*

String

Amount of electricity to be vended

phone_number*

String

Phone number of the customer (will receive token via sms)

email*

String

Email address of the customer (will receive token via email)

Sample Request​

  {
      "phone_number": "+2347062918558",
      "amount": 13000.00,
      "email": "victor@gmail.com",
      "reference": "IE-250521ee7b7922e19965e7"
  }
{
  "status": 200,
  "success": true,
  "message": "Success",
  "data": {
      "reference": "IE-2505305db8e15f0ab62bb6",
      "amount": "13000.00",
      "merchant_amount": "12883.00",
      "phone_number": "07062918558",
      "email": "victor@gmail.com",
      "merchant_id": "SBS5B8VU36",
      "wallet_batch_id": "EUMXBV9AURZKE3LDGJRRQBNGJSAP3ZU",
      "value_reference": "26832663990919393911",
      "network": null,
      "transaction_id": null,
      "type": "electricity",
      "action": "debit",
      "status": "success",
      "meta": "{\"reference\":\"IE-2505305db8e15f0ab62bb6\",\"token\":\"26832663990919393911\",\"total_units\":\"332.35\",\"account_name\":\"GALADIMA SHEHU MALAMI\",\"account_no\":\"0102016364\",\"outstanding_debt\":\"361257.12\",\"kct\":\"\",\"meter_number\":\"45067198783\",\"receipt_number\":\"250530971742\",\"address\":\"9 ADEYEMO STREET MAFOLUKU\",\"tariff_class\":\"C-Non MD\",\"tariff_rate\":\"45.8\",\"amount_paid\":13000,\"meter_type\":\"prepaid\",\"transaction_date\":\"20250530152931\",\"vat_rate\":\"0.075\",\"balance\":\"0.00\",\"fixed_charge\":\"0\",\"reconnection_fee\":\"00\",\"loss_of_revenue\":\"0\",\"vat\":\"-2221.83\",\"cost_of_unit\":\"15221.83\",\"administrative_charge\":\"0.00\",\"installation_fee\":\"0\",\"penalty\":\"0\",\"meter_cost\":\"0.00\",\"current_charge\":\"0.00\",\"meter_service_charge\":\"0.00\",\"hp_wallet_batch_id\":\"EUMXBV9AURZKE3LDGJRR1T112YJMVXG\",\"hp_profit\":39,\"provider\":\"IE\",\"provider_meta\":{\"code\":\"IE\",\"name\":\"Ikeja Electricity\",\"total_rate_percent\":1.2,\"total_rate_cap\":1500,\"third_party_rate_percent\":0.9,\"third_party_rate_cap\":1000,\"hb_income_percent\":0.3,\"logo_url\":\"https://www.insideojodu.com/wp-content/uploads/2022/11/Ikeja-Electric-Vacancy.png\",\"type\":\"electricity\"}}",
      "meta_json": {
          "kct": "",
          "vat": "-2221.83",
          "token": "26832663990919393911",
          "address": "9 ADEYEMO STREET MAFOLUKU",
          "balance": "0.00",
          "penalty": "0",
          "provider": "IE",
          "vat_rate": "0.075",
          "hp_profit": 39,
          "reference": "IE-2505305db8e15f0ab62bb6",
          "account_no": "0102016364",
          "meter_cost": "0.00",
          "meter_type": "prepaid",
          "amount_paid": 13000,
          "tariff_rate": "45.8",
          "total_units": "332.35",
          "account_name": "GALADIMA SHEHU MALAMI",
          "cost_of_unit": "15221.83",
          "fixed_charge": "0",
          "meter_number": "45067198783",
          "tariff_class": "C-Non MD",
          "provider_meta": {
              "code": "IE",
              "name": "Ikeja Electricity",
              "type": "electricity",
              "logo_url": "https://www.insideojodu.com/wp-content/uploads/2022/11/Ikeja-Electric-Vacancy.png",
              "total_rate_cap": 1500,
              "hb_income_percent": 0.3,
              "total_rate_percent": 1.2,
              "third_party_rate_cap": 1000,
              "third_party_rate_percent": 0.9
          },
          "current_charge": "0.00",
          "receipt_number": "250530971742",
          "loss_of_revenue": "0",
          "installation_fee": "0",
          "outstanding_debt": "361257.12",
          "reconnection_fee": "00",
          "transaction_date": "20250530152931",
          "hp_wallet_batch_id": "EUMXBV9AURZKE3LDGJRR1T112YJMVXG",
          "meter_service_charge": "0.00",
          "administrative_charge": "0.00"
      },
      "createdAt": "2025-05-30T15:29:28.557Z",
      "updatedAt": "2025-05-30T15:29:32.154Z"
  }
}

Retrieve Transactions​

This endpoint allows you to retrieve and verify the details and status of your transactions.

GET
https://sandbox-api-d.squadco.com/vending/transactions

This API retrieves/verify vending

Parameters

Body

page

Integer

Page number

perPage

Integer

Number of rows per page

sorted_by

String

Sorting by creation date

date_from

date

Beginning date

date_to

date

Ending date

reference

String

Reference of specific electricity transaction


info

Please note that if you do not provide a reference value, the system will return an array of your VAS transactions.

{
  "status": 200,
  "success": true,
  "message": "Success",
  "data": {
      "reference": "IE-2505305db8e15f0ab62bb6",
      "amount": "13000.00",
      "merchant_amount": "12883.00",
      "phone_number": "07062918558",
      "email": "victor@gmail.com",
      "merchant_id": "SBS5B8VU36",
      "wallet_batch_id": "EUMXBV9AURZKE3LDGJRRQBNGJSAP3ZU",
      "value_reference": "26832663990919393911",
      "network": null,
      "transaction_id": null,
      "type": "electricity",
      "action": "debit",
      "status": "success",
      "meta": "{\"reference\":\"IE-2505305db8e15f0ab62bb6\",\"token\":\"26832663990919393911\",\"total_units\":\"332.35\",\"account_name\":\"GALADIMA SHEHU MALAMI\",\"account_no\":\"0102016364\",\"outstanding_debt\":\"361257.12\",\"kct\":\"\",\"meter_number\":\"45067198783\",\"receipt_number\":\"250530971742\",\"address\":\"9 ADEYEMO STREET MAFOLUKU\",\"tariff_class\":\"C-Non MD\",\"tariff_rate\":\"45.8\",\"amount_paid\":13000,\"meter_type\":\"prepaid\",\"transaction_date\":\"20250530152931\",\"vat_rate\":\"0.075\",\"balance\":\"0.00\",\"fixed_charge\":\"0\",\"reconnection_fee\":\"00\",\"loss_of_revenue\":\"0\",\"vat\":\"-2221.83\",\"cost_of_unit\":\"15221.83\",\"administrative_charge\":\"0.00\",\"installation_fee\":\"0\",\"penalty\":\"0\",\"meter_cost\":\"0.00\",\"current_charge\":\"0.00\",\"meter_service_charge\":\"0.00\",\"hp_wallet_batch_id\":\"EUMXBV9AURZKE3LDGJRR1T112YJMVXG\",\"hp_profit\":39,\"provider\":\"IE\",\"provider_meta\":{\"code\":\"IE\",\"name\":\"Ikeja Electricity\",\"total_rate_percent\":1.2,\"total_rate_cap\":1500,\"third_party_rate_percent\":0.9,\"third_party_rate_cap\":1000,\"hb_income_percent\":0.3,\"logo_url\":\"https://www.insideojodu.com/wp-content/uploads/2022/11/Ikeja-Electric-Vacancy.png\",\"type\":\"electricity\"}}",
      "meta_json": {
          "kct": "",
          "vat": "-2221.83",
          "token": "26832663990919393911",
          "address": "9 ADEYEMO STREET MAFOLUKU",
          "balance": "0.00",
          "penalty": "0",
          "provider": "IE",
          "vat_rate": "0.075",
          "hp_profit": 39,
          "reference": "IE-2505305db8e15f0ab62bb6",
          "account_no": "0102016364",
          "meter_cost": "0.00",
          "meter_type": "prepaid",
          "amount_paid": 13000,
          "tariff_rate": "45.8",
          "total_units": "332.35",
          "account_name": "GALADIMA SHEHU MALAMI",
          "cost_of_unit": "15221.83",
          "fixed_charge": "0",
          "meter_number": "45067198783",
          "tariff_class": "C-Non MD",
          "provider_meta": {
              "code": "IE",
              "name": "Ikeja Electricity",
              "type": "electricity",
              "logo_url": "https://www.insideojodu.com/wp-content/uploads/2022/11/Ikeja-Electric-Vacancy.png",
              "total_rate_cap": 1500,
              "hb_income_percent": 0.3,
              "total_rate_percent": 1.2,
              "third_party_rate_cap": 1000,
              "third_party_rate_percent": 0.9
          },
          "current_charge": "0.00",
          "receipt_number": "250530971742",
          "loss_of_revenue": "0",
          "installation_fee": "0",
          "outstanding_debt": "361257.12",
          "reconnection_fee": "00",
          "transaction_date": "20250530152931",
          "hp_wallet_batch_id": "EUMXBV9AURZKE3LDGJRR1T112YJMVXG",
          "meter_service_charge": "0.00",
          "administrative_charge": "0.00"
      },
      "createdAt": "2025-05-30T15:29:28.557Z",
      "updatedAt": "2025-05-30T15:29:32.154Z"
  }
}