No momento, esta página não está disponível em português
Payment-method icon

BACS Direct Debit for API only

Add BACS Direct Debit to an existing API-only integration.

We strongly recommend that you use our Drop-in or Component solution. This is because BACS Direct Debit must certify the UI that you show to shoppers. If you do not use our Drop-in or Component, the BACS payment method may be disabled, and shoppers may file for chargebacks.

Accept BACS Direct Debit payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

Before starting your BACS Direct Debit integration:

  1. Make sure that you have set up your back end implementation.
  2. Add BACS Direct Debit in your test Customer Area.

Build your payment form for BACS Direct Debit

Include BACS Direct Debit in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:

The response contains paymentMethod.type: directdebit_GB.

We provide logos for BACS and Direct Debit which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: directdebit_GB
  • paymentMethod.holderName: Name of the account holder.
  • paymentMethod.bankAccountNumber: The bank account number.
  • paymentMethod.bankLocationId: The unique identifier (sort code) for a bank location.
  • shopperEmail: The shopper's email address.

For a received payment, the /payments response contains the action.url that you need in the next step.

    "resultCode": "Received",
    "action": {
        "type": "voucher",
        "paymentMethodType": "directdebit_GB",
        "url": "PDF_MANDATE_URL"

Present the payment result

Use the  resultCode that you received in the /payments response to present the payment result to your shopper.

The resultCode values you can receive for BACS Direct Debit are:

resultCode Description Action to take
Received Adyen has received the payment and will submit the DDI and the payment for processing to BACS. You will receive a webhook when the status of the payment has been updated.
There will be a settlement delay of four to six days. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
Present the shopper with the URL in action.url from the response. The shopper may optionally download the mandate PDF document.
Authorised The payment was successful. Inform the shopper that the payment was successful.
Error There was an error when the payment was being processed. For more information, check the refusalReason field. Inform the shopper that there was an error processing their payment.
Refused The payment was refused. For more information, check the refusalReason field. Ask the shopper to try the payment again using a different payment method.

Recurring payments

If you have a recurring or subscription business model, we recommend tokenizing the shopper's payment details. When you create a shopper token from a payment, we store the shopper's payment details with the token. You can use this token to make recurring payments.

You need to use the /payments endpoint to make recurring payments with the token.

We strongly recommend that you request explicit permission from the shopper if you intend to make recurring payments. Being transparent about the payment schedule and the amount they will be charged will reduce the risk of chargebacks.

Under the Direct Debit Guarantee, if there is a change in the collection date or the amount, you must give the shopper advance notice of the payment.

Create shopper token

Tokenize the shopper's payment details when you make the initial payment.

  1. When you make a POST request to /payments to make a payment, additionally include:
  • shopperReference: Your unique ID for this shopper.
  • paymentMethod.storePaymentMethod: true.
  1. When you receive the RECURRING_CONTRACT webhook, store the pspReference. This is the token you will need to make recurring payments for this shopper.

Make recurring payments

We strongly recommend giving shoppers advance notice before each payment.

For each recurring payment for this shopper, make a BACS Direct Debit payment with a POST request to the /payments endpoint, and additionally include:

  • paymentMethod.recurringDetailReference or paymentMethod.storedPaymentMethodIdfor API v49 and above. This is the pspReference returned in the RECURRING_CONTRACT webhook when you created the token.
  • shopperReference: The same unique shopper ID you used to create the shopper token.
  • shopperInteraction: ContAuth.
   "reference":"BACS test payment",

If the payment was successfully received the response will contain the resultCode Received and a pspReference, which is our unique identifier for this transaction. You can track whether the payment was successful using webhooks.


The BACS scheme and the Direct Debit Guarantee give significant consumer rights to the shopper, such as:

  • An immediate money back guarantee if an error is made in the payment of a direct debit.
  • The right to cancel the DDI at any time.

Unpaid direct debits are booked as chargebacks. A chargeback can indicate that:

  • The DDI was changed or cancelled.
  • The shopper disputes the due date, amount, or frequency of the direct debit.
  • The shopper has not paid the direct debit.
  • There were insufficient funds in the shopper's bank account.

You cannot defend chargebacks. These will always result in the shopper receiving a refund.

For more information on the chargeback process, refer to Dispute management.

Chargeback webhook

A webhook for a chargeback has:

  • pspReference: Adyen's unique reference associated with the payment request.
  • eventCode: CHARGEBACK.
  • reason: Reason for the chargeback.
  • success: true.

Here is an example of a webhook for a chargeback due to insufficient funds in the shopper's bank account.

               "directdebit_GB.serviceUserName":"Adyen Payments",
            "reason":"Insufficient funds",

Test and go live

Before accepting live payments, test your integration using the following details:

Account Name Account Number Sort Code
David Archer 40308669 560036

Check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live payments, you need to submit a request for in your live Customer Area.

See also