Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Open Banking Component

Add Open Banking to an existing Components integration.

Our Open Banking Component renders Open Banking in your payment form, and redirects the shopper to their selected bank's website to complete the payment.

When making an Open Banking payment, you additionally need to:

Before you begin

This page explains how to add Open Banking to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Open Banking integration:

  1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
  2. Add Open Banking in your test Customer Area.

Show Open Banking in your payment form

To show Open Banking Component in your payment form, you need to:

  1. Specify in your /paymentMethods request:

    Pass the full response to the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

  2. Add the Open Banking Component:

    a. Create a DOM element for Open Banking, placing it where you want the form to be rendered:

    <div id="openbanking"></div>

    b. Create an instance of the Open Banking Component, and mount it. You can also include optional configuration for presenting the list of issuing banks.

Field Description Default
showImage Set to true to show the issuer image in the dropdown. true
issuer Value that denotes an issuer's ID. null
const openbanking = checkout.create('openbanking_UK', {
  //Optional configuration
  items: [{id: 1, name: "Model Bank v2"}...], 
  showImage: false,
  issuer: "1"

Make a payment

When the shopper selects to pay, the Component calls the onChange event, which contains a

  1. If state.isValid is true, collect the and pass this to your server.

  2. From your server, make a /payments, specifying:
    • paymentMethod: The from the onChange event from your front end.
    • reference: Your unique reference for this payment.
    • amount: The amount that the shopper needs to pay.
    • returnUrl: The URL the shopper will be redirected back to after they complete the payment.

   "reference":"open banking test",

The /payments response contains:

  • resultCode: RedirectShopper
  • details: Array that contains the key parameter name and the corresponding data type that you should expect when the shopper is redirected to your returnURL. You need to submit this value in your /payments/details request when handling the redirect.
  • action: Object containing information about the redirect.
  • action.paymentData: Value that you need to submit in your /payments/details request when handling the redirect.
  • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
    The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

   "resultCode": "RedirectShopper",
   "action": {
      "data": {},
      "method": "GET",
      "paymentData": "Ab02b4c0!M=...",
      "paymentMethodType": "openbanking_UK",
      "type": "redirect",
      "url": ""
   "details": [
      "key": "payload",
      "type": "text"
   "paymentData": "Ab02b4c0!M=...",
   "redirect": {
      "method": "GET",
      "url": ""
  1. Pass the action object to your front end. The Component needs the action object to redirect the shopper to the issuing bank's website.

Handle the redirect result

The Component uses the action object to redirect the shopper to the issuing bank's website. After the shopper is redirected back to your website, you need to check the payment result by making a /payments/details request.

For more information and detailed instructions, refer to Handling the redirect result.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Open Banking are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
You will receive the funds in 2-3 days.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or request that they select a different payment method.
Pending The shopper has completed the payment but the final result is not yet known. It may take minutes or hours for the Open Banking payments network to confirm this. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION notification.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.
If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION notification.

Test and go live

Before accepting live Open Banking payments, test your integration using the following details: 

Bank name Issuer ID Username Password
Model Bank v2 1 mits mits

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

See also