GET v1/Agency/{AgencyId}/BankAccounts

List Agency Bank Accounts

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AgencyId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of AgencyBankDTO
NameDescriptionTypeAdditional information
BankTransitNumber

Bank routing / transit code

string

Required

Matching regular expression pattern: ^\d{1,10}$

String length: inclusive between 0 and 10

AccountNumber

string

Required

Matching regular expression pattern: ^\d{1,128}$

String length: inclusive between 0 and 128

AgencyBankType

AgentBankTypeEnum

Required

EFTBankAccountType

BankAccountTypeEnum

Required

Id

Primary Id

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BankTransitNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "AgencyBankType": "Unknown",
    "EFTBankAccountType": "Unknown",
    "Id": 3
  },
  {
    "BankTransitNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "AgencyBankType": "Unknown",
    "EFTBankAccountType": "Unknown",
    "Id": 3
  }
]

application/xml, text/xml

Sample:
<ArrayOfAgencyBankDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <AgencyBankDTO>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>3</Id>
    <AccountNumber>sample string 2</AccountNumber>
    <AgencyBankType>Unknown</AgencyBankType>
    <BankTransitNumber>sample string 1</BankTransitNumber>
    <EFTBankAccountType>Unknown</EFTBankAccountType>
  </AgencyBankDTO>
  <AgencyBankDTO>
    <Expand></Expand>
    <Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
    <Id>3</Id>
    <AccountNumber>sample string 2</AccountNumber>
    <AgencyBankType>Unknown</AgencyBankType>
    <BankTransitNumber>sample string 1</BankTransitNumber>
    <EFTBankAccountType>Unknown</EFTBankAccountType>
  </AgencyBankDTO>
</ArrayOfAgencyBankDTO>