How aarohanbasnet/payflow-api works
PayFlow is a learning-focused wallet and payments API. Its main user journey is registration and email verification, followed by login, then authenticated account operations such as peer transfers or utility payments; transaction records can also be retrieved and used for invoice PDFs. The graph separates HTTP routing, identity, wallet operations, and supporting services. Relationships are based on the README and the supplied excerpts and SOURCE INDEX; unsampled route and service details are represented only where those references support them.
Main entry points: app.ts Express application · email.service.ts Email delivery · transaction.service.ts Transfers and payments · prisma.ts Relational database
Components 31
API surface
- Express application
src/app.ts - Auth routes
src/modules/auth/auth.route.ts - User routes
src/modules/user/user.routes.ts - Account routes
src/modules/account/account.route.ts - Transaction routes
src/modules/transaction/transaction.route.ts - Invoice routes
src/modules/invoice/invoice.route.ts - Request middleware
src/middlewares
Identity and users
- Auth handlers
src/modules/auth/auth.controller.ts - Authentication logic
src/modules/auth/auth.services.ts - Auth validation
src/modules/auth/auth.schema.ts - User handlers
src/modules/user/user.controller.ts - User profile and MPIN
src/modules/user/user.service.ts - User validation
src/modules/user/user.schema.ts - Identity utilities
src/utils
Wallet operations
- Account handlers
src/modules/account/account.controller.ts - Account operations
src/modules/account/account.service.ts - Account validation
src/modules/account/account.schema.ts - Transaction handlers
src/modules/transaction/transaction.controller.ts - Transfers and payments
src/modules/transaction/transaction.service.ts - Transaction validation
src/modules/transaction/transaction.schema.ts - Invoice handlers
src/modules/invoice/invoice.controller.ts - Invoice data
src/modules/invoice/invoice.service.ts - PDF generation
src/modules/invoice/pdf/invoice.pdf.ts
Supporting services
- Relational database
src/config/prisma.ts - Email delivery
src/modules/services/email/email.service.ts - Email templates
src/modules/services/email/email.template.ts - Transaction limits
src/modules/services/limit.service.ts - MPIN verification
src/modules/services/verify-mpin.service.ts - Environment settings
src/config/env.ts
Other components
- API client
- Resend
Connections 35
- API client → Express application: sends requests
src/app.ts - Express application → Auth routes: mounts routes
src/app.ts - Express application → User routes: mounts routes
src/app.ts - Express application → Account routes: mounts routes
src/app.ts - Express application → Transaction routes: mounts routes
src/app.ts - Express application → Invoice routes: mounts routes
src/app.ts - Auth routes → Auth handlers: dispatches to
src/modules/auth/auth.route.ts - Auth routes → Request middleware: uses validation and limits
src/modules/auth/auth.route.ts - User routes → User handlers: dispatches to
src/modules/user/user.routes.ts - User routes → Request middleware: authenticates and validates
src/modules/user/user.routes.ts - Auth handlers → Authentication logic: calls
src/modules/auth/auth.controller.ts - Auth handlers → Auth validation: uses input types
src/modules/auth/auth.controller.ts - Authentication logic → Relational database: reads and writes
src/modules/auth/auth.services.ts - Authentication logic → Identity utilities: uses token and credential helpers
src/modules/auth/auth.services.ts - Authentication logic → Email delivery: sends OTP email
src/modules/auth/auth.services.ts - User handlers → User profile and MPIN: calls
src/modules/user/user.controller.ts - User handlers → User validation: uses input types
src/modules/user/user.controller.ts - Account handlers → Account operations: calls
src/modules/account/account.controller.ts - Account handlers → Account validation: uses validation
src/modules/account/account.controller.ts - Account operations → Relational database: reads and writes
src/modules/account/account.service.ts - Account operations → Email delivery: uses email delivery
src/modules/account/account.service.ts - Account operations → MPIN verification: checks MPIN
src/modules/account/account.service.ts - Transaction handlers → Transfers and payments: calls
src/modules/transaction/transaction.controller.ts - Transaction handlers → Transaction validation: uses validation
src/modules/transaction/transaction.controller.ts - Transfers and payments → Relational database: reads and writes
src/modules/transaction/transaction.service.ts - Transfers and payments → Transaction limits: checks limits
src/modules/transaction/transaction.service.ts - Transfers and payments → MPIN verification: checks MPIN
src/modules/transaction/transaction.service.ts - Transfers and payments → Email delivery: sends alerts
src/modules/transaction/transaction.service.ts - Invoice handlers → Invoice data: calls
src/modules/invoice/invoice.controller.ts - Invoice handlers → PDF generation: uses PDF generation
src/modules/invoice/invoice.controller.ts - Invoice data → Relational database: reads records
src/modules/invoice/invoice.service.ts - Email delivery → Email templates: renders messages
src/modules/services/email/email.service.ts - Email delivery → Resend: sends email
src/modules/services/email/email.service.ts - Email delivery → Environment settings: reads credentials
src/modules/services/email/email.service.ts - Relational database → Environment settings: gets connection settings
src/config/prisma.ts