This page explains how to add Pay by Bank (Europe) to your existing Web Drop-in integration.
Requirements
Select the server-side flow that your integration uses:
Import resources for v6
If you are using Web Drop-in v6, import the resources you need for Pay by Bank (Europe):
import { AdyenCheckout, PayByBank} from '@adyen/adyen-web'
API reference
Select which endpoint you are using:
Drop-in configuration
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:
Parameter name | Description | Default |
---|---|---|
showImage |
Set to false to remove the bank logos from the Pay by Bank form. | true |
issuer |
Set to an issuer ID to preselect a specific bank. | No bank is preselected. |
highlightedIssuers |
Set to the 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 Drop-in 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.
};
Include the openBankingConfiguration
object when creating a configuration object for Drop-in:
Pass the Drop-in configuration object when creating your instance of AdyenCheckout
:
const checkout = await AdyenCheckout(configuration);
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:
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:
- 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_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
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
We recommend that you test various scenarios, such as