Pay by Bank (Europe) Component integration

On this page, you can find additional configuration for adding Pay by Bank (Europe) to your Components integration.

Before you begin

Before starting your Pay by Bank (Europe) integration:

1. Contact our Support Team to add Pay by Bank (Europe) in your test Customer Area.

2. Make sure you have integrated Components v5.27.0 or later.

API reference

Select which endpoint you're integrating:

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

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

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 don't 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 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.
};

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 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

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_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token that you need to make recurring payments for this shopper.

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.

Chargebacks

In rare scenarios, it is possible that you do not receive the funds even after receiving a successful AUTHORISATION webhook. The successful AUTHORISATION webhook means that the shopper's account passed the verifications by the issuer and our Pay by Bank (Europe) partners, and that the bank transfer was initiated successfully. However, the payment can still fail for the following reasons:

• The shopper cancelled the transaction. Some banks allow shoppers to cancel bank transfers until midnight of the day of the transaction.
• Some banks process transactions with a delay and do not block the funds for an authorized Pay by Bank payment. For example, if the shopper completes a payment on a Saturday, the bank might only process it on Monday. If the shopper has withdrawn funds in the meantime, the payment can fail due to insufficient funds.

In these cases, Adyen is not informed that the transaction failed. We also don't know whether the bank might still process it later.

On our side, the status of the payment is SentForSettle until we receive the funds. You can check the status of the payment in your Customer Area.

If we have not received the funds after 8 weekdays, the status of the payment becomes Settled, then Chargeback, and you receive a CHARGEBACK webhook.

In case we receive the money after this point, you receive a CHARGEBACK_REVERSED webhook.

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.

UK test credentials

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

Bank name	Issuer ID
Tink Demo Bank	uk-demobank-open-banking-handoff
Tink Demo Bank	uk-demobank-open-banking-redirect
Tink Demo Bank	uk-demobank-open-banking-redirect-aispis
Tink Demo Bank	uk-demobank-open-banking-redirect-extendable

To test different scenarios, use those test issuer IDs and the following scenario-specific credentials:

Approved
Username: u02792141
Password: udy509

Authentication error
Username: u82559259
Password: dfo473

Temporary error
Username: u18312037
Password: eyj733

See also