Jump to Content
Guides
API Reference
Changelog
Postman collections ↗
Bud Console ↗
API Reference
Postman collections ↗
Bud Console ↗
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
Changelog
Delete Buckets
Search
JUMP TO
Authentication
OAuth2
OAuth2
post
Customers API
Manage Customers
Create Customer V3
post
Retrieve Customers V3
get
Create Customers V3 (Batch)
post
Remove Customer V3
delete
Retrieve Remove Customer V3 Status
get
Create Customer
post
Create Customer(s)
post
Remove Customer
delete
Retrieve Customer Context
get
Update Customer Context
put
Connect API
Create a Connection
Retrieve OB Providers
get
Retrieve Authorisation Gateway URL (v2)
post
Initiate Provider Authorisation
post
Retrieve Authorisation URL
get
Submit Authorisation Codes
post
Submit Authorisation Codes V2
post
Retrieve Connection Status
get
Manage a Connection
Initiate Refresh
post
Retrieve Refresh Status
get
Initiate Refresh V2
post
Retrieve Refresh Status V2
get
Retrieve Customer Consents
get
Initiate Revoke Consent
post
Retrieve Revoke Consent Status
get
Reconfirm Consent
post
Ingest First Party Data
Ingest Accounts
post
Ingest Transactions
post
Book Transactions
post
Decline Transactions
post
Retrieve Ingestion Task Status
get
Financial Data API
Retrieve Financial Data
Retrieve Accounts V2
get
Retrieve Account By ID V2
get
Retrieve Accounts V3
get
Retrieve Account By ID V3
get
Retrieve Balances Over Time
get
Retrieve Balances Over Time By Account
get
Retrieve Balances Over Time V3
get
Retrieve Balances Over Time By Account V3
get
Retrieve Transactions V2
get
Retrieve Authorised Payments V2
get
Manage Financial Data
Remove Provider Data
delete
Correct Financial Data
Correct Transaction Categories V2
post
Correct Transaction Merchant
post
Correction Merchant Search
get
Create a new custom merchant
post
Fetch custom merchants for customer
get
Similar Transactions
get
Similar Transactions Including Merchants
get
Suggests changes to a merchant
post
Enrichment API
Enrichment Resources
Retrieve Available Categorisation Models V2
get
Retrieve Categories V2
get
Enrichment Totals
Retrieve Category Totals V2
get
Retrieve Category Totals Trends
get
Retrieve Statistics For Essential Total Spend
get
Retrieve Merchant Totals V2
get
Smart Finders API
Regular Payments Finder
Retrieve Regular Transactions
get
Retrieve Future Transactions V2
get
Income Finder
Retrieve Income Transactions V2
get
Retrieve Benefits Transactions
get
Retrieve Benefits Totals
get
Loan Finder
Retrieve Loan Transactions
get
Debt Collection Finder
Retrieve Debt Collection Transactions
get
Product Finder
Retrieve Financial Products V2
get
Subscription Finder
Retrieve Subscriptions
get
Goals API
Savings Goals
Create Savings Goal
post
Retrieve Savings Goals
get
Remove All Savings Goals
delete
Update Savings Goal
patch
Remove Savings Goal
delete
Create Savings Goal Action
post
Retrieve Savings Goal Actions
get
Update Savings Goal Action
patch
Remove Savings Goal Action
delete
Spending Budgets
Create Spending Budget
post
Retrieve Spending Budgets
get
Delete all Spending Budgets
delete
Patch a Spending Budget
patch
Delete a Spending Budget
delete
Retrieve Spending Budget Transactions
get
Insights API
Retrieve Actionable Insights
Retrieve Balances Actionable Insights
get
Retrieve Balances Actionable Insight Details
get
Retrieve Income Actionable Insights
get
Retrieve Income Actionable Insight Details
get
Retrieve Spending Actionable Insights
get
Retrieve Spending Actionable Insight Details
get
Custom Insights
Create new custom insight
post
List existing custom insights
get
Detail the transactions used to generate a custom insight
get
Delete existing custom insight
delete
Update existing custom insight
patch
Delete all existing custom insights
delete
Build custom insights profile
post
Retrieve custom insights profile
get
Frontend Widgets
Generate Card Summary URL
post
Generate Financial Calendar URL
post
Generate Balances Over Time URL
post
Generate Recurring and Forecasted Transactions URL
post
Generate Spending Analysis URL
post
Characteristics API
Retrieve Customer Characteristics
Retrieve Customer Characteristics
get
Retrieve Customer Characteristics - Credit Card
get
Retrieve Customer Characteristics - Loan
get
Retrieve Customer Characteristics - Overdraft
get
Retrieve Customer Characteristics - Saver
get
Intelligent Search API
Transaction Search
Create Intelligent Search Frontend Widget URL
post
Search customer transactions.
get
Get transaction search by ID.
get
Get transaction search insight.
get
Get transactions used by the search insight.
get
Assess API
Customer Applications
Create Customer Application
post
Retrieve Customer Applications
get
Retrieve Customer Application
get
Delete Customer Application
delete
Customer Application Links
Retrieve Customer Application URL
post
Aggregation Buckets
Create Buckets
post
Retrieve All Buckets
get
Retrieve Bucket
get
Update Bucket
put
Delete Buckets
delete
Retrieve Bucket Totals
get
Retrieve Affordability Report
Retrieve Affordability Report
get
Retrieve Affordability Transactions
get
Retrieve Affordability Transactions V2
get
Retrieve Affordability Report V2
Retrieve Affordability Report V2
get
Retrieve Affordability Risk Insights
Retrieve income/expenditure break down reports
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 a report on a customers unauthorised overdraft.
get
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
Payments API
Initiate Payment - Bud license
Retrieve Providers
get
Retrieve Bud Pay URL - Single Payment
post
Retrieve Bud Pay URL - Standing Order
post
Retrieve Bud Pay URL - Scheduled Payment
post
Initiate Payment - Client license
Create Single Payment
post
Submit Authorisation Codes
post
Confirm Single Payment
post
Create Standing Order
post
Confirm Standing Order
post
Create Scheduled Payment
post
Confirm Scheduled Payment
post
Manage Payments
Search for Single Payments
get
Retrieve Single Payment Status
get
Search for Standing Orders
get
Retrieve Standing Order Payment Status
get
Search for Scheduled Payments
get
Retrieve Scheduled Payment Status
get
Delete Buckets
delete
https://api-sandbox.thisisbud.com/aggregations/v2/buckets/
{bucket_id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer