{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b4ed362f-42a6-4769-98e8-b696300743ff","name":"Ncwallet Africa API Doc","description":"## **Getting started guide**\n\n[<b>Ncwallet Africa</b>](https://www.ncwallet.africa) builds and delivers cutting-edge payment products across the African, utilizing modern financial infrastructure. We empower both individuals and businesses by offering an array of personalized and scalable financial services.\n\nFor **personal users**, we provide seamless access to bill payments, gift codes, bank transfers, and virtual card services. On the **business side**, we enable companies to open business accounts, issue sales invoices, set up payment links, store customer information, and even manage event ticketing. Our integration simplifies the ability to process payments, manage financial transactions, and extend economic growth, helping businesses tap into new customer bases both locally and internationally.\n\n#### Getting Started\n\nTo start using **Ncwallet** API, you need to:\n\n1. Sign up for a test account on the [<b>Sandbox</b>](https://www.ncwallet.africa) and once done you can proceed to going live [<b>Ncwallet Africa</b>](https://www.ncwallet.africa) Account\n    \n2. Obtain your API key\n    \n3. Test all endpoints with sandbox keys\n    \n4. Satisfied with the integration? Proceed with your UAT and once done go live\n    \n\n**Thanks.**\n\nAll requests to **Ncwallet Africa** API must be done using the web API URL below.\n\n`live Url Base: https://ncwallet.africa/api/v1/`\n\n## 1.0 Authentication Process\n\n**Ncwallet Africa** uses Bearer {{**Token**}} as the basic security protocol.\n\nTo access **Ncwallet Africa** endpoints you'd need to get **API Key** and **Transaction PIN** ready to grants you access to the service.\n\n#### **Setup sample**\n\n- It should be passed as stated below,  \n    Please use the following details for authorization in header section.  \n    **Authorization**: Your **Ncwallet Africa** API Key as Bearer  \n    **trnx_pin:** Your **Ncwallet Africa** Transaction PIN\n    \n\n#### **Error response**\n\n- If **Authorization** or **trnx_pin** is missing, wrong, malformed, or invalid, you will receive an HTTP code 400 `{\"status\": \"error\"}` failed response code.\n    \n\n#### **Request and Response Security**\n\n- Our API uses SSL encryption to ensure secure transactions\n    \n- Use HTTPS protocol to make requests\n    \n- API requests should be made in JSON format\n    \n- API responses will be in JSON format\n    \n\n#### **Rate limit**\n\n- **Ncwallet Africa** allows up to 60 API requests/sec. When you go beyond that cap, you will get an HTTP error code of 400 with json response below.  \n    `{\"status\": \"error\", \"message\": \"Limit error, wait a minute and retry.\"}`\n    \n\n### **2.0 Allowed API Operations**\n\n**Require Minimum of Tier 4 (Unregistered Business)**\n\n- **User Details:** (To get Account Information i.e username, balance, referral balance etc).\n    \n- **Get Service plan IDs:** (To get all services plan IDs for all the bills payment product).\n    \n- **(Query) Verify Transaction:** (To get all transactions history and to query each transaction with **ref_id**).\n    \n- **Bills Payment (VAS):** (To Purchase Data, Airtime, Betsite funding, Eletricity token, Cabletv sub, Send BulkSMS, Datacard, Result checker and Exam registration PIN).\n    \n- **Create Virtual Bank Account:** (To generate Bank account number for your customers, Check Payment Status, Get each and all generated Bank account numbers).\n    \n- **Bank Transfer:** (To get bank code list, verify account number and initiate bank transfer to other bank).\n    \n\n### 3.0 Services Integration explanation\n\nEach service endpoint has is own desicription for easy integration.\n\nGet all service plan IDs, i.e **Data** **plan IDs, Network IDs, CableTV plan IDs and more from** [<b>Pricing Plan ID here.</b>](https://documenter.getpostman.com/view/19369636/2sA2rB13JL#d02c4c79-e9bc-43f4-aa25-9ea0eda8c5be)\n\n#### _**Expected status response to determine the transaction status.**_\n\n> `{\"status\" == \"success\"}` \n  \n\nThis means that the transaction is successful and you have been charged, contact support if not delilevered.\n\n> `{\"status\" == \"error\"}` \n  \n\nThis means that the transaction failed and you were not been charged.\n\n> `{\"status\" == \"process\"} or other response` \n  \n\nThis means that the transaction is pending and you have been charged, kindly wait for about 5mins or reachout to our support with you transaction reference ID for confirmation.\n\n> `{\"status\" == \"refunded\"} or {status\" == \"reversed\"}` \n  \n\nThis means that the transaction was previously `success` or `process` and you were charged and now refunded, now the amount of the transaction has been reversed back to your wallet.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19369636","team":3949592,"collectionId":"b4ed362f-42a6-4769-98e8-b696300743ff","publishedId":"2sA2rB13JL","public":true,"publicUrl":"https://documenter-api.postman.tech/view/19369636/2sA2rB13JL","privateUrl":"https://go.postman.co/documentation/19369636-b4ed362f-42a6-4769-98e8-b696300743ff","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Ncwallet Africa API Documentation and guide."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/cc57c78d-7edd-4b1b-8a26-daee5b9ba3a1/TmN3YWxsZXQtQWZyaS0yLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/cc57c78d-7edd-4b1b-8a26-daee5b9ba3a1/TmN3YWxsZXQtQWZyaS0yLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-02-22T14:51:38.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Ncwallet Africa API Documentation and guide."},"logos":{"logoLight":"https://content.pstmn.io/cc57c78d-7edd-4b1b-8a26-daee5b9ba3a1/TmN3YWxsZXQtQWZyaS0yLnBuZw==","logoDark":"https://content.pstmn.io/cc57c78d-7edd-4b1b-8a26-daee5b9ba3a1/TmN3YWxsZXQtQWZyaS0yLnBuZw=="}},"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/5c9ecca2186c0d46b6d96725fdfafeb7c41e202d9f440808025fa0e05aba5c95","favicon":""},"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/2sA2rB13JL"}