Change credit limit

Description

This web service changes the Credit Limit for a Loan Account in the Marketplace. After changing the credit limit it returns the updated Loan Account.

POST

https://<domain>/services/apexrest/peer/v1/loanAccounts/changeCreditLimit/*

The table given below provides details of the request parameters used by this web service:

Field	Type	Description
loanId*	String	This is used to identify the loan account. This should be passed in the URL as specified under the sample request. For example, /v1/loanAccounts/changeCreditLimit/<loanId\|loanName>. The field used to identify the loan account is the Loan_Id_Field__c field in Custom settings for API Configuration. Salesforce ID is used if a field is not mentioned .
transactionDate	String	Date of the transaction. If passed null then current system date is considered.
newCreditLimit	Decimal	This is the new Credit Limit for the loan. It must be a positive decimal.

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
INVALID_INPUT	Unable to parse the Request parameters.	UNABLE_PARSE_REQ_PARAMS	If error occurs while parsing request parameters.	400
INVALID_INPUT	Unknown Exception : <exception_message>	UNKNOWN_EXCEPTION	Unknown exception while parsing request parameters.	400
INVALID_INPUT	Loan Account Id is null.	LOAN_ACCOUNT_ID_NULL	Loan Account Id for Loan is not specified in the request parameters.	400
INVALID_INPUT	No parameters specified in the JSON body request.	INVALID_JSON_BODY_IN_POST_REQUEST	Empty JSON body passed in the HTTP Post Request.	400
INVALID_INPUT	Unable to find the Loan Account.	LOAN_ACCOUNT_NOT_FOUND	No record exists in the system for Loan Id (loanId) specified in the request parameters for a lending account.	400
INVALID_INPUT	Required parameter/s is/are null.	REQUIRED_PARAMETERS_NULL	If new Credit Limit is not passed in the request, then system will raise this exception.	400
INVALID_INPUT	Draw Term is not valid.	NEGATIVE_CREDIT_LIMIT	If new Credit Limit is passed but it is not a positive decimal number then system will raise this exception.	400
API_EXCEPTION	<exception_message>	Not Applicable	If any validation fails or any unexpected error occurs during the processing of the request, system will raise the exception.	500

The sample request to be sent is as shown below:

POST

https://<domain>/services/apexrest/peer/v1/loanAccounts/changeCreditLimit/loanId

Where:

Sample request to be sent

{
   "newCreditLimit":10000
}

Where:

Return response: Success if the limit is increased, failure with reason if limit is not increased

Sample response

{
   
    "status": "SUCCESS",
    "response": [],
    "errorMessage": null,
    "errorCode": "NO_ERROR",
    
}