Payitoff

Payitoff Documentation

Explore our guides, examples, and documentation to integrate Payitoff into your products.

We'll get you up and running in an afternoon - or we owe you a beer / mocktail!

Get Started    API Reference

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 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

Properties in bold are required fields.

Property

Type

Format

Description

account_number

string

The Borrower's account number for a Loan with a Servicer, if known.

capitalized_amount

number

float

Interest charged on a loan that is then added to the principal balance.

disbursement_dates

array

type: string
format: date

An array of dates on which funds were disbursed to a Borrower.

due_date

string

date

TODO

external_id

string

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.

guarantor

string

The entity who guarantees a loan will be paid in the event a student borrower defaults on the loan.

idr_renewal_date

string

date

The date on which an IDR plan requires income recertification.

interest_rate

number

float

The interest rate applied to a loan.

is_overdue

boolean

Is the loan currently in past due status?

last_payment

number

float

The amount of the last payment made on the loan.

last_payment_date

string

date

The date on which the last payment was made.

last_statement_balance

number

float

The total loan balance as of the last monthly statement.

last_statement_date

string

date

The date on which the last monthly statement was issued.

loan_status

string

The current status of the Loan (description or code). A complete list can be found on our Loan Statuses page.

loan_status_history

object

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.

loan_type

string

The type of loan. A complete list can be found on our Loan Types page.

maturity_date

string

date

TODO

min_payment

number

float

TODO

monthly_payment

number

float

The standard monthly payment over the course of the repayment term.

original_principal

number

float

Original principal balance when Loan entered repayment.

origination_date

string

date

The date the Loan was officially given to the borrower.

outstanding_interest

number

float

Total unpaid interest.

outstanding_principal

number

float

Total unpaid principal.

pslf_cumulative_periods

integer

int32

How many monthly payments have been made that count toward PSLF eligibility.

repayment_begin_date

string

date

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).

repayment_plan_begin_date

string

date

The date the Loan entered the current Repayment Plan.

repayment_plan_type

string

alternative
alt_graduated
alt_neg_am
alt_repaye
extended
extended_graduated
graduated
ibr
icr
isr
new_ibr
no_repayment
paye
repaye
standard

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 RepaymentPlan object.

servicer_name

string

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 about a month ago


LoanPayload


Payitoff API: LoanPayload Schema

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.