POST api/banks

Insert a new Bank

Request Information

URI Parameters

None.

Body Parameters

Create Bank

Name	Description	Type	Additional information
BankName		string	Required Max length: 100
IsPositivePayEnabled	IsPositivePayEnabled	boolean	None.
Description		string	Max length: 100
CountryCode		string	Required
InstitutionNumber	Institution Number	string	None.
Active		boolean	Required
InterestBearingAccountCreateViewModel	Interest Bearing account	InterestBearingAccountCreateViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "bankName": "sample string 1",
  "isPositivePayEnabled": true,
  "description": "sample string 3",
  "countryCode": "sample string 4",
  "institutionNumber": "sample string 5",
  "active": true,
  "interestBearingAccountCreateViewModel": {
    "accountTypeId": 1,
    "effectiveRate": 1.0,
    "effectiveDate": "2025-04-03T16:04:51.2379805-04:00",
    "maturityDate": "2025-04-03T16:04:51.2379805-04:00"
  }
}

application/xml, text/xml

Sample:

<BankCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Active>true</Active>
  <BankName>sample string 1</BankName>
  <CountryCode>sample string 4</CountryCode>
  <Description>sample string 3</Description>
  <InstitutionNumber>sample string 5</InstitutionNumber>
  <InterestBearingAccountCreateViewModel xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
    <d2p1:AccountTypeId>1</d2p1:AccountTypeId>
    <d2p1:EffectiveDate>2025-04-03T16:04:51.2379805-04:00</d2p1:EffectiveDate>
    <d2p1:EffectiveRate>1</d2p1:EffectiveRate>
    <d2p1:MaturityDate>2025-04-03T16:04:51.2379805-04:00</d2p1:MaturityDate>
  </InterestBearingAccountCreateViewModel>
  <IsPositivePayEnabled>true</IsPositivePayEnabled>
</BankCreateViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BankCreateViewModel'.

Response Information

Resource Description

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
}

application/xml, text/xml

Sample:

<BankViewModel 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>
  <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>