Paybeta API is a RESTful API that allows you to integrate bills payment services available on the platform.
\nArchitecture: REST
\nData Format: JSON
\nCommission Rate Here
\nTo register developer account click here
\nCreate your account by providing the necessary details
\nJoin our Slack community Here.
\nRequest for API access by reaching out to support@paybeta.com.ng
\nYour account manager will request for necessary documentations and KYC
\nNOTE: You must be enabled for Live before you can make live Api call to our production endpoints.
BASE URL: The base URL for the API is as seen below
\nhttps://api-service.paybeta.ng
We expose the endpoint over HTTPS and we require that Basic Authorization
header be sent with every request to the Paybeta VAS interface. The basic Authentication
requires your Paybeta.ng username (email) and password to use for the Basic Authentication
on all API calls.
Authentication Examples:
\nPHP: php.net, StackOverflow, Laravel,
\n\n\nC#.Net: C-sharp corner, microsoft.com, dontnetcentral
\nJava: Baeldung, SpringFramework
\nheaders.set('Authorization', 'Basic ' + base64.encode(username + \":\" + password));\n\nAccept: This field is required & must always be set to application/json
\nContent-Type: This field is required & must always be set to application/json
\nAuthorization: All endpoints require a Basic authentication to authorise the request.
\nBills Payment refers to all forms of utility payments online. This includes, but is not limited to, electricity, airtime, data, cable TV subscriptions, taxes, and government levies. Paybeta Bills Payment is an easy-to-integrate API product that helps software developers embed online bills payment natively into their products.
\nWith our Bills Payment API, you get instant access to 9 out of 11 Discos in Nigeria, MTN, 9Mobile, Airtel, GLO, StarTimes, DSTV, and GOTV. When live, your customers can buy credits or subscription units on your platform via our API within minutes.
\nPaybeta takes care of all the complexities and background relationships with the service providers.
\nThere are four ebills services on Paybeta Bills Payment - electricity bills, airtime, Internet data, and cable TV subscriptions.
\nFor electricity, we support Eko Disco, Jos Disco, Kano Disco, Abuja Disco, Kaduna Disco, Enugu Disco, Ikeja Disco, Ibadan Disco, Porthacourt Disco, Benin Disco and Aba Disco. We do not currently offer Yola Disco & Benin Disco at the moment.
\nFor airtime/data, we support all major telcos - MTN, Airtel, GLO and 9Mobile. For cable TV subscriptions, we support StarTimes, DSTV, and GOTV.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Get Started","slug":"get-started"},{"content":"Getting access to the APIs","slug":"getting-access-to-the-apis"},{"content":"General API information","slug":"general-api-information"},{"content":"Authentication","slug":"authentication"},{"content":"Request Headers","slug":"request-headers"},{"content":"Response Definitions","slug":"response-definitions"},{"content":"What services can you offer?","slug":"what-services-can-you-offer"}],"owner":"22654275","collectionId":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","publishedId":"2sA3BoaBRN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-20T09:47:05.000Z"},"item":[{"name":"Airtime","item":[{"name":"Providers","id":"a11ad86d-d783-49f9-94cb-d6f50d107b7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/airtime/providers","description":"Response:
\n{\n \"status\": \"successful\",\n \"message\": \"Request processed successfully.\",\n \"data\": [\n {\n \"name\": \"MTN VTU\",\n \"category\": \"airtime\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709773/Provider/VTU/800px-New-mtn-logo_wpn9qq.jpg\"\n },\n {\n \"name\": \"GLO VTU\",\n \"category\": \"airtime\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709647/Provider/VTU/glo_fpaf7m.svg\"\n },\n {\n \"name\": \"AIrtel VTU\",\n \"category\": \"airtime\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709747/Provider/VTU/airtel_qkjpk1.png\"\n },\n {\n \"name\": \"9mobile VTU\",\n \"category\": \"airtime\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709763/Provider/VTU/9mobile_iswfnh.svg\"\n }\n ]\n}\n\nThe available service are:
\nmtn_vtu
\nglo_vtu
\n9mobile_vtu
\nairtel_vtu
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","name":"PAYBETA VAS API","type":"collection"}},"urlObject":{"path":["v1","airtime","purchase"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f5e57e5b-c01b-4aa9-bfaf-5c2e1c0d23b7","name":"Purchase","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"service\": \"mtn_vtu\",\r\n \"phoneNumber\": \"08068539220\",\r\n \"amount\": 2000,\r\n \"reference\": \"1714747864\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/airtime/purchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 03 May 2024 13:27:55 GMT"},{"key":"Server","value":"Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"successful\",\n \"message\": \"Transaction successful\",\n \"data\": {\n \"reference\": \"1714742875\",\n \"amount\": 2000,\n \"chargedAmount\": 1950,\n \"commission\": 50,\n \"biller\": \"MTN AIRTIME\",\n \"customerId\": \"08068539221\",\n \"previousBalance\": 499971725,\n \"currentBalance\": 499969775,\n \"transactionDate\": \"2024-05-03 14:27:57\",\n \"transactionId\": \"1714742877672593466202420\"\n }\n}"}],"_postman_id":"ea3c2921-992f-49a9-9a65-c7d370f7b224"}],"id":"5fe9e08f-d5ef-4dae-8d6e-126034d78669","_postman_id":"5fe9e08f-d5ef-4dae-8d6e-126034d78669","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","name":"PAYBETA VAS API","type":"collection"}}},{"name":"Data Bundle","item":[{"name":"Get Providers","id":"a9794050-a42d-4fe0-bb36-aff773e05725","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/data-bundle/providers","description":"{\n \"status\": \"successful\",\n \"message\": \"Request processed successfully.\",\n \"data\": [\n {\n \"name\": \"Airtel Data\",\n \"category\": \"internet\",\n \"slug\": \"airtel-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709747/Provider/VTU/airtel_qkjpk1.png\"\n },\n {\n \"name\": \"MTN Data\",\n \"category\": \"internet\",\n \"slug\": \"mtn-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709773/Provider/VTU/800px-New-mtn-logo_wpn9qq.jpg\"\n },\n {\n \"name\": \"Glo Data\",\n \"category\": \"internet\",\n \"slug\": \"glo-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709647/Provider/VTU/glo_fpaf7m.svg\"\n },\n {\n \"name\": \"9mobile Data\",\n \"category\": \"internet\",\n \"slug\": \"9mobile-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709763/Provider/VTU/9mobile_iswfnh.svg\"\n }\n ]\n}\n\n{\n \"status\": \"successful\",\n \"message\": \"Request processed successfully.\",\n \"data\": [\n {\n \"name\": \"Airtel Data\",\n \"category\": \"internet\",\n \"slug\": \"airtel-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709747/Provider/VTU/airtel_qkjpk1.png\"\n },\n {\n \"name\": \"MTN Data\",\n \"category\": \"internet\",\n \"slug\": \"mtn-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709773/Provider/VTU/800px-New-mtn-logo_wpn9qq.jpg\"\n },\n {\n \"name\": \"Glo Data\",\n \"category\": \"internet\",\n \"slug\": \"glo-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709647/Provider/VTU/glo_fpaf7m.svg\"\n },\n {\n \"name\": \"9mobile Data\",\n \"category\": \"internet\",\n \"slug\": \"9mobile-data\",\n \"status\": true,\n \"logo\": \"https://res.cloudinary.com/paybeta/image/upload/v1713709763/Provider/VTU/9mobile_iswfnh.svg\"\n }\n ]\n}\n\nUsing a GET method, transaction status can be queried with the endpoint below:
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","name":"PAYBETA VAS API","type":"collection"}},"urlObject":{"path":["v1","transaction","query"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"97d6ebbe-1e8a-4206-958e-093b7bb59d5a","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"reference\": \"1715458530\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/transaction/query"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 May 2024 23:52:34 GMT"},{"key":"Server","value":"Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.1.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"successful\",\n \"message\": \"Your DStv Compact Plus is successful\",\n \"data\": {\n \"paymentStatus\": \"successful\",\n \"reference\": \"1715458530\",\n \"amountPaid\": \"197.99\",\n \"product\": \"DStv Compact Plus\",\n \"customerId\": \"7061084212\",\n \"transactionDate\": \"2024-05-11 21:15:40\"\n }\n}"},{"id":"11818a3e-f04a-4d41-9c40-7d2777947d89","name":"Invalid refrence","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"reference\": \"1715458530\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/transaction/query"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Sep 2024 12:37:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"Accept","value":"application/json"},{"key":"Access-Control-Allow-Methods","value":"GET, POST"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"Content-Encoding","value":"gzip"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=0AZQ6DT4IDHye0zoNydGaU3TVx%2FJ8wD5yscwxQ1Q0xk3sLuJJBMpFdEpxVSWwrkhWjxD6Y9z9H3szRteMsogQFSuyEq0hc1egTB5jMTspfoOA06H2B5TBOkSyw0gXs41kzE6EIusgZIQ\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c8b111dfc39b75a-AMS"}],"cookie":[],"responseTime":null,"body":"{\n \"statu\": \"unknown\",\n \"message\": \"Transaction not found\",\n \"data\": null\n}"},{"id":"b6e0d441-b106-4d3b-aace-1b41f2446a42","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"reference\": \"1715458530\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/transaction/query"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"reversed\",\n \"message\": \"Your DStv Compact Plus + HD/ExtraView is reversed\",\n \"data\": {\n \"paymentStatus\": \"failed\",\n \"reference\": \"1715458530\",\n \"amountPaid\": 206.85,\n \"product\": \"DStv Compact Plus + HD/ExtraView\",\n \"customerId\": \"7061084212\",\n \"transactionId\": \"17283421536669076632\",\n \"transactionDate\": \"2022-10-08 00:02:36\"\n }\n}"}],"_postman_id":"4e66c347-9b98-4314-9b20-2630a915471f"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]}},"event":[{"listen":"prerequest","script":{"id":"f7ee3fdc-5bf0-43b5-a0b1-da03b934291d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"21a89897-8941-4a3f-be2b-00e5e1b41a20","type":"text/javascript","packages":{},"exec":[""]}}]}