GET api/banks?abaNumber={abaNumber}&countryCode={countryCode}&active={active}&hasBankStatementFolder={hasBankStatementFolder}

GET: api/banks

Request Information

URI Parameters

Name	Description	Type	Additional information
abaNumber	Optional parameter to filter by ABA number	string	None.
countryCode	Optional parameter to filter banks by countryCode	string	None.
active	Optional parameter to filter by active, inactive or all banks	boolean	None.
hasBankStatementFolder	Optional parameter to filter which have Bank Statement Folder id	boolean	None.

Body Parameters

None.

Response Information

Resource Description

List of banks with country name and ABA numbers, filtered if params are provided

Collection of BankViewModel

Name	Description	Type	Additional information
AbaNumbers	AbaNumbers	Collection of AbaNumberViewModel	None.
BankId	BankID	integer	None.
BankName	BankName	string	None.
IsPositivePayEnabled	IsPositivePayEnabled	boolean	None.
Description	Description	string	None.
Country	Country	string	None.
CountryName	Country Code	string	None.
CountryCode	Country Code	string	None.
Active	Active	boolean	None.
InstitutionNumber	Institution Number	string	None.
BankStatementFolderId	BankStatementFolderId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "abaNumbers": [
      {
        "abaId": 1,
        "abA_Number": "sample string 2",
        "abaNumber": "sample string 3",
        "bankId": 4,
        "description": "sample string 5",
        "active": true,
        "transitNumber": {
          "id": 1,
          "transitNumber": "sample string 2",
          "abaNumberId": 3,
          "description": "sample string 4",
          "active": true
        }
      },
      {
        "abaId": 1,
        "abA_Number": "sample string 2",
        "abaNumber": "sample string 3",
        "bankId": 4,
        "description": "sample string 5",
        "active": true,
        "transitNumber": {
          "id": 1,
          "transitNumber": "sample string 2",
          "abaNumberId": 3,
          "description": "sample string 4",
          "active": true
        }
      }
    ],
    "bankId": 1,
    "bankName": "sample string 2",
    "isPositivePayEnabled": true,
    "description": "sample string 4",
    "country": "sample string 5",
    "countryName": "sample string 6",
    "countryCode": "sample string 7",
    "active": true,
    "institutionNumber": "sample string 9",
    "bankStatementFolderId": 1
  },
  {
    "abaNumbers": [
      {
        "abaId": 1,
        "abA_Number": "sample string 2",
        "abaNumber": "sample string 3",
        "bankId": 4,
        "description": "sample string 5",
        "active": true,
        "transitNumber": {
          "id": 1,
          "transitNumber": "sample string 2",
          "abaNumberId": 3,
          "description": "sample string 4",
          "active": true
        }
      },
      {
        "abaId": 1,
        "abA_Number": "sample string 2",
        "abaNumber": "sample string 3",
        "bankId": 4,
        "description": "sample string 5",
        "active": true,
        "transitNumber": {
          "id": 1,
          "transitNumber": "sample string 2",
          "abaNumberId": 3,
          "description": "sample string 4",
          "active": true
        }
      }
    ],
    "bankId": 1,
    "bankName": "sample string 2",
    "isPositivePayEnabled": true,
    "description": "sample string 4",
    "country": "sample string 5",
    "countryName": "sample string 6",
    "countryCode": "sample string 7",
    "active": true,
    "institutionNumber": "sample string 9",
    "bankStatementFolderId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfBankViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BankViewModel>
    <Active>true</Active>
    <BankId>1</BankId>
    <BankName>sample string 2</BankName>
    <BankStatementFolderId>1</BankStatementFolderId>
    <Country>sample string 5</Country>
    <CountryCode>sample string 7</CountryCode>
    <CountryName>sample string 6</CountryName>
    <Description>sample string 4</Description>
    <InstitutionNumber>sample string 9</InstitutionNumber>
    <IsPositivePayEnabled>true</IsPositivePayEnabled>
    <AbaNumbers>
      <AbaNumberViewModel>
        <ABAId>1</ABAId>
        <ABA_Number>sample string 2</ABA_Number>
        <AbaNumber>sample string 3</AbaNumber>
        <Active>true</Active>
        <BankId>4</BankId>
        <Description>sample string 5</Description>
        <TransitNumber>
          <AbaNumberId>3</AbaNumberId>
          <Active>true</Active>
          <Description>sample string 4</Description>
          <Id>1</Id>
          <TransitNumber>sample string 2</TransitNumber>
        </TransitNumber>
      </AbaNumberViewModel>
      <AbaNumberViewModel>
        <ABAId>1</ABAId>
        <ABA_Number>sample string 2</ABA_Number>
        <AbaNumber>sample string 3</AbaNumber>
        <Active>true</Active>
        <BankId>4</BankId>
        <Description>sample string 5</Description>
        <TransitNumber>
          <AbaNumberId>3</AbaNumberId>
          <Active>true</Active>
          <Description>sample string 4</Description>
          <Id>1</Id>
          <TransitNumber>sample string 2</TransitNumber>
        </TransitNumber>
      </AbaNumberViewModel>
    </AbaNumbers>
  </BankViewModel>
  <BankViewModel>
    <Active>true</Active>
    <BankId>1</BankId>
    <BankName>sample string 2</BankName>
    <BankStatementFolderId>1</BankStatementFolderId>
    <Country>sample string 5</Country>
    <CountryCode>sample string 7</CountryCode>
    <CountryName>sample string 6</CountryName>
    <Description>sample string 4</Description>
    <InstitutionNumber>sample string 9</InstitutionNumber>
    <IsPositivePayEnabled>true</IsPositivePayEnabled>
    <AbaNumbers>
      <AbaNumberViewModel>
        <ABAId>1</ABAId>
        <ABA_Number>sample string 2</ABA_Number>
        <AbaNumber>sample string 3</AbaNumber>
        <Active>true</Active>
        <BankId>4</BankId>
        <Description>sample string 5</Description>
        <TransitNumber>
          <AbaNumberId>3</AbaNumberId>
          <Active>true</Active>
          <Description>sample string 4</Description>
          <Id>1</Id>
          <TransitNumber>sample string 2</TransitNumber>
        </TransitNumber>
      </AbaNumberViewModel>
      <AbaNumberViewModel>
        <ABAId>1</ABAId>
        <ABA_Number>sample string 2</ABA_Number>
        <AbaNumber>sample string 3</AbaNumber>
        <Active>true</Active>
        <BankId>4</BankId>
        <Description>sample string 5</Description>
        <TransitNumber>
          <AbaNumberId>3</AbaNumberId>
          <Active>true</Active>
          <Description>sample string 4</Description>
          <Id>1</Id>
          <TransitNumber>sample string 2</TransitNumber>
        </TransitNumber>
      </AbaNumberViewModel>
    </AbaNumbers>
  </BankViewModel>
</ArrayOfBankViewModel>