Predict Payment Application

This request allows you to preview a payment's breakdown before it's logged and processed.


Like the name suggests, this request allows you to predict how a payment will apply to different pieces of a loan. Here's what you need to know about this request:

  • This request does not log a payment. It simply displays how the payment affects the loan.
  • This request is useful for testing if your payment will affect other payments. If this is the case, the response will include an affectedPayments object.
  • Depending on the loan's extraextra - An overpaid—or "extra"—amount made on a payment. Your Extra Towards setting will affect how this amount is applied by the system. settings, a payment amount that is larger than the scheduled payment will apply to future payments.


For information on payment database tables, see the following articles:

     "Date": "2022-03-19",
     "Amount": 250,
     "PaymentTypeId": 1,
     "Extra": "payment.extra.tx.principal",
     "chargeFeeType": "loan.cardfee.types.1",
     "chargeFeeAmount": 5,
     "chargeFeePercentage": 5


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.

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.

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