ADadyen
General

Send a direct debit request

Changed on

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

  • Base URL
    https://cal-test.adyen.com/cal/services/Fund/v5
  • URL
    https://cal-test.adyen.com/cal/services/Fund/v5/debitAccountHolder
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

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.

Changes

  • v56eb6183e18c1Revision changes
    • breaking

      removed the enum value PaymentFeeAcquiring of the request property //

    • breaking

      removed the enum value PaymentFeeAdyen of the request property //

    • breaking

      removed the enum value PaymentFeeAdyenCommission of the request property //

    • breaking

      removed the enum value PaymentFeeAdyenMarkup of the request property //

    • breaking

      removed the enum value PaymentFeeInterchange of the request property //

    • breaking

      removed the enum value PaymentFeeSchemeFee of the request property //

    • breaking

      removed the enum value Verification of the request property //

    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

    • info

      the request property // became optional

    • info

      added the new AcquiringFees enum value to the request property //

    • info

      added the new AdyenCommission enum value to the request property //

    • info

      added the new AdyenFees enum value to the request property //

    • info

      added the new AdyenMarkup enum value to the request property //

    • info

      added the new Interchange enum value to the request property //

    • info

      added the new SchemeFee enum value to the request property //

  • v5f513591a2ef7Revision changes
    • warning

      added the new payoutMethod enum value to the /// response property for the response status

    • warning

      added the new payoutMethod enum value to the /// response property for the response status

    • info

      added the new PaymentFeeAcquiring enum value to the request property //

    • info

      added the new PaymentFeeAdyen enum value to the request property //

    • info

      added the new PaymentFeeAdyenCommission enum value to the request property //

    • info

      added the new PaymentFeeAdyenMarkup enum value to the request property //

    • info

      added the new PaymentFeeInterchange enum value to the request property //

    • info

      added the new PaymentFeeSchemeFee enum value to the request property //