Edit Recurring Charges

This request updates a recurring charge on a loan.

General

Recurring charges are used to automatically incur charges to a loan—often in the form of fees. Here's what you need to know about this request:

  • Recurring charges differ slightly from regular charges. Recurring charges are based on loan events and rules. When the criteria for a recurring charge is met, it is added to a loan.
  • Recurring charges are a tenant-level setting. These apply to all loans (if desired), and they are created by navigating to Settings > Loan > Charges > Recurring Charges. Since they're a tenant-level configuration, you can't create them via the API.
  • This request edits how a recurring charge configuration applies to the loan in question. This request does not edit how the recurring charge configuration applies to the entire tenant.

For an example of how recurring charges work within the UI, take a look at our Recurring Charges article on our help site.

Database

For information regarding charges database tables, see the following articles:

{
     "RecurrentCharges": {
          "results": [
               {
                    "fixedAmount": "10.00",
                    "status": 1,
                    "__id": 18,
                    "__update": true
               }
          ]
     }
}

📘

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—expand the object by clicking the "+" symbol and 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.

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