SEPA Direct Debit Component

This page explains how to add SEPA Direct Debit to your existing Web Components integration.

Requirements

Select the server-side flow that your integration uses:

Import resources for v6

If you are using Web Components v6, import the Component that you need for SEPA Direct Debit:

import { AdyenCheckout, SepaDirectDebit } from '@adyen/adyen-web'

API reference

You do not need to send additional fields for SEPA Direct Debit. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

• /sessions: This is the default with Components v5.0.0 or later.
• /payments: If you implemented an additional use case.

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="sepadirectdebit-container"></div>

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

• Your instance of AdyenCheckout.

const sepa = new SepaDirectDebit(checkout).mount('#sepadirectdebit-container');

const sepaComponent = checkout.create('sepadirectdebit').mount('#sepadirectdebit-container');

Capture the payment

If you do not use automatic capture, you must capture the payment in one of the following ways:

• Use delayed automatic capture. This means that the payment is captured automatically after a delay that you can set yourself.
• Manually capture the payment by making a /payments/{paymentPspReference}/captures request.

SEPA Direct Debit authorizations do not expire, so you can capture a payment any time after it is authorized.

Contact our Support Team to enable multiple partial captures for SEPA Direct Debit.

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

To create a token, include in your /payments request:

• amount: The transaction must have a minimum value of EUR 0.01.
• storePaymentMethod: true
• shopperReference: your unique identifier for the shopper (minimum length three characters). Do not include personally identifiable information (PII), such as name or email address.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile

  From Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

When the payment is settled, you receive a RECURRING_CONTRACT webhook containing:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token that you need to make recurring payments for this shopper.

Make recurring payment

For each recurring payment for this shopper, make a SEPA payment to the /payments endpoint, specifying:

• paymentMethod.type: sepadirectdebit
• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook. You can also get this value using the /listRecurringDetails endpoint.
• shopperReference: The shopper ID you provided when you created the shopper token.
• shopperInteraction: ContAuth.

• recurringProcessingModel: Subscription or UnscheduledCardOnFile.

  From Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Tokenization.

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

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