{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7ed69a69-89aa-4bdd-9996-5f3eb5634f52","name":"POS-Padi API","description":"**Postman collection for testing the POS-Padi API**\n\nPOS-Padi is a web-based POS management platform designed to give agents and business owners full control over their operations, from tracking profits and resolving disputes to managing terminals and receiving fraud alerts in real-time.\n\nThe platform tackles key problems in the informal POS sector like fraud, delayed dispute resolution, and limited cash access, by offering a smart, centralised system for real-time visibility, financial tools, and customer engagement.\n\n#### 🏗️ **Architecture**\n\nThis collection documents both backend services:\n\n- **Django Backend (Auth & Core User System)**\n    \n    Handles authentication (JWT), users, agents, customers, and company records.\n    \n- **Express Backend (Transaction Layer)**\n    \n    Handles disputes, transactions, and real-time notifications.\n    \n\nBoth services are deployed separately and consume tokens issued after login.\n\n#### 🔐 **Authentication**\n\nAll endpoints are protected and require a JWT token in the `Authorization` header:\n\n```\nAuthorization: Bearer <access_token>\n\n ```\n\nThe Django service generates Tokens upon successful login.\n\nCheck the login response for the JWT access token.\n\n#### 🌍 **Base URLs**\n\n| Service | Environment Variable | URL |\n| --- | --- | --- |\n| Django Backend | `djangoUrl` | `https://pos-padi-django-backend.onrender.com/` |\n| Express Backend | `nodeUrl` | `https://pos-padi-express-backend.onrender.com/` |\n\n---\n\n#### 📂 **Collection Features**\n\n- Grouped folders by service and functionality (e.g., `Auth`, `Customers`, `Transactions`, `Disputes`)\n    \n- Live examples and prefilled request bodies\n    \n- Tests and pre-request scripts\n    \n- Global variables: `authToken`, `djangoUrl`, `nodeUrl`\n    \n- Environment setup file for dev and production\n    \n- Visual tags for HTTP method, auth requirement, and service\n    \n\n#### 👥 **Contributors**\n\n- **Johnathan** – Django Developer\n    \n- **Anyim Ossi** – Django Developer\n    \n- **Michael Peter** – Express Developer\n    \n- **Adeyemi** – Express Developer\n    \n- **Steve** – Django Developer\n    \n- **Ogaga** – Express Developer\n    \n- **Kayode** – Express Developer\n    \n- **Sanele Skhosana** – Django Developer\n    \n- **Oyinda** – Express Developer\n    \n\n#### 📌 **Public Use & Licensing**\n\nThis API is part of the POS-Padi MVP project and is intended for **internal frontend use**, contributor collaboration, and (eventually) public developer testing under controlled environments.\n\n#### 🚀 **Supported Use Cases (MVP)**\n\n- Agent/terminal assignment\n    \n- Daily transaction tracking\n    \n- Customer profile & history\n    \n- Expense tagging & profit breakdown\n    \n- Real-time dispute logging\n    \n- Push alerts for fraud & cash low\n    \n\n---\n\nInteract securely with the POS-Padi backend.\n\n#### **QUICK START**\n\n**Log in** via the login user endpoint(Authentication folder) to generate an auth token.\n\nToken is automatically added to the collection variables.\n\n`❗Log in is required.`\n\nFollow the implementation docs.\n\n---\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"43614350","team":7474302,"collectionId":"7ed69a69-89aa-4bdd-9996-5f3eb5634f52","publishedId":"2sB2ixjZkQ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/43614350/2sB2ixjZkQ","privateUrl":"https://go.postman.co/documentation/43614350-7ed69a69-89aa-4bdd-9996-5f3eb5634f52","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Postman collection for testing the POS-Padi API\nPOS-Padi is a web-based POS management platform designed to give agents and business owners full control over their operations, from tracking profits and resolving disputes to managing terminals and receiving fraud alerts in real-time.\nThe platform tackles key problems in"},{"name":"title","value":""}],"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.10.1","publishDate":"2025-04-29T09:08:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Postman collection for testing the POS-Padi API\nPOS-Padi is a web-based POS management platform designed to give agents and business owners full control over their operations, from tracking profits and resolving disputes to managing terminals and receiving fraud alerts in real-time.\nThe platform tackles key problems in"},"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/94cba07b5399d8f421e617ade3934d391313c323f73de228b347975420bae8de","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/2sB2ixjZkQ"}