Waiving Interest
Description
This REST API is used to waive partial or full interest (accrued not due + interest remaining) on a loan contract.
Definition
https://<domain>/services/apexrest/peer/v1/loanAccounts/waiveInterest
Parameters
The table given below provides details of the request parameters used by this web service:
Fields |
Type |
Description |
|---|---|---|
loanAccountId |
String |
|
waivedInterest |
Decimal |
This is the amount of interest to be waived. *Waived interest as a % of the total interest due but not paid can be specified, if waiver is done directly through the CL Marketplace application. |
Error Messages
When you use this web service you can receive the possible error messages as shown in the table below:
Error code |
Error Message |
System.Label |
Reason |
HTTP Status Code |
|---|---|---|---|---|
API_EXCEPTION |
Interest to be waived cannot be greater than total interest. | CL016430 | If interest waived is more than the total interest due+remaining on the contract. | 500 |
| INVALID_INPUT |
Sample Request
The sample request to be sent is as shown below:
https://na35.salesforce.com/services/apexrest/peer/v1/loanAccounts/waiveInterest
{
"loanAccountId":"a4p410000000SRZ",
"waivedInterest":45
}
Sample Response
{
"status": "SUCCESS",
"rowNumber": -1,
"response": [],
"errorNumber": 0,
"errorMessage": null,
"errorCode": "NO_ERROR",
"content": []
}