Deep Linking into Online Banking

Note

Q2’s web application makes use of URLSCHEMEs– thus iOS and Android do not automatically redirect the user to the app store if they do not have the app installed. If the user has the app installed then deep links will work correctly, otherwise an error will be shown.

Deep Linking to a Specific Page in a Browser

Q2’s web application behaves as most web applications/sites do: if you want to create a link to a specific page, simply navigate to that page and then copy the URL from the location bar.

If that URL is accessed via hyperlink, the user will be first prompted to login (including 2FA, disclaimers, interstitial, etc). Once they have completed the login steps, they will be instantly redirected to the linked page instead of #/landingPage.

If the user accesses a link and is already logged in, they will simply be taken through the interstitial page and redirected to the specified page.

Deep Link to Tecton Extension Passing Parameters

Assuming you’ve already setup your Tecton extension to accept parameters. If you haven’t, please first configure parameters using this guide: Module Parameters

Getting the correct deeplink to a specific extension is easily done by using the URL that’s in the browser when you navigate to the extension. Most Tecton extension’s will have a url like uux.aspx#/extension/MyExtension/SomeOtherEntrypoint. If your extension accept’s parameters, it is a bit trickier to construct the correct URL.

uux.aspx#/extension/MyExtension/SomeOtherEntrypoint?tectonState=%7B%22tectonRoute.MyExtension.

SomeOtherEntrypoint.deep_like_param_name_here%22%3A%22deep_link_value_here%22%7D

In this example, extension name is “MyExtension”, entrypoint is “SomeOtherEntrypoint”, the tectonState query param is a URL encoded (https://www.urlencoder.org/) JSON object where the key is the parameter name thats been configured for the “SomeOtherEntrypoint” entrypoint, and the value is the value that will be what the extension has access to.

Deep Link to a SSO

It is a common request to link directly to an SSO. This is trickier as the actual SSO linkout URL is obscured from the end user. Online banking has a special url for SSO deep linking: #/ssoDirect/{vendorId}. You will need to know the specific vendorId for your SSO, and note that this ID will likely be different for each environment.

Deep Linking to a Specific Page in the Mobile App (iOS)

Most, but not all, instances of Q2’s iOS Mobile Applications are built with a URLSCHEME. The URLSCHEME of an mobile application can be found by following these instructions:

https://www.amerhukic.com/finding-the-custom-url-scheme-of-an-ios-app

A deep link URL to open the app must be formatted using the following pattern: URLSCHEME://open?targetPage={EncodedUUXPage}

To know the URL for an individual page, open online banking in the browser, navigate to that page and copy the path (everything after uux.aspx) The copied path should be URL encoded, you can use this page to convert: https://www.urlencoder.org

Example for Sales Demo:

THRIVE0001://open?targetPage=%23%2Ftransfer

Note

The query parameter for iOS is targetPage

Here, the target page is #/transfer– first it must be URL encoded to %23%2Ftransfer.

Here are a few link samples assuming the URL Scheme is configured THRIVE0001: THRIVE0001://open?targetPage=%23%2Fmessages -> will navigate to messages THRIVE0001://open?targetPage=%23%2Fstatements -> will navigate to statements THRIVE0001://open?targetPage=%23%2Fbranches -> will navigate to branches THRIVE0001://open?targetPage=%23%2Fsettings%2Fsecurity -> will navigate to settings/security

Deep Linking to a Specific Page in the Mobile App (Android)

A deep link URL to open the app must be formatted using the following pattern: app://{packageName}/open?targetPageName={EncodedUUXPage}

Note

The query parameter for Android is targetPageName

To know the URL for an individual page, open online banking in the browser, navigate to that page and copy the path (everything after uux.aspx) The copied path should be URL encoded, you can use this page to convert: https://www.urlencoder.org

To find the package name of an Android application, follow this guide:

https://www.techmesto.com/find-android-app-package-name/

Warning

If the user has already downloaded Q2’s Android mobile banking app, but has not opened, deep links will not work and a blank page will be shown. This is because the link is not registered– the app needs to be run once for deep links to work.

Once the app has been opened at least once, the deep link will work and open the app upon being accessed.

Example for the Sales Demo:

app://com.q2ebanking.gen2.SDXProdThrive/open?targetPageName=uux.aspx%23%2Ftransfer