Authentication

OAuth2
- OAuth2post

Customers API

Manage Customers

Connect API

Create a Connection
Manage a Connection
Ingest First Party Data

Financial Data API

Retrieve Financial Data
Manage Financial Data
- Remove Provider Datadelete
Correct Financial Data

Enrichment API

Enrichment Resources
- Retrieve Available Categorisation Models V2get
- Retrieve Categories V2get
Enrichment Totals

Smart Finders API

Regular Payments Finder
- Retrieve Regular Transactionsget
- Retrieve Future Transactions V2get
Income Finder
Loan Finder
- Retrieve Loan Transactionsget
Debt Collection Finder
- Retrieve Debt Collection Transactionsget
Product Finder
- Retrieve Financial Products V2get
Subscription Finder
- Retrieve Subscriptionsget

Goals API

Savings Goals
Spending Budgets

Insights API

Retrieve Actionable Insights
Custom Insights
Frontend Widgets

Characteristics API

Retrieve Customer Characteristics

Assess API

Customer Applications
Customer Application Links
- Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Affordability Report
Retrieve Affordability Report V2
- Retrieve Affordability Report V2get
Retrieve Affordability Risk Insights

Payments API

Initiate Payment - Bud license
Initiate Payment - Client license
Manage Payments

Authentication

OAuth2
- OAuth2post

Customers API

Manage Customers

Connect API

Create a Connection
Manage a Connection
Ingest First Party Data

Financial Data API

Retrieve Financial Data
Manage Financial Data
- Remove Provider Datadelete
Correct Financial Data

Enrichment API

Enrichment Resources
- Retrieve Available Categorisation Models V2get
- Retrieve Categories V2get
Enrichment Totals

Smart Finders API

Regular Payments Finder
- Retrieve Regular Transactionsget
- Retrieve Future Transactions V2get
Income Finder
Loan Finder
- Retrieve Loan Transactionsget
Debt Collection Finder
- Retrieve Debt Collection Transactionsget
Product Finder
- Retrieve Financial Products V2get
Subscription Finder
- Retrieve Subscriptionsget

Goals API

Savings Goals
Spending Budgets

Insights API

Retrieve Actionable Insights
Custom Insights
Frontend Widgets

Characteristics API

Retrieve Customer Characteristics

Assess API

Customer Applications
Customer Application Links
- Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Affordability Report
Retrieve Affordability Report V2
- Retrieve Affordability Report V2get
Retrieve Affordability Risk Insights

Payments API

Initiate Payment - Bud license
Initiate Payment - Client license
Manage Payments

Retrieve OB Providers

get https://api-sandbox.thisisbud.com/v1/open-banking/providers

List the available account providers with their name, icon and maintenance status.

Query Params

types

string

A comma separated list of Bud support provider types to be shown. If no filter is applied, all the providers are returned.

region

string

A comma separated list of Bud regions to be shown. If no filter is applied, all the providers are returned.

scopes

string

A comma separated list of Bud ob scopes to be shown. If no filter is applied, all the providers are returned.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

Responses

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

data

array of objects

required

data*

object

provider

string

required

The name of the available open banking provider used as an identifier throughout Bud's API services

display_name

string

required

The name of the available open banking provider used for display purposes

maintenance_window

required

maintenance_status

string

required

The status of the maintenance window associated with the provider

active inactive

icon

string

required

A URL for the icon of the corresponding provider

regions

array of strings

required

A list of the different regions (i.e. country codes in ISO 3166 format) associated with the open banking provider

regions*

mobile_only

boolean

required

If true, the provider is only available on mobile devices and requires a dedicated provider app to be installed on the device

metadata

400

Bad Request that fails validations on headers & payload

401

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

5XX

An unexpected error occurred on the server side

Updated over 1 year ago

Update Customer Context

Retrieve Authorisation Gateway URL (v2)

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.thisisbud.com/v1/open-banking/providers \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated over 1 year ago

Update Customer Context

Retrieve Authorisation Gateway URL (v2)

Did this page help you?

Authentication
OAuth2
OAuth2post

