Adyen · Schema

BankAccount

BankAccount schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
bankAccountNumber string The bank account number (without separators).
bankCity string The bank city.
bankLocationId string The location id of the bank. The field value is `nil` in most cases.
bankName string The name of the bank.
bic string The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.
countryCode string Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL').
iban string The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).
ownerName string The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For exa
taxId string The bank account holder's tax ID.
View JSON Schema on GitHub

JSON Schema

checkout-bank-account-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/checkout-bank-account-schema.json",
  "title": "BankAccount",
  "description": "BankAccount schema from Adyen API",
  "type": "object",
  "properties": {
    "bankAccountNumber": {
      "description": "The bank account number (without separators).",
      "type": "string"
    },
    "bankCity": {
      "x-addedInVersion": "18",
      "description": "The bank city.",
      "type": "string"
    },
    "bankLocationId": {
      "description": "The location id of the bank. The field value is `nil` in most cases.",
      "type": "string"
    },
    "bankName": {
      "description": "The name of the bank.",
      "type": "string"
    },
    "bic": {
      "description": "The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.",
      "type": "string"
    },
    "countryCode": {
      "description": "Country code where the bank is located.\n\nA valid value is an ISO two-character country code (e.g. 'NL').",
      "type": "string"
    },
    "iban": {
      "description": "The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).",
      "type": "string"
    },
    "ownerName": {
      "description": "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* \u03c712 is converted to ch12.\n* \u00fcA is converted to euA.\n* Peter M\u00f8ller is converted to Peter Mller, because banks don't accept '\u00f8'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.",
      "type": "string"
    },
    "taxId": {
      "x-addedInVersion": "18",
      "description": "The bank account holder's tax ID.",
      "type": "string"
    }
  }
}