⚡Electricity

Note: all requests should have your API Token as a bearer token in authorization header. Content-Type application/json

We have eleven different services on Electricity with following Service codes

SN	Service Code	Service Name
1	BPE-NGCABABB-OR	Abuja Postpaid
2	BPE-NGCABABA-OR	Abuja Prepaid
3	BPE-NGEK-OR	Eko PHCN
4	BPE-NGEN-OR	Enugu Distribution
5	BPE-NGIB-OR	Ibadan Distribution
6	BPE-NGIE-OR	Ikeja Electric
7	BPE-NGKD-OR	Kaduna Electric
8	BPE-NGCAAVC-OR	Kano Postpaid
9	BPE-NGCAAVB-OR	Kano Prepaid
10	BPE-NGCABIB-OR	Port Harcourt Postpaid
11	BPE-NGCABIA-OR	Port Harcourt Prepaid

Account Validation

POST http://epayment.com.ng/epayment/api/3pelectricity_validate

Headers

Name	Type	Description
Bearer Token*	String	your-api-token

Request Body

Name	Type	Description
Body*	String	{ "service":"BPE-NGCABABA-OR", "customer_reference":"B10012 3", "meter":"45056459105"}

200: OK {"name":"Mr Kola Idiaro","address":"BLK C30 1 N CRESCENT OPP Und St. Trade More","number":"45036537814","disco":"AEDC","minAmount":" 600.0000"}

{
    // Response
}

Vend Electricity

POST http://epayment.com.ng/epayment/api/3pelectricity_vend

Headers

Name	Type	Description
Bearer Token*	String	your-api-token

Request Body

Name	Type	Description
Body*	String	{ "service":"BPE-NGCABABA-OR", "meter":"45056459105", "customer_reference":"100123 ", "amount":"600"}

200: OK {"_id":"605db9767f0e4f023173e207","updatedAt":"2021-03-26T10:37:52.094Z","createdAt":"2021- 03- 26T10:37:42.465Z","exec_agent":null,"exec_ip":"192.241.155.216","exec_by":"6057a9cd8e91c40269 ee1cb9","test":false,"operator_reference":"4b601310-8e1f-11eb-a683- 176daa8e08be","client_apireqbody":"{\"meter\":\"45056459105\",\"product_id\":\"BPE-NGCABABA- OR\",\"denomination\":\"600\",\"customer_reference\":\"1542- 494846\"}","app_host":"gra46","subtype":"electricity","type":"billpay","channel":"api","opera tor_name":"Abuja Prepaid","country":"Nigeria","customer_reference":"5e2619dae30f4873ae91148f#1542- 494846","paid_currency":"NGN","paid_amount":591,"topup_currency":"NGN","topup_amount":600,"ta rget":"45056459105","txkey":"213261137410461111","state":"fin","wholesaler":"586d78cfb7746627 5ba0bd2d","account":"5e2619dae30f4873ae91148f","product_id":"BPE-NGCABABA- OR","__v":2,"wh_com":-9,"client_apiresponse":"{\"status\":201,\"message\":\"Operation Successful, Recharge created, Reference : 4b601310-8e1f-11eb-a683-176daa8e08be\",\"reference\":\"4b601310-8e1f-11eb-a683- 176daa8e08be\",\"code\":\"RECHARGE_COMPLETE\",\"paid_amount\":591,\"paid_currency\":\"NGN\",\ "topup_amount\":600,\"topup_currency\":\"NGN\",\"target\":\"45056459105\",\"product_id\":\"BP E-NGCABABA-OR\",\"time\":\"2021-03- 26T10:37:52.094Z\",\"country\":\"Nigeria\",\"operator_name\":\"Abuja Prepaid\",\"completed_in\":10262,\"customer_reference\":\"1542- 494846\",\"pin_based\":true,\"pin_code\":\"11726918305519546894\",\"pin_option1\":\"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; \"}","code":"RECHARGE_COMPLETE","completed_in":10262,"message":"Operation Successful","pin_based":true,"pin_code":"11726918305519546894","pin_option1":"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; ","success":true,"ws_host":"210326954352","custom_details":[],"related_transactions":["605db9 757f0e4f023173e206","605db9807f0e4f023173e209","605db9767f0e4f023173e207"],"time":"2021-03- 26T10:37:42.464Z"}