Customers API
Manage Customers
Update Customer Contextput
Retrieve Customer Contextget
Remove Customerdelete
Create Customer(s)post
Create Customerpost
Retrieve Remove Customer V3 Statusget
Remove Customer V3delete
Create Customers V3 (Batch)post
Retrieve Customers V3get
Create Customer V3post

Connect API
Create a Connection
Retrieve Connection Statusget
Submit Authorisation Codes V2post
Submit Authorisation Codespost
Retrieve Authorisation URLget
Initiate Provider Authorisationpost
Retrieve Authorisation Gateway URL (v2)post
Retrieve OB Providersget
Manage a Connection
Reconfirm Consentpost
Retrieve Revoke Consent Statusget
Initiate Revoke Consentpost
Retrieve Customer Consentsget
Retrieve Refresh Status V2get
Initiate Refresh V2post
Retrieve Refresh Statusget
Initiate Refreshpost
Ingest First Party Data
Retrieve Ingestion Task Statusget
Decline Transactionspost
Book Transactionspost
Ingest Transactionspost
Ingest Accountspost

Financial Data API
Retrieve Financial Data
Retrieve Authorised Payments V2get
Retrieve Transactions V2get
Retrieve Balances Over Time By Account V3get
Retrieve Balances Over Time V3get
Retrieve Balances Over Time By Accountget
Retrieve Balances Over Timeget
Retrieve Account By ID V3get
Retrieve Accounts V3get
Retrieve Account By ID V2get
Retrieve Accounts V2get
Manage Financial Data
Remove Provider Datadelete
Correct Financial Data
Suggests changes to a merchantpost
Similar Transactions Including Merchantsget
Similar Transactionsget
Fetch custom merchants for customerget
Create a new custom merchantpost
Correction Merchant Searchget
Correct Transaction Merchantpost
Correct Transaction Categories V2post

Enrichment API
Enrichment Resources
Retrieve Categories V2get
Retrieve Available Categorisation Models V2get
Enrichment Totals
Retrieve Merchant Totals V2get
Retrieve Statistics For Essential Total Spendget
Retrieve Category Totals Trendsget
Retrieve Category Totals V2get

Smart Finders API
Regular Payments Finder
Retrieve Future Transactions V2get
Retrieve Regular Transactionsget
Income Finder
Retrieve Benefits Totalsget
Retrieve Benefits Transactionsget
Retrieve Income Transactions V2get
Loan Finder
Retrieve Loan Transactionsget
Debt Collection Finder
Retrieve Debt Collection Transactionsget
Product Finder
Retrieve Financial Products V2get
Subscription Finder
Retrieve Subscriptionsget

Goals API
Savings Goals
Remove Savings Goal Actiondelete
Update Savings Goal Actionpatch
Retrieve Savings Goal Actionsget
Create Savings Goal Actionpost
Remove Savings Goaldelete
Update Savings Goalpatch
Remove All Savings Goalsdelete
Retrieve Savings Goalsget
Create Savings Goalpost
Spending Budgets
Retrieve Spending Budget Transactionsget
Delete a Spending Budgetdelete
Patch a Spending Budgetpatch
Delete all Spending Budgetsdelete
Retrieve Spending Budgetsget
Create Spending Budgetpost

Insights API
Retrieve Actionable Insights
Retrieve Spending Actionable Insight Detailsget
Retrieve Spending Actionable Insightsget
Retrieve Income Actionable Insight Detailsget
Retrieve Income Actionable Insightsget
Retrieve Balances Actionable Insight Detailsget
Retrieve Balances Actionable Insightsget
Custom Insights
Retrieve custom insights profileget
Build custom insights profilepost
Delete all existing custom insightsdelete
Update existing custom insightpatch
Delete existing custom insightdelete
Detail the transactions used to generate a custom insightget
List existing custom insightsget
Create new custom insightpost
Frontend Widgets
Generate Spending Analysis URLpost
Generate Recurring and Forecasted Transactions URLpost
Generate Balances Over Time URLpost
Generate Financial Calendar URLpost
Generate Card Summary URLpost

