API – Roll Payment


This article is going to go over roll payment in the API.

Preview Roll Payment

To preview a roll payment, send a GET request to:

  • “<id>” – The ID of the target loan
  • “<amount>” – The target payment amount
  • “<method>” – The method to use (discussed below)

Set Roll Payment

To roll a payment for a loan, send a POST request to the following URL:

  • “<id>”  – The ID of the loan

The body is formatted as follows:

  "amount": "100.00",
  "method": "loan.rollPayment.loanRate",
  "amountIncludes": {
    "escrow": [
  • amount – The target payment amount
  • method – The method for rolling the payment, formatted “loan.rollPayment.<method>” for loans, and “loan.rollPaymentLease.<method>” for leases. The values for <method> are:
    • Loans:
      • fee – Change Underwriting/Refinance Fee
      • loanRate – Change interest rate
      • term – Change Whole Term (term as a whole number)
      • termExact – Change term (includes partial terms)
    • Lease:
      • loanRate – Change interest rate
      • termExact – Change term (includes partial terms)
  • amountIncludes – Add an array labelled “escrow” with any escrows to include in the payment calculation

How did we do?

Powered by HelpDocs (opens in a new tab)