GET api/banks/{id}/details

Get Bank Details By ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

BankID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Bank

BankDetailViewModel
NameDescriptionTypeAdditional information
AbaNumbers

AbaNumbers

Collection of AbaNumberDetailViewModel

None.

ATB

Automated Transaction Bank

AutomatedTransactionalBankViewModel

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": [
    {
      "isAssignedToBankCode": true,
      "abaId": 2,
      "abA_Number": "sample string 3",
      "abaNumber": "sample string 4",
      "bankId": 5,
      "description": "sample string 6",
      "active": true,
      "transitNumber": {
        "id": 1,
        "transitNumber": "sample string 2",
        "abaNumberId": 3,
        "description": "sample string 4",
        "active": true
      }
    },
    {
      "isAssignedToBankCode": true,
      "abaId": 2,
      "abA_Number": "sample string 3",
      "abaNumber": "sample string 4",
      "bankId": 5,
      "description": "sample string 6",
      "active": true,
      "transitNumber": {
        "id": 1,
        "transitNumber": "sample string 2",
        "abaNumberId": 3,
        "description": "sample string 4",
        "active": true
      }
    }
  ],
  "atb": {
    "id": 1,
    "bankName": "sample string 2",
    "description": "sample string 3",
    "active": true,
    "displayOrder": 5,
    "ocrLineFormat": "sample string 6",
    "supportSAByOldFormat": true,
    "lockboxOldFormatName": "sample string 8",
    "lockboxNewFormatName": "sample string 9",
    "lockboxValidationFileFormatName": "sample string 10",
    "clientId": "sample string 11",
    "onlinePaymentFormatName": "sample string 12",
    "couponFileFormat": "sample string 13",
    "statementFileFormat": "sample string 14",
    "isDateEntryRequiredForOldLB": true,
    "isDateEntryRequiredForNewLB": true,
    "isBalancedAchFile": true,
    "isKlikFormat": true,
    "bankId": 19
  },
  "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:
<BankDetailViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <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>
  <ATB xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Bank">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:BankId>19</d2p1:BankId>
    <d2p1:BankName>sample string 2</d2p1:BankName>
    <d2p1:ClientId>sample string 11</d2p1:ClientId>
    <d2p1:CouponFileFormat>sample string 13</d2p1:CouponFileFormat>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DisplayOrder>5</d2p1:DisplayOrder>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsBalancedAchFile>true</d2p1:IsBalancedAchFile>
    <d2p1:IsDateEntryRequiredForNewLB>true</d2p1:IsDateEntryRequiredForNewLB>
    <d2p1:IsDateEntryRequiredForOldLB>true</d2p1:IsDateEntryRequiredForOldLB>
    <d2p1:IsKlikFormat>true</d2p1:IsKlikFormat>
    <d2p1:LockboxNewFormatName>sample string 9</d2p1:LockboxNewFormatName>
    <d2p1:LockboxOldFormatName>sample string 8</d2p1:LockboxOldFormatName>
    <d2p1:LockboxValidationFileFormatName>sample string 10</d2p1:LockboxValidationFileFormatName>
    <d2p1:OcrLineFormat>sample string 6</d2p1:OcrLineFormat>
    <d2p1:OnlinePaymentFormatName>sample string 12</d2p1:OnlinePaymentFormatName>
    <d2p1:StatementFileFormat>sample string 14</d2p1:StatementFileFormat>
    <d2p1:SupportSAByOldFormat>true</d2p1:SupportSAByOldFormat>
  </ATB>
  <AbaNumbers>
    <AbaNumberDetailViewModel>
      <ABAId>2</ABAId>
      <ABA_Number>sample string 3</ABA_Number>
      <AbaNumber>sample string 4</AbaNumber>
      <Active>true</Active>
      <BankId>5</BankId>
      <Description>sample string 6</Description>
      <TransitNumber>
        <AbaNumberId>3</AbaNumberId>
        <Active>true</Active>
        <Description>sample string 4</Description>
        <Id>1</Id>
        <TransitNumber>sample string 2</TransitNumber>
      </TransitNumber>
      <IsAssignedToBankCode>true</IsAssignedToBankCode>
    </AbaNumberDetailViewModel>
    <AbaNumberDetailViewModel>
      <ABAId>2</ABAId>
      <ABA_Number>sample string 3</ABA_Number>
      <AbaNumber>sample string 4</AbaNumber>
      <Active>true</Active>
      <BankId>5</BankId>
      <Description>sample string 6</Description>
      <TransitNumber>
        <AbaNumberId>3</AbaNumberId>
        <Active>true</Active>
        <Description>sample string 4</Description>
        <Id>1</Id>
        <TransitNumber>sample string 2</TransitNumber>
      </TransitNumber>
      <IsAssignedToBankCode>true</IsAssignedToBankCode>
    </AbaNumberDetailViewModel>
  </AbaNumbers>
</BankDetailViewModel>