Characteristics API
Retrieve Customer Characteristics
Retrieve Customer Characteristics - Saverget
Retrieve Customer Characteristics - Overdraftget
Retrieve Customer Characteristics - Loanget
Retrieve Customer Characteristics - Credit Cardget
Retrieve Customer Characteristicsget

Assess API
Customer Applications
Delete Customer Applicationdelete
Retrieve Customer Applicationget
Retrieve Customer Applicationsget
Create Customer Applicationpost
Customer Application Links
Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Bucket Totalsget
Delete Bucketsdelete
Update Bucketput
Retrieve Bucketget
Retrieve All Bucketsget
Create Bucketspost
Retrieve Affordability Report
Retrieve Affordability Transactions V2get
Retrieve Affordability Transactionsget
Retrieve Affordability Reportget
Retrieve Affordability Report V2
Retrieve Affordability Report V2get
Retrieve Affordability Risk Insights
Retrieve transactions relating to a specific insight report section.get
Retrieve a health report on a customers financial profile.get
Retrieve transactions relating to a specific insight report section.get
Retrieve a report on a customers unauthorised overdraft.get
Retrieve transactions relating to a specific insight report section.get
Retrieve merchant-specific breakdown reports.get
Retrieve transactions relating to a specific insight report section.get
Retrieve income/expenditure break down reportsget

Payments API
Initiate Payment - Bud license
Retrieve Bud Pay URL - Scheduled Paymentpost
Retrieve Bud Pay URL - Standing Orderpost
Retrieve Bud Pay URL - Single Paymentpost
Retrieve Providersget
Initiate Payment - Client license
Confirm Scheduled Paymentpost
Create Scheduled Paymentpost
Confirm Standing Orderpost
Create Standing Orderpost
Confirm Single Paymentpost
Submit Authorisation Codespost
Create Single Paymentpost
Manage Payments
Retrieve Scheduled Payment Statusget
Search for Scheduled Paymentsget
Retrieve Standing Order Payment Statusget
Search for Standing Ordersget
Retrieve Single Payment Statusget
Search for Single Paymentsget

Authentication
OAuth2
OAuth2post

Customers API
Manage Customers
Update Customer Contextput
Retrieve Customer Contextget
Remove Customerdelete
Create Customer(s)post
Create Customerpost
Retrieve Remove Customer V3 Statusget
Remove Customer V3delete
Create Customers V3 (Batch)post
Retrieve Customers V3get
Create Customer V3post

Connect API
Create a Connection
Retrieve Connection Statusget
Submit Authorisation Codes V2post
Submit Authorisation Codespost
Retrieve Authorisation URLget
Initiate Provider Authorisationpost
Retrieve Authorisation Gateway URL (v2)post
Retrieve OB Providersget
Manage a Connection
Reconfirm Consentpost
Retrieve Revoke Consent Statusget
Initiate Revoke Consentpost
Retrieve Customer Consentsget
Retrieve Refresh Status V2get
Initiate Refresh V2post
Retrieve Refresh Statusget
Initiate Refreshpost
Ingest First Party Data
Retrieve Ingestion Task Statusget
Decline Transactionspost
Book Transactionspost
Ingest Transactionspost
Ingest Accountspost

Financial Data API
Retrieve Financial Data
Retrieve Authorised Payments V2get
Retrieve Transactions V2get
Retrieve Balances Over Time By Account V3get
Retrieve Balances Over Time V3get
Retrieve Balances Over Time By Accountget
Retrieve Balances Over Timeget
Retrieve Account By ID V3get
Retrieve Accounts V3get
Retrieve Account By ID V2get
Retrieve Accounts V2get
Manage Financial Data
Remove Provider Datadelete
Correct Financial Data
Suggests changes to a merchantpost
Similar Transactions Including Merchantsget
Similar Transactionsget
Fetch custom merchants for customerget
Create a new custom merchantpost
Correction Merchant Searchget
Correct Transaction Merchantpost
Correct Transaction Categories V2post

Enrichment API
Enrichment Resources
Retrieve Categories V2get
Retrieve Available Categorisation Models V2get
Enrichment Totals
Retrieve Merchant Totals V2get
Retrieve Statistics For Essential Total Spendget
Retrieve Category Totals Trendsget
Retrieve Category Totals V2get

