BankAccount
Bank account information with IBAN, SWIFT/BIC, and account details - supports international banking standards and multiple account types
Properties
| Property | Type | Mode | Description | Required |
|---|---|---|---|---|
| accountNumber | string | stored | Bank account number (domestic format) Example: | Optional |
| iban | string | stored | International Bank Account Number (IBAN) - ISO 13616 standard Example: | Optional |
| swift | string | stored | SWIFT/BIC code of the bank - ISO 9362 standard (8 or 11 characters) Example: | Optional |
| bankName | string | stored | Name of the bank or financial institution Example: | Optional |
| accountName | string | stored | Name of the account holder Example: | Optional |
| accountType | string | enum | Type of bank account Values: Example: | Optional |
| currency | Currency | stored | Primary currency of the account (reference to Currency entity) Example: | Optional |
| country | Country | stored | Country where the bank account is domiciled (reference to Country entity) Example: | Optional |
| branchCode | string | stored | Bank branch code or sort code (country-specific) Example: | Optional |
| routingNumber | string | stored | Routing number (US) or similar domestic routing identifier Example: | Optional |
| use | string | enum | Primary use or purpose of this account Values: Example: | Optional |
| label | string | stored | Human-readable label for this account Example: | Optional |
| isActive | boolean | stored | Whether this account is currently active Example: | Optional |
| isPrimary | boolean | stored | Whether this is the primary/default account Example: | Optional |
| period | Period | stored | Period during which this account is valid for use | Optional |
| mandateReference | string | stored | SEPA mandate reference for direct debit (EU) Example: | Optional |
| notes | string | stored | Additional notes or instructions for this account Example: | Optional |
Examples
Example 1
{
"@type": "BankAccount",
"iban": "FR7630006000011234567890189",
"swift": "BNPAFRPPXXX",
"bankName": "BNP Paribas",
"accountName": "ACME Corporation",
"accountType": "business",
"currency": {
"@type": "Currency",
"code": "EUR",
"name": "Euro"
},
"country": {
"@type": "Country",
"code": "FR",
"name": "France"
},
"use": "main",
"label": "Main Business Account - EUR",
"isActive": true,
"isPrimary": true
}Example 2
{
"@type": "BankAccount",
"accountNumber": "123456789",
"routingNumber": "021000021",
"swift": "CHASUS33XXX",
"bankName": "JPMorgan Chase Bank",
"accountName": "ACME Corporation",
"accountType": "checking",
"currency": {
"@type": "Currency",
"code": "USD",
"name": "US Dollar"
},
"country": {
"@type": "Country",
"code": "US",
"name": "United States of America"
},
"use": "international",
"label": "US Dollar Account",
"isActive": true,
"isPrimary": false
}Example 3
{
"@type": "BankAccount",
"iban": "DE89370400440532013000",
"swift": "COBADEFFXXX",
"bankName": "Commerzbank",
"accountName": "ACME GmbH",
"accountType": "payroll",
"currency": {
"@type": "Currency",
"code": "EUR",
"name": "Euro"
},
"country": {
"@type": "Country",
"code": "DE",
"name": "Germany"
},
"use": "payroll",
"label": "Payroll Account - Germany",
"isActive": true,
"isPrimary": false,
"mandateReference": "SEPA-PAYROLL-2024"
}Example 4
{
"@type": "BankAccount",
"iban": "GB29NWBK60161331926819",
"swift": "NWBKGB2L",
"bankName": "NatWest",
"accountName": "ACME Ltd",
"accountType": "business",
"currency": {
"@type": "Currency",
"code": "GBP",
"name": "British Pound Sterling"
},
"country": {
"@type": "Country",
"code": "GB",
"name": "United Kingdom"
},
"branchCode": "601613",
"use": "main",
"label": "UK Main Account",
"isActive": true,
"isPrimary": false
}