HomeGuidesAPI Reference

MonthlyPayment

Payitoff API: MonthlyPayment Schema

A MonthlyPayment object describes both what has been retrieved from Servicer Aggregation, as well as any other pertinent information we can interpret and calculate from collected data to accurately describe each PortfolioLoan object.

Schema Definition

PropertyTypeFormatDescription
scheduled_amountstringdecimalThe scheduled monthly payment a borrower is expected to pay, as reported by their Servicer.

NOTE: As of v1.0.1, all float values are returned as decimal strings with 2-digit precision.

Example

{
  "scheduled_amount": "427.96"
}