LoanPayload
Payitoff API: LoanPayload
Schema
When using our API to Create Loans for a Borrower, you can supply an array
of LoanPayload
objects.
The following are the minimum required properties to successfully create Loans
:
interest_rate
loan_type
original_principal
origination_date
outstanding_interest
outstanding_principal
servicer_name
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
Properties in bold are required fields.
Property | Type | Format | Description |
---|---|---|---|
|
| The | |
|
|
| Interest charged on a loan that is then added to the principal balance. |
|
|
| An array of dates on which funds were disbursed to a |
|
|
| TODO |
|
| 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 entity who guarantees a loan will be paid in the event a student borrower defaults on the loan. | |
|
|
| The date on which an IDR plan requires income recertification. |
|
|
| The interest rate applied to a loan. |
|
| Is the loan currently in past due status? | |
|
|
| The amount of the last payment made on the loan. |
|
|
| The date on which the last payment was made. |
|
|
| The total loan balance as of the last monthly statement. |
|
|
| The date on which the last monthly statement was issued. |
|
| The current status of the | |
|
| 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 |
|
|
| 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 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). |
|
|
| The date the Loan entered the current Repayment Plan. |
|
|
| The type of Repayment Plan. Preferred values for this property are the enumerated values of the |
|
| The name of the financial institution servicing the loan, to whom the borrower makes monthly payments. |
Example
{
"loan_type": "Direct Stafford Unsubsidized Loan",
"interest_rate": 7.08,
"outstanding_principal": 20000.00,
"outstanding_interest": 0.0,
"original_principal": 20000.00,
"origination_date": "2019-09-22",
"servicer_name": "Nelnet",
"loan_status": "in repayment",
"monthly_payment": 300,
"repayment_plan_begin_date": "2020-05-11"
}
Updated 9 months ago