HomeGuidesAPI Reference


Payitoff API: Loan Schema

A Loan object provides the details fo a single student loan for a Borrower.


Use LoanPayload for API POST requests

When creating Loans for Borrowers via the Create Loans API endpoint, you must supply loan details in the shape of a LoanPayload.

You will receive a Loan object in the API response.

Schema Definition

account_numberstringThe Borrower's account number for a Loan with a Servicer, if known.
balance_entering_repaymentnumberfloatThe total Loan balance at the time a borrower first entered repayment.
borrower_idintegerint64The Payitoff ID of the Borrower this Loan belongs to.
created_atstringdate-timeA DateTime string indicating when this Loan was created.
disbursement_datesarraytype: string
format: date
An array of dates on which funds were disbursed to a Borrower.
external_idstringIt is possible to create Loans using data fetched from third parties, such as Plaid's Liabilities endpoint. When doing so, we recommend providing any unique identifier, such as Plaid's account_id value in the external_id property to help you keep track of which Payitoff loans correspond to the loan info you retrieve from subsequent syncs with Plaid and other products.
final_monthly_paymentnumberfloatThe amount of the final monthly payment.
guarantorstringThe entity who guarantees a loan will be paid in the event a student borrower defaults on the loan.
idintegerint64The Payitoff ID of this Loan object.
idr_renewal_datestringdateThe date on which an IDR plan requires income recertification.
interest_ratenumberfloatThe interest rate applied to a loan.
loan_statusstringThe current status of a Loan (description or code). A complete list can be found on our Loan Statuses page.
loan_status_historyobjectThe history of loan status changes.

Returns key-value pairs where the status change is the value and the date on which the status changed is the key.
loan_typestringThe type of loan. A complete list can be found on our Loan Types page.
metadataobjectadditionalProperties: trueTODO
monthly_paymentnumberfloatThe standard monthly payment over the course of the repayment term.
original_principalnumberfloatOriginal principal balance when Loan entered repayment.
origination_datestringdateThe date the Loan was officially given to the borrower.
outstanding_interestnumberfloatTotal unpaid interest.
outstanding_principalnumberfloatTotal unpaid principal.
periods_in_repaymentHow many months a Loan has been in repayment.
pslf_cumulative_periodsintegerint32How many monthly payments have been made that count toward PSLF eligibility.
repayment_begin_datestringdateThe date a borrower first entered repayment. This date could be in the future (if borrower is currently a student) or in the past (if borrower is currently or has been in repayment).
repayment_planobjectRepaymentPlanAn object describing the Loan's Repayment Plan.
repayment_plan_begin_datestringdateThe date the Loan entered the current Repayment Plan.
repayment_plan_typestringThe type of Repayment Plan. This will be the name value of the associated RepaymentPlan.
servicer_namestringThe name of the financial institution servicing the loan, to whom the borrower makes monthly payments.
total_costnumberfloatWith IDR plans, there is sometimes a "tax bomb" at the end of their repayment term—any outstanding balance is forgiven, but treated as taxable income. The total_cost field provides the sum of total_paid plus the taxes owed on that forgiven amount (which is calculated and provided in the estimated_tax_liability field). In other words, total_cost is the bottom line amount a borrower will pay to dispense of their loan on its current Repayment Plan.
updated_atstringdate-timeA DateTime string indicating when this Loan was last updated.
ytd_interest_paidnumberfloatThe total Year-to-Date interest paid.
ytd_principal_paidnumberfloatThe total Year-to-Date principal paid.


  "account_number": null,
  "balance_entering_repayment": 25664.00,
  "borrower_id": 259,
  "created_at": "2021-02-17T23:25:23.667483Z",
  "disbursement_dates": null,
  "external_id": null,
  "guarantor": null,
  "id": 676,
  "idr_renewal_date": null,
  "interest_rate": 7.08,
  "loan_status": "In Repayment",
  "loan_status_history": {},
  "loan_type": "Direct Stafford Unsubsidized Loan",
  "metadata": {},
  "monthly_payment": 300.00,
  "original_principal": 20000.00,
  "origination_date": "2019-09-22",
  "outstanding_interest": 0.00,
  "outstanding_principal": 20000.00,
  "periods_in_repayment": 0,
  "pslf_cumulative_periods": null,
  "repayment_begin_date": null,
  "repayment_plan": {
    "description": "Standard Repayment Plan",
    "idr": false,
    "name": "Standard",
    "type": "standard"
  "repayment_plan_begin_date": "2020-05-11",
  "repayment_plan_type": "Standard",
  "servicer_name": "Nelnet",
  "updated_at": "2021-02-17T23:25:23.667483Z",
  "ytd_interest_paid": null,
  "ytd_principal_paid": null