HomeGuidesAPI ReferenceChangelog

PortfolioRepaymentPlan

Payitoff API: PortfolioRepaymentPlan Schema

Every Loan 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 Loan's current Repayment Plan, the RepaymentPlan object provides full details.

Schema Definition

Property

Type

Format

Description

description

string

A full description of this plan.

income_driven_repayment

boolean

Is this an income-driven Repayment Plan?

type

string

alternative
alt_graduated
alt_neg_am
alt_repaye
extended
extended_graduated
graduated
ibr
icr
isr
new_ibr
no_repayment
paye
repaye
standard

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"
}

Did this page help you?