Adyen · Schema

ACH Direct Debit

PaymentsFinancial ServicesFintech

Properties

Name Type Description
bankAccountNumber string The bank account number (without separators).
bankAccountType string The bank account type (checking, savings...).
bankLocationId string The bank routing number of the account. The field value is `nil` in most cases.
checkoutAttemptId string The checkout attempt identifier.
encryptedBankAccountNumber string Encrypted bank account number. The bank account number (without separators).
encryptedBankLocationId string Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases.
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
recurringDetailReference string This is the `recurringDetailReference` returned in the response when you created the token.
storedPaymentMethodId string This is the `recurringDetailReference` returned in the response when you created the token.
type string **ach**
View JSON Schema on GitHub

JSON Schema

adyen-achdetails-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AchDetails",
  "title": "ACH Direct Debit",
  "additionalProperties": false,
  "properties": {
    "bankAccountNumber": {
      "description": "The bank account number (without separators).",
      "type": "string"
    },
    "bankAccountType": {
      "description": "The bank account type (checking, savings...).",
      "enum": [
        "balance",
        "checking",
        "deposit",
        "general",
        "other",
        "payment",
        "savings"
      ],
      "type": "string"
    },
    "bankLocationId": {
      "description": "The bank routing number of the account. The field value is `nil` in most cases.",
      "type": "string"
    },
    "checkoutAttemptId": {
      "x-addedInVersion": "68",
      "description": "The checkout attempt identifier.",
      "type": "string"
    },
    "encryptedBankAccountNumber": {
      "description": "Encrypted bank account number. The bank account number (without separators).",
      "type": "string"
    },
    "encryptedBankLocationId": {
      "description": "Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases.",
      "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* 12 is converted to ch12.\n* A is converted to euA.\n* Peter Mller is converted to Peter Mller, because banks don't accept ''.\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"
    },
    "recurringDetailReference": {
      "deprecated": true,
      "x-deprecatedInVersion": "49",
      "x-deprecatedMessage": "Use `storedPaymentMethodId` instead.",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "type": "string"
    },
    "storedPaymentMethodId": {
      "x-addedInVersion": "49",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "maxLength": 64,
      "type": "string"
    },
    "type": {
      "default": "ach",
      "description": "**ach**",
      "enum": [
        "ach",
        "ach_plaid"
      ],
      "type": "string"
    }
  },
  "required": [
    "bankAccountNumber"
  ],
  "type": "object"
}