Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Open Banking Drop-in integration

Add Open Banking to an existing Drop-in integration.

Our Web Drop-in 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 Drop-in integration. The Web Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your Open Banking integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payments form.
  2. Add Open Banking in your test Customer Area.

Show Open Banking in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show Open Banking in your payment form, specify in your /paymentMethods request:

Optional Drop-in configuration

When creating an instance of Drop-in, you can also include optional configuration for presenting the list of issuing banks.

const dropin = checkout
    .create('dropin', {
        paymentMethodsConfiguration: {
            openbanking: { // Optional configuration for Open Banking
                showImage: false, // Optional. Set to **false** to remove the bank logos from the Open Banking form.
                issuer: "0015" // // Optional. Set this to an **id** of an Open Banking issuer to preselect it.
            }
        }
    })
    .mount('#dropin');

Make a payment

When the shopper selects the Pay button, Drop-in calls the onSubmit event, which contains a state.data.

  1. Pass the state.data to your server.

  2. From your server, make a /payments request, specifying:
    • paymentMethod: The state.data.paymentMethod from the onSubmit 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.
curl https://checkout-test.adyen.com/v51/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"GBP",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"openbanking_UK",
    "issuer":"1"
  },
  "returnUrl":"https://your-company.com/..."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "GBP",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "openbanking_UK",
    :issuer => "1"
  },
  :returnUrl => "https://your-company.com/...",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("GBP");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setIssuer("1");
    paymentMethodDetails.setType("openbanking_UK");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/...");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "GBP",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "openbanking_UK",
    "issuer" => "1"
  ),
  "returnUrl" => "https://your-company.com/...",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'GBP'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'openbanking_UK',
      'issuer': '1'
   },
   'returnUrl': 'https://your-company.com/...',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("GBP", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "openbanking_UK",
  Issuer = "1"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/...",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "GBP", value: 1000 },
    paymentMethod: {
        type: 'openbanking_UK',
        issuer: '1'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/..."
}).then(res => res);

The /payments response contains:

  • action: Object containing information about the redirect.
  • action.paymentData: Store this on your server — you need to submit this in your /payments/details request when handling the redirect result.
  • 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": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=openbanking_UK..."
   },
   "details": [
   {
      "key": "payload",
      "type": "text"
   }
   ],
   "paymentData": "Ab02b4c0!M=...",
   "redirect": {
      "method": "GET",
      "url": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=openbanking_UK..."
   }
}
  1. Pass the action object to your front end. Drop-in needs the action object to redirect the shopper to the issuing bank's website.

Handle the redirect result

Drop-in usesdropin.handleAction(action) to redirect the shopper to the issuing bank's website. After the shopper is redirected back to your website, check the redirect result.

  • From your server, make a POST /payments/details request, specifying:
    • paymentData: Value you received in the /payments response.
    • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload. To check the parameters that you should submit, refer to the details.key returned in the /payments response.
    {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
    }
    You receive a response containing:
    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.
     {
       "resultCode": "Authorised",
       "pspReference": "88154795347618C"
     }
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 ask them to 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.

Before you can accept live Open Banking payments, you need to submit a request for Open Banking in your live Customer Area.

See also