BACS Direct Debit Component

Our BACS Direct Debit Component renders BACS Direct Debit in your payment form. When making an BACS Direct Debit payment, you additionally need to use createFromAction to handle the redirect to an Adyen-hosted page, and back to your website.

Before you begin

This page explains how to add BACS Direct Debit to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your BACS Direct Debit integration:

1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
2. Add BACS Direct Debit in your test Customer Area.

Show BACS Direct Debit in your payment form

To show BACS Direct Debit Component in your payment form, you need to:

1. Specify in your /paymentMethods request:

   • countryCode: GB
   • amount.currency: GBP

   Pass the full response to the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

2. Add the BACS Direct Debit Component:

   a. Create a DOM element for BACS Direct Debit, placing it where you want the form to be rendered:

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

   b. Create an instance of the BACS Direct Debit Component, and mount it. This renders a button on the payments form.

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

Make a payment

When the shopper selects to pay, the Component calls the onChange event, which contains a state.data.

1. If state.isValid is true, collect the state.data and pass this to your server.

2. From your server, make a /payments, specifying:
   • paymentMethod: The state.data.paymentMethod from the onChange event from your front end.

curl https://checkout-test.adyen.com/v51/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"GBP",
    "value":1000
  },
  "{hint:paymentComponentData.paymentMethod from app}paymentMethod{/hint}":{
    "type":"directdebit_GB"
  },
  "returnUrl":"adyencheckout://your.package.name"
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "GBP",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "directdebit_GB"
  },
  :returnUrl => "adyencheckout://your.package.name",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("GBP");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("directdebit_GB");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("adyencheckout://your.package.name");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "GBP",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "directdebit_GB"
  ),
  "returnUrl" => "adyencheckout://your.package.name",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);

#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'GBP'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'directdebit_GB'
   },
   'returnUrl': 'adyencheckout://your.package.name',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})

// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("GBP", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "directdebit_GB"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"adyencheckout://your.package.name",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "GBP", value: 1000 },
    paymentMethod: {
        type: 'directdebit_GB'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "adyencheckout://your.package.name"
}).then(res => res);

The /payments response contains:

• resultCode: RedirectShopper
• details: Array that contains the key parameter name and the corresponding data type that you should expect when the shopper is redirected to your returnURL. You need to submit this value in your /payments/details request when handling the redirect.
• action: Object containing information about the redirect.
• action.paymentData: Value that you need to submit in your /payments/details request when handling the redirect.
• action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
  The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

{
    "resultCode": "RedirectShopper",
    "action": {
        "method": "GET",
        "paymentData": "abcxyz...",
        "paymentMethodType": "directdebit_GB",
        "type": "redirect",
        "url": "https://test.adyen.com/hpp/details.shtml?brandCode=directdebit_GB&countryCode=GB..."
    },
    "details": [
        {
            "key": "payload",
            "type": "text"
        }
    ],
    "paymentData": "abcxyz...",
    "redirect": {
        "method": "GET",
        "url": "https://test.adyen.com/hpp/details.shtml?brandCode=directdebit_GB&countryCode=GB..."
    }
}    

3. Pass the action object to your front end.

Handle the redirect result

1. Call createFromAction and pass the action object from the previous step. This will return a new Component that you need to mount:

      checkout.createFromAction(action).mount('#my-container');

   The Component redirects the shopper to an Adyen-hosted webpage to complete the payment.

2. After the shopper is redirected back to your website, check the payment result by making a /payments/details request. For more information and detailed instructions, refer to Handling the redirect result.

Present the payment result

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

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

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.

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.

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

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":"YourMerchantAccount",
   "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/..."
}    

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.

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":"YourMerchantAccount",
            "merchantReference":"TMRef1234",
            "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: 

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