Retrieving a bank account

  • Updated

Retrieving a bank account

Description

This web service returns a Bank Account with given account usage.

Definition

GET https://<domain>/services/apexrest/peer/v1/bankAccount/*

Parameters 

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

Fields Type Description

usage*

 String

This is the account usage we want to retrieve a bank account with.

Error messages

When you post a web service, you can receive the possible error messages as shown in the table below:

Error Code Reason HTTP Status Code
<exception message> You will receive this error if 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:

GET https://na11.salesforce.com/services/apexrest/peer/v1/bankAccounts?usage=Collections Trust Account

Sample response

The sample response that you will receive is as shown below:

{
   "status":"SUCCESS",
   "response":[

   ],
   "errorCode":"NO_ERROR",
   "content":[
      {
         "attributes":{
            "type":"loan__Bank_Account__c",
            "url":"/services/data/v30.0/sobjects/loan__Bank_Account__c/a3EG000000056V8MAI"         },
         "Name":"BA-00081",
         "loan__Bank_Account_Number__c":"12345678",
         "peer__Branch_Code__c":"3422",
         "Id":"a3EG000000056V8MAI",
         "loan__Bank_Name__c":"Citi Bank"      }
   ]
}

In This Article