HomeGuidesAPI ReferenceChangelog

LoansFilePayload

Payitoff API: LoansFilePayload Schema

When using our API to Create Loans for a Borrower, you can supply a LoansFilePayload object which is and encoded MyStudentData (MSD) file.

🚧

Use LoansFilePayload 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 LoansFilePayload.

You will receive an array of Loan objects in the API response.

Schema Definition

Properties in bold are required fields.

Property

Type

Format

Description

loans

string

A Base64-encoded MyStudentData file

Example

{
  "loans": "UGF5aXRvZmYgZ2l2ZXMgYmV0dGVyIGJvcnJvd2VyIG91dGNvbWVzIQo=",
}

Did this page help you?