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 your existing iOS Drop-in integration.

Our iOS Drop-in renders Open Banking in your payment form, and redirects the shopper to their selected bank's website or app 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 iOS Drop-in integration. The iOS 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 payment 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, you need to specify in your /paymentMethods request:

After the shopper selects a payment method and provides payment details, Drop-in invokes the didSubmit method which contains data.paymentMethod. Pass data.paymentMethod to your server and make a payment request.

Make a payment

When the shopper proceeds to pay, Drop-in invokes the didSubmit method which contains data.paymentMethod.

  1. Pass data.paymentMethod to your server.
  2. From your server, make a /payments, specifying:
    • paymentMethod: The state.data.paymentMethod 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.

{
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "reference":"open banking test",
   "amount":{
      "currency":"GBP",
      "value":1000
   },
   "paymentMethod":{
      "type":"openbanking_UK",
      "issuer":"1"
   },
   "returnUrl":"https://your-company.com/..."
}

The /payments response contains:

  • action: Object containing information about the redirect.

{
   "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 client app. Drop-in needs this to redirect the shopper to the issuing bank's website or app.

Handle the redirect result

Drop-in redirects the shopper to the issuing bank's app or website where they complete the payment. However, you need to inform Drop-in when the shopper returns to your app. To do this, implement the following in your UIApplicationDelegate:

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
   RedirectComponent.applicationDidOpen(from: url)

   return true
}

After the shopper is redirected back to your app, check the payment result by making a /payments/details request.

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