The OK2PAY API is a RESTFull API that allows you to integrate Buy Airtime, Data Subcription, SME/Gifting Data and Bills payment services available on the OK2PAY platform on your application.
\nServices available on the OK2PAY API include:
\nStartFragment
\nFor an updated list, please check the OK2PAY platform.
\nPlease Use this URL to get access the api
\nLive URL: https://ok2pay.ng/api/v1/
\nStartFragment
\nMake sure to use your Api Token as Bearer Token Authentication to access the API
\nEndFragment
\nCable ID
\n","type":"text/plain"},"key":"cable_id","value":"1"},{"description":{"content":"Smart Card Number
\n","type":"text/plain"},"key":"smart_card","value":"1212121212"}],"variable":[]}},"response":[],"_postman_id":"90d04dc9-2e30-46be-b059-ec1cc2c3cb4b"},{"name":"Pay Cable Subscription","id":"377b975b-1d20-4195-bb10-c63967240d72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/cable/pay?cable_id=1&smart_card=1212121212&subscription_type=renew&plan_id=1&mobile=01307366733&amount=500","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Cable ID
\n","type":"text/plain"},"key":"cable_id","value":"1"},{"description":{"content":"Smart Card Number
\n","type":"text/plain"},"key":"smart_card","value":"1212121212"},{"description":{"content":"renew Or Change
\n","type":"text/plain"},"key":"subscription_type","value":"renew"},{"description":{"content":"Plan Code
\n","type":"text/plain"},"key":"plan_id","value":"1"},{"description":{"content":"Phone Number
\n","type":"text/plain"},"key":"mobile","value":"01307366733"},{"description":{"content":"Amount of Renew or Plan Price (Amount Should be match with renew or plan price. otherwise we will topup the amount to customer account)
\n","type":"text/plain"},"key":"amount","value":"500"}],"variable":[]}},"response":[{"id":"a8a80c5e-c737-4402-bd74-a13151ee3e61","name":"Pay Cable Subscription","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/cable/pay?cable_id=1&smart_card=1212121212&subscription_type=change&plan_code=dstv-padi&mobile=01307366733&amount=500","host":["http://127.0.0.1:8000/api/v1/cable"],"path":["pay"],"query":[{"key":"cable_id","value":"1","description":"Cable ID"},{"key":"smart_card","value":"1212121212","description":"Smart Card Number"},{"key":"subscription_type","value":"change","description":"renew Or Change"},{"key":"plan_code","value":"dstv-padi","description":"Plan Code"},{"key":"mobile","value":"01307366733","description":"Phone Number "},{"key":"amount","value":"500","description":"Amount of Renew or Plan Price (Amount Should be match with renew or plan price. otherwise we will topup the amount to customer account)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Fri, 25 Mar 2022 00:58:06 GMT"},{"key":"Date","value":"Fri, 25 Mar 2022 00:58:06 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.3"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 100,\n \"status\": \"success\",\n \"message\": \"Transaction Successful\",\n \"data\": {\n \"transactions\": {\n \"tnx_status\": \"delivered\",\n \"type\": \"Cable Bill Payment\",\n \"operator\": \"dstv\",\n \"mobile\": \"01307366733\",\n \"smart_card\": \"1212121212\",\n \"smart_card_type\": null,\n \"amount\": \"500\",\n \"transactionId\": \"202203250158-0000000527\",\n \"credit_amount\": 550,\n \"fee\": 50,\n \"discount\": null\n },\n \"transactions_time\": {\n \"date_time\": \"2022-03-25 01:58:06\",\n \"timezone\": \"Africa/Lagos\"\n },\n \"request_by\": {\n \"email\": \"tomalsen2000@gmail.com\",\n \"phone\": \"01307366733\"\n }\n }\n}"},{"id":"a52fd87d-ad24-401a-a853-1a34f21ccae2","name":"Pay Cable Subscription","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/cable/pay?cable_id=1&smart_card=1212121212&subscription_type=renew&plan_id=1&mobile=01307366733&amount=500","host":["http://127.0.0.1:8000/api/v1/cable"],"path":["pay"],"query":[{"key":"cable_id","value":"1","description":"Cable ID"},{"key":"smart_card","value":"1212121212","description":"Smart Card Number"},{"key":"subscription_type","value":"renew","description":"renew Or Change"},{"key":"plan_id","value":"1","description":"Plan Code"},{"key":"mobile","value":"01307366733","description":"Phone Number "},{"key":"amount","value":"500","description":"Amount of Renew or Plan Price (Amount Should be match with renew or plan price. otherwise we will topup the amount to customer account)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Thu, 14 Apr 2022 22:23:02 GMT"},{"key":"Date","value":"Thu, 14 Apr 2022 22:23:02 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.3"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 100,\n \"status\": \"success\",\n \"message\": \"Transaction Successful\",\n \"data\": {\n \"transactions\": {\n \"tnx_status\": \"success\",\n \"type\": \"Cable Bill Payment\",\n \"operator\": \"dstv\",\n \"mobile\": \"01307366733\",\n \"smart_card\": \"1212121212\",\n \"smart_card_type\": null,\n \"amount\": \"500\",\n \"transactionId\": \"202204142323-0000000126\",\n \"credit_amount\": 600,\n \"fee\": 100,\n \"discount\": null,\n \"details\": []\n },\n \"transactions_time\": {\n \"date_time\": \"2022-04-14 23:23:02\",\n \"timezone\": \"Africa/Lagos\"\n },\n \"request_by\": {\n \"email\": \"tomalsen200@gmail.com\",\n \"phone\": \"01736744457\"\n }\n }\n}"}],"_postman_id":"377b975b-1d20-4195-bb10-c63967240d72"},{"name":"Get Electricity Operators and Id","id":"ca75d724-02dd-4822-b9c4-d59eaf9c1210","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/electricity/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Operator ID
\n","type":"text/plain"},"key":"operator_id","value":"1"},{"description":{"content":"Meter No
\n","type":"text/plain"},"key":"meter_number","value":"1010101010101"},{"description":{"content":"prepaid OR Postpaid
\n","type":"text/plain"},"key":"meter_type","value":"postpaid"}],"variable":[]}},"response":[{"id":"502006b6-8a42-4905-afe2-8e296583cb1a","name":"Electricity Meter Verify","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/electricity/verify/?operator_id=1&meter_number=1010101010101&meter_type=postpaid","host":["http://127.0.0.1:8000/api/v1/electricity"],"path":["verify",""],"query":[{"key":"operator_id","value":"1","description":"Operator Id"},{"key":"meter_number","value":"1010101010101","description":"Meter No"},{"key":"meter_type","value":"postpaid","description":"prepaid OR postpaid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Fri, 25 Mar 2022 00:28:57 GMT"},{"key":"Date","value":"Fri, 25 Mar 2022 00:28:57 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.3"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 100,\n \"status\": \"success\",\n \"massage\": \"Meter No Verified Successfully\",\n \"data\": {\n \"customer_name\": \"TESTMETER1\",\n \"meter_no\": null,\n \"address\": \"ABULE - EGBA BU ABULE\",\n \"customer_district\": \"007903312\",\n \"meter_type\": \"POSTPAID\"\n }\n}"}],"_postman_id":"e558dd3f-3ab9-4630-a2e6-67c5fb6a6de5"},{"name":"Pay Electricity Bill","id":"9450a54d-2abe-4825-a4ad-4819f225b473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/electricity/pay/?operator_id=1&meter_number=1111111111111&meter_type=prepaid&amount=500&mobile=01307366733&request_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Operator ID
\n","type":"text/plain"},"key":"operator_id","value":"1"},{"description":{"content":"Meter Number
\n","type":"text/plain"},"key":"meter_number","value":"1111111111111"},{"description":{"content":"prepaid OR postpaid
\n","type":"text/plain"},"key":"meter_type","value":"prepaid"},{"description":{"content":"Amount
\n","type":"text/plain"},"key":"amount","value":"500"},{"description":{"content":"Mobile Number
\n","type":"text/plain"},"key":"mobile","value":"01307366733"},{"description":{"content":"a Unique request id of current time stamp
\n","type":"text/plain"},"key":"request_id","value":null}],"variable":[]}},"response":[{"id":"37c080a3-e6d6-437e-9caa-185b7123cfc8","name":"Pay Electricity Bill","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/electricity/pay/?operator_id=1&meter_number=1010101010101&meter_type=postpaid&amount=500&mobile=01307366733","host":["http://127.0.0.1:8000/api/v1/electricity"],"path":["pay",""],"query":[{"key":"operator_id","value":"1"},{"key":"meter_number","value":"1010101010101"},{"key":"meter_type","value":"postpaid"},{"key":"amount","value":"500"},{"key":"mobile","value":"01307366733"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Fri, 25 Mar 2022 00:30:19 GMT"},{"key":"Date","value":"Fri, 25 Mar 2022 00:30:19 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.3"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 100,\n \"status\": \"success\",\n \"message\": \"Transaction Successful\",\n \"data\": {\n \"transactions\": {\n \"tnx_status\": \"delivered\",\n \"type\": \"Electricity Bill Payment\",\n \"operator\": \"ikeja-electric\",\n \"mobile\": \"01307366733\",\n \"meter_no\": \"1010101010101\",\n \"meter_type\": \"postpaid\",\n \"amount\": \"500\",\n \"transactionId\": \"202203250130-0000000513\",\n \"credit_amount\": 550,\n \"fee\": 50,\n \"discount\": null\n },\n \"transactions_time\": {\n \"date_time\": \"2022-03-25 01:30:19\",\n \"timezone\": \"Africa/Lagos\"\n },\n \"request_by\": {\n \"email\": \"tomalsen2000@gmail.com\",\n \"phone\": \"01307366733\"\n }\n }\n}"}],"_postman_id":"9450a54d-2abe-4825-a4ad-4819f225b473"}],"id":"a4ba4ce0-d456-4db5-aefa-d78062e43d11","_postman_id":"a4ba4ce0-d456-4db5-aefa-d78062e43d11","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"