API – Activating a Loan

General

In LoanPro, loans have both an activated and a non-activated state. You can activate a loan either in the UI, or through the API, which is explained in this article.

When you first create a loan, by default it isn’t activated. This means that the loan numbers aren’t being updated daily, and the loan functions as though it’s not aware of dates. This means that, for example, if a non-activated loan has a first payment date of October 1, 2021 and today is November 8, 2021, the loan will not know that a payment has been missed.

Non-activated loans are treated differently in other respects as well. For example, non-activated loans will not be included in the credit export.

Once a loan is activated, the numbers will be updated every day and will be included in the daily maintenance process.

Loan Activation

It is easy to activate a loan via the API. Just send a POST request to the following endpoint:

https://loanpro.simnang.com/api/public/api/1/Loans({id})/AutoPal.Activate()

Remember you'll need to replace {id} with the loan ID of the specific loan you want to activate. If you don't know the ID for the loan you want to activate, see our article on Finding Loan and Customer IDs. For this particular POST request, no payload is needed.

Your response should read as follows:

{
"d": {
"activated": true
}
}

If the loan in question is already activated, the response will come back as <false> instead of <true>.

If you want to test it out, try entering the POST request in the StackBlitz example below.

Many of our articles use StackBlitz examples like this. These examples are like a window into a REST client right here in your browser. The window is divided into two sides. Developers can use info in the editor on the left side when configuring your API integration, and the right side shows a preview of a REST client. Click 'Preview' on the bottom, and you'll only see the REST client.

The entire request is set up and connected to a demo API tenant in LMS. Just scroll down and click 'send' and you should get a 200 response. If you want to get some practice with error codes, try editing the endpoint, headers, method and payload to see what responses you get.


How did we do?


Powered by HelpDocs (opens in a new tab)