Set Roll Payment

This request allows you to set a Roll PaymentRoll Payment - The use of a payment equation to solve for one or more loan terms by entering a specific payment amount. configuration for a loan.

General

LoanPro's loan calculator offers a Roll PaymentRoll Payment - The use of a payment equation to solve for one or more loan terms by entering a specific payment amount. 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 be inactivated to use the roll payment feature.
  • Your loan will need to have its setup terms completed before the roll schedule feature will work.

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:

{
  "amount": "195.91",
  "method": "loan.rollPayment.loanRate",
  "amountIncludes": {
    "escrow": [
      2
    ]
  }
}

📘

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",
       "submittedPayment": 190,
       "adjustedPayment": 190,
       "payment": 190,
       "solution": 4.021
     }
}

The method field determines what value you are trying to solve for. In this instance, the calculator is solving for interest rateinterest rate - Determines how quickly the unpaid balance accrues debt.. The ideal payment amount in this example is set at 190. Using the other terms of the loan, the calculator determines that a rate of 4.021% will be required for the desire payment amount.

Language
Authentication
Click Try It! to start a request and see the response here!