Sign in

v1

latestOpenAPI 3.1.02026-07-2083190.2 KB
General

Send a direct debit request

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.

post/debitAccountHolder

Request body

accountHolderCodestring required

The code of the account holder.

bankAccountUUIDstring required

The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.

descriptionstring

A description of the direct debit. Maximum length: 35 characters.

Allowed characters: a-z, A-Z, 0-9, and special characters /?:().,'+ ";.

merchantAccountstring required

Your merchant account.

Response

OK - the request has succeeded.

accountHolderCodestring

The code of the account holder.

bankAccountUUIDstring

The Adyen-generated unique alphanumeric identifier (UUID) of the account holder's bank account.

merchantReferencesstring[]

List of the reference values from the split array in the request.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.