SEPA Direct Debit for API only

You can add SEPA Direct Debit to your existing integration. The following instructions show only what you must add to your integration specifically for SEPA Direct Debit.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

How it works

1. The shopper selects SEPA Direct Debit as the payment method.
2. The shopper enters their details in the payment form that you build.
3. When you make the payment request, you include additional information about the items that the shopper intends to purchase.
4. If you do not use automatic capture, you must capture the payment.

Build your payment form

1. Include SEPA Direct Debit in the list of available payment methods.

2. After the shopper selects SEPA, render the input fields for SEPA to collect their issuer selection. You'll need this to make a payment.

   Payment details	Example
   The name on the SEPA bank account.	"A Schneider"
   The IBAN of the bank account.	"DE87123456781234567890"

Get SEPA Direct Debit as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that SEPA Direct Debit is included in the response.

Add additional parameters to your /payments request

When you make a payment, add the following parameters:

Parameter	Required	Description
paymentMethod.sepa.ownerName		The name on the SEPA bank account.
paymentMethod.sepa.ibanNumber		The IBAN of the bank account. Make sure that you do not encrypt this value.

The response includes the action.type: direct.

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.token.created webhook containing:

• type: recurring.token.created
• shopperReference: your unique identifier for the shopper.
• eventId: the pspReference of the initial payment.
• storedPaymentMethodId: 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 storedPaymentMethodId from the recurring.token.created 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