Filtering Banks for User Selection
In order for your customers to be able to choose the bank in which they have an account and grant you permission to confirm available funds, the complete list of Token-connected banks for the desired country (where the banks are located) needs to be filtered by the open banking feature(s) needed to support the type of access the customer wants to permit; in this case, confirmation of available funds. The result of such filtering is a smaller list (subset) of Token-connected banks meeting the criteria specified, which is then displayed to the customer for selection. Of course, if the customer's bank isn't in the list, access to account information cannot go forward.
To present the user with an appropriate list of banks from which to select, you have two options:
- Redirect the user to the bank selection screen in the Token web app
- Display your own bank selection UIUser Interface – at the most basic level, this is the series of screens, pages, and visual elements—like buttons and icons—that enable a user to interact with your product or service.
The first method is invoked by default. It allows the user to search for their bank by entering the bank name or other bank identifier. The second leverages the SDK's getBanks method to retrieve a list of bank objects. Employing getBanks gives you the chance filter-out the banks that support the features you need before displaying them to the user for selection.
Using Token's Bank Selection Screen
If you choose to employ Token's web app for bank selection (pictured below, hover to enlarge), just submit the token request and construct the redirect URL with the requestId returned in the callback, then direct your front-end to visit it.
There are a couple of ways to accomplish this.
- Send an HTTP POST call to your backend to initiate the token request and redirect using a HTTP 302An HTTP response with this status code will additionally provide a URL in the header field Location. This is an invitation to the user agent (i.e., a web browser) to make a second, otherwise identical, request to the new URL specified in the location field. The end result is a redirection to the new URL..
- Create a Token button for your UI that, when clicked, redirects the user to the Token web app or launches a pop-up window in the user's browser. Use token.createRequest to automatically choose the best option based on the user's device (laptop/desktop vs. smartphone/tablet).
You can learn more about these redirect options for bank selection in the discussion on redirecting the user to authenticate.
As introduced above, the SDK's getBanks method is used to retrieve a list of Token-connected Bank objects matching your filtering criteria with respect to where the bank is located and the open banking features it supports. Based on the results, you can then perform additional filtering within your environment before presenting the finalised list to the customer for selection. Once the selection is made, you'll need to include the Bank ID of the chosen bank in your transfer token request.
Let's begin with the basic Bank object. It contains all the open banking information available for a single Token-connected bank. The AISAccount Information Service – supports TPP secure access to customer accounts and data, but only with the bank-verified consent of the customer.-related fields and attributes in the Bank object are listed in the following table.
Beginning with requires_one_step_payment in the table above, the fields that follow it are all payment-related features. These fields constitute the supported features you can specify in the bankFeatures parameter of a getBanks call for payment initiation.
Additional Filtering Criteria
In addition to bankFeatures, the getBanks method also specifies the parameters listed in the next table.
|bankIds||Returns banks with a bank id matching any of the bank IDs you provide in this field, up to a maximum of 1,000 banks|
|search||Returns banks with a name or identifier containing this case-sensitive search string|
|country||Returns banks located in a country matching any one of the country codes (ISO 3166-1 Alpha 2) included in this field|
|page||Returns only the paged results of the specified page; default = 1|
|perPage||Maximum number of records to return per page, up to a maximum of 200; default = 200|
|sort||Sorts collected results by bank name in ascending alpha order|
|provider||Returns banks using the specified provider only — FinApi, Token (case-sensitive)|
|bankFeatures||List of supported features desired (see Bank object above); specifically, supports_funds_confirmation
Here's how to use the getBanks method:
* Returns a list of token-enabled banks.
* @param bankIds If specified, return banks whose 'id' matches any one of the given ids
* (case-insensitive). Can be at most 1000.
* @param search If specified, return banks whose 'name' or 'identifier' contains the given
* search string (case-insensitive)
* @param country If specified, return banks whose 'country' matches the given ISO 3166-1
* alpha-2 country code (case-insensitive)
* @param page Result page to retrieve. Default to 1 if not specified.
* @param perPage Maximum number of records per page. Can be at most 200. Default to 200
* if not specified.
* @param sort The key to sort the results. Could be one of: name, provider and country.
* Defaults to name if not specified.
* @param provider If specified, return banks whose 'provider' matches the given provider
* (case insensitive).
* @return a list of banks
getBanks(bankIds, search, country, page, perPage, sort, provider, bankFeatures).
Upon obtaining the user-selected bankId from your UI, be sure to include it in the TokenRequest with setBankId() as discussed in Creating an Access Token Request.