Clearing recurring ACH

  • Updated

Clearing recurring ACH

Description

This web service stops Recurring ACH for a loan payment.

Definition

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

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 (as shown below in the Sample Request).

accountId   

String

This is ID of the borrower account and is a parameter related to SMS verification. It is ignored, if SMS verification is disabled.

sms_Token

String

This is the SMS Token to be verified and is a parameter related to SMS verification. It is ignored, if SMS verification is disabled.

sms_Unique_Id

String

This is the unique Id related to SMS token and is a parameter related to SMS verification. It is ignored, if SMS verification is disabled.

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

INVALID_INPUT

Loan Account Id is null

LOAN_ACCOUNT_ID_NULL

Loan Account ID (loanId) is not specified in the Request URL.

400

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.

400

API_EXCEPTION

You cannot Cancel/Stop ACH for a non-active loan.

CANNOT_CANCEL_ACH_NON_ACTIVE_LOAN

The specified loan account is not active

500

API_EXCEPTION

No Recurring ACH is setup on this account.

RECUR_ACH_SETUP_NOT_EXIST

There is no recurring ACH on the specified loan account

500

API_EXCEPTION

<exception_message>

NA

If any validation fails or any unexpected error occurs during the processing of the request, the system will raise the exception.

500

Sample request

The sample request to be sent is as shown below:

https://na11.salesforce.com/services/apexrest/peer/v1/loanAccounts/stopRecurringACH/LAI-00000079

Sample response

This sample response contains the payments between the specified dates for the given loan account. The sample response that you will receive 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__Borrower_ACH__c":null,
         "loan__Ach_Debit_Day__c":null,
         "loan__ACH_Account_Type__c":null,
         "loan__ACH_Bank_Name__c":null,
         "loan__ACH_Debit_Amount__c":0,
         "loan__ACH_Frequency__c":null,
         "loan__ACH_On__c":false,
         "loan__ACH_Account_Number__c":null,
         "loan__ACH_Start_Date__c":null,
         "loan__ACH_Routing_Number__c":null,
         "loan__Loan_Status__c":"Active - Good Standing",
         "loan__ACH_End_Date__c":null,
         "loan__ACH_Next_Debit_Date__c":null,
         "loan__ACH_Relationship_Type__c":null,
         "Id":"a1WG0000000jMwRMAU",
         "loan__ACH_Drawer_Name__c":null
      }
   ]
}

In This Article