This request allows you to suspend the forecasted payments on a loan.
The suspend forecasted payments tool allows lenders to calculate situations such as early payoff without taking scheduled payments into account. For example, a borrower may decide to skip their next scheduled payment but pay off the entirety of their loan afterwards. Suspending the loan's forecasted payments until the payoff date will provide an accurate representation of the payoff amount. Here's what you need to know about this request:
- This request does not adjust a loan's due dates. You will need to use a Change Due Date request to do that.
- This is a POST request, but there is no payload. Instead, you will enter the necessary values into the endpoint.
- The loan used in this request must be activated.
For an example of how suspending forecasted payments works within the UI, take a look at our Suspending Payments article on our help site.
Pay special attention to the endpoint of this request.
This request does not use OData, so it's not included in the endpoint like most other LMS requests.
For information on payment database tables, see the following articles:
Try It Instructions
Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—hit Try It to send the request.
However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.