201: Created {"_id":"605db9767f0e4f023173e207","updatedAt":"2021-03-26T10:37:52.094Z","createdAt":"2021- 03- 26T10:37:42.465Z","exec_agent":null,"exec_ip":"192.241.155.216","exec_by":"6057a9cd8e91c40269 ee1cb9","test":false,"operator_reference":"4b601310-8e1f-11eb-a683- 176daa8e08be","client_apireqbody":"{\"meter\":\"45056459105\",\"product_id\":\"BPE-NGCABABA- OR\",\"denomination\":\"600\",\"customer_reference\":\"1542- 494846\"}","app_host":"gra46","subtype":"electricity","type":"billpay","channel":"api","opera tor_name":"Abuja Prepaid","country":"Nigeria","customer_reference":"5e2619dae30f4873ae91148f#1542- 494846","paid_currency":"NGN","paid_amount":591,"topup_currency":"NGN","topup_amount":600,"ta rget":"45056459105","txkey":"213261137410461111","state":"fin","wholesaler":"586d78cfb7746627 5ba0bd2d","account":"5e2619dae30f4873ae91148f","product_id":"BPE-NGCABABA- OR","__v":2,"wh_com":-9,"client_apiresponse":"{\"status\":201,\"message\":\"Operation Successful, Recharge created, Reference : 4b601310-8e1f-11eb-a683-176daa8e08be\",\"reference\":\"4b601310-8e1f-11eb-a683- 176daa8e08be\",\"code\":\"RECHARGE_COMPLETE\",\"paid_amount\":591,\"paid_currency\":\"NGN\",\ "topup_amount\":600,\"topup_currency\":\"NGN\",\"target\":\"45056459105\",\"product_id\":\"BP E-NGCABABA-OR\",\"time\":\"2021-03- 26T10:37:52.094Z\",\"country\":\"Nigeria\",\"operator_name\":\"Abuja Prepaid\",\"completed_in\":10262,\"customer_reference\":\"1542- 494846\",\"pin_based\":true,\"pin_code\":\"11726918305519546894\",\"pin_option1\":\"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; \"}","code":"RECHARGE_COMPLETE","completed_in":10262,"message":"Operation Successful","pin_based":true,"pin_code":"11726918305519546894","pin_option1":"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; ","success":true,"ws_host":"210326954352","custom_details":[],"related_transactions":["605db9 757f0e4f023173e206","605db9807f0e4f023173e209","605db9767f0e4f023173e207"],"time":"2021-03- 26T10:37:42.464Z"}

{
    // Response
}

Verify Completed Electricity Vending

POST http://epayment.com.ng/epayment/api/3pelectricity_verify

Headers

Name	Type	Description
Bearer Token*	String	your-api-token

Request Body

Name	Type	Description
Body*	String	{ "customer_reference":"100123" }

