Get Paid Balance

This request pulls the paid balance of a loan between a specified date range.

   Click here to learn more about this request

This request is used to pull a breakdown of the amount paid on an account between a specified date range, and it is a useful tool when embedded within your own borrower portal or app:

• The response of this request includes total amounts for the following information:

  • Payment amount
  • Discount
  • Escrow
  • Fees
  • Interest
  • Principal

• This request uses a payload body to determine a date range. Either YYYY-MM-DD or datetime formats can be used to determine a date range.

• The response of this request returns "startDate" and "endDate" information in a Unix format. For more information, read our guide on Dates and Times ↗

Database

For information regarding loan and payment database tables, see the following articles:

• Database – Loan Table (loan_entity)
• Database – Payments (payment_entity)
• Database – Loan Status Entity (loan_status_entity)

Payload Example

{
    "startDate": "2022-01-01 07:00:00",
    "endDate": "2023-08-01 06:59:59"
}