When using our API to Create Loans for a Borrower, you can supply an
The following are the minimum required properties to successfully create
Borrowersvia the Create Loans API endpoint, you must supply loan details in the shape of a
You will receive a
Loanobject in the API response.
Properties in bold are required fields.
Borrower's account number for a Loan with a Servicer, if known.
|Interest charged on a loan that is then added to the principal balance.
|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
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.
|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
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.
|The standard monthly payment over the course of the repayment term.
|Original principal balance when
Loan entered repayment.
|The date the
Loan was officially given to the borrower.
|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
type property of a
RepaymentPlan object. However, due to disparities in how repayment plans are identified across a variety of servicers and sources, our API accepts many variations on this value and coerces them to canonical values returned as a
|The name of the financial institution servicing the loan, to whom the borrower makes monthly payments.
"loan_type": "Direct Stafford Unsubsidized Loan",
"loan_status": "in repayment",
Updated about 2 years ago