SEPA Direct Debit Component

Add SEPA Direct Debit to an existing Components integration.

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

Before you begin

This page assumes you have already:

API reference

You don't 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

If your integration uses iOS Components v5.0.0 or later, configure and create an instance of the SEPA Direct Debit Component:

//Create a payment method object for SEPA Direct Debit.
let paymentMethod = paymentMethods.paymentMethod(ofType: sepadirectdebitComponentPaymentMethod.self)
//Create a configuration object for the SEPA Direct Debit Component.
var sepadirectdebitComponentConfiguration = sepadirectdebitComponent.Configuration()
//Set additional parameters on the configuration object.
sepadirectdebitComponentConfiguration.localizationParameters = //Optional custom localization parameters.

There is no required SEPA Direct Debit specific integration for Components.

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

We strongly recommend that you request explicit permission from the shopper if you intend to make recurring SEPA payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.

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

amount: The transaction must have a minimum value of 0.01 EUR.
recurringProcessingModel: Subscription, CardOnFile, or UnscheduledCardOnFile
storePaymentMethod: true
shopperReference: Your unique identifier for the shopper (minimum length three characters).

As of 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 sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.

Make recurring payment

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

storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook.

You can also get this value by using the /listRecurringDetails endpoint.
shopperReference: The shopper ID you provided when created the shopper token.
shopperInteraction: ContAuth.
recurringProcessingModel: Subscription or UnscheduledCardOnFile.

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

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
       "amount":{
          "value":1000,
          "currency":"EUR"
       },
       "paymentMethod":{
          "type":"sepadirectdebit",
          "storedPaymentMethodId":"7219687191761347"
       },
       "reference":"YOUR_ORDER_NUMBER",
       "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
       "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       "shopperInteraction":"ContAuth",
       "recurringProcessingModel": "Subscription"
}'

# 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",
    :storedPaymentMethodId => "7219687191761347"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :shopperInteraction => "ContAuth",
  :recurringProcessingModel => "Subscription"
})

// 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(15000L);
paymentsRequest.setAmount(amount);

SepaDirectDebitDetails paymentMethodDetails = new SepaDirectDebitDetails();
paymentMethodDetails.setStoredPaymentMethodId("7219687191761347");
paymentMethodDetails.setType("sepadirectdebit");
paymentsRequest.setPaymentMethod(paymentMethodDetails);

paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
paymentsRequest.setShopperInteraction(PaymentsRequest.ShopperInteractionEnum.CONTAUTH);
paymentsRequest.setRecurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum.SUBSCRIPTION);

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",
    "storedPaymentMethodId" => "7219687191761347"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  "recurringProcessingModel" => "Subscription",
  "shopperInteraction" => "ContAuth",
  "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',
      'storedPaymentMethodId': '7219687191761347'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
   'shopperInteraction':'ContAuth',
   'recurringProcessingModel': 'Subscription'
})

// 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 Adyen.Model.Checkout.Amount("EUR", 1000);
var details = new Adyen.Model.Checkout.DefaultPaymentMethodDetails{
  Type = "sepadirectdebit",
  StoredPaymentMethodId = "7219687191761347"
};
var paymentsRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  RecurringProcessingModel = Adyen.Model.Checkout.PaymentRequest.RecurringProcessingModelEnum.Subscription,
  ShopperInteraction = Adyen.Model.Checkout.PaymentRequest.ShopperInteractionEnum.ContAuth,
  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',
        storedPaymentMethodId: "7219687191761347"
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    shopperInteraction: "ContAuth",
    recurringProcessingModel: "Subscription"
}).then(res => res);

https://docs.adyen.com/payment-methods/sepa-direct-debit/ios-component#recurring

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.

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.

You cannot defend against SEPA chargebacks. These will always result in the shopper receiving a refund.

A SEPA chargeback notification can indicate that:

The shopper disputed the charge.
There were insufficient funds in the shopper's bank account.
The bank account was inactive.
Direct debit is blocked on this bank account, either in general or for this creditor specifically.
There was a technical error.

For a list of detailed SEPA chargeback reasons and reason codes, see Dispute reason codes.

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

{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "additionalData":{
               "chargebackReasonCode":"AM04",
               "modificationMerchantReferences":"",
               "chargebackSchemeCode":"sepadirectdebit",
               "defensePeriodEndsAt":"2021-05-06T22:09:50+02:00",
               "defendable":"false",
               "disputeStatus":"Lost"
            },
            "amount":{
               "currency":"EUR",
               "value":1000
            },
            "eventCode":"CHARGEBACK",
            "eventDate":"2021-05-06T22:09:50+02:00",
            "merchantAccountCode":"YOUR_MERCHANT_ACCOUNT",
            "merchantReference":"YOUR_REFERENCE",
            "originalReference":"9913333333333333",
            "paymentMethod":"sepadirectdebit",
            "pspReference":"9915555555555555",
            "reason":"AM04:InsufficientFunds",
            "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.

Account Name	IBAN	Country
A. Klaassen	NL13TEST0123456789	NL
B. Klaassen	NL36TEST0236169114	NL
C. Klaassen	NL26TEST0336169116	NL
D. Klaassen	NL16TEST0436169118	NL
E. Klaassen	NL81TEST0536169128	NL
F. Klaassen	NL27TEST0636169146	NL
G. Klaassen	NL39TEST0736169237	NL
H. Klaassen	NL82TEST0836169255	NL
I. Klaassen	NL72TEST0936169257	NL
J. Klaassen	NL46TEST0136169112	NL
K. Klaassen	NL70TEST0736160337	NL
L. Klaassen	NL18TEST0736162437	NL
M. Klaassen	NL92TEST0736163433	NL
A. Schneider	DE87123456781234567890	DE
B. Schneider	DE92123456789876543210	DE
C. Schneider	DE14123456780023456789	DE
D. Schneider	DE36444488881234567890	DE
E. Schneider	DE41444488889876543210	DE
F. Schneider	DE60444488880023456789	DE
G. Schneider	DE89888888881234567890	DE
H. Schneider	DE94888888889876543210	DE
I. Schneider	DE16888888880023456789	DE
A. Pacini	IT60X0542811101000000123456	IT
A. Grand	FR1420041010050500013M02606	FR
A. Martin	ES9121000418450200051332	ES
W. Hurth	AT151234512345678901	AT
H. Gasser	CH4912345123456789012	CH
R. Paulsen	DK8612341234567890	DK
B. Dalby	NO6012341234561	NO
A. Bak	PL20123123411234567890123456	PL
A. Andersson	SE9412312345678901234561	SE

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.

Are you looking for test card numbers?

Would you like to contact support?

SEPA Direct Debit Component

Before you begin

API reference

Component configuration

Recurring payments

Create shopper token

Make recurring payment

Chargebacks

Test and go live

See also