Guides and tutorials

Configuring the Bud Connect journey

Bud Connect allows you to make a series of different configurations for the Connect user journey to suit your use case. Below, we outline each of these configurations, how you can use them, and the impact each of them has on you and your customers. All the configurations in this guide are made when calling POST v2/open-banking/authorisation-gateway-url, the accompanying documentation for the request body schema can be found here.

Entire flow

Provider configurations

Here we give an overview of which configurations you can make to the screen used to allow the customer to select a banking provider. The configurations include filtering, specifying one provider, or specifying a list of providers.

To specify one provider (Remove select-a-provider screen)

Group 36 (1)

You can specify one banking provider using the following API call.

POST /v2/open-banking/authorisation-gateway-url

{
"redirect_url":"https://thisisbud.com/",
"providers": ["HSBC"]
}


By specifying the banking provider, the customer will skip the ‘select-a-provider' screen, this screen presents the user with a list of banking providers that they are able to connect to. Upon consenting to the end-user agreement, the customer will be redirected to your specified banking provider's mobile app or online banking page. For example, if you specify “HSBC" in the “providers" parameter, your customer will be sent to HSBC's app or banking page.

This configuration can be used if you already have identified accounts that your customers own or if you need the customer to reconsent to an expired account connection.

To specify a list of providers

Group 37 (1)

You can also specify a list of providers using the following API call.

POST /v2/open-banking/authorisation-gateway-url
{
"redirect_url":"https://thisisbud.com/",
"providers": ["Barclays", "Lloyds"]
}


You can specify each banking provider you would like to show to your customer(s) in the "providers" parameter and create a list of banking providers, excluding others that are available via Buds API. For example, specifying "Barclays" and "Lloyds" will display accounts from just those two banking providers when your customer reaches the ‘select-a provider’ screen.

This configuration can be used when you already know the list of banks that your customer has to provide them with a more personalised experience.

Group 15064Config

 

To filter providers

Group 37 (1)

You can filter providers by type using the following API call.

POST /v2/open-banking/authorisation-gateway-url
{
"redirect_url":"https://thisisbud.com/",
"provider_types": ["business"] ["retail"]
}


By specifying the provider type, you can filter which providers are shown in the ‘select-a-provider’ screen. You are able to choose from "business" or "retail" depending on your use case.

This configuration can be used if your customers only have retail accounts or only have business accounts.

Group 15065Config (1)

 

Connect more accounts

You can add a button to allow the customer to ‘connect another account'. This can be used in conjunction with other configurations included in this guide. 

To enable the ‘connect another account' button

Group 38 (1)

You can give your customer the option of connecting to more than one account using the following API call.

POST /v2/open-banking/authorisation-gateway-url
{
"redirect_url":"https://thisisbud.com/",
"connect_more_accounts_button": true
}


Once your customer has successfully connected an account, by setting the
"connect_more_accounts_button" as "true", you will present an option to the customer for them to connect another account at the end of the connect journey. They will then be taken to the ‘select-a-provider’ screen to choose the banking provider they want to connect to. This button can be used as many times as necessary.

Group 15066Config



Account Summary

Here we give an overview of which configurations you can make to present the customer with their connected accounts at certain stages. The configurations include being presented to the customer when opening the journey or after connecting an account

Account summary - Before and after connecting an account

Group 42 (1)

You can provide your customer with a summary of their accounts on the initial Bud screen using the following API call and after the connection process.

POST /v2/open-banking/authorisation-gateway-url
{
"redirect_url":"https://thisisbud.com/",
"connect_more_accounts_button": true,
"initial_screen": "accounts_summary"
}


By using the parameter
"initial_screen" set as "accounts_summary" after your customer is directed to Bud to connect their accounts, before consenting or selecting a provider, they will be presented with an accounts summary screen. If they have no accounts connected they will be presented with the example screen below. If they do have accounts connected they will be visible and they will be given the option to connect more. You can use the summary screen here as a way for customers to view and manage their existing consents without needing to connect an account first.

Group 15067Config

 

Account summary - after connecting an account

Group 40 (1)

You can provide your customer with a summary of their accounts after connecting an account using the following API call. The redirect URL will be dependent on your chosen URL, the example below is for illustration purposes.

POST /v2/open-banking/authorisation-gateway-url
{
"redirect_url":"https://thisisbud.com/",
"accounts_summary": true
}


By setting the parameter “account_summary" as true you will show your customer a summary of their accounts after they have gone through the process of connecting their account. After they have successfully connected an account, the summary screen will be shown after pressing continue on the success page. Here, your customers can view and manage all of their consents for their connected accounts. If they wish to remove or add an account, they may also do this here.

This configuration can be used if you want the customer to be presented with all their account connections before returning back to your app. This can give the customer more control and visibility over their connected accounts.

Group 15068Config (1)

 

Account summary - allow customers to download their data

 Group 41 (1)

You can give your customer the option of retrieving a downloadable summary of their data using the following API call.

POST /v2/open-banking/authorisation-gateway-url
{
"redirect_url":"https://thisisbud.com/",
"accounts_summary": true,
"enable_account_data_management": true
}


By setting "enable_account_data_management" as true you can allow your customer to download their data in a JSON file. The customer can download their data by selecting the burger menu in the right-hand corner, above connected accounts. This will open up a menu with the option to ‘Download Data’.

This configuration can be used if your use case requires that the customer is able to download their data, or if you simply would like to give them the option of doing so.

Group 15069Config

 

 

 

 

 

Looking for more?

Get in touch with one of the team

Get started

Market coverage

All of our connections for account aggregation and payments

Get started

API Docs

Take a look at the resources available for our APIs.

API Docs