{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","name":"PAYBETA VAS API","description":"<img src=\"https://content.pstmn.io/5c910037-5ac3-4913-8a1e-f27842264687/QmFubmVyLmpwZWc=\">\n\n# **Get Started**\n\nPaybeta API is a RESTful API that allows you to integrate bills payment services available on the platform.\n\n- Architecture: REST\n    \n- Data Format: JSON\n    \n- Commission Rate [Here](https://www.paybeta.ng/commissions)\n    \n\n# Getting access to the APIs\n\n### Sign up and start building\n\n- To register developer account [click here](https://www.paybeta.ng/register)\n    \n- Create your account by providing the necessary details\n    \n- Join our **Slack community** [Here](https://join.slack.com/t/paybetacommunity/shared_invite/zt-215i1gm93-tUxac83S_m3VWFTynadgOw).\n    \n- Request for **API** access by reaching out to [<b>support@paybeta.com.ng</b>](https://mailto:support@paybeta.com.ng)\n    \n- Your account manager will request for necessary documentations and **KYC**\n    \n\n# General API information\n\n**NOTE**: You must be enabled for `Live` before you can make live Api call to our production endpoints.\n\n**BASE URL:** The base URL for the API is as seen below\n\n`https://api-service.paybeta.ng`\n\n# Authentication\n\nWe expose the endpoint over **HTTPS** and we require that Basic Authorization  \nheader be sent with every request to the Paybeta VAS interface. The basic Authentication  \nrequires your [Paybeta.ng](https://www.paybeta.ng/login) _**username**_ _(email)_ and _**password**_ to use for the [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)  \non all API calls.\n\n**Authentication Examples**:\n\n**PHP**: [php.net](https://www.php.net/manual/en/features.http-auth.php), [StackOverflow, ](https://stackoverflow.com/questions/2140419/how-do-i-make-a-request-using-http-basic-authentication-with-php-curl) [Laravel,](https://laravel.com/docs/10.x/http-client#authentication)\n\n**Node**: [npmjs.com](https://www.npmjs.com/package/basic-auth), [Forgeeks](https://www.geeksforgeeks.org/basic-authentication-in-node-js-using-http-header/)\n\n**Python**: [YouTube](https://youtu.be/TMxmkHdhfr8), [FastAPI](https://fastapi.tiangolo.com/advanced/security/http-basic-auth/#simple-http-basic-auth)\n\n**C#.Net**: [C-sharp corner](https://www.c-sharpcorner.com/article/basic-authentication-with-asp-net-core-web-api-using-mysql-server/), [microsoft.com](https://learn.microsoft.com/en-us/aspnet/web-api/overview/security/basic-authentication), [dontnetcentral](https://dotnetcorecentral.com/blog/basic-authentication-client/)\n\n**Java**: [Baeldung](https://www.baeldung.com/java-httpclient-basic-auth), [SpringFramework](https://docs.spring.io/spring-security/reference/servlet/authentication/passwords/basic.html)\n\n``` javascript\nheaders.set('Authorization', 'Basic ' + base64.encode(username + \":\" + password));\n\n ```\n\n# Request Headers\n\n- **Accept**: This field is required & must always be set to application/json\n    \n- **Content-Type**: This field is required & must always be set to application/json\n    \n- **Authorization**: All endpoints require a _Basic authentication_ to authorise the request.\n    \n\n# Response Definitions\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| status | string | This can be '**successful**', '**failed**' or '**pending**' |\n| message | string | Additional details on the request status |\n| data | array | Contains relevant response data for the transaction. E.g For EPINS, it will contain the pins, for electricity, it will contain the electricity values such as token, unit, amount, etc. |\n\n### **Meet Paybeta Bill Payment:**\n\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&nbsp;](https://www.paybeta.ng/)  is an easy-to-integrate API product that helps software developers embed online bills payment natively into their products.\n\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.\n\nPaybeta takes care of all the complexities and background relationships with the service providers.\n\n<img src=\"https://content.pstmn.io/4a487b65-0f63-4e8b-86f8-8a56aa5af50f/cGF5YmV0YV9zZXJ2aWNlcy5qcGc=\">\n\n# What services can you offer?\n\nThere are four ebills services on Paybeta Bills Payment - electricity bills, airtime, Internet data, and cable TV subscriptions.\n\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.\n\nFor airtime/data, we support all major telcos - MTN, Airtel, GLO and 9Mobile. For cable TV subscriptions, we support StarTimes, DSTV, and GOTV.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"22654275","team":4165987,"collectionId":"4ac6a8f2-8b94-475d-bd69-8deb635c2786","publishedId":"2sA3BoaBRN","public":true,"publicUrl":"https://documenter-api.postman.tech/view/22654275/2sA3BoaBRN","privateUrl":"https://go.postman.co/documentation/22654275-4ac6a8f2-8b94-475d-bd69-8deb635c2786","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Utility bill payment API in Nigeria for businesses and developers."},{"name":"title","value":"Airtime VTU and Utility Bill Payment API - Paybeta"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2024-04-20T09:47:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Airtime VTU and Utility Bill Payment API - Paybeta","description":"Utility bill payment API in Nigeria for businesses and developers."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/621cc759aeac4663ac0680d78fda48f4f6a9b6cfd0d144c05ca588cad1ee197e","favicon":"https://res.cloudinary.com/postman/image/upload/v1674402712/team/lpinkookxohoe6iskjuy.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3BoaBRN"}