BACS Direct Debit Component

Our BACS Direct Debit Component renders BACS Direct Debit in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns 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 present the BACS Direct Debit Component in your payment form:

1. From your server, make a POST /paymentMethods request specifying:

   • countryCode: GB
   • amount.currency: GBP

2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

3. 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="bacs-container"></div>

   b. Create and mount an instance of the BACS Direct Debit Component using its component name, directdebit_GB. This renders a button on your payment form.

   function handleOnSubmit(state, component) {
       // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
       state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
       state.data // Provides the data that you need to pass in the `/payments` call.
       component // Provides the active component instance that called this event.
   }
   const bacsComponent =  checkout.create('directdebit_GB', {
       onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
   }).mount('#bacs-container');

   When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

From your server, make a POST /payments request, specifying:

• paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
• returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

Here is how you would make a payment request for 10 GBP.

curl https://checkout-test.adyen.com/v64/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:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"directdebit_GB"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'

# 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 => "https://your-company.com/checkout?shopperOrder=12xy..",
  :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("https://your-company.com/checkout?shopperOrder=12xy..");

    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" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "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': 'https://your-company.com/checkout?shopperOrder=12xy..',
   '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 paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  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: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains an action object with type:redirect.

{
    "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..."
    }
}

If your integration is set up correctly, the action object is passed from your server to the client, and the action.paymentData temporarily stored on your server.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

1. Call createFromAction, passing 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 BACS Direct Debit to complete the payment.
2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
   • paymentData: The value from the /payments response.
   • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload or redirectResult.
   The parameters can vary based on the payment method configuration. To check which parameters you should submit, always check the details array from the /payments response.
   https://docs.adyen.com/payment-methods/paytm/web-component#-payments-details-request

   /payments/details request

   {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
   }

   The /payments/details response contains:
   • resultCode: Use this to present the payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/paytm/web-component#-payments-details-response

   /payments/details response

   {
         "resultCode": "Authorised",
         "pspReference": "88154795347618C"
   }

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:

If the shopper failed to return to your website or app, wait for the AUTHORISATION notification to receive the outcome of the payment:

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 {/risk-management/disputes-api/dispute-notifications#chargeback}

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