POST /debitAccountHolder

Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a DIRECT_DEBIT_INITIATED notification webhook.

To learn more about direct debits, see Top up accounts.

Servers

https://cal-test.adyen.com/cal/services/Fund/v6

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`description`	String	No	A description of the direct debit. Maximum length: 35 characters. Allowed characters: a-z, A-Z, 0-9, and special characters /?:().,'+ ";.
`splits[]`	Array	Yes	Contains instructions on how to split the funds between the accounts in your platform. The request must have at least one split item.
`splits[].account`	String	No	The unique identifier of the account to which the split amount is booked. Required if `type` is MarketPlace or BalanceAccount. Classic Platforms integration: The `accountCode` of the account to which the split amount is booked. Balance Platform: The `balanceAccountId` of the account to which the split amount is booked.
`splits[].description`	String	No	Your description for the split item.
`splits[].amount`	Object	No	The amount of the split item. Required for all split types in the Classic Platforms integration. Required if `type` is BalanceAccount, Commission, Default, or VAT in your Balance Platform integration.
`splits[].amount.value`	Integer	Yes	The value of the split amount, in minor units.
`splits[].amount.currency`	String	No	The three-character ISO currency code. By default, this is the original payment currency.
`splits[].type`	String	Yes	The part of the payment you want to book to the specified `account`. Possible values for the Balance Platform: BalanceAccount: books part of the payment (specified in `amount`) to the specified `account`. Transaction fees types that you can book to the specified `account`: AcquiringFees: the aggregated amount of the interchange and scheme fees. PaymentFee: the aggregated amount of all transaction fees. AdyenFees: the aggregated amount of Adyen's commission and markup fees. AdyenCommission: the transaction fees due to Adyen under blended rates. AdyenMarkup: the transaction fees due to Adyen under Interchange ++ pricing. Interchange: the fees paid to the issuer for each payment made with the card network. SchemeFee: the fees paid to the card scheme for using their network. Commission: your platform's commission on the payment (specified in `amount`), booked to your liable balance account. Remainder: the amount left over after a currency conversion, booked to the specified `account`. TopUp: allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. VAT: the value-added tax charged on the payment, booked to your platforms liable balance account. Commission: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account. Default: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support. Possible values for the Classic Platforms integration: Commission, Default, Marketplace, PaymentFee, VAT. Possible values: `"MarketPlace"` `"SchemeFee"` `"Surcharge"` `"Commission"` `"PaymentFee"` `"AdyenCommission"` `"Tip"` `"AdyenMarkup"` `"Remainder"` `"Interchange"` `"AcquiringFees"` `"AdyenFees"` `"BalanceAccount"` `"Default"` `"VAT"`
`splits[].reference`	String	No	Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is MarketPlace (Classic Platforms integration) or BalanceAccount (Balance Platform). For the other types, we also recommend providing a unique reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.
`amount`	Object	Yes	The amount to be debited from the account holder's bank account.
`amount.value`	Integer	Yes	The amount of the transaction, in minor units.
`amount.currency`	String	Yes	The three-character ISO currency code.
`merchantAccount`	String	Yes	Your merchant account.
`bankAccountUUID`	String	Yes	The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.
`accountHolderCode`	String	Yes	The code of the account holder.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.