💰 Withdrawals Module
📋 Overview
The Withdrawals module manages the withdrawal operations within the OnSpot system. This module handles the creation, tracking, processing, and management of financial withdrawal requests from user accounts.
🏗️ Module Structure
The withdrawals module consists of the following components:
📁 Controller & Routes
- Location:
src/withdrawals/withdrawals.controller.ts - Purpose: Handles HTTP endpoints for withdrawal operations
- Key Endpoints: Create, retrieve, update, and process withdrawal requests
🧠 Service & Logic
- Location:
src/withdrawals/withdrawals.service.ts - Purpose: Contains the business logic for withdrawal operations
- Features: Withdrawal validation, processing logic, status management
🗄️ Entities & Database
- Location:
src/withdrawals/entities/withdrawal.entity.ts - Purpose: Database schema and entity definitions
- Schema: Withdrawal records with amounts, status, and relationships
📝 DTOs (Data Transfer Objects)
- Location:
src/withdrawals/dto/ - Purpose: Input validation and output formatting
- Types: Creation, update, and response DTOs
🔗 Related Modules
- Users - Links withdrawals to user accounts
- Accounts - Account balance management
- Bank Accounts - Destination account information
🚀 Quick Navigation
| Component | Description | Link |
|---|---|---|
| Controller/Routes | HTTP endpoints and routing | → View Details |
| Service/Logic | Business logic implementation | → View Details |
| Entities/Database | Database schema and models | → View Details |
| DTOs | Input/output data structures | → View Details |