Loan
Payitoff API: Loan
Schema
A Loan
object provides the details fo a single student loan for a Borrower
.
Use
LoanPayload
for APIPOST
requestsWhen creating
Loans
forBorrowers
via the Create Loans API endpoint, you must supply loan details in the shape of aLoanPayload
.You will receive a
Loan
object in the API response.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
|
| The | |
|
|
| The total |
|
|
| The Payitoff ID of the |
|
|
| A |
|
|
| An array of dates on which funds were disbursed to a |
|
| It 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 | |
|
|
| The amount of the final monthly payment. |
|
| The entity who guarantees a loan will be paid in the event a student borrower defaults on the loan. | |
|
|
| The Payitoff ID of this |
|
|
| The date on which an IDR plan requires income recertification. |
|
|
| The interest rate applied to a loan. |
|
| The current status of a Loan (description or code). A complete list can be found on our Loan Statuses page. | |
|
| The 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. | |
|
| The type of loan. A complete list can be found on our Loan Types page. | |
|
|
| TODO |
|
|
| The standard monthly payment over the course of the repayment term. |
|
|
| Original principal balance when |
|
|
| The date the |
|
|
| Total unpaid interest. |
|
|
| Total unpaid principal. |
| How many months a Loan has been in repayment. | ||
|
|
| How many monthly payments have been made that count toward PSLF eligibility. |
|
|
| The 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). |
|
| An object describing the | |
|
|
| The date the |
|
| The type of Repayment Plan. This will be the | |
|
| The name of the financial institution servicing the loan, to whom the borrower makes monthly payments. | |
|
|
| With 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 |
|
|
| A |
|
|
| The total Year-to-Date interest paid. |
|
|
| The total Year-to-Date principal paid. |
Example
{
"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
}
Updated 5 months ago