HomeGuidesAPI Reference
Guides

LoansPayload

Payitoff API: LoansPayload Schema

Suggest Edits

Whenever you create Loan objects for a Borrower using the Create Loans API endpoint, you must supply a request payload. This payload is always marked by a loans property. However, the value of that loans property may be one of two entities:

PropertyTypeFormatDescription
loansstringbytebase64-encoded MSD file as LoansFilePayload
loansarrayLoanPayloadArray of LoanPayload objects with loan attributes.

LoanPayload array example

When creating Loan objects via data collected from your Borrower, Plaid, or other source, the loans property value should be an array of LoanPayload objects with loan attributes directly:

{
  "loans": [
    {
      "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"
    },
    {
      "loan_type": "Direct Stafford Unsubsidized Loan",
      "interest_rate": 7.08,
      "outstanding_principal": 20000,
      "outstanding_interest": 0.0,
      "original_principal": 20000.00,
      "origination_date": "2019-09-22",
      "loan_status": "in repayment",
      "monthly_payment": 300,
      "servicer_name": "Navient",
      "repayment_plan_begin_date": "2020-05-11"
    }
  ]
}

LoansFilePayload example

When creating Loan objects by uploading an MSD file, the loans property value should be a base64-encoded LoansFilePayload of the MSD file itself:

{
  "loans": "iVBORw0KGgoAAAANSUhEUgAAAvwAAAUeCAYAAAACc..."
}

Updated almost 3 years ago