# B2B Recharge Portal – Full Functional & Technical Documentation --- ## 1. Introduction This document defines the **complete functional, technical, and administrative documentation** for a **B2B Recharge Portal** similar to platforms like CGRPay, RechargeCare, etc. The system is designed to support **multi-tier users**, **wallet-based transactions**, **dynamic API integration**, and **real-time recharge & bill payment services**. --- ## 2. User Roles & Hierarchy ### 2.1 User Types * **Super Admin** – Full system control * **Distributor** – Manages sub-distributors & retailers * **Sub-Distributor** – Manages retailers * **Retailer / Agent** – Performs recharges * **API User** – External system using APIs ### 2.2 Permission System Each role has permission-based access: * Recharge access * Wallet transfer * Reports * API access * Commission management --- ## 3. Services Supported ### 3.1 Recharge Services * Mobile Recharge (Prepaid / Postpaid) * DTH Recharge * Data Card * FASTag * Broadband ### 3.2 Bill Payment Services * Electricity * Water * Gas * Landline * Insurance ### 3.3 Optional Services * AEPS * Micro ATM * Payouts * PAN services --- ## 4. Wallet Management System ### 4.1 Wallet Types * Main Wallet * Credit Wallet * Commission Wallet ### 4.2 Wallet Operations * Add balance (Admin/Distributor) * Debit on recharge * Refund on failure * Auto-settlement ### 4.3 Wallet Rules * Minimum balance rules * Credit limit support * Low balance alerts --- ## 5. Commission & Margin System ### 5.1 Commission Structure * Operator-wise commission * User-level commission slabs * Percentage or flat margin ### 5.2 Multi-Level Distribution * Admin → Distributor * Distributor → Sub-Distributor * Sub-Distributor → Retailer ### 5.3 Settlement * Auto commission settlement * Monthly statements * TDS & GST ready reports --- ## 6. Recharge Flow (Standard) 1. User submits recharge request 2. Wallet balance verified 3. API routing engine triggered 4. Recharge API called 5. Status stored 6. Wallet updated 7. Callback / notification sent --- ## 7. Dynamic API Management (Core Feature) ### 7.1 API Provider Management Admin can dynamically: * Add new APIs * Update endpoints * Enable / Disable APIs * Set API priority **API Provider Fields:** * API Name * Base URL * Recharge Endpoint * Status Endpoint * Method (GET/POST) * Auth Type * API Key / Secret * Timeout * Priority --- ## 8. Operator to API Mapping Each operator can be mapped to **multiple APIs** with priority. Example: * AIRTEL → API-1 (Primary), API-2 (Fallback) * JIO → API-2 (Primary) Automatic fallback is supported. --- ## 9. Dynamic API Request Builder Each API has its own request structure. ### 9.1 Request Template Mapping Fields are dynamically mapped: * User input fields * Static API credentials * Operator codes This allows **zero-code API addition**. --- ## 10. Dynamic API Response Parser Each API response is normalized into common statuses: * SUCCESS * FAILED * PENDING Admin defines: * Success keys & values * Failure keys & values --- ## 11. Dynamic Routing Conditions API selection can be based on: * Operator * Amount * Time (day/night) * API success rate * Wallet balance Routing rules are configurable from admin panel. --- ## 12. Recharge Status Handling ### 12.1 Status Types * Success – Wallet settled * Failed – Wallet refunded * Pending – Status cron checks ### 12.2 Cron Jobs * Pending status reconciliation * API balance check * Auto refunds --- ## 13. API Services (For External Users) ### 13.1 Recharge API * Create recharge * Check status * Callback URL support ### 13.2 Authentication * API Key & Secret * IP whitelisting * Signature-based auth (optional) --- ## 14. Admin Panel Features ### 14.1 System Management * User creation & KYC * Commission setup * Wallet control * API management ### 14.2 Reports * Recharge reports * Wallet ledger * Commission reports * API performance --- ## 15. Retailer Panel Features * Quick recharge * Wallet balance * Transaction history * Commission earned * Support tickets --- ## 16. Security Features * OTP login * IP restriction * Session timeout * API request signing * Audit logs --- ## 17. Logs & Monitoring * Recharge logs * API request/response logs * Callback logs * Wallet logs --- ## 18. Notifications System * SMS alerts * Email alerts * WhatsApp alerts (optional) * Webhook callbacks --- ## 19. Technology Stack (Suggested) * Backend: Node.js / PHP / Python * Database: MySQL / PostgreSQL * Cache: Redis * Queue: RabbitMQ / Bull * Frontend: React / Vue / Blade --- ## 20. Scalability & Performance * Load balancing * Horizontal scaling * API rate limiting * Retry & timeout handling --- ## 21. Compliance & Business Rules * KYC compliance * GST & TDS reports * Data protection * Audit readiness --- ## 22. Summary This B2B Recharge Portal is a **complete financial transaction ecosystem** featuring: * Multi-level hierarchy * Wallet & commission system * Fully dynamic API engine * Admin-controlled routing & fallback * Secure & scalable architecture This document can be used as: * Product requirement document (PRD) * Developer reference * Client presentation * Audit & compliance guide ---