Pay by Bank (Europe) Component integration

This page explains how to add Pay by Bank (Europe) 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 Pay by Bank (Europe):

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

API reference

Select which endpoint you are using:

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="paybybank-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 openBanking = new PayByBank(checkout).mount('#paybybank-container');

const openBankingComponent = checkout.create('paybybank').mount('#paybybank-container');

Optional configuration

You can optionally configure your payment form to include a list of issuing banks for Pay by Bank (Europe).

In some regions, like Germany, there are so many banks that you cannot show a list of issuing banks. Shoppers are redirected to our open banking partner Tink to select their bank.

In other regions, like the United Kingdom, you can let shoppers pre-select their bank before redirecting them to Tink, by showing the list of issuing banks in your payment form. If you do not show the list of issuing banks, shoppers select their bank after being redirected to Tink.

In markets where issuer selection is supported, you can use the following optional configuration to show the list of issuing banks:

If you want to add optional configuration, include this in a configuration object. The following example shows how to configure the Pay by Bank Component to remove the bank logos, and preselect Bank of Scotland:

const openBankingConfiguration = {
  showImage: false, // Optional. Set to **false** to remove the bank logos from the Pay by Bank form.
  issuer: "uk-bankofscotland-oauth2" // Optional. Set this to an **id** of an open banking 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 openBankingComponent = new PayByBank(checkout, openBankingConfiguration).mount('#paybybank-container');

const openBankingComponent = checkout.create('paybybank', openBankingConfiguration).mount('#paybybank-container');

List of issuer IDs

For the UK, where you can show the issuer list in the payment form, the list may include the following banks:

Recurring payments

We support recurring transactions for Pay by Bank (Europe) through SEPA Direct Debit.

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

To make recurring payments, you need to:

1. Create a shopper token.
2. Use the token to make future payments for the shopper.

Create a token

Store SEPA details

When creating a token for SEPA Direct Debit, use the standard tokenization parameters in your payment request. You do not need to include any additional parameters for SEPA Direct Debit.

When a token is created, you receive a recurring.token.created webhook. The webhook contains the storedPaymentMethodId that you can use to make subsequent payments using the stored payment details.

Make a payment with a token

Make a subscription payment

Make a subscription payment using the standard tokenization parameters. You do not need to include any additional parameters for SEPA Direct Debit.

Make an unscheduled card-on-file payment

Make an unscheduled card-on-file using the standard tokenization parameters. You do not need to include any additional parameters for SEPA Direct Debit.

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

We recommend that you test various scenarios, such as approved payments, authentication errors, and payments cancelled by the shopper. See the Tink documentation for screenshots that can help you navigate the flow. You can check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live Pay by Bank (Europe) payments, you need to add Pay by Bank (Europe) in your live Customer Area.

Test credentials

Use the relevant test credentials and test issuer IDs, where available.

UK

For the UK, where you can show the issuer list in the payment form, use the following test issuer IDs:

When you send a test payment and are redirected to our open banking partner Tink, log in with the following test credentials for the UK:

For an Approved test scenario, you will see two checking accounts. Select the first checking account (ending in 285) for payment amounts greater than GBP 150, or the second checking account (ending in 327) for amounts less than GBP 150.

Germany

When you send a test payment and are redirected to our open banking partner Tink, log in with the following test credentials for Germany:

France

When you send a test payment and are redirected to our open banking partner Tink, log in with the following test credentials for France:

Finland

When you send a test payment and are redirected to our open banking partner Tink, log in with the following test credentials for Finland:

See also