This request allows you to preview the effects of a Roll Payment configuration for a loan.
General
LoanPro's loan calculator offers a Roll Payment feature so you can test some basic loan terms. Here's what you need to know about this request:
- The roll payment feature will help solve payment equations by allowing you to choose a variable to solve for.
- You determine your solve parameters in the endpoint of this request.
- Your loan will need to have its setup terms completed before the roll schedule feature will work.
- This request does not save a roll payment configuration on the loan but instead simply provides a preview.
For an example of how this feature works in the UI, take a look at our Roll Payment article.
Database
For information on loan 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.
How to Interpret Your Response
The response for this request may look a bit confusing if you don't know what you're looking at. Here's an example of what the response will look like:
{ "d": { "method": "loan.rollPayment.term", "payment": 190, "solution": 58 } }The
method
field determines what value you are trying to solve for. In this instance, the calculator is solving for loan term, or the amount of payments it will take for the loan to be paid off. The ideal payment amount in this example is set at190
. Using the other terms of the loan, the calculator determines that it will take 58 months with payments of $190 to pay off the loan.