Jump to Content
Guides
API Reference
Changelog
Postman collections ↗
Bud Console ↗
API Reference
Postman collections ↗
Bud Console ↗
Guides
API Reference
Changelog
Retrieve Affordability Report
All
Pages
Start typing to 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
del
Retrieve Remove Customer V3 Status
get
Retrieve Customer Context
get
Update Customer Context
put
Remove Customer By Idempotent Identifier V3
del
Connect API
Create a Connection
Retrieve Bank Providers
get
Retrieve Authorisation Gateway URL (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
Ingest First Party Data
Ingest Accounts
post
Ingest Transactions
post
Close Accounts
post
Book Transactions
post
Reopen Accounts
post
Decline Transactions
post
Retrieve Ingestion Task Status
get
Financial Data API
Retrieve Financial Data
Retrieve Accounts V3
get
Retrieve Account By ID V3
get
Retrieve Balances Over Time V3
get
Retrieve Balances Over Time By Account V3
get
Retrieve Enriched Transactions V2
get
Retrieve Accounts V2
get
Retrieve Account By ID V2
get
Retrieve Balances Over Time
get
Retrieve Balances Over Time By Account
get
Retrieve Account Transaction Dates
get
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
Manage Financial Data
Remove Account Data V2
del
Enrichment API
Enrichment Totals
Retrieve Category Totals V2
get
Retrieve Category Totals Trends
get
Retrieve Statistics For Essential Total Spend
get
Retrieve Merchant Totals V2
get
Enrichment Resources
Retrieve Available Categorisation Models V2
get
Retrieve Categories V2
get
Retrieve Categories
get
Smart Finders API
Regular Payments Finder
Retrieve Regular Transactions
get
Retrieve Future Forecasted 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
del
Update Savings Goal
patch
Remove Savings Goal
del
Create Savings Goal Action
post
Retrieve Savings Goal Actions
get
Update Savings Goal Action
patch
Remove Savings Goal Action
del
Spending Budgets
Create Spending Budget
post
Retrieve Spending Budgets
get
Delete all Spending Budgets
del
Patch a Spending Budget
patch
Delete a Spending Budget
del
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
del
Update existing custom insight
patch
Delete all existing custom insights
del
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
Generate Intelligent Search Widget URL
post
Generate Accounts URL
post
Generate Spending Budgets 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
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
Customer Application Links
Aggregation Buckets
Retrieve Affordability Report
Retrieve Affordability Report V2
Retrieve Affordability Risk Insights
MCP (Model Context Protocol) API
MCP (Model Context Protocol)
Create MCP (Model Context Protocol) URL
post
Retrieve Affordability Report
Ask AI
