# Bud Developer Hub Documentation > Welcome to Bud. Jumpstart your exploration and partnership with our guides, API documentation, and resources. A great developer experience or a curated learning journey for the not-so-technical. ## Guides: Welcome - [Start here](https://docs.thisisbud.com/docs/console-get-started.md) - [Get access to Bud API](https://docs.thisisbud.com/docs/get-access-to-bud.md) - [Postman collection quick start](https://docs.thisisbud.com/docs/postman-collection.md) - [OpenAPI spec and libraries](https://docs.thisisbud.com/docs/openapi-spec-and-libraries.md) ## Guides: Bud - [Want a demo?](https://docs.thisisbud.com/docs/want_a_demo.md) - [Intro to Bud](https://docs.thisisbud.com/docs/intro-to-bud.md) ## Guides: Fundamentals - [Fair Use Implementation Guide](https://docs.thisisbud.com/docs/fair-use-implementation-guide.md): This guidance should be front of mind when integrating the Bud platform - [Best Practice Recommendations](https://docs.thisisbud.com/docs/best-practice-recommendations.md): Optimise and fine tune your integration with Bud by following these recommendations. - [Authentication](https://docs.thisisbud.com/docs/authentication.md) - [Client Secret Rotation](https://docs.thisisbud.com/docs/rotate-an-app-secret.md) - [Setup your Customers](https://docs.thisisbud.com/docs/setup-customers.md) - [Use your own User ID](https://docs.thisisbud.com/docs/use-your-own-user-id.md) - [Environments and limits](https://docs.thisisbud.com/docs/environments.md) - [Sandbox environment](https://docs.thisisbud.com/docs/sandbox-environment.md) - [Sandbox call limits](https://docs.thisisbud.com/docs/sandbox-call-limits.md) - [Production environment](https://docs.thisisbud.com/docs/production-environment.md) - [Webhook setup](https://docs.thisisbud.com/docs/webhook-setup.md) - [API message formats](https://docs.thisisbud.com/docs/api-message-formats.md) - [Custom headers](https://docs.thisisbud.com/docs/request-custom-headers.md) - [Success responses](https://docs.thisisbud.com/docs/success-responses.md) - [Error responses](https://docs.thisisbud.com/docs/error-responses.md) - [Versioning & deprecations](https://docs.thisisbud.com/docs/versioning.md) ## Guides: BUD OBJECTS - [Transactions](https://docs.thisisbud.com/docs/transactions.md) - [Accounts](https://docs.thisisbud.com/docs/accounts.md) - [Authorised payments](https://docs.thisisbud.com/docs/authorised-payments.md) ## Guides: Connect - [Intro to Connect](https://docs.thisisbud.com/docs/intro-to-connect.md) - Setting up Connect - [Set up Connect under Bud's licence](https://docs.thisisbud.com/docs/setup-bud-banking-connections.md) - [Set up Connect with your own license](https://docs.thisisbud.com/docs/setup-connect-with-your-own-license.md) - [Consents](https://docs.thisisbud.com/docs/consents.md): Learn about consents and how they should be managed. - How to test Connect - [Connect sandbox credential(s)](https://docs.thisisbud.com/docs/connect-sandbox-credentials.md) - [Configure the journey](https://docs.thisisbud.com/docs/configure-the-journey.md) - [Customise user interface (UI)](https://docs.thisisbud.com/docs/customise-the-user-interface-ui.md) - [Get the most out of Connect](https://docs.thisisbud.com/docs/get-the-most-out-of-connect.md) - [Connect coverage table](https://docs.thisisbud.com/docs/connect-coverage-table.md) - [Transaction history](https://docs.thisisbud.com/docs/transaction-history.md) - [Revoking consent and deleting data](https://docs.thisisbud.com/docs/revoking-consent-and-deleting-data.md) - [Connect API errors](https://docs.thisisbud.com/docs/connect-errors.md) - [Auth Denied](https://docs.thisisbud.com/docs/auth-denied.md) - [Auth Expired](https://docs.thisisbud.com/docs/auth-expired.md) - [Auth Used](https://docs.thisisbud.com/docs/auth-used.md) - [Awaiting Authorisation](https://docs.thisisbud.com/docs/awaiting-authorisation.md) - [Connection Expired](https://docs.thisisbud.com/docs/connection-expired.md) - [Connection Not Found](https://docs.thisisbud.com/docs/connection-not-found.md) - [Connection Permission](https://docs.thisisbud.com/docs/connection-permission.md) - [Connection Reauthenticate](https://docs.thisisbud.com/docs/re-authenticate.md) - [Connection Revoked](https://docs.thisisbud.com/docs/connection-revoked.md) - [Connection Status](https://docs.thisisbud.com/docs/connection-status.md) - [Consent Not Found](https://docs.thisisbud.com/docs/consent-not-found.md) - [Extension Not Permitted](https://docs.thisisbud.com/docs/extension-not-permitted.md) - [Internal Auth Error](https://docs.thisisbud.com/docs/internal-auth-error.md) - [Provider Endpoint Deprecated](https://docs.thisisbud.com/docs/provider-endpoint-deprecated.md) - [Provider Endpoint Unimplemented](https://docs.thisisbud.com/docs/provider-endpoint-unimplemented.md) - [Provider Endpoint Unsupported](https://docs.thisisbud.com/docs/provider-endpoint-unsupported.md) - [Provider Failure](https://docs.thisisbud.com/docs/provider-failed.md) - [Provider Limit](https://docs.thisisbud.com/docs/provider-limit.md) - [Provider Maintenance](https://docs.thisisbud.com/docs/provider-maintenance.md) - [Provider Marked Account Invalid](https://docs.thisisbud.com/docs/provider-marked-account-invalid.md) - [Provider Not Found](https://docs.thisisbud.com/docs/provider-not-found.md) - [Provider Unauthorised](https://docs.thisisbud.com/docs/provider-unauthorised.md) - [Provider Unavailable](https://docs.thisisbud.com/docs/provider-unavailable.md) - [Provider Timeout](https://docs.thisisbud.com/docs/provider-timeout.md) - [Request Decoding](https://docs.thisisbud.com/docs/request-decoding.md) - [Request Validation](https://docs.thisisbud.com/docs/request-validation.md) - [Resource Not Found](https://docs.thisisbud.com/docs/resource-not-found.md) - [Task Not Found](https://docs.thisisbud.com/docs/task-not-found.md) - [Consent Revoke Reasons](https://docs.thisisbud.com/docs/consent-revoke-reasons.md) - [Bud Hosted Refreshes](https://docs.thisisbud.com/docs/open-banking-hosted-refreshes.md): For a simpler integration, let Bud take control of your background refreshes. - [Refreshing customer accounts](https://docs.thisisbud.com/docs/refreshing-customer-accounts.md) - [Working with existing aggregators](https://docs.thisisbud.com/docs/migrating-from-existing-aggregators.md) - [Set up First Party Ingestion](https://docs.thisisbud.com/docs/setup_data_enrichment.md): How to successfully ingest customer transactions into the Bud Platform. - [Synchronous Transaction Enrichment End-to-End Walkthrough](https://docs.thisisbud.com/docs/synchronous-transaction-enrichment-end-to-end-walkthrough.md) - [Keep Your Data in Sync with Bud](https://docs.thisisbud.com/docs/keep-your-data-in-sync-with-bud.md) - [Webhooks](https://docs.thisisbud.com/docs/connect-webhooks.md): Use webhooks to be notified when Open Banking or ingestion events occur - [Open Banking Connect Completed](https://docs.thisisbud.com/docs/open-banking-connect-completed.md): open_banking.connect.completed - [Open Banking Refresh Completed](https://docs.thisisbud.com/docs/open-banking-refresh-completed.md): open_banking.refresh.completed - [Open Banking Refresh V2 Completed](https://docs.thisisbud.com/docs/open-banking-v2-refresh-completed.md): open_banking.v2.refresh.completed - [Open Banking Refresh V2 Provider Completed](https://docs.thisisbud.com/docs/open-banking-v2-refresh-provider-completed.md): open_banking.v2.refresh.provider.completed - [Open Banking Consent Reconfirmed](https://docs.thisisbud.com/docs/open-banking-consent-reconfirmed.md): open_banking.consent.reconfirmed - [Open Banking Consent Revoked](https://docs.thisisbud.com/docs/open-banking-consent-revoked.md): open_banking.consent.revoked - [First Party Data Ingestion Events](https://docs.thisisbud.com/docs/first-party-data-ingestion-events.md): first_party_ingester.ingest.succeeded and first_party_ingester.ingest.failed ## Guides: Engage - [Introduction to Engage](https://docs.thisisbud.com/docs/intro-to-engage.md) - [Displaying Category and Merchant Totals](https://docs.thisisbud.com/docs/displaying-category-and-merchant-totals.md) - [Regular Payments Finder](https://docs.thisisbud.com/docs/regular-payments-finder-1.md) - [Income Finder](https://docs.thisisbud.com/docs/income-finder-1.md) - [Benefits Finder](https://docs.thisisbud.com/docs/benefits-finder.md) - [Loan & Debt Finders](https://docs.thisisbud.com/docs/loan-debt-finders.md) - [Product Finder](https://docs.thisisbud.com/docs/product-finder-1.md) - [Subscription Finder](https://docs.thisisbud.com/docs/subscription-finder-1.md) - [Spending Budgets](https://docs.thisisbud.com/docs/spending-budgets-1.md) - [Actionable Insights](https://docs.thisisbud.com/docs/actionable-insights.md) - [Custom Insights](https://docs.thisisbud.com/docs/custom-insights.md) - [Customer Characteristics](https://docs.thisisbud.com/docs/customer-characteristics.md) - [Intelligent Search](https://docs.thisisbud.com/docs/intelligent-search-2.md) - [Locations](https://docs.thisisbud.com/docs/locations.md) - [Correcting transactions categories](https://docs.thisisbud.com/docs/correcting-transactions.md) - [Correcting transactions merchants](https://docs.thisisbud.com/docs/correcting-transactions-merchants.md) - [How Engage can help with cost of living](https://docs.thisisbud.com/docs/how-insights-can-help-with-cost-of-living.md) - [Subscriptions](https://docs.thisisbud.com/docs/subscriptions.md) - [Credit cards](https://docs.thisisbud.com/docs/credit-cards.md) - [Loan repayments](https://docs.thisisbud.com/docs/loan-repayments.md) - [Total debt](https://docs.thisisbud.com/docs/total-debt.md) - [Spending compared to last month](https://docs.thisisbud.com/docs/spending-compared-to-last-month.md) - [Spending on non-essentials](https://docs.thisisbud.com/docs/spending-on-non-essentials.md) - [Forecasting future transactions](https://docs.thisisbud.com/docs/forecasting-future-transactions.md) - [Emergency fund](https://docs.thisisbud.com/docs/emergency-fund.md) - [Frontend Widgets](https://docs.thisisbud.com/docs/frontend-widgets-1.md): Frontend widgets that a developer can quickly and easily embed into your application - [Accounts Widget](https://docs.thisisbud.com/docs/accounts-widget.md) - [Intelligent Search Widget](https://docs.thisisbud.com/docs/intelligent-search.md) - [Balances Over Time Widget](https://docs.thisisbud.com/docs/balances-over-time.md) - [Action Cards Widget](https://docs.thisisbud.com/docs/action-cards-widget.md) - [Insight Summary Widget](https://docs.thisisbud.com/docs/insight-summary.md) - [Financial Calendar Widget](https://docs.thisisbud.com/docs/financial-calendar.md) - [Recurring and Forecasted Transactions Widget](https://docs.thisisbud.com/docs/recurring-and-forecasted-transactions.md) - [Spending Analysis Widget](https://docs.thisisbud.com/docs/spending-analysis.md) - [Spending Budgets Widget](https://docs.thisisbud.com/docs/spending-budgets-2.md) - [Savings Goals Widget](https://docs.thisisbud.com/docs/savings-goals.md) - [Net Worth Widget](https://docs.thisisbud.com/docs/net-worth.md) - [Engage Webhooks](https://docs.thisisbud.com/docs/engage-webhooks.md): Use webhooks to be notified when Insights or Financial data change events occur - [Insight Summary Completed](https://docs.thisisbud.com/docs/insight-summary-completed.md): insights.summary.completed - [Insights Balances Triggered](https://docs.thisisbud.com/docs/insights-balances-triggered.md): insights.balances.triggered - [Insights Spending Triggered](https://docs.thisisbud.com/docs/insights-spending-triggered.md): insights.spending.triggered - [Insights Income Triggered](https://docs.thisisbud.com/docs/insights-income-triggered.md): insights.income.triggered - [Corrections Category Corrected](https://docs.thisisbud.com/docs/corrections-category-corrected.md): corrections.category.corrected - [Corrections Merchant Corrected](https://docs.thisisbud.com/docs/corrections-merchant-corrected.md): corrections.merchant.corrected ## Guides: Drive - [Introduction to Drive](https://docs.thisisbud.com/docs/introduction-to-drive.md) - Drive Segments - [Creating your first Segment](https://docs.thisisbud.com/docs/creating-your-first-segment.md) - [Understanding Segment Criteria](https://docs.thisisbud.com/docs/understanding-segment-criteria.md) - [Working with Drive Flags](https://docs.thisisbud.com/docs/working-with-drive-flags.md) - Drive Campaigns - [Creating and Managing Campaigns](https://docs.thisisbud.com/docs/creating-and-managing-campaigns.md) - [Personalising Campaign Content](https://docs.thisisbud.com/docs/personalizing-campaign-content.md) - [Triggering Campaigns with BudQL](https://docs.thisisbud.com/docs/triggering-campaigns-with-budql.md) - [Displaying Campaigns](https://docs.thisisbud.com/docs/displaying-campaigns.md) - [Campaign Performance Insights](https://docs.thisisbud.com/docs/campaign-performance-insights.md) - [Campaign Agent Templates](https://docs.thisisbud.com/docs/campaign-agent-templates.md) - [Building Campaigns with the Campaign Agent](https://docs.thisisbud.com/docs/building-campaigns-with-the-campaign-agent.md) - [Drive Dashboards](https://docs.thisisbud.com/docs/drive-dashboards.md) - [Drive Model Context Protocol Servers](https://docs.thisisbud.com/docs/drive-model-context-protocol-servers.md): We supply Model Context Protocol (MCP) Servers to expose Drive functionality to your Agents. ## Guides: Assess - [Intro to Assess](https://docs.thisisbud.com/docs/intro-to-assess.md) - [Assess dashboard](https://docs.thisisbud.com/docs/assess-dashboard-get-started.md) - [Creating applications](https://docs.thisisbud.com/docs/dashboard-create-applications.md) - [Managing applications](https://docs.thisisbud.com/docs/dashboard-managing-applications.md) - [Reviewing applications](https://docs.thisisbud.com/docs/dashboard-reviewing-applications.md) - [Exporting application data](https://docs.thisisbud.com/docs/dashboard-export-application.md) - [Affordability Risk Insights](https://docs.thisisbud.com/docs/affordability-risk-insights.md) - [Assess API](https://docs.thisisbud.com/docs/assess-api-get-started.md) - [Creating Customer Applications](https://docs.thisisbud.com/docs/creating-customers-applications-for-assess-api-one-time-consent.md): Assess API (One Time Consent) - [Assess API to Assess Dashboard Create Customer Application Journey](https://docs.thisisbud.com/docs/hybrid-assess-api-to-assess-dashboard-create-customer-application-journey.md): The below steps should be followed when integrating the hybrid Assess API to Assess Dashboard Journey. - [Common aggregations](https://docs.thisisbud.com/docs/api-common-aggregations.md) - [Affordability report](https://docs.thisisbud.com/docs/api-affordability-report.md) - [Financial health indicators](https://docs.thisisbud.com/docs/api-financial-health-data.md) - [Custom aggregations](https://docs.thisisbud.com/docs/api-custom-aggregation.md) - [Affordability risk insights (beta)](https://docs.thisisbud.com/docs/api-affordability-insights.md) - [Categorisation and aggregation](https://docs.thisisbud.com/docs/categorisation-and-aggregation.md) - [Create your own dashboard](https://docs.thisisbud.com/docs/create-your-own-dashboard.md) ## Guides: Check - [Intro to Check](https://docs.thisisbud.com/docs/intro-to-check.md) - [How to perform account verification with Check](https://docs.thisisbud.com/docs/how-to-perform-account-verification-with-check.md) - [Check coverage table](https://docs.thisisbud.com/docs/check-coverage-table.md) ## Guides: Payments - [Setup payments](https://docs.thisisbud.com/docs/setup-bud-payments.md) - [Setup Payments with your own license](https://docs.thisisbud.com/docs/setup-payments-with-your-own-license.md) - [Payments coverage table](https://docs.thisisbud.com/docs/payments-coverage-table.md) - [Payments sandbox credential(s)](https://docs.thisisbud.com/docs/payments-sandbox-credentials.md) - [Webhooks](https://docs.thisisbud.com/docs/payment-webhooks.md): Use webhooks to be notified when Payments change state - [Payment Status Updated](https://docs.thisisbud.com/docs/payment-status-updated.md): payment.status.updated - [Standing Order Status Updated](https://docs.thisisbud.com/docs/standing-order-status-updated.md): standing_order.status.updated - [Scheduled Payment Status Updated](https://docs.thisisbud.com/docs/scheduled-payment-status-updated.md): scheduled_payment.status.updated ## Guides: AI SOLUTIONS - [Model Context Protocol](https://docs.thisisbud.com/docs/model-context-protocol.md) ## Guides: Bud Console - [Console sign up](https://docs.thisisbud.com/docs/console-sign-up-and-login.md) ## Guides: Support and Ops - [Contact support](https://docs.thisisbud.com/docs/contact-support.md) ## API Reference: Authentication - OAuth2 - [OAuth2](https://docs.thisisbud.com/reference/oauth_token_post.md): This endpoint is used to create access and refresh tokens. The access token is used as a bearer token to authenticate requests to Bud endpoints; the refresh token is used to generate a new access… - Client Secrets - [List Client Secrets](https://docs.thisisbud.com/reference/v1_client_secrets_get.md): This endpoint is used to retrieve the list of Client Secrets associated with a given set of API Credentials. Note that the `client_secret` value itself is never returned by this endpoint - it is… - [Create Client Secret](https://docs.thisisbud.com/reference/v1_client_secrets_post.md): This endpoint is used to create a new Client Secret for a given set of API Credentials. The `client_secret` value is only ever returned in the response to this request. Make sure to store it… - [Revoke Client Secret](https://docs.thisisbud.com/reference/v1_client_secret_revoke.md): This endpoint is used to revoke a single Client Secret associated with a given set of API Credentials. Once revoked, the `client_secret` can no longer be used to authenticate via the… ## API Reference: Customers API - Manage Customers - [Create Customer V3](https://docs.thisisbud.com/reference/platform_v3_customers_post.md): This endpoint is used to create a new Customer in order for them to consume the Bud services. When we refer to a Customer, we're talking about the end-user of yours and Bud's technology. Customer… - [Retrieve Customers V3](https://docs.thisisbud.com/reference/platform_v3_customers_get.md): This endpoint is used to list customers associated with the current project. Customers are listed ordered by their ID. Deleted customers will not be included in the list. The list of customers can… - [Create Customers V3 (Batch)](https://docs.thisisbud.com/reference/platform_v3_customers_batch_post.md): This endpoint is used to create a batch of new Customers in order for them to consume the Bud services. For more information on Customers in the Bud platform, please refer to our handy… - [Remove Customer V3](https://docs.thisisbud.com/reference/platform_v3_customers_delete.md): This endpoint is used to delete an existing Customer. Calling this endpoint initiates deleting all data relating to a customer returning a task id that can be used to check the status of the delete… - [Retrieve Remove Customer V3 Status](https://docs.thisisbud.com/reference/platform_v3_customers_delete_status.md): Check the status and get the result of a Remove Customer V3 task. - [Create Customer](https://docs.thisisbud.com/reference/customers_create_v1.md): This endpoint is used to create a new Customer in order for them to consume the Bud services. **Please note: this endpoint is now deprecated, please migrate to using the POST /v2/customers… - [Create Customer(s)](https://docs.thisisbud.com/reference/customers_create_v2.md): This endpoint is used to create one or many new Customers, in order for them to consume the Bud services. - [Remove Customer](https://docs.thisisbud.com/reference/customers_delete.md): This endpoint is used to delete an existing Customer. Calling this deletes all data associated with the customer including any Open Banking Consents. If the customer with the given ID does not exist… - [Retrieve Customer Context](https://docs.thisisbud.com/reference/v1_customer_context_get.md): Retrieve the customer level context, i.e. a set of parameters that defines their language, region and their customer type. - [Update Customer Context](https://docs.thisisbud.com/reference/v1_customer_context_put.md): Updates the customer context. All three body parameters (region, locale, and models) will overwrite any existing values. If a parameter is not provided, it's corresponding context field will be set… - [Remove Customer By Idempotent Identifier V3](https://docs.thisisbud.com/reference/platform_v3_customers_idempotent_identifier_delete.md): This endpoint is used to delete an existing Customer. Calling this endpoint initiates deleting all data relating to a customer returning a task id that can be used to check the status of the delete… ## API Reference: Connect API - Create a Connection - [Retrieve OB Providers](https://docs.thisisbud.com/reference/open_banking_providers_get.md): List the available account providers with their name, icon and maintenance status. - [Retrieve Authorisation Gateway URL (v2)](https://docs.thisisbud.com/reference/v2_ob_authorisation_gateway_url_post.md): 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… - [Initiate Provider Authorisation](https://docs.thisisbud.com/reference/open_banking_authorisation_url_post.md): Request a new Open Banking authorisation url for a specific Customer and provider. This endpoint should be used when using Bud as a Technical Service Provider(TSP). This means that Bud will be using… - [Retrieve Authorisation URL](https://docs.thisisbud.com/reference/open_banking_authorisation_url_get.md): Check the status and get the result of an Initiate Provider Authorisation URL task. If the task is not yet completed, the data element will be null. Once the customer has successfully authorised… - [Submit Authorisation Codes](https://docs.thisisbud.com/reference/v1_open_banking_authorisation_codes_post.md): When using Bud as a TSP (Technical Service Provider) and doing full app-to-app authorisation, the customer is returned from the provider directly back to your app. Your app will then need to send all… - [Submit Authorisation Codes V2](https://docs.thisisbud.com/reference/v2_open_banking_authorisation_codes_post.md): When using Bud as a TSP (Technical Service Provider) and doing full app-to-app authorisation, the customer is returned from the provider directly back to your app. Your app will then need to send all… - [Retrieve Connection Status](https://docs.thisisbud.com/reference/open_banking_connect_get.md): Check the status of an account connection task. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be ingested. The… - Manage a Connection - [Initiate Refresh](https://docs.thisisbud.com/reference/open_banking_refresh_post.md): Instruct Bud to retrieve the latest account information for a customer. Refresh the accounts from a single provider with an existing connection. By default this task will retrieve transactions since… - [Retrieve Refresh Status](https://docs.thisisbud.com/reference/open_banking_refresh_get.md): Check the status of an account information refresh task. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be collected via… - [Initiate Refresh V2](https://docs.thisisbud.com/reference/v2_open_banking_refresh_post.md): Instruct Bud to retrieve the latest account information for a customer. Refresh the accounts from all providers with an existing connection. By default this task will retrieve transactions since the… - [Retrieve Refresh Status V2](https://docs.thisisbud.com/reference/v2_open_banking_refresh_get.md): Check the status of an account information refresh task. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be collected via… - [Retrieve Customer Consents](https://docs.thisisbud.com/reference/open_banking_connections_get.md): Retrieve the list of all available Open Banking consents granted by the customer. > 📘 Note: > > For more information about Consents, please refer to our… - [Initiate Revoke Consent](https://docs.thisisbud.com/reference/open_banking_account_access_consent_revoke_post.md): Start a task to remove consent and remove Bud’s ability to download further information for a specified customer account. This will revoke `all` the consents for the specified provider associated to… - [Retrieve Revoke Consent Status](https://docs.thisisbud.com/reference/open_banking_account_access_consent_revoke_get.md): Check the status and result of a Revoke Consent task. Use the `task_id` taken from a successful `Initiate Revoke Consent` request. - [Reconfirm Consent](https://docs.thisisbud.com/reference/open_banking_consents_reconfirm_post.md): Reconfirm a customer's consent to extend the expiration date by 90 days. If the provider requires SCA authentication or the consent status is not showing "Authorised" or the consent is expired, the… - Ingest First Party Data - [Ingest Accounts](https://docs.thisisbud.com/reference/v2_ingest_accounts_post.md): This endpoint is for pushing customer(s) account(s) and balance(s) through the Bud architecture. It can ingest data for multiple customers per request. By default, this is synchronous and will report… - [Ingest Transactions](https://docs.thisisbud.com/reference/v2_ingest_transactions_post.md): This endpoint should be used to ingest customer transactions into the Bud Platform. By default, this endpoint is synchronous but can be easily switched to asynchronous using the… - [Book Transactions](https://docs.thisisbud.com/reference/v3_ingest_transactions_book_post.md): The Book Transactions endpoint, allows transactions ingested with a `status` of `pending` to set their status to `booked`. The date_time field indicates the timestamp when the transaction booked.… - [Decline Transactions](https://docs.thisisbud.com/reference/v3_ingest_transactions_decline_post.md): The Decline Transactions endpoint, allows transactions ingested with a `status` of `pending` to set their status to `declined`. The date_time field indicates the timestamp when the transaction… - [Retrieve Ingestion Task Status](https://docs.thisisbud.com/reference/v3_ingest_status_get.md): Check the status of an ingest request. Please note that this works for both the Ingest Transactions endpoints And Ingest Accounts endpoints. Reports status of the ingestion task, with details for… - [Close Accounts](https://docs.thisisbud.com/reference/v3_ingest_accounts_close_post.md): Close one or more accounts for a given customer. This will set the account status to closed and set the `closed_at` field on the __Retrieve Accounts V3__ response. If an account is already closed,… - [Reopen Accounts](https://docs.thisisbud.com/reference/v3_ingest_accounts_reopen_post.md): Reopen one or more accounts for a given customer. This will remove the account status and `closed_at` fields on the __Retrieve Accounts V3__ response. If an account is already open, then the request… ## API Reference: Financial Data API - Retrieve Financial Data - [Retrieve Accounts V3](https://docs.thisisbud.com/reference/financial_v3_accounts_get.md): Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below. > 📘 Note: > > For more information on the Account object, please refer to our… - [Retrieve Account By ID V3](https://docs.thisisbud.com/reference/financial_v3_accounts_account_id_get.md): Retrieves a customer's connected account by its ID. > 📘 Note: > > For more information on the Account object, please refer to our handy [guide](https://docs.thisisbud.com/docs/accounts). - [Retrieve Balances Over Time V3](https://docs.thisisbud.com/reference/financial_v3_balances_get.md): List the balances of each bank account for a customer across all ingestion sources. Ordered by balance date. It calculates the balance for each date, by iterating from the date the account was last… - [Retrieve Balances Over Time By Account V3](https://docs.thisisbud.com/reference/financial_v3_accounts_balances_get.md): List the balances of a specific bank account for a customer across all ingestion sources. Ordered by balance date. It calculates the balance for each date, by iterating from the date the account was… - [Retrieve Transactions V2](https://docs.thisisbud.com/reference/v2_transactions_get.md): List the Transactions for a customer across all ingestion sources and accounts. Ordered by `date_time` and then `transaction_id` descending. They are also provided with Enrichments -… - [Retrieve Authorised Payments V2](https://docs.thisisbud.com/reference/financial_v2_authorised_payments_get.md): Retrieves a list of a customer's authorised payments. Currently supported authorised payment types include (but are not necessarily limited to): - direct debits - standing orders - scheduled payments… - [Retrieve Accounts V2](https://docs.thisisbud.com/reference/financial_v2_accounts.md): Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below. > ❗️ Deprecation: > > Support will cease for this endpoint on the 1st of April… - [Retrieve Account By ID V2](https://docs.thisisbud.com/reference/financial_v2_accounts_account_id.md): Retrieves a customer's connected account by its ID. > ❗️ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Accounts V3… - [Retrieve Balances Over Time](https://docs.thisisbud.com/reference/financial_v2_balances_get.md): > ❗️ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Balances Over Time V3 endpoint by that point in time. For further… - [Retrieve Balances Over Time By Account](https://docs.thisisbud.com/reference/financial_v2_accounts_balances_get.md): > ❗️ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Balances Over Time By Account V3 endpoint by that point in time.… - [Retrieve Account Transaction Dates](https://docs.thisisbud.com/reference/financial_v3_accounts_transaction_dates_get.md): Retrieves a summary listing the first and last transaction per customer's accounts. - Manage Financial Data - [Remove Provider Data](https://docs.thisisbud.com/reference/v1_provider_delete-1.md): Delete all data (transactions, enrichments, accounts) related to the specified provider. - [Remove Account Data V2](https://docs.thisisbud.com/reference/v2_account_delete.md): Delete all data (including transactions and balances) related to the specified account. - Correct Financial Data - [Correct Transaction Categories V2](https://docs.thisisbud.com/reference/corrections_v2_categories_post.md): Allow a customer to change a transaction’s (and similar transactions') category and/or subcategory. If `include_similar` is set to `true`, then all previous and future transactions (i.e. those that… - [Correct Transaction Merchant](https://docs.thisisbud.com/reference/corrections_v2_merchants_post.md): Allow a customer to change a transaction’s (and similar transactions') merchant. If `include_similar` is set to `true`, then all previous and future transactions (i.e. those that are yet to happen… - [Correction Merchant Search](https://docs.thisisbud.com/reference/corrections_v2_merchant_search_get.md): Allows a customer to find a merchant to be used for a correction. - [Create a new custom merchant](https://docs.thisisbud.com/reference/corrections_v2_custom_merchants_post.md): Creates a new custom merchant for use in the merchant corrections flow. - [Fetch custom merchants for customer](https://docs.thisisbud.com/reference/corrections_v2_custom_merchants_get.md): Retrieves custom merchants for a given customer - [Similar Transactions](https://docs.thisisbud.com/reference/corrections_v2_similar_categories_get.md): This endpoint is used to find similar transactions to the *source* transaction. Similar transactions are determined based on transactions with similar descriptions & amounts to the source… - [Similar Transactions Including Merchants](https://docs.thisisbud.com/reference/corrections_v2_similar_merchants_get.md): This endpoint is used to find similar transactions to the *source* transaction. Similar transactions are determined based on transactions with similar descriptions & amounts to the source… - [Suggests changes to a merchant](https://docs.thisisbud.com/reference/corrections_v2_merchant_feedback_post.md): Records feedback we can use to improve our merchant database. - [Correct Transaction Regularity](https://docs.thisisbud.com/reference/corrections_v3_regularity_post.md): Correct, or remove, the regularity frequency of a transaction, and optionally all similar transactions. A frequency value of `"unknown"` removes the regularity of a transaction, and optionally all… - [End Transaction Regularity](https://docs.thisisbud.com/reference/corrections_v3_regularity_end_post.md): Mark a given transaction as the end of a regular transaction. Bud will not detect similar transactions which succeed the given transaction as regular. - [Correct Transaction Similarity Grouping](https://docs.thisisbud.com/reference/corrections_v3_similar_post.md): Mark a given set of transaction IDs as similar to one-another, or to a given reference transaction ID. This improve's Bud's ability to detect regular transactions, and expands the set of… - [Retrieve Correction Rule](https://docs.thisisbud.com/reference/corrections_v3_rules_rule_id_get.md): Retrieve a single regularity or similarity correction rule belonging to the requesting customer, by its rule id. There is intentionally no endpoint to list all rules. - [Delete Correction Rule](https://docs.thisisbud.com/reference/corrections_v3_rules_rule_id_delete.md): Delete a regularity or similarity correction rule. This reverts the correction and triggers re-enrichment of the affected transactions back to Bud's model value, which may take up to ~60 seconds to… - Manage Transaction Labels - [Create Transaction Label](https://docs.thisisbud.com/reference/financial_v2_labels_post.md): Create a new transaction label for the authenticated customer. Label names are case-insensitively unique per customer; an attempt to create a label with a name that already exists returns `409`. - [Retrieve Transaction Labels](https://docs.thisisbud.com/reference/financial_v2_labels_get.md): List all transaction labels owned by the authenticated customer. - [Rename Transaction Label](https://docs.thisisbud.com/reference/financial_v2_labels_patch.md): Rename an existing transaction label owned by the authenticated customer. Label names are case-insensitively unique per customer; an attempt to rename to a name that already exists returns `409`. - [Delete Transaction Label](https://docs.thisisbud.com/reference/financial_v2_labels_delete.md): Delete an existing transaction label owned by the authenticated customer. The label is removed from any transactions it was attached to. - [Assign Transaction Label](https://docs.thisisbud.com/reference/v2_transaction_labels_post.md): Attach a customer-defined label to a transaction. The label must already exist for the customer (create one with __Create Transaction Label__). - [Unassign Transaction Label](https://docs.thisisbud.com/reference/v2_transaction_labels_delete.md): Remove a customer-defined label from a transaction. The label itself is not deleted; use __Delete Transaction Label__ to remove the label entirely. ## API Reference: Enrichment API - Enrichment Resources - [Retrieve Available Categorisation Models V2](https://docs.thisisbud.com/reference/resources_v2_models_get.md): Retrieve the available Bud categorisation models. - [Retrieve Categories V2](https://docs.thisisbud.com/reference/resources_v2_categories_get.md): Retrieve a list of primary and secondary categories supported by Bud's categorisation model. - Enrichment Totals - [Retrieve Category Totals V2](https://docs.thisisbud.com/reference/v2_category_totals_get.md): Provides a customer’s total income and expenditure for each l1 and l2 category, over a given time period. L1 and l2 categories can be filtered using the category query parameter. Example: -… - [Retrieve Category Totals Trends](https://docs.thisisbud.com/reference/v2_category_totals_trends_get.md): Provides category totals for desired categories over a given time period of time with a given granularity. L1 and l2 categories can be filtered using the category query parameter. Example: -… - [Retrieve Statistics For Essential Total Spend](https://docs.thisisbud.com/reference/aggregations_v2_totals_essential_statistics_get.md): Provides a few useful statistics which allow you to quickly see a customers total essential and non essential spend. Will also allow you to see this spend as a percentage of overall spend. - [Retrieve Merchant Totals V2](https://docs.thisisbud.com/reference/v2_merchants_totals_get-1.md): Provides a customer’s total debit and credit amounts for each merchant. - [Retrieve Merchant Totals Trends](https://docs.thisisbud.com/reference/v2_merchants_totals_trends_get.md): Provides merchant totals for desired merchants over a given time period of time with a given granularity. Can be used for producing graphs of merchant totals over time. ## API Reference: Smart Finders API - Regular Payments Finder - [Retrieve Regular Transactions](https://docs.thisisbud.com/reference/regular_transactions_get.md): Provides a list of customer transactions that occur regularly. Currently the following periods are supported: - `daily` - `weekly` - `biweekly` - `monthly` - `quarterly` - `unknown` - [Retrieve Future Transactions V2](https://docs.thisisbud.com/reference/v2_future_transactions_get.md): Provides a list of transactions predicted to occur in the next specified number of months. Currently the following periods are supported: - `daily` - `weekly` - `biweekly` - `monthly` - `quarterly` -… - Income Finder - [Retrieve Income Transactions V2](https://docs.thisisbud.com/reference/v2_income_get.md): Provides a list of a customer's income based transactions found within their connected accounts, and predicts whether each income transaction is related to a customer's `salary_or_wages`. Any income… - [Retrieve Benefits Transactions](https://docs.thisisbud.com/reference/v1_benefits_get.md): Provides a list of a customer's benefits based transactions found within their connected accounts. When `X-From` is omitted from the request, a default value of 30 days from before today's date will… - [Retrieve Benefits Totals](https://docs.thisisbud.com/reference/v1_benefits_totals_get.md): Provides a customers' total income under each detected benefit type. When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is… - Loan Finder - [Retrieve Loan Transactions](https://docs.thisisbud.com/reference/v1_loans_get.md): Provides a list of a customers' outgoing loan transactions found within their connected accounts. When `X-From` is omitted from the request, a default value of 30 days from before today's date will… - Debt Collection Finder - [Retrieve Debt Collection Transactions](https://docs.thisisbud.com/reference/v1_debt_collection_get.md): Provides a list of a customers' outgoing debt collection transactions found within their connected accounts. When `X-From` is omitted from the request, a default value of 30 days from before today's… - Product Finder - [Retrieve Financial Products V2](https://docs.thisisbud.com/reference/insights_v2_products.md): Financial Products returns the finance oriented products and services that a customer uses. This endpoint generates data using a customer's transaction history. Financial Products detects the… - Subscription Finder - [Retrieve Subscriptions](https://docs.thisisbud.com/reference/v1_subscriptions_get.md): This endpoint is used to retrieve information about a user's subscriptions When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is… ## API Reference: Goals API - Savings Goals V2 - [Create Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_post.md): Create a savings goal for the given account. The `allocation_ratio` defines the proportion of the account balance that is considered allocated to this goal. For example, an `allocation_ratio` of… - [Retrieve Savings Goals V2](https://docs.thisisbud.com/reference/goals_v2_savings_goals_get.md): Retrieve all savings goals for the customer. The results can be filtered by the `account_id` query parameter. The `goal_balance` for each goal is calculated as the current account balance multiplied… - [Retrieve Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_get.md): Retrieve a savings goal by its `savings_goal_id`. The `goal_balance` is calculated as the current account balance multiplied by the `allocation_ratio`. - [Update Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_patch.md): Update a savings goal with the given `savings_goal_id`. All fields are optional. The `goal_balance` returned in the response is recalculated as the current account balance multiplied by the updated… - [Remove Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_delete.md): Remove a savings goal with the given `savings_goal_id`. - Spending Budgets - [Create Spending Budget](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_post.md): Create a spending budget. - [Retrieve Spending Budgets](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_get.md): Retrieve all spending budgets. Accounts IDs can be supplied as part of the URL query to return budgets with values filtered to the accounts IDs supplied. These budgets' spent amounts will only… - [Delete all Spending Budgets](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_delete_all.md): Delete all of a customers' spending budgets. - [Patch a Spending Budget](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_patch.md): Update a Spending Budget with a given `budget_id`. - [Delete a Spending Budget](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_delete.md): Delete a specific spending budget with the given `budget_id` - [Retrieve Spending Budget Transactions](https://docs.thisisbud.com/reference/goals_v1_spending_budget_transactions_get.md): Retrieve all of the transactions associated with a spending budget. The results of this endpoint are paginated with a default page size of `100` and a maximum of `200`. The page size is configurable… ## API Reference: Insights API - Retrieve Actionable Insights - [Retrieve Balances Actionable Insights](https://docs.thisisbud.com/reference/insights_v1_actionable_balances_get.md): Generate balances actionable insights. > 📘 Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Balances Actionable Insight Details](https://docs.thisisbud.com/reference/insights_v1_actionable_balances_details_get.md): Retrieve insight-specific details and transaction and account data responsible for the triggered balances insight of the given type and ID. > 📘 Note: > > For more information about Actionable… - [Retrieve Income Actionable Insights](https://docs.thisisbud.com/reference/insights_v1_actionable_income_get.md): Generate income actionable insights. > 📘 Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Income Actionable Insight Details](https://docs.thisisbud.com/reference/insights_v1_actionable_income_details_get.md): Retrieve insight-specific details and transaction and account data responsible for the triggered income insight of the given type and ID. > 📘 Note: > > For more information about Actionable… - [Retrieve Spending Actionable Insights](https://docs.thisisbud.com/reference/insights_v1_actionable_spending_get.md): Generate spending actionable insights. > 📘 Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Spending Actionable Insight Details](https://docs.thisisbud.com/reference/insights_v1_actionable_spending_details_get.md): Retrieve insight-specific details and transaction and account data responsible for the triggered income insight of the given type and ID. > 📘 Note: > > For more information about Actionable… - Custom Insights - [Create new custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_manage_post.md): Create a custom insight to be applied to all customers upon ingestion or refresh of transactions - [List existing custom insights](https://docs.thisisbud.com/reference/custom_insight_v1_manage_get.md): Retrieve a list of created custom insights, if they are currently active, and when they were created - [Detail the transactions used to generate a custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_detail_get.md): This endpoint will return some transactions used to determine the custom insight. More specifically it will return transactions filtered for in the WHERE expression of the custom insight query. - [Delete existing custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_manage_delete.md): Permanently deletes a custom insight query - [Update existing custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_manage_patch.md): Patches a custom insight, updating the query, or setting it to active/inactive - [Delete all existing custom insights](https://docs.thisisbud.com/reference/custom_insight_v1_manage_delete_all.md): Permanently deletes all custom insight queries - [Build custom insights profile](https://docs.thisisbud.com/reference/custom_insight_v1_profile_post.md): Manually builds a custom insight profile for a customer, is automatically called after successful ingestion and enrichment. - [Retrieve custom insights profile](https://docs.thisisbud.com/reference/custom_insight_v1_profile_get.md): Lists the insights which applied to a customer at \'created_at\'. To recompute make a call to Build custom insights profile. - Customer-Level Insights - [List Customer-Level Flags](https://docs.thisisbud.com/reference/v1_organisation_customer_flags_list.md): Evaluate every flag available to you against the customer's data, and return each flag with whether the customer matched it. - [Retrieve Customer-Level Flag](https://docs.thisisbud.com/reference/v1_organisation_customer_flag_get.md): Evaluate a single flag against the customer's data, and return whether the customer matched it. - [List Customer-Level Facts](https://docs.thisisbud.com/reference/v1_organisation_customer_facts_list.md): Calculate every fact available to you from the customer's data. - [Retrieve Customer-Level Fact](https://docs.thisisbud.com/reference/v1_organisation_customer_fact_get.md): Calculate a single fact from the customer's data. - Frontend Widgets - [Generate Card Summary URL](https://docs.thisisbud.com/reference/insights_v1_summary_url_post.md): Generates customer's weekly summary insights. - [Generate Financial Calendar URL](https://docs.thisisbud.com/reference/insights_v1_financial_calendar_url_post.md): Generates a URL to access the customer's financial calendar. - [Generate Balances Over Time URL](https://docs.thisisbud.com/reference/insights_v1_balances_over_time_url_post.md): Generates a URL to access the customer's balances over time. - [Generate Recurring and Forecasted Transactions URL](https://docs.thisisbud.com/reference/insights_v1_recurring_and_forecasted_transactions_url_post.md): Generates a URL to access the customer's recurring and forecasted transactions. - [Generate Spending Analysis URL](https://docs.thisisbud.com/reference/insights_v1_spending_analysis_url_post.md): Generates a URL to access the customer's spending analysis. - [Generate Intelligent Search Widget URL](https://docs.thisisbud.com/reference/insights_v1_intelligent_search_url_post-1.md): Generates a URL to a frontend to allow searching a customers transactions. - [Generate Accounts URL](https://docs.thisisbud.com/reference/insights_v1_accounts_url_post.md): Generates a URL to access the customer's account. - [Generate Spending Budgets URL](https://docs.thisisbud.com/reference/insights_v1_spending_budgets_url_post.md): Generates a URL to access the customer's spending budgets. - [Generate Savings Goals URL](https://docs.thisisbud.com/reference/insights_v1_savings_goals_url_post.md): Generates a URL to access the customer's savings goals. - [Generate Net Worth Summary URL](https://docs.thisisbud.com/reference/insights_v1_net_worth_url_post.md): Generates a URL to access the customer's net worth analysis. - [Generate Action Cards URL](https://docs.thisisbud.com/reference/insights_v1_action_cards_url_post.md): Generates a URL to access the customer's action cards, a prioritised set of personalised prompts generated from their financial data. ## API Reference: Characteristics API - Retrieve Customer Characteristics - [Retrieve Customer Characteristics](https://docs.thisisbud.com/reference/characteristics_v1_customer_get.md): Retrieves a collection of characteristics associated with an individual Customer. For data on why an individual characteristic applies to a Customer, use the relevant detailed endpoint. The… - [Retrieve Customer Characteristics - Credit Card](https://docs.thisisbud.com/reference/characteristics_v1_customer_credit_card_get.md): Retrieves detailed information for a customer that marks them as a credit card user. - [Retrieve Customer Characteristics - Loan](https://docs.thisisbud.com/reference/characteristics_v1_customer_loan_get.md): Retrieves detailed information for a customer that marks them as a loan user. - [Retrieve Customer Characteristics - Overdraft](https://docs.thisisbud.com/reference/characteristics_v1_customer_overdraft_get.md): Retrieves detailed information for a customer that marks them as an overdraft user. - [Retrieve Customer Characteristics - Saver](https://docs.thisisbud.com/reference/characteristics_v1_customer_saver_get.md): Retrieves detailed information for a customer that marks them as a saver. ## API Reference: Intelligent Search API - Transaction Search - [Search customer transactions.](https://docs.thisisbud.com/reference/search_beta_transactions_get.md): Finds the most relevant transactions matching the `user_input` text. An initial free text search will then suggest `suggested_searches` which use structured data e.g. `category_l1` or… - [Get transaction search by ID.](https://docs.thisisbud.com/reference/search_beta_transactions_search_get.md): Retrieves an existing transaction search by its search ID. **📘 Note: Searches are transient. After the search expires (see `metadata.expires_in`), this endpoint will return a `Not Found` response.… - [Get transaction search insight.](https://docs.thisisbud.com/reference/search_beta_transactions_insight_get.md): Retrieves an AI-generated insight to enrich the output, or answer the question asked in the input to the transaction search. There is no multi-currency support in insights, so the default currency… - [Get transactions used by the search insight.](https://docs.thisisbud.com/reference/search_beta_transactions_insight_transactions_get.md): Retrieves transactions used to calculate the AI-generated transaction search insight, to provide explainability for the insight. This insight can take some time to generate, so until the insight is… ## API Reference: Assess API - Customer Applications - [Create Customer Application](https://docs.thisisbud.com/reference/v1_customer_applications_post.md): Create a new customer application. Applications can hold more data than just the standard Bud Customer information, such as: - Applicant First Name - Applicant Last Name - Names for Secondary… - [Retrieve Customer Applications](https://docs.thisisbud.com/reference/v1_customer_applications_get.md): Retrieve a list of all your customer applications. - [Retrieve Customer Application](https://docs.thisisbud.com/reference/v1_customer_application_get.md): Retrieve an individual customer's application. - [Delete Customer Application](https://docs.thisisbud.com/reference/v1_customer_application_delete.md): Delete an individual customer's application, and all financial data associated with it. - Customer Application Links - [Retrieve Customer Application URL](https://docs.thisisbud.com/reference/v1_customer_applications_customer_links_post.md): Allow customers to share their account information in relation to a specific application. A URL is provided in the response, which is to be given to the customer for them to follow in order to share… - Aggregation Buckets - [Create Buckets](https://docs.thisisbud.com/reference/aggregations_v2_buckets_post.md): Create a new bucket, which can be used to group transactions for totals. - [Retrieve All Buckets](https://docs.thisisbud.com/reference/aggregations_v2_buckets_get.md): Retrieve the top-level definitions of buckets you have created. Use this to retrieve the IDs of buckets to then retrieve their individual definitions and totals for customer transactions. - [Retrieve Bucket](https://docs.thisisbud.com/reference/aggregations_v2_bucket_get.md): Retrieve the definition of a bucket, and retrieve helper metadata which can be used for presenting options to customers. For example, the `metadata.category_lookup` property can be used to show a… - [Update Bucket](https://docs.thisisbud.com/reference/aggregations_v2_bucket_put.md): Update an existing bucket (overwrites all content). - [Delete Buckets](https://docs.thisisbud.com/reference/aggregations_v2_bucket_delete.md) - [Retrieve Bucket Totals](https://docs.thisisbud.com/reference/aggregations_v2_bucket_totals_get.md): Retrieve the totals of a defined bucket for a particular customer. Use the `group_by` property to configure how the totals are grouped together (e.g. by `bucket_l1`, by `month`, etc...) - Retrieve Affordability Report - [Retrieve Affordability Report](https://docs.thisisbud.com/reference/v1_affordability_report-1.md): Get an overview of a customer's financial status. > ❗️ Deprecation: > > Support will cease for this endpoint on the 31st of August 2025 - please complete your migration to the Retrieve Affordability… - [Retrieve Affordability Transactions](https://docs.thisisbud.com/reference/v1_affordability_transactions_get-1.md): View the transactions that were used to calculate a customer's Retrieve Affordability Report. > ❗️ Deprecation: > > Support will cease for this endpoint on the 31st of Jan 2025 - please complete your… - [Retrieve Affordability Transactions V2](https://docs.thisisbud.com/reference/v2_affordability_transactions_get-1.md): This is a complimentary endpoint to the Retrieve Affordability Report V2 endpoint. This endpoint is designed to allow clients to retrieve transactions used to generate sections of the V2… - Retrieve Affordability Report V2 - [Retrieve Affordability Report V2](https://docs.thisisbud.com/reference/v2_affordability_report.md): Get an overview of a customer's financial status. - Retrieve Affordability Risk Insights - [Retrieve income/expenditure break down reports](https://docs.thisisbud.com/reference/insights_beta_report_income_expenditure_get.md): Retrieve income/expenditure break down reports. Each report is presented as a total expenditure vs income break down to give a high level overview of a customers spending's in comparison to income.… - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_income_expenditure_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to… - [Retrieve merchant-specific breakdown reports.](https://docs.thisisbud.com/reference/insights_beta_report_merchants_get.md): Endpoint is responsible for returning merchant based aggregated transaction breakdowns. The reports are presented in a way that allows for a high level overview of a customers spending habits with… - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_merchants_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to `insights_beta_report_merchants_get`, in… - [Retrieve a report on a customers unauthorised overdraft.](https://docs.thisisbud.com/reference/insights_beta_report_balance_unauthorised_overdraft_get.md): Endpoint is responsible for returning balance based aggregated transaction breakdowns and insights. The reports are presented in a way that allows for a high level overview of a customers balances.… - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_unauthorised_overdraft_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to… - [Retrieve a health report on a customers financial profile.](https://docs.thisisbud.com/reference/insights_beta_report_income_health_get.md): Retrieve a list of insights that reflect various health reports based on a customers ingested data. Reports found within this grouping reflect aggregations against a customers income sources. Where… - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_income_health_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to… ## API Reference: Payments API - Initiate Payment - Bud license - [Retrieve Providers](https://docs.thisisbud.com/reference/v1_payments_providers_get.md): This endpoint is used list the payment service providers (PSPs) supported via Bud's Payment APIs. - [Retrieve Bud Pay URL - Single Payment](https://docs.thisisbud.com/reference/v1_payments_single_bud_pay_url_post.md): Retrieve a Bud Pay URL to initiate a single payment. Please note that this endpoint should be used if you are using Bud as a Third Party Provider (TPP), i.e. you are not yourself regulated as an… - [Retrieve Bud Pay URL - Standing Order](https://docs.thisisbud.com/reference/v1_payments_standing_order_bud_pay_url_post.md): Retrieve a Bud Pay URL to initiate a Standing Order. Please note that this endpoint should be used if you are using Bud as a Third Party Provider (TPP), i.e. you are not yourself regulated as an… - [Retrieve Bud Pay URL - Scheduled Payment](https://docs.thisisbud.com/reference/v1_payments_scheduled_bud_pay_url_post.md): Retrieve a Bud Pay URL to initiate a Scheduled Payment. Please note that this endpoint should be used if you are using Bud as a Third Party Provider (TPP), i.e. you are not yourself regulated as an… - Initiate Payment - Client license - [Create Single Payment](https://docs.thisisbud.com/reference/v1_payments_single_post.md): Create a unique single payment identifier and retrieve the authorisation url for the specific payment provider. Please note that this endpoint can only be used in the event that you are using Bud as… - [Submit Authorisation Codes](https://docs.thisisbud.com/reference/v1_payments_authorisation_codes_post.md): When using Bud as a TSP (Technical Service Provider) and doing full app-to-app authorisation, the customer is returned from the provider directly back to your app. Your app will then need to send all… - [Confirm Single Payment](https://docs.thisisbud.com/reference/v1_payments_single_confirm_post.md): Confirm and execute payment order for a specific payment. - [Create Standing Order](https://docs.thisisbud.com/reference/v1_payments_standing_order_post.md): Create a new Standing Order payment identifier and retrieve the authorisation url for the specific payment provider. Please note that this endpoint can only be used in the event that you are using… - [Confirm Standing Order](https://docs.thisisbud.com/reference/v1_payments_standing_order_confirm_post.md): Confirm and execute a Standing Order for a specific payment id. - [Create Scheduled Payment](https://docs.thisisbud.com/reference/v1_payments_scheduled_post.md): Create a new scheduled payment identifier and retrieve the authorisation url for the specific payment provider. Please note that this endpoint can only be used in the event that you are using Bud as… - [Confirm Scheduled Payment](https://docs.thisisbud.com/reference/v1_payments_scheduled_payment_id_confirm_post.md): Confirm and execute a Scheduled Payment for a specific payment id. - Manage Payments - [Search for Single Payments](https://docs.thisisbud.com/reference/v1_payment_get.md): Retrieve and view the status of multiple payments - [Retrieve Single Payment Status](https://docs.thisisbud.com/reference/v1_payments_single_payment_id_get.md): Retrieve and view the status of a payment - [Search for Standing Orders](https://docs.thisisbud.com/reference/v1_payments_standing_order_get.md): Retrieve and view the status of multiple Standing Orders - [Retrieve Standing Order Payment Status](https://docs.thisisbud.com/reference/v1_payments_standing_order_payment_id_get.md): Retrieve and view the status of a specific Standing Order payment - [Search for Scheduled Payments](https://docs.thisisbud.com/reference/v1_payments_scheduled_get.md): Retrieve and view the status of multiple Scheduled Payments - [Retrieve Scheduled Payment Status](https://docs.thisisbud.com/reference/v1_payments_scheduled_payment_id_get.md): Retrieve and view the status of a specific Scheduled payment ## API Reference: MCP (Model Context Protocol) API - MCP (Model Context Protocol) - [Create MCP (Model Context Protocol) URL](https://docs.thisisbud.com/reference/beta_bud_api_mcp_url_post.md): Generates a URL and customer specific authentication bearer token for an MCP Client to connect with. Currently in beta ## API Reference: Drive API - Drive Segments API - [Retrieve Segment Tags](https://docs.thisisbud.com/reference/v1_segment_tags_get.md): Retrieves every segment tag used across your organisation. - [Create Segment From Existing (Fixed Customers)](https://docs.thisisbud.com/reference/v1_segment_from_existing_fixed_customers_post.md): Creates a new segment from another segment's current members, fixed at the point of creation. - [Create Segment From Existing (Criteria)](https://docs.thisisbud.com/reference/v1_segment_from_existing_criteria_post.md): Creates a new segment by copying the criteria from an existing segment. - [Upload Segment](https://docs.thisisbud.com/reference/v1_segments_upload.md): Creates a fixed customer-list segment from an uploaded list of customer IDs. - [Retrieve Segment](https://docs.thisisbud.com/reference/v1_segment_get.md): Retrieves a segment. - [Patch Segment](https://docs.thisisbud.com/reference/v1_segment_patch.md): Partially updates a segment. - [Delete Segment](https://docs.thisisbud.com/reference/v1_segment_delete.md): Deletes a segment. - [Compare Segments (Similarity)](https://docs.thisisbud.com/reference/v1_compare_segments_get.md): Compares two segments and returns how much their customers overlap. - [Query Segment Customers](https://docs.thisisbud.com/reference/v1_segment_query_post.md): Creates an export of every customer matching a segment and returns a link to download it. - [Get Segment Statistics Overview](https://docs.thisisbud.com/reference/v1_segment_statistics_overview_get.md): Retrieves a segment's current statistics, such as total customers and category spend. - [Get Segments](https://docs.thisisbud.com/reference/v2_segments_get.md): Lists your segments. - [Create Segment](https://docs.thisisbud.com/reference/v2_segments_post.md): Creates a new segment — empty, seeded from existing criteria, or from an uploaded customer list. - [Get Segment Criteria](https://docs.thisisbud.com/reference/v2_segments_criteria_get.md): Retrieves a segment's current criteria. - [Save Segment Criteria](https://docs.thisisbud.com/reference/v2_segments_criteria_put.md): Attaches a draft criteria to a segment. - [Get Segment Criteria Active Options](https://docs.thisisbud.com/reference/v2_segment_criteria_active_options_get.md): Lists the criteria options currently applied to a segment. - [Run Segment Criteria](https://docs.thisisbud.com/reference/v2_segments_criteria_run_post.md): Runs a segment's current criteria and returns the number of matching customers. - [Get Criteria Options](https://docs.thisisbud.com/reference/v2_criteria_options_get.md): Lists the flags, segments, and custom criteria available to build a new criteria from. - [Create Draft Criteria](https://docs.thisisbud.com/reference/v2_criteria_drafts_post.md): Creates a new, empty draft criteria to build up before saving it to a segment. - [Get Draft Criteria](https://docs.thisisbud.com/reference/v2_criteria_draft_get.md): Retrieves the definition of a draft criteria. - [Update Draft Criteria](https://docs.thisisbud.com/reference/v2_criteria_draft_put.md): Updates the definition of a draft criteria. - [Run Draft Criteria](https://docs.thisisbud.com/reference/v2_criteria_draft_run_post.md): Runs a draft criteria and returns the number of matching customers. - [Run Ad-hoc Criteria](https://docs.thisisbud.com/reference/v2_criteria_run_post.md): Runs a criteria definition directly, without saving it as a draft first. - [Suggest Segment Name](https://docs.thisisbud.com/reference/v2_criteria_suggestions_segment_name_post.md): Suggests a name and description for a segment, generated from its criteria. Exists to reduce friction in the dashboard UI (pre-fills a name when the user hits create) — kept as an opt-in convenience… - Drive Campaigns API - [Get Campaigns](https://docs.thisisbud.com/reference/drive_v1_campaigns_get.md): Lists and searches your campaigns. - [Create Campaign](https://docs.thisisbud.com/reference/drive_v1_campaigns_post.md): Creates a new campaign. Triggers aren't a separate endpoint — they're expressed as BudQL inside the campaign's `schedule`; see… - [Get Campaign](https://docs.thisisbud.com/reference/drive_v1_campaign_get.md): Retrieves a campaign. - [Delete Campaign](https://docs.thisisbud.com/reference/drive_v1_campaign_delete.md): Permanently deletes a campaign. - [Update Campaign Status](https://docs.thisisbud.com/reference/drive_v1_campaign_status_put.md): Sets a campaign live, paused, or ended. - [Get Campaign Content](https://docs.thisisbud.com/reference/drive_v1_campaign_content_get.md): Retrieves a campaign's live and draft content. - [Update Campaign Content](https://docs.thisisbud.com/reference/drive_v1_campaign_content_put.md): Updates a campaign's draft content. Triggers aren't a separate endpoint — they're expressed as BudQL inside the campaign's `schedule`; see… - [Get Campaign Performance Trends](https://docs.thisisbud.com/reference/drive_campaign_insights_performance_trends_get.md): Retrieves performance metrics and trends for a campaign. - [Get Campaign Content Variables](https://docs.thisisbud.com/reference/drive_v1_campaigns_content_variables_get.md): Lists the personalization variables available for use in campaign content. - [Get Banner Widgets](https://docs.thisisbud.com/reference/drive_v1_campaigns_banner_widgets_get.md): Retrieves the active campaign banners a specific customer is eligible to see. **Note**: unlike every other Drive Campaigns API endpoint, this one authenticates as an end customer rather than as a… - [Build Campaign From Business Goal](https://docs.thisisbud.com/reference/drive_v1_campaigns_agent_post.md): Starts a campaign agent run and returns immediately. You describe the outcome you want in plain language, and the agent finds the audience that matches it, writes the campaign copy, generates the… - [Get Campaign Agent Run](https://docs.thisisbud.com/reference/drive_v1_campaigns_agent_get.md): Reports where a run has got to, and carries the finished campaign once it is done. `result` is null until the status is `completed`, so you poll this one endpoint throughout rather than switching to… - [Get Compiled Campaign Templates](https://docs.thisisbud.com/reference/v1_compiled_templates_get.md): Retrieves the campaign templates available to your organisation. Bud manages template creation and updates internally — clients can read and delete templates, but not create or update them. - [Delete Campaign Template](https://docs.thisisbud.com/reference/v1_client_campaign_templates_delete.md): Removes your organisation's own customisation of a campaign template. - Drive MCP API - [Copilot MCP Server](https://docs.thisisbud.com/reference/v1_drive_mcp_copilot_post.md): The connection URL for Drive's general copilot Model Context Protocol server. **Connecting a client**: this endpoint is the MCP server itself, not a URL-minting step — point your MCP client directly… - [Segments MCP Server](https://docs.thisisbud.com/reference/v1_drive_mcp_segments_post.md): The connection URL for Drive's Segments Model Context Protocol server. **Connecting a client**: this endpoint is the MCP server itself, not a URL-minting step — point your MCP client directly at it,… - [Campaigns MCP Server](https://docs.thisisbud.com/reference/v1_drive_mcp_campaigns_post.md): The connection URL for Drive's Campaigns Model Context Protocol server. **Connecting a client**: this endpoint is the MCP server itself, not a URL-minting step — point your MCP client directly at… ## Changelog - [Version 5.9.0: 07/10/2026](https://docs.thisisbud.com/changelog/version-590-07102026.md) - [Version 5.8.4: 05/10/2026](https://docs.thisisbud.com/changelog/version-584-05102026.md) - [Version 5.8.3: 01/10/2026](https://docs.thisisbud.com/changelog/version-583-01102026.md) - [Version 5.8.2: 25/09/2026](https://docs.thisisbud.com/changelog/version-582-25092026.md) - [Version 5.8.1: 22/09/2026](https://docs.thisisbud.com/changelog/version-581-22092026.md) - [Version 5.8.0: 17/09/2026](https://docs.thisisbud.com/changelog/version-580-17092026.md) - [Version 5.7.0: 09/09/2026](https://docs.thisisbud.com/changelog/version-570-09092026.md) - [Version 5.6.0: 18/08/2026](https://docs.thisisbud.com/changelog/version-560-18082026.md) - [Version 5.5.0: 04/08/2026](https://docs.thisisbud.com/changelog/version-550-04082026.md) - [Version 5.4.0: 31/07/2026](https://docs.thisisbud.com/changelog/version-540-31072026.md)