Versioning & deprecations

Updates to Bud's API documentation are made frequently.

Please see the Changelog for a list of all changes that have been made to Bud’s API documentation. This includes both backward-compatible and backward-incompatible changes.

Backward Compatibility

Bud aims to make integration as seamless as possible for its clients and therefore takes all possible steps to prevent backward-compatibility breaks. In the scenario where a backward-compatibility break is unavoidable, Bud creates a new endpoint, either: (a) by bumping the version within the endpoint URL; or (b) in some circumstances renaming the URL entirely. The previous endpoint may then become deprecated, and support for the endpoint will cease after a period of three months. Clients with access to any of Bud’s API services will be notified of deprecations to any endpoints and provided with ample time in which to make any necessary changes.

Fields within a response or request schemas may also become deprecated. Along with deprecated endpoints, these breaking changes will be clearly highlighted within the changelog.

Deprecations

Bud will continue to support deprecations for a period of three months after they are first announced.

Date of Announcement	Deprecation Details
05/09/2022	Deprecated Retrieve Merchant Totals V1 in favour of new Retrieve Merchant Totals V2 endpoint
01/08/2022	Deprecated `YYYY-MM-DD` date format for `X-From` and `X-To` headers within `/v1/affordability/spending-groups`. Both `X-From` and `X-To` headers now follow the `YYYY-MM` date format.
14/03/2022	Deprecated Enrich Transaction endpoints from the Ingest and Enrich API suite.
01/11/2021	Deprecated Energy Switching API, Mortgage API, Home Insurance API and Broadband API which formed Bud's marketplace offering.
01/11/2021	Deprecated Retrieve Authorisation Gateway URL endpoint in favour of new Retrieve Authorisation Gateway URL (v2) endpoint.
01/09/2021	Deprecated GET Warnings endpoints in favour of new GET Money Management, GET Customer Characteristics and GET Financial Insight endpoints.
04/12/2020	Changed the base URL of the GET Warnings, GET Trends and GET Forecast endpoints from `/v1/assistant/` to `/v1/signal/`.
06/08/2020	Removed `bank_name` field in favour of a new field called `provider` in the following endpoints: POST`/v1/open-banking/authorisation-url` (Request Payload) POST`/v1/open-banking/connect/{connection_task_id}` (Response Payload) POST`/v1/open-banking/refresh/{task_id}` (Response Payload)

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.