Obligations

This object represents information on the borrower's obligation for a given loan period. It also provides information on the current status of the fulfillment of the obligation vis-à-vis the amount due and the due date. The obligation is dynamically changing as a result of factors such as payments and service credits made, and the crossing over of due dates.

Get loan obligations

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

query Parameters

periodId	string Use this to limit results to a specific periodId.
status	string Use this to filter a search for obligations that are `unfulfilled` or `overdue`. Enum: "unfulfilled" "overdue"
fromDate	string <date> The first date in the range to return. The system will return any period for which period's `startDate` - `endDate` fully or partially overlap with `fromDate` - `toDate` range. Both `fromDate` and `toDate` must be passed to get all periods in the range.
toDate	string <date> The last date in the range to return. The system will return any period for which period's `startDate` - `endDate` fully or partially overlap with `fromDate` - `toDate` range. Both `fromDate` and `toDate` must be passed to get all periods in the range.
dueDate	string <date> The due date of the period. The system will return the object corresponding to the period with due date equal to `dueDate`. If no matching period is found, the system will return no results.
isOpen	boolean `true` means that the obligation is still "open" and the `obligationAmount` is not final. The obligation amount can potentially change until the period ends. `false` means that the obligation is "sealed" and the `obligationAmount` is final.

Responses

200

Success

get/people/{personId}/loans/{loanId}/obligations

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"isOverdue": true,
"overdueAmount": 0,
"daysOverdue": 0,
"obligations": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"overLimitAmount": 0,
"periodId": "string",
"dueDate": "2019-08-24",
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"isLateFeeBlockedByPyramidingConfig": false,
"migration": {"migratedOverdueAmount": 0,
"migratedOverdueRemainingAmount": 0,
"migratedDaysOverdue": 0
},
"loanGracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
},
"gracePeriod": [{"drawId": "string",
"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
}
]
}
]
}
}

Get draw obligations

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
drawId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The draw identifier.

query Parameters

periodId	string Use this to limit results to a specific periodId.
status	string Use this to filter a search for obligations that are `unfulfilled` or `overdue`. Enum: "unfulfilled" "overdue"
fromDate	string <date> The first date in the range to return. The system will return any period for which period's `startDate` - `endDate` fully or partially overlap with `fromDate` - `toDate` range. Both `fromDate` and `toDate` must be passed to get all periods in the range.
toDate	string <date> The last date in the range to return. The system will return any period for which period's `startDate` - `endDate` fully or partially overlap with `fromDate` - `toDate` range. Both `fromDate` and `toDate` must be passed to get all periods in the range.
dueDate	string <date> The due date of the period. The system will return the object corresponding to the period with due date equal to `dueDate`. If no matching period is found, the system will return no results.
isOpen	boolean `true` means that the obligation is still "open" and the `obligationAmount` is not final. The obligation amount can potentially change until the period ends. `false` means that the obligation is "sealed" and the `obligationAmount` is final.

Responses

200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/obligations

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"isOverdue": true,
"overdueAmount": 0,
"daysOverdue": 0,
"obligations": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"overLimitAmount": 0,
"periodId": "string",
"dueDate": "2019-08-24",
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"isLateFeeBlockedByPyramidingConfig": false,
"migration": {"migratedOverdueAmount": 0,
"migratedOverdueRemainingAmount": 0,
"migratedDaysOverdue": 0
},
"gracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
}
}
]
}
}

Get loan obligation by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
obligationId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The obligation object unique identifier.

Responses

200

Success

get/people/{personId}/loans/{loanId}/obligations/{obligationId}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"overLimitAmount": 0,
"periodId": "string",
"dueDate": "2019-08-24",
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"isLateFeeBlockedByPyramidingConfig": false,
"migration": {"migratedOverdueAmount": 0,
"migratedOverdueRemainingAmount": 0,
"migratedDaysOverdue": 0
},
"loanGracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
},
"gracePeriod": [{"drawId": "string",
"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
}
],
"isLocked": true
}
}

Get draw obligation by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
drawId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The draw identifier.
obligationId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The obligation object unique identifier.

Responses

200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"overLimitAmount": 0,
"periodId": "string",
"dueDate": "2019-08-24",
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"isLateFeeBlockedByPyramidingConfig": false,
"migration": {"migratedOverdueAmount": 0,
"migratedOverdueRemainingAmount": 0,
"migratedDaysOverdue": 0
},
"gracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
},
"isLocked": true
}
}

➔ Next to Periods

Request sandbox access