Open banking Component

On this page, you can find additional configuration for adding open banking to your Components integration.

Before you begin

Before starting your open banking integration:

1. Contact our Support Team to add open banking in your test Customer Area.

2. Make sure you've integrated Components v5.27.0 or later.

API reference

You don't need to send additional fields for open banking. 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="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 add the following optional configuration:

If you want to add optional configuration, include this in a configuration object. The following example shows how to configure the open banking 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 open banking 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

The available banks for open banking are different in the test and live environment:

Test and go live

We provide different test issuers for testing open banking payments, including testing for failed or cancelled payments. Select the corresponding test issuer name, for example Demo Open Banking Redirect (payment cancelled), to simulate a cancelled payment scenario.

We recommend that you test each scenario before you go live.

Check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live open banking payments, contact our Support Team to add open banking in your test Customer Area.

See also