Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Open Banking Android Component

Add Open Banking to an existing Components integration.

Our Open Banking Component renders Open Banking in your payment form and collects your shopper's selected bank.

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

Before you begin

This page explains how to add Open Banking to your existing Android Components integration. The Android 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 for making API requests.
  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:
  2. Deserialize the response from the /paymentMethods call and get the object with type: openbanking_UK.
  3. Add the Open Banking Component:

    a. Import the Open Banking Component to your build.gradle file.

    implementation "com.adyen.checkout:openbanking-ui:<latest-version>"

    Check the latest version on GitHub.

    b. Create an openBankingConfiguration object:

    val openBankingConfiguration =
     OpenBankingConfiguration.Builder(Locale.getDefault(), resources.displayMetrics, Environment.TEST)
     .build()

    c. Initialize the Open Banking Component. Pass the payment method object and the openBankingConfiguration object.

    val openBankingComponent = OpenBankingComponent.PROVIDER.get(this@YourActivity, paymentMethod, openBankingConfiguration)

    d. Add the Open Banking Component view to your layout.

    <com.adyen.checkout.openbanking.OpenBankingSpinnerView
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"/>

    e. Attach the Component to the view to start getting your shopper's payment details.

    OpenBankingSpinnerView.attach(openBankingComponent, this@YourActivity)

    f. When shoppers enter their payment details, you start receiving updates. If isValid is true and the shopper proceeds to pay, pass the paymentComponentState.data.paymentMethod to your server and make a payment request.

    openBankingComponent.observe(this@coreActivity, Observer {
      if (it?.isValid == true) {
          // When the shopper proceeds to pay, pass the `it.data` to your server to send a /payments request
      }
    })

Make a payment

When the shopper proceeds to pay, the Component returns the paymentComponentState.data.paymentMethod.

  1. Pass the paymentComponentState.data.paymentMethod to your server.
  2. From your server, make a /payments request, specifying:
    • paymentMethod.type: The paymentComponentState.data.paymentMethod from your client app.
    • returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

{
   "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"
   }
   ],
   ...
}
  1. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

Use the Redirect Component to redirect the shopper to the issuing bank's app or website. After the shopper is redirected back to your app, make a /payments/details call to check the payment result.

For more information and detailed instructions, refer to Using the Redirect Component.

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