HomeGuidesAPI Reference

Enrollment

Payitoff API: Enrollment Schema

Suggest Edits

🚧

Use EnrollmentPayload to create an Enrollment

When creating Enrollment objects via API, send an EnrollmentPayload as your request body. You'll receive an Enrollment as a response.

Schema Definition

PropertyTypeFormatDescription
created_atstringdate-timeA DateTime string indicating when the Enrollment was created.
estimated_approval_datestringdateThe date on which we expect a valid Enrollment to be accepted by Servicer(s).
idintegerint64The Payitoff ID value of this Enrollment
repayment_planobjectRepaymentPlanSummaryAn object indicating what IDR Plan a Borrower is enrolling in.
statusobjectEnrollmentStatusAn object providing details on the status of this Enrollment.
uuidstringuuidA unique UUID identifier for this Enrollment.

Example

{
  "created_at": "2021-02-22T17:56:08.368Z",
  "estimated_approval_date": "2021-02-22",
  "id": 123,
  "repayment_plan": {
    "description": "Pay as You Earn",
    "type": "paye"
  },
  "status": {
    "updated_at": "2021-02-22T17:56:08.368Z",
    "description": "Enrollment Pending",
    "type": "pending"
  },
  "uuid": "df6a5264-1081-4494-bf04-ee4139ad82d3"
}

Updated 11 months ago