Get Paid Balance

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

 Click here to learn more about pulling paid balances

Pulling Paid Balance Information

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. Here's what you need to know about this request:

  • 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:

{
    "startDate": "2022-01-01 07:00:00",
    "endDate": "2023-08-01 06:59:59"
}
Language
Authorization
Click Try It! to start a request and see the response here!