Smart Finders API
Regular Payments Finder
Retrieve Future Transactions V2get
Retrieve Regular Transactionsget
Income Finder
Retrieve Benefits Totalsget
Retrieve Benefits Transactionsget
Retrieve Income Transactions V2get
Loan Finder
Retrieve Loan Transactionsget
Debt Collection Finder
Retrieve Debt Collection Transactionsget
Product Finder
Retrieve Financial Products V2get
Subscription Finder
Retrieve Subscriptionsget

Goals API
Savings Goals
Remove Savings Goal Actiondelete
Update Savings Goal Actionpatch
Retrieve Savings Goal Actionsget
Create Savings Goal Actionpost
Remove Savings Goaldelete
Update Savings Goalpatch
Remove All Savings Goalsdelete
Retrieve Savings Goalsget
Create Savings Goalpost
Spending Budgets
Retrieve Spending Budget Transactionsget
Delete a Spending Budgetdelete
Patch a Spending Budgetpatch
Delete all Spending Budgetsdelete
Retrieve Spending Budgetsget
Create Spending Budgetpost

Insights API
Retrieve Actionable Insights
Retrieve Spending Actionable Insight Detailsget
Retrieve Spending Actionable Insightsget
Retrieve Income Actionable Insight Detailsget
Retrieve Income Actionable Insightsget
Retrieve Balances Actionable Insight Detailsget
Retrieve Balances Actionable Insightsget
Custom Insights
Retrieve custom insights profileget
Build custom insights profilepost
Delete all existing custom insightsdelete
Update existing custom insightpatch
Delete existing custom insightdelete
Detail the transactions used to generate a custom insightget
List existing custom insightsget
Create new custom insightpost
Frontend Widgets
Generate Spending Analysis URLpost
Generate Recurring and Forecasted Transactions URLpost
Generate Balances Over Time URLpost
Generate Financial Calendar URLpost
Generate Card Summary URLpost

Characteristics API
Retrieve Customer Characteristics
Retrieve Customer Characteristics - Saverget
Retrieve Customer Characteristics - Overdraftget
Retrieve Customer Characteristics - Loanget
Retrieve Customer Characteristics - Credit Cardget
Retrieve Customer Characteristicsget

Assess API
Customer Applications
Delete Customer Applicationdelete
Retrieve Customer Applicationget
Retrieve Customer Applicationsget
Create Customer Applicationpost
Customer Application Links
Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Bucket Totalsget
Delete Bucketsdelete
Update Bucketput
Retrieve Bucketget
Retrieve All Bucketsget
Create Bucketspost
Retrieve Affordability Report
Retrieve Affordability Transactions V2get
Retrieve Affordability Transactionsget
Retrieve Affordability Reportget
Retrieve Affordability Report V2
Retrieve Affordability Report V2get
Retrieve Affordability Risk Insights
Retrieve transactions relating to a specific insight report section.get
Retrieve a health report on a customers financial profile.get
Retrieve transactions relating to a specific insight report section.get
Retrieve a report on a customers unauthorised overdraft.get
Retrieve transactions relating to a specific insight report section.get
Retrieve merchant-specific breakdown reports.get
Retrieve transactions relating to a specific insight report section.get
Retrieve income/expenditure break down reportsget

Payments API
Initiate Payment - Bud license
Retrieve Bud Pay URL - Scheduled Paymentpost
Retrieve Bud Pay URL - Standing Orderpost
Retrieve Bud Pay URL - Single Paymentpost
Retrieve Providersget
Initiate Payment - Client license
Confirm Scheduled Paymentpost
Create Scheduled Paymentpost
Confirm Standing Orderpost
Create Standing Orderpost
Confirm Single Paymentpost
Submit Authorisation Codespost
Create Single Paymentpost
Manage Payments
Retrieve Scheduled Payment Statusget
Search for Scheduled Paymentsget
Retrieve Standing Order Payment Statusget
Search for Standing Ordersget
Retrieve Single Payment Statusget
Search for Single Paymentsget

200List of providers available via Bud's Open Banking Aggregation APIs