Adyen · Schema

DebitAccountHolderRequest

PaymentsFinancial ServicesFintech

Properties

Name Type Description
accountHolderCode string The code of the account holder.
amount object The amount to be debited from the account holder's bank account.
bankAccountUUID string The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.
description string A description of the direct debit. Maximum length: 35 characters. Allowed characters: **a-z**, **A-Z**, **0-9**, and special characters **/?:().,'+ ";**.
merchantAccount string Your merchant account.
splits array Contains instructions on how to split the funds between the accounts in your platform. The request must have at least one split item.
View JSON Schema on GitHub

JSON Schema

adyen-debitaccountholderrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DebitAccountHolderRequest",
  "title": "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": "#/components/schemas/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": "#/components/schemas/Split"
      },
      "type": "array"
    }
  },
  "required": [
    "accountHolderCode",
    "bankAccountUUID",
    "amount",
    "splits",
    "merchantAccount"
  ],
  "type": "object"
}