This request is used to retrieve 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. Note the following when using this request:

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

1. Payment amount
2. Discount
3. Escrow
4. Fees
5. Interest
6. 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)

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