SEPA Direct Debit Component

Our SEPA Direct Debit Component renders SEPA Direct Debit in your payment form, where shoppers provide their account holder name and IBAN, and then review and confirm the payment.

Before you begin

This page explains how to add SEPA 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 SEPA Direct Debit integration:

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

Show SEPA Direct Debit in your payment form

To present the SEPA Direct Debit Component in your payment form:

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

   • countryCode: Country where SEPA Direct Debit is supported. For example, NL.
   • amount.currency: EUR

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

3. Add the SEPA Direct Debit Component:

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

   <div id="sepa"></div>

   b. Create an instance of the SEPA Component, and mount it.

   const sepa = checkout.create("sepadirectdebit").mount("#sepa");

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/v52/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":"EUR",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"sepadirectdebit",
    "sepa.ownerName":"A. Schneider",
    "sepa.ibanNumber":"DE87123456781234567890"
  },
  "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 => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "sepadirectdebit",
    :sepa.ownerName => "A. Schneider",
    :sepa.ibanNumber => "DE87123456781234567890"
  },
  :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("EUR");
            amount.setValue(1000L);
            paymentsRequest.setAmount(amount);

            DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
            paymentMethodDetails.setSepaOwnerName("A. Schneider");
            paymentMethodDetails.setSepaIbanNumber("DE87123456781234567890");
            paymentMethodDetails.setType("sepadirectdebit");
            paymentsRequest.setPaymentMethod(paymentMethodDetails);

            paymentsRequest.setReference("YOUR_ORDER_NUMBER");
            paymentsRequest.setReturnUrl("https://your-company.com/...");

            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" => "EUR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "sepadirectdebit",
    "sepa.ownerName" => "A. Schneider",
    "sepa.ibanNumber" => "DE87123456781234567890"
  ),
  "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': 'EUR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'sepadirectdebit',
      'sepa.ownerName': 'A. Schneider',
      'sepa.ibanNumber': 'DE87123456781234567890'
   },
   '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("EUR", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "sepadirectdebit",
  Sepa.OwnerName = "A. Schneider",
  Sepa.IbanNumber = "DE87123456781234567890"
};
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: "EUR", value: 1000 },
    paymentMethod: {
        type: 'sepadirectdebit',
        sepa.ownerName: 'A. Schneider',
        sepa.ibanNumber: 'DE87123456781234567890'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains:

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

To verify the payment result, you also need the following from the /payments response:

• action.paymentData: Store this on your server — this is the paymentData value that you send in your /payment/details request.
• details: Array of parameters that you need to send in your /payment/details request. For example, payload or redirectResult.
  The parameters can vary based on the payment method configuration. Make sure to check the details array to confirm the parameters that you need to send in your next API request.

{
    "pspReference": "881572960484022G",
    "resultCode": "Received",
    "merchantReference": "YOUR_ORDER_NUMBER"
}

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 SEPA 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 SEPA payment, we store their payment details with the token. The token can be used to make recurring payments for the shopper.

You can create a shopper token and then make subsequent recurring payments with the token using the /payments endpoint.

Create shopper token

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

1. When you call /payments to make a payment, additionally include:
   • shopperReference: Your unique ID for this shopper.
   • paymentMethod.storePaymentMethod: true
2. When you receive the response (or 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 payment

For each recurring payment for this shopper, make a SEPA payment with a /payments call, and additionally include:

• recurringDetailReference or storedPaymentMethodId for API v49 and above. This is the recurringDetailReference returned in the response when you created the token. This holds the token you received back in the initial payment.
• shopperReference: The shopper ID you provided when created the shopper token.
• shopperInteraction: ContAuth.

{
   "amount":{
       "value":1000,
       "currency":"EUR"
   },
   "paymentMethod":{
       "type":"sepadirectdebit",
       "storedPaymentMethodId":"7219687191761347"
   },
   "reference":"Your Reference Here",
   "merchantAccount":"TestMerchant",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
   "shopperInteraction":"ContAuth"
}

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

Chargebacks

If a shopper for some reason wants the funds from a payment returned, they can ask their bank for a refund. This is referred to as a chargeback.
For SEPA, the chargeback process gives significant consumer rights to the shopper. They have:

• Eight weeks to dispute a SEPA payment without providing a reason.
• Thirteen months to dispute an unauthorised or incorrect SEPA payment when they provide evidence to their bank.

A SEPA chargeback notification can indicate that:

• The shopper disputed the charge.
• There were insufficient funds in the shopper's bank account.

A chargeback notification contains:

• 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 that indicates a SEPA chargeback because there were insufficient funds in the shopper's bank account.

{
  "live":"false",
  "notificationItems":[
    {
      "NotificationRequestItem":{
        "amount":{
          "value":1000,
          "currency":"EUR"
        },

        "pspReference":"931354792477061C",
        "eventCode":"CHARGEBACK",
        "eventDate":"2020-01-01T01:02:01.111+02:00",
        "merchantAccountCode":"YourMerchantAccount",
        "merchantReference":"YourMerchantReference",
        "paymentMethod":"sepadirectdebit",
        "reason":"Insufficient funds",
        "success":true
      }
    }
  ]
}

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

Test and go live

Before making live SEPA payments, use the following Account Names and IBANs to test your integration.

You can check the status of SEPA test payments in your Customer Area > Transactions > Payments.

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

See also