200: OK {"_id":"605db9767f0e4f023173e207","updatedAt":"2021-03-26T10:37:52.094Z","createdAt":"2021- 03- 26T10:37:42.465Z","exec_agent":null,"exec_ip":"192.241.155.216","exec_by":"6057a9cd8e91c40269 ee1cb9","test":false,"operator_reference":"4b601310-8e1f-11eb-a683- 176daa8e08be","client_apireqbody":"{\"meter\":\"45056459105\",\"product_id\":\"BPE-NGCABABA- OR\",\"denomination\":\"600\",\"customer_reference\":\"1542- 494846\"}","app_host":"gra46","subtype":"electricity","type":"billpay","channel":"api","opera tor_name":"Abuja Prepaid","country":"Nigeria","customer_reference":"5e2619dae30f4873ae91148f#1542- 494846","paid_currency":"NGN","paid_amount":591,"topup_currency":"NGN","topup_amount":600,"ta rget":"45056459105","txkey":"213261137410461111","state":"fin","wholesaler":"586d78cfb7746627 5ba0bd2d","account":"5e2619dae30f4873ae91148f","product_id":"BPE-NGCABABA- OR","__v":2,"wh_com":-9,"client_apiresponse":"{\"status\":201,\"message\":\"Operation Successful, Recharge created, Reference : 4b601310-8e1f-11eb-a683-176daa8e08be\",\"reference\":\"4b601310-8e1f-11eb-a683- 176daa8e08be\",\"code\":\"RECHARGE_COMPLETE\",\"paid_amount\":591,\"paid_currency\":\"NGN\",\ "topup_amount\":600,\"topup_currency\":\"NGN\",\"target\":\"45056459105\",\"product_id\":\"BP E-NGCABABA-OR\",\"time\":\"2021-03- 26T10:37:52.094Z\",\"country\":\"Nigeria\",\"operator_name\":\"Abuja Prepaid\",\"completed_in\":10262,\"customer_reference\":\"1542- 494846\",\"pin_based\":true,\"pin_code\":\"11726918305519546894\",\"pin_option1\":\"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; \"}","code":"RECHARGE_COMPLETE","completed_in":10262,"message":"Operation Successful","pin_based":true,"pin_code":"11726918305519546894","pin_option1":"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; ","success":true,"ws_host":"210326954352","custom_details":[],"related_transactions":["605db9 757f0e4f023173e206","605db9807f0e4f023173e209","605db9767f0e4f023173e207"],"time":"2021-03- 26T10:37:42.464Z"}

{
    // Response
}

201: Created {"_id":"605db9767f0e4f023173e207","updatedAt":"2021-03-26T10:37:52.094Z","createdAt":"2021- 03- 26T10:37:42.465Z","exec_agent":null,"exec_ip":"192.241.155.216","exec_by":"6057a9cd8e91c40269 ee1cb9","test":false,"operator_reference":"4b601310-8e1f-11eb-a683- 176daa8e08be","client_apireqbody":"{\"meter\":\"45056459105\",\"product_id\":\"BPE-NGCABABA- OR\",\"denomination\":\"600\",\"customer_reference\":\"1542- 494846\"}","app_host":"gra46","subtype":"electricity","type":"billpay","channel":"api","opera tor_name":"Abuja Prepaid","country":"Nigeria","customer_reference":"5e2619dae30f4873ae91148f#1542- 494846","paid_currency":"NGN","paid_amount":591,"topup_currency":"NGN","topup_amount":600,"ta rget":"45056459105","txkey":"213261137410461111","state":"fin","wholesaler":"586d78cfb7746627 5ba0bd2d","account":"5e2619dae30f4873ae91148f","product_id":"BPE-NGCABABA- OR","__v":2,"wh_com":-9,"client_apiresponse":"{\"status\":201,\"message\":\"Operation Successful, Recharge created, Reference : 4b601310-8e1f-11eb-a683-176daa8e08be\",\"reference\":\"4b601310-8e1f-11eb-a683- 176daa8e08be\",\"code\":\"RECHARGE_COMPLETE\",\"paid_amount\":591,\"paid_currency\":\"NGN\",\ "topup_amount\":600,\"topup_currency\":\"NGN\",\"target\":\"45056459105\",\"product_id\":\"BP E-NGCABABA-OR\",\"time\":\"2021-03- 26T10:37:52.094Z\",\"country\":\"Nigeria\",\"operator_name\":\"Abuja Prepaid\",\"completed_in\":10262,\"customer_reference\":\"1542- 494846\",\"pin_based\":true,\"pin_code\":\"11726918305519546894\",\"pin_option1\":\"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; \"}","code":"RECHARGE_COMPLETE","completed_in":10262,"message":"Operation Successful","pin_based":true,"pin_code":"11726918305519546894","pin_option1":"Token: 11726918305519546894; Units : 13.4Kwh; Debt Amount : N/A; Debt Remaining : N/A; Recept No: 210326954352; ","success":true,"ws_host":"210326954352","custom_details":[],"related_transactions":["605db9 757f0e4f023173e206","605db9807f0e4f023173e209","605db9767f0e4f023173e207"],"time":"2021-03- 26T10:37:42.464Z"}

{
    // Response
}