Retrieve Authorisation Gateway URL (v2)

post https://api-sandbox.thisisbud.com/v2/open-banking/authorisation-gateway-url

Allow customers to authorise with, and connect to, a provider, using Bud’s Bud Connect. Bud Connect is a UI component hosted by Bud that can be integrated into any mobile or web experience, and
allows your customers to connect to and authorise with their chosen provider, allowing Bud to pull their account information.

Using the different configuration options that can be set through the request body you can personalize the experience for your Customer. Please, refer to the documentation below for more information about the available configurations.

The status of the authorisation step will be provided to you as a path parameter within the redirect_url specified within the request payload.
This redirect_url is where your customer will be redirected to once they have either failed, or successfully completed, the authorisation process with their provider.

The URL generated with this endpoint is valid for up to 30 minutes. We suggest to generate the URL right before redirecting your Customer to it.

Please note that in order to recieve status updates on a given account connection task, you will need to configure your Callback URL within the developer console.
Once the entire connection process has been completed and the customer's account information is ready to be collected, Bud will send a request to your callback URL.

Body Params

redirect_url

string

required

length ≤ 2083

URL where the Customer will be redirected to once they have completed the Connection flow. This can be a web based URL or a mobile application internal URL.
When the Customer is redirected to your URL we include the following query parameters:

status: Represents the status of the connection. It can be success, failure or pending
task_id: Is the identifier that can be used to check the status of the connection task and retrieve more information in case of failure

providers

array of strings | null

Specify a list of one or more providers that will be displayed to the customer during the connection flow. If only a single provider is given, the customer will no longer be shown the select provider screen.

Note, that these must match the provider_id returned by the Retrieve OB Providers endpoint.

providers

connect_more_accounts_button

boolean | null

When enabled, the customer will see an additional button at the end of the connection flow that allows them to start the connection flow again in order to connect to a new provider.

accounts_summary

boolean | null

When enabled, the customer will be shown a summary screen at the end of the flow that lists the names and balances of all of the accounts that the customer has active consents for (including those connected in previous sessions).

initial_screen

string | null

The first screen that the customer will be shown. When value is 'accounts_summary' the customer will see a list of the names and balances of the accounts that the customer currently has active consents for.
When value is 'connect_accounts', the customer will see a list of providers to connect their accounts with.
By default this value is 'connect_accounts'. When the value is 'download_data', the customer can download their data in a JSON file.
When the value is 'revoke_consent', the customer can revoke consent for accounts they have previously connected.

enable_async_connect

boolean | null

When enabled, once the consent authorisation has completed, the customer will be moved on in the flow. The data is then fetched and enriched in the background, instead of the customer waiting on a loading spinner

skip_success_screen

boolean | null

When enabled, once the customer has completed the connect flow, they will be redirected back to the client redirect_url bypassing the success screen. This should be used if you don’t want your customers to see the Bud success screen.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

Responses

401

Unauthorized (BearerToken in 'Authorization' header fails the authentication)

405

The request uses an unexpected HTTP method.

422

Unprocessable request (e.g. requested providers are in maintenance)

5XX

An unexpected error occurred on the server side

Callback

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.thisisbud.com/v2/open-banking/authorisation-gateway-url \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

201The resource has been successfully created.

400The request contains an invalid payload.