Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

BACS Direct Debit Component

Add BACS Direct Debit to an existing Components integration.

On this page, you can find additional configuration for adding BACS Direct Debit to your Components integration.

Before you begin

This page assumes you've already:

API reference

Select which endpoint you're integrating:

This is the default with Web Components v5.0.0 or later.
Parameter name Required Description
shopperEmail -white_check_mark- The shopper's email address. 
curl https://checkout-test.adyen.com/v68/sessions \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "amount": {
      "value": 1000,
      "currency": "GBP"
  },
  "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
  "reference": "YOUR_ORDER_NUMBER",
  "countryCode": "GB",
  "shopperEmail":"s.hopper@example.com"
}'

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="directdebit_GB-container"></div>

Step 2: Create an instance of the Component

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component: 

const bacsDirectDebitComponent = checkout.create('directdebit_GB').mount('#directdebit_GB-container');

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 BACS Direct Debit payment, we store the shopper's payment details with the token. You can use this token to make recurring BACS Direct Debit 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 BACS Direct Debit 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 BACS Direct Debit 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 notification that the payment was authorised, note the recurringDetailReference or the storedPaymentMethodId. 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 recurringDetailReference returned in the response when you created the token. This holds the token for the shopper received in the successful payment notification for the initial payment.
  • shopperReference: The same unique shopper ID you used to create the shopper token.
  • shopperInteraction: ContAuth.
{
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "reference":"BACS test payment",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
   "shopperInteraction":"ContAuth",
   "amount":{
      "currency":"GBP",
      "value":49900
   },
   "paymentMethod":{
      "type":"directdebit_GB",
      "storedPaymentMethodId":"7219687191761347"
   },
   "countryCode":"GB",
   "shopperLocale":"en_gb",
   "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}

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 notifications.

Chargebacks

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 BACS Direct Debit chargebacks. These will always result in the shopper receiving a refund.

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

Chargeback notification

A notification 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 notification for a chargeback due to insufficient funds in the shopper's bank account.

{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "additionalData":{
               "directdebit_GB.mandateId":"424544",
               "directdebit_GB.serviceUserNumber":"298288",
               "directdebit_GB.serviceUserName":"Adyen Payments",
               "directdebit_GB.sequenceType":"OneOff",
               "directdebit_GB.dateOfSignature":"2016-10-21"
            },
            "amount":{
               "currency":"GBP",
               "value":1000
            },
            "eventCode":"CHARGEBACK",
            "eventDate":"2016-10-21T11:34:15+02:00",
            "merchantAccountCode":"YOUR_MERCHANT_ACCOUNT",
            "merchantReference":"YOUR_PAYMENT_REFERENCE",
            "paymentMethod":"directdebit_GB",
            "pspReference":"9914770424540842",
            "reason":"Insufficient funds",
            "success":"true"
         }
      }
   ]
}

Test and go live

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

Account Name Account Number Sort Code
David Archer 40308669 560036

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

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

See also