Clearing one time ACH
Description
This web service clears one time ACH details from a loan account.
Definition
https://<domain>/services/apexrest/peer/v1/loanAccounts/cancelOneTimeACH/*Parameters
The table given below provides details of the request parameters used by this web service:
Fields |
Type | Description |
|---|---|---|
loanId* |
String | This is the ID of the loan Account. It should be appended to the URL (For more information, see< Sample Request> given below). |
accountId* |
String | This is the ID of the loan Account. It should be appended to the URL (For more information, see< Sample Request> given below). |
sms_Token |
String | This is the ID of the loan Account. It should be appended to the URL (For more information, see< Sample Request> given below). |
sms_Unique_Id |
String | This is the ID of the loan Account. It should be appended to the URL (For more information, see< Sample Request> given below). |
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 |
|---|---|---|---|
INVALID_INPUT |
Loan Account Id is null |
LOAN_ACCOUNT_ID_NULL |
Loan Account Id (loanId) is not specified in the Request URL. |
INVALID_INPUT |
Unable to find the Loan Account |
LOAN_ACCOUNT_NOT_FOUND |
No record exists in the system for the Loan Account Id (loanId) specified in the Request URL. |
API_EXCEPTION |
You cannot Cancel/Stop ACH for a non-active loan. |
CANNOT_CANCEL_ACH_NON_ACTIVE_LOAN |
Specified loan account is not active |
API_EXCEPTION |
No Unprocessed One Time ACH transaction exists for this account. |
UNPROCESSED_OT_ACH_NOT_EXIST |
There is no unprocessed one time ACH to cancel |
API_EXCEPTION |
<exception_message> |
NA |
If any validation fails or any unexpected error occurs during the processing of the request, system will raise the exception. |
Sample request
The sample request to be sent is as shown below:
https://na11.salesforce.com/services/apexrest/peer/v1/loanAccounts/cancelOneTimeACH/LAI-00000079Sample response
This contains the modified loan account. The sample response is as shown below:
{
"status":"SUCCESS",
"response":[
],
"errorMessage":null,
"errorCode":"NO_ERROR",
"content":[
{
"attributes":{
"type":"loan__Loan_Account__c",
"url":"/services/data/v31.0/sobjects/loan__Loan_Account__c/a1WG0000000jMwRMAU"
},
"loan__OT_ACH_Drawer_Address2__c":null,
"loan__OT_ACH_Debit_Date__c":null,
"loan__OT_Borrower_ACH__c":null,
"loan__OT_ACH_Account_Type__c":null,
"loan__OT_ACH_Relationship_Type__c":null,
"loan__OT_ACH_Drawer_City__c":null,
"loan__OT_ACH_Routing_Number__c":null,
"loan__Loan_Status__c":"Active - Good Standing",
"loan__OT_ACH_Payment_Amount__c":0,
"loan__OT_ACH_Fee_Amount__c":0,
"loan__OT_ACH_Drawer_Address1__c":null,
"loan__OT_ACH_Drawer_Name__c":null,
"Id":"a1WG0000000jMwRMAU",
"loan__OT_ACH_Bank_Name__c":null,
"loan__OT_ACH_Account_Number__c":null,
"loan__OT_ACH_Drawer_Zip__c":null,
"loan__OT_ACH_Drawer_State__c":null
}
]
}