EnrollmentStatus
Payitoff API: EnrollmentStatus
Schema
An Enrollment
object will always include an EnrollmentStatus
object under the status
property.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
description | string | See examples below. | User-friendly string describing the EnrollmentStatus.type value. |
type | string | cancelled complete partially_submitted pending unprocessable approved needs_attention | Lowercased string describing the current status of an Enrollment . |
updated_at | string | date-time | A DateTime string value indicating when the Enrollment.status was last updated. |
Examples
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submission Cancelled",
"type": "cancelled"
}
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submission Complete. Look for a letter from your servicer confirming your updated monthly payment.",
"type": "complete"
}
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submitted to some but not yet all servicers",
"type": "partially_submitted"
}
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submission in Progress",
"type": "pending"
}
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submission Unprocessable",
"type": "unprocessable"
}
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submission Approved",
"type": "approved"
}
{
"updated_at": "2021-02-22T17:56:08.368Z",
"description": "Submission Needs Attention",
"type": "needs_attention"
}
Updated almost 3 years ago