DebitAccountHolderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-debit-account-holder-request-schema.json",
  "title": "DebitAccountHolderRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-debitaccountholder-api-openapi.yml#/components/schemas/DebitAccountHolderRequest",
  "properties": {
    "accountHolderCode": {
      "description": "The code of the account holder.",
      "type": "string"
    },
    "amount": {
      "description": "The amount to be debited from the account holder's bank account.",
      "$ref": "#/$defs/Amount"
    },
    "bankAccountUUID": {
      "description": "The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.",
      "type": "string"
    },
    "description": {
      "description": "A description of the direct debit. Maximum length: 35 characters.\n\nAllowed characters: **a-z**, **A-Z**, **0-9**, and special characters **/?:().,'+ \";**.",
      "maxLength": 35,
      "type": "string"
    },
    "merchantAccount": {
      "description": "Your merchant account.",
      "type": "string"
    },
    "splits": {
      "description": "Contains instructions on how to split the funds between the accounts in your platform. The request must have at least one split item.",
      "items": {
        "$ref": "#/$defs/Split"
      },
      "type": "array"
    }
  },
  "required": [
    "accountHolderCode",
    "bankAccountUUID",
    "amount",
    "splits",
    "merchantAccount"
  ],
  "type": "object",
  "$defs": {
    "Amount": {
      "properties": {
        "currency": {
          "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
          "maxLength": 3,
          "minLength": 3,
          "type": "string"
        },
        "value": {
          "description": "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "value",
        "currency"
      ],
      "type": "object"
    },
    "Split": {
      "properties": {
        "account": {
          "description": "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
          "type": "string"
        },
        "amount": {
          "description": "The amount of this split.",
          "$ref": "#/$defs/SplitAmount"
        },
        "description": {
          "description": "A description of this split.",
          "type": "string"
        },
        "reference": {
          "description": "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
          "type": "string"
        },
        "type": {
          "description": "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**, **Surcharge**, **Tip**.",
          "enum": [
            "BalanceAccount",
            "Commission",
            "Default",
            "MarketPlace",
            "PaymentFee",
            "PaymentFeeAcquiring",
            "PaymentFeeAdyen",
            "PaymentFeeAdyenCommission",
            "PaymentFeeAdyenMarkup",
            "PaymentFeeInterchange",
            "PaymentFeeSchemeFee",
            "Remainder",
            "Surcharge",
            "Tip",
            "VAT",
            "Verification"
          ],
          "type": "string"
        }
      },
      "required": [
        "amount",
        "type"
      ],
      "type": "object"
    },
    "SplitAmount": {
      "properties": {
        "currency": {
          "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
          "maxLength": 3,
          "minLength": 3,
          "type": "string"
        },
        "value": {
          "description": "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    }
  }
}