HomeGuidesAPI Reference

PortfolioSummary

Payitoff API: PortfolioSummary Schema

A PortfolioSummary object provides a high-level overview of the total financial impact of a borrower's entire loan portfolio.

📘

New in v1.0.5

We've revamped our Portfolio API to provide richer, more detailed information of a borrowers entire loan portfolio. All details are now grouped by the Servicers they belong to, so you can see the full picture of each servicer who holds a borrower's loans. The PortfolioSummary provides a high-level total of the entire portfolio.

Schema Definition

Property

Type

Format

Description

accrued_interest

string

decimal

The total accrued interest reported by all servicers. Included in outstanding_balance.

current_principal

string

decimal

The total outstanding principal balance owed to all servicers. Included in outstanding_balance.

outstanding_balance

string

decimal

The total outstanding balance owed to all servicers. Includes accrued_interest and current_principal.

monthly_payment

string

decimal

The total estimated monthly payment owed to all servicers. This is the total financial impact of a borrower's student loan debt.

Example

{
  "accrued_interest": "345.88",
  "current_principal": "73975.70",
  "outstanding_balance": "74321.58",
  "monthly_payment": "445.95"
}

Did this page help you?