Edit Charge

General

Lenders use charges to include additional amounts to a loan. Charges are most commonly used to deter borrowers from making late payments. Here's what you need to know about this request:

• A charge can only be edited one time. Once a charge has been edited, it is inactivated.
• Edited charges require an editComment field. This field is used to describe why the edit was made.
• Editing a charge is different from reversing a charge. You can reverse a charge with a specific payload, and we've listed that payload in the payload examples.

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

Database

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

• Database – Charges Table (charge_entity)
• Database – Default Charges (defaults_charges)
• Database – Recurring Charge Entity (recurring_charge_entity)

{
     "Charges": {
          "results": [
               {
                    "displayId": 7332,
                    "info": "Change Due Date Fee",
                    "date": "2023-01-01",
                    "priorcutoff": false,
                    "amount": 12,
                    "chargeTypeId": 1,
                    "paidAmount": 0,
                    "paidPercent": 0,
                    "chargeApplicationType": "loan.latefeeapp.standard",
                    "interestBearing": 1,
                    "active": 1,
                    "__update": true,
                    "__id": 2674,
                    "editComment": "Clerical Error"
               }
          ]
     }
}

{
    "Charges": {
        "results": [
            {
                "editComment": "Fee Forgiveness Program",
                "active": 0,
                "isReversal": 1,
                "__update": true,
                "__id": 211
            }
        ]
    }
}

🚧

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 a bit different.

We can’t provide sample values that will work for multiple users. But, if you’d like to see a sample of a 200 response, click the response examples located under the Try It button.

To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.