This API can be used for Electricity Bill and Cable TV Subscription.
\nThis API has two sections in the request: message and data or errors
\nThe API make use of access token, the access token can be fetched by calling the login endpoint. This access token should be sent along the http headers whenever any endpoint that requires authentication is called.
The access_token is a Bearer token and valid for 1hour.
Status code 422 is returned for all validation error cases except token authentication error (401) or internal server/connection error (503)
http://127.0.0.1:8000/v1
This endpoint can be used for user registration
\nCall this end point to verify user email address.
\nCall this end point to resend verification code to user.
\nUse the login endpoint to get your API access token, some endpoints of the API requires the API access token
\nCall this end point to request for user password reset
\nThis endpoint enables user to reset his password
\nThe link sent to user email contains front end url in this format https://airtimeflip.com/password/reset/[user]/[token] so the email and token should be sent to this endpoint
Call this endpoint to log user out of the API
\n","urlObject":{"path":["logout"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d721605e-a964-4a72-ab41-11995cd7ec3d","name":"Logout","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Mon, 22 Jun 2020 16:00:06 GMT"},{"key":"Date","value":"Mon, 22 Jun 2020 16:00:06 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.7"},{"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"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User logged out from API successfully\"\n}"}],"_postman_id":"2f2efc34-afc1-40f0-9809-dbe74dbf3242"}],"id":"4fdf4964-6709-40db-adce-6f8808ec3b9c","description":"This section contains all authentication endpoints
\n","event":[{"listen":"prerequest","script":{"id":"b1ed980a-9bf6-48c8-8d77-c7b69beba5c3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8357848c-3c77-4730-bbd8-9dd9b04de265","type":"text/javascript","exec":[""]}}],"_postman_id":"4fdf4964-6709-40db-adce-6f8808ec3b9c"},{"name":"Users","item":[{"name":"Profile","id":"4ca0f3cf-05cf-4a26-b329-c05ee2e4fdfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{access_token}}","type":"text"}],"url":"{{url}}/user","description":"Get profile of currently logged in user
\n","urlObject":{"path":["user"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6236120d-49bc-46f7-b6be-0bce51923975","name":"Profile","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{access_token}}","type":"text"}],"url":"{{url}}/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Mon, 21 Sep 2020 21:31:29 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:31:29 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.9"},{"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"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Data retrieved successfully\",\n \"data\": {\n \"id\": 474171,\n \"first_name\": \"Umar\",\n \"last_name\": \"Farouq\",\n \"other_name\": \"Yusuf\",\n \"email\": \"umar@app.com\",\n \"phone_number\": \"08078780858\",\n \"status\": \"active\",\n \"email_verified_at\": \"2020-09-21T21:02:43.000000Z\",\n \"created_at\": \"2020-09-21T21:02:43.000000Z\",\n \"updated_at\": \"2020-09-21T21:30:20.000000Z\",\n \"full_name\": \"Farouq Umar Yusuf\"\n }\n}"}],"_postman_id":"4ca0f3cf-05cf-4a26-b329-c05ee2e4fdfd"},{"name":"Get Users","id":"9e3e3d89-5823-4e87-904c-15aad4af0aa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"{{access_token}}","type":"text"}],"url":"{{url}}/users","description":"This endpoint provides the list of all users on the system
\n","urlObject":{"path":["users"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"de2d0898-73c7-462f-9bfe-e1c75254630b","name":"Get Users Success","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"{{access_token}}","type":"text"}],"url":"{{url}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Date","value":"Mon, 21 Sep 2020 21:32:05 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:32:05 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.9"},{"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"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success.\",\n \"data\": [\n {\n \"id\": 474171,\n \"first_name\": \"Umar\",\n \"last_name\": \"Farouq\",\n \"other_name\": \"Yusuf\",\n \"email\": \"umar@app.com\",\n \"phone_number\": \"08078780858\",\n \"status\": \"active\",\n \"email_verified_at\": \"2020-09-21T21:02:43.000000Z\",\n \"created_at\": \"2020-09-21T21:02:43.000000Z\",\n \"updated_at\": \"2020-09-21T21:30:20.000000Z\",\n \"full_name\": \"Farouq Umar Yusuf\"\n },\n {\n \"id\": 743467,\n \"first_name\": \"Umar\",\n \"last_name\": \"Farouq\",\n \"other_name\": \"Yusuf\",\n \"email\": \"umar@gmail.com\",\n \"phone_number\": \"08078780859\",\n \"status\": \"active\",\n \"email_verified_at\": \"2020-09-21T21:16:25.000000Z\",\n \"created_at\": \"2020-09-21T21:09:21.000000Z\",\n \"updated_at\": \"2020-09-21T21:16:25.000000Z\",\n \"full_name\": \"Farouq Umar Yusuf\"\n }\n ]\n}"}],"_postman_id":"9e3e3d89-5823-4e87-904c-15aad4af0aa1"},{"name":"Update User","id":"4e68ee8d-879c-49ea-ac0c-573eed53275c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Yusuf\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/user","description":"This endpoint can be used to update user profile
\nUse this endpoint to update users password
\nThis consist of all endpoint for managing user profile.
\n","event":[{"listen":"prerequest","script":{"id":"95e4e412-a571-4877-b721-61fefc244a1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3bc77899-7938-4777-aea0-529281123644","type":"text/javascript","exec":[""]}}],"_postman_id":"45d9df41-5270-4c5d-99fe-c6430968d5c7"},{"name":"Services","item":[{"name":"Electricity Bill","item":[{"name":"Get Billers","id":"77f8012e-3a47-49ed-83aa-f7bcdb890961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/electricity/billers","description":"use this endpoint to get all electricity billers
\nThis endpoint allows user to verify meter number and initiate transaction
\nThis endpoint allows user to verify meter number and initiate transaction
\nElectricity Bill endpoints
\n","event":[{"listen":"prerequest","script":{"id":"b93c5af1-cef5-4bdf-b282-aa8c5744cb96","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dc58540b-8d9e-44dc-89f0-d14a1a89ed67","type":"text/javascript","exec":[""]}}],"_postman_id":"cdec74a7-1867-4762-a8dc-4e1a4181eaa1"},{"name":"DSTV","item":[{"name":"Get Provider Bouquets","id":"282c39f5-93d1-49b2-af74-2feffb35896e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/multichoice/providers","description":"This endpoint provides list of all provider bouquets for DSTV Subscription
This endpoint allows user to verify meter number and initiate transaction
\nThis endpoint enables user to purchase a cable tv subscription
\nDSTV Subscription Endpoints
\n","event":[{"listen":"prerequest","script":{"id":"11cf8687-a8be-4a50-9950-61260d1f8bba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ef940083-9eb3-40a2-96eb-7624f91e36fd","type":"text/javascript","exec":[""]}}],"_postman_id":"980737c5-aab0-45a2-9f3c-ffee1b81f52f"}],"id":"9229bd18-c6d5-4983-b14d-32d0e96631f2","description":"This section provides endpoint for Electricity Bill and Cable TV (DSTV) subscription.
This endpoint provides transaction history of a user
\nThis endpoint provides details of a single transaction
\nThis endpoint allows user to requery pending transaction
\nThis section consists of all endpoint for fetching and requerying user transactions
\n","event":[{"listen":"prerequest","script":{"id":"f7348777-7c03-4851-9a80-0552250be144","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"935909f6-68ab-489e-a563-6ae756853676","type":"text/javascript","exec":[""]}}],"_postman_id":"5d2ac714-b3e9-4c2a-a322-a0aff4bad071"}],"event":[{"listen":"prerequest","script":{"id":"198c780b-4eb7-48a2-bc06-628e1ccf9dc9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4b422ca8-9191-4d45-a54a-81531b980bdd","type":"text/javascript","exec":[""]}}]}