HomeGuidesAPI Reference

PortfolioRepaymentPlan

Payitoff API: PortfolioRepaymentPlan Schema

Every PortfolioLoan in repayment is on a Repayment Plan. While many of our API request payload objects and responses indicate a repayment_plan_type as a short, helpful string representation of a PortfolioLoan's current Repayment Plan, the PortfolioRepaymentPlan object provides full details.

Schema Definition

PropertyTypeFormatDescription
descriptionstringA full description of this plan.
income_driven_repaymentbooleanIs this an income-driven Repayment Plan?
typestringalternative
alt_graduated
alt_neg_am
alt_repaye
extended
extended_graduated
graduated
ibr
icr
isr
new_ibr
no_repayment
paye
repaye
standard
SAVE
The type of Repayment Plan, often used as shorthand (in all-caps) and the value you'd supply in repayment_plan_type fields, and to Nexus as the plan argument when starting the Nexus.enroll workflow.

Example

{
  "description": "Pay As You Earn Repayment Plan",
  "income_driven_repayment": true,
  "type": "paye"
}