Add Credit

This request allows you to add a creditcredit - Transaction placed on an account to forgive portions of the debt. to an account.

General

Credits are used when a lender decides to forgive a portion of a borrower's loan. Many credits are used as promotional incentives or relief. Here's what you need to know about this request:

  • A credit differs from an advancementadvancement - Transaction placed on an account that raises the principal balance. You can log an advancement in Account Setup > Setup Tools within a loan's page.. Credits function similar to payments, and they affect loan calculations. An advancement simply increases a loan's principal balance.
  • Credits apply to the portions of a loan in the order that is determined by the paymentType in the payload.

For an example of how credits work within the UI, take a look at our Log an Advancement/Credit article on our help site.

Database

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

{
    "Credits": {
        "results": [
            {
                "resetPastDue": 1,
                "loanId": 9118,
                "date": "2022-05-06",
                "amount": "100.00",
                "paymentType": 1,
                "category": 1,
                "title": "Promo Credit"
            }
        ]
    }
}

📘

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
Authentication
Click Try It! to start a request and see the response here!