Skip to content
My Docs

Payment Model

PaymentModel Documentation

Overview

The PaymentModel in the MongoDB database is structured to handle payment-related data. It’s built using Mongoose, a MongoDB object modeling tool designed to work in an asynchronous environment.

Schema Details:

  • user_id: A reference to the user’s ID. This is an ObjectID linking to the users collection.
  • amount: The payment amount, stored as a Number.
  • status: The status of the payment, which can be ‘pending’, ‘complete’, or ‘failed’.
  • due_date: The date by which payment should be made.
  • date_paid: The actual date the payment was made.
  • transaction_id: A unique identifier for the transaction.
  • isRecurring: A Boolean indicating whether the payment is recurring.
  • last_payment_due_date: The due date of the last payment, applicable for recurring payments.
  • title: A String to title or describe the payment.
  • description: Detailed description of the payment.
  • billing_details: A reference to billing details, linked to a separate billing details collection.
  • currency: The currency of the payment, restricted to ‘US’ or ‘XCD’.
  • timestamps: Automatic timestamping for creation and updates, including fields createdAt and updatedAt.

Model Use

The PaymentModel is used to create, read, update, and delete payment records in the database. It supports operations related to individual and recurring payments, along with linking to relevant user and billing details.

Integration

  • Import and use this model in routes or controllers handling payment operations.
  • Ensure proper validation and error handling when performing database operations.
  • Utilize transaction_id for tracking and referencing specific transactions.

Improvements

  • Consider implementing additional validations for fields like transaction_id for uniqueness.
  • Review and update default values as necessary to align with application logic.
  • Ensure secure handling of sensitive payment information.