This page explains how to add EPS to your existing Web Components integration.
Requirements
Select which endpoint you are using:
Import resources for v6
If you are using Web Components v6, import the Component that you need for EPS:
import { AdyenCheckout, EPS } from '@adyen/adyen-web'
API reference
You do not need to send additional fields for EPS. 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="eps-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 eps = new EPS(checkout).mount('#eps-container');
v5.x.x or earlier
Use the create
method of your AdyenCheckout
instance, in this case checkout
, to create the Component:
const epsComponent = checkout.create('eps').mount('#eps-container');
Optional configuration
You can add the following optional configuration:
Parameter name | Description | Default |
---|---|---|
issuer |
Set to an EPS issuer ID to preselect a specific bank. | No bank is preselected. |
highlightedIssuers |
Set to the EPS issuer IDs for banks you want to show on top of the dropdown menu. Added in v5.1.0 | All issuers are shown in the dropdown. |
placeholder |
The string you want to show as the dropdown menu text. Custom translation configuration overrides this value. | Select your bank |
If you want to add optional configuration, include this in a configuration object. The following example shows how to configure the EPS Component to remove the bank logos, and preselect Dolomitenbank:
const epsConfiguration = {
issuer: "d5d5b133-1c0d-4c08-b2be-3c9b116dc326" // Optional. Set this to an **id** of an EPS issuer to preselect it.
};
v6.0.0 or later
Create an instance of the Component, passing:
- Your instance of
AdyenCheckout
. - The payment method-specific configuration.
const eps = new EPS(checkout, epsConfiguration).mount('#eps-container');
v5.x.x or earlier
Use the create
method of your AdyenCheckout
instance, in this case checkout
, to create an instance of the Component. Add the configuration object if you created one.
const epsComponent = checkout.create('eps', epsConfiguration).mount('#eps-container');
List of issuer IDs
The available banks for EPS are different in the test and live environment:
Recurring payments
We support recurring transactions for EPS through SEPA Direct Debit. To make recurring payments, you need to:
Create a 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:
storePaymentMethod
: true- shopperReference: Your unique identifier for the shopper (minimum length three characters).
When the payment has been settled, you receive a webhook containing:
eventCode
: RECURRING_CONTRACToriginalReference
: ThepspReference
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 a payment with a token
To make a payment with the token, include in your /payments request:
paymentMethod.storedPaymentMethodId
: ThepspReference
from the RECURRING_CONTRACT webhook.
You can also get this value using the /listRecurringDetails endpoint.
shopperReference
: The unique shopper identifier that you specified when creating the token (minimum length three characters).shopperInteraction
: ContAuth.recurringProcessingModel
: Subscription or UnscheduledCardOnFile.
For more information about the shopperInteraction
and recurringProcessingModel
fields, refer to Tokenization.
Test and go live
Check the status of EPS test payments in your Customer Area > Transactions > Payments.
Before you can accept live EPS payments, you need to submit a request for EPS in your live Customer Area.