Enrollment
Payitoff API: Enrollment
Schema
Use
EnrollmentPayload
to create anEnrollment
When creating
Enrollment
objects via API, send anEnrollmentPayload
as your request body. You'll receive anEnrollment
as a response.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
created_at | string | date-time | A DateTime string indicating when the Enrollment was created. |
estimated_approval_date | string | date | The date on which we expect a valid Enrollment to be accepted by Servicer(s). |
id | integer | int64 | The Payitoff ID value of this Enrollment |
repayment_plan | object | RepaymentPlanSummary | An object indicating what IDR Plan a Borrower is enrolling in. |
status | object | EnrollmentStatus | An object providing details on the status of this Enrollment . |
uuid | string | uuid | A 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": "Saving on a Valuable Education",
"type": "save"
},
"status": {
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Enrollment Pending",
"type": "pending"
},
"uuid": "df6a5264-1081-4494-bf04-ee4139ad82d3"
}
Updated 4 months ago