Gordon Gichini's Blog

Designing a Robust Backend Payment System for a Business Directory Mobile App

Gordon Gichini's photo
Gordon Gichini
·

4 min read

Designing a Robust Backend Payment System for a Business Directory Mobile App

Introduction

In today's digital marketplace, efficient and secure payment systems are crucial for the success of mobile applications. This article outlines the approach and design for a backend payment system for a mobile app featuring a business directory. The app allows vendors to register their businesses and users to view these listings, with vendors required to pay for space to list their products.

Backend Design Approach

When approaching the backend design of the payment system for our mobile app, several key factors need to be considered:

  1. Microservices Architecture: Implementing a microservices architecture allows for separation of concerns and independent scaling of different components. This approach enhances maintainability and allows for easier updates and modifications to specific parts of the system without affecting others.

  2. RESTful API: Designing a RESTful API ensures standardized communication between the mobile app and backend services. This promotes ease of integration and scalability.

  3. Database Design: Utilizing a combination of relational databases (e.g., PostgreSQL) for user, business, and subscription data, and NoSQL databases (e.g., MongoDB) for product information allows for both structured data management and flexibility in product attributes.

  4. Payment Gateway Integration: Integrating with a reliable payment gateway (such as Stripe or PayPal) ensures secure and efficient payment processing.

  5. Subscription Management: Implementing a robust subscription management system capable of handling different tiers, prorations, and upgrades/downgrades is crucial for this business model.

  6. Caching: Implementing caching mechanisms (e.g., Redis) improves performance for frequently accessed data.

  7. Authentication and Authorization: Using JWT (JSON Web Tokens) for secure authentication and implementing role-based access control ensures that only authorized users can access specific parts of the system.

  8. Logging and Monitoring: Comprehensive logging and monitoring systems help track system health and user activities, crucial for maintaining and improving the system over time.

  9. Scalability: Designing the system to be horizontally scalable, using load balancers and containerization (e.g., Docker) allows for easy deployment and scaling as the user base grows.

System Design

The system design for our backend payment system can be visualized as follows:

```mermaid title="Mobile App Backend System Design" type="diagram" graph TD A[Mobile App] -->|API Requests| B[Load Balancer] B --> C[API Gateway] C --> D[Authentication Service] C --> E[User Service] C --> F[Business Service] C --> G[Product Service] C --> H[Payment Service] C --> I[Subscription Service] D --> J[(User DB)] E --> J F --> K[(Business DB)] G --> L[(Product DB)] H --> M[Payment Gateway] I --> N[(Subscription DB)] H --> O[Redis Cache] I --> O

Subscription Tiers and Edge Cases

Our mobile application offers the following subscription tiers:

  1. Starter (£1/month) - Up to 10 products
  2. Pro (£3/month) - 11-100 products
  3. Enterprise (£5/month) - Unlimited products (100+)

Additionally, for each additional branch, we charge a business £1/month.

Several edge cases could arise in this payment model. Here are some potential scenarios and how to handle them:

  1. Mid-month Tier Changes:

  2. Issue: A business upgrades or downgrades their subscription mid-month.

  3. Solution: Implement prorated billing. Calculate the remaining days in the current billing cycle and charge or credit accordingly.

  1. Product Count Fluctuations:

  2. Issue: A business frequently adds and removes products, potentially crossing tier thresholds.

  3. Solution: Implement a grace period (e.g., 7 days) before enforcing tier changes. This prevents constant tier switching for businesses near the threshold.

  1. Multiple Branches Added/Removed:

  2. Issue: A business adds or removes multiple branches in a short period.

  3. Solution: Implement batch processing for branch changes and prorate the charges accordingly.

  1. Failed Payments:

  2. Issue: A payment fails due to insufficient funds or expired card.

  3. Solution: Implement a retry mechanism with exponential backoff. Notify the user and provide a grace period before suspending the account.

  1. Seasonal Businesses:

  2. Issue: Some businesses may want to pause their subscription during off-seasons.

  3. Solution: Offer a "hibernate" option that allows businesses to pause their subscription for a small fee, maintaining their data but not appearing in searches.

  1. Exceeding Product Limits:

  2. Issue: A business on a lower tier temporarily exceeds their product limit.

  3. Solution: Implement a soft limit with a grace period. Notify the user and automatically upgrade if not addressed within the grace period.

  1. Currency Conversion:

  2. Issue: Businesses from different countries may want to pay in their local currency.

  3. Solution: Integrate with a currency conversion API and offer multiple currency options, updating exchange rates regularly.

Payment Module Implementation

The payment module has been implemented using Node.js with Express and TypeScript. The code and documentation can be found in the following GitHub repository:

Payment Module Repository

The implementation focuses on core functionality for handling subscriptions and payments, providing a solid foundation for further development.