Welcome to Bud's Project Rocket API Documentation. All endpoints follow standard RESTful principles and example request and response payload snippets are provided to get you up and running quickly and easily.

This documentation is relevant to two different environments, namely:

1. Sandbox Environment - https://rocket-sandbox.thisisbud.com/

2. Production Environment - https://rocket.thisisbud.com/

About

The Sandbox environment is a development environment for integrating and testing Bud’s services. Its version is kept up to date with production. The sandbox environment mirrors the production environment and all updates are made in tandem. On the Sandbox environment, the variety of providers that you can connect to via Bud's Open Banking Aggregation Product is limited and contains a predefined set of dummy accounts and transaction data. The instance size doesn’t differ from production, although certain rate limits are in place.

API Access

To start interacting with the Sandbox environment, please contact your relevant Bud account manager to get the relevant credentials. These can be used to obtain OAuth2 access and refresh tokens using the authentication endpoint.

The access token must be supplied as a Bearer token within every service API call made to the Bud Platform. Once the access token has expired, the refresh token must be used to obtain another access token.

Details on the authentication process can be found in the Authentication section of this documentation.

Sandbox Providers

Bud’s sandbox is built to mirror its production environment. The main difference is the available open banking providers that a customer is able to connect to. In the sandbox, Bud’s aggregation service only supports the use of Open Banking sandbox providers which issue dummy data.

Necessary access credentials will be provided by your Bud account manager.

About

Bud’s production environment is designed for use within your application when going live to real Customers. The environment is fully scalable, secure and facilitates the use of real Customer data.

API Access

To start interacting with Bud’s Production environment please contact your Bud account manager to get access to Bud’s production environment.

Bud’s platform is made available through Application Programming Interface (API) endpoints, all of which adhere to RESTful principles. Standard HTTP verbs and status codes are used for requests and response statuses. Request and response payloads are JSON encoded data formatted. Communication with the Bud Platform is handled over HTTPS protocol only.

HTTP Verbs

HTTP Response Codes

Some endpoints will require the presence of custom headers in the HTTP Request to be properly processed by Bud Platform services.

Response Custom Headers

The description and the listed status codes below indicate that an action requested by the client was successfully processed.

The successful responses will have status codes in the 200-299 range and have relevant response content where required. However, 204 No Content and 205 Reset Content status codes won't contain a response content.

Response Style Properties

Examples

200 OK

After getting an existing resource with GET /resources/{id}.

{
  "operation_id": "resources_get",
  "data": {
    "id": "111-AAA-222-BBB",
    "name": "Bud",
    "email": "[email protected]",
    "created_at": "2019-01-01T15:53:00+05:00"
  }
}

201 Created

After creating a new resource with POST /resources.

{
  "operation_id": "resources_post",
  "data": {
    "id": "111-AAA-222-BBB"
  }
}

Response Style Properties

Client Error Responses

The description and the listed status codes below indicate that the action requested by the client was not successfully processed due to apparent client errors in the request.

The client errors will have status codes in the 400-499 range and have relevant response content where required.

Generic Client Error Responses

List of Code Ids

Examples

400 Bad Request

Returned after a failed attempt to create a new resource by passing invalid data to POST /resources.

After trying to create a new resources by passing invalid data to POST /resources.

{
  "operation_id": "resources_post",
  "code_id": "failed_validation",
  "message": "Invalid request payload.",
  "metadata": {},
  "errors": {
    "name": "This value is required.",
    "email": "This value is invalid."
  }
}

Server Error Responses

The server errors will have status codes in the 500-599 range. The server errors will look very much like the "Client Errors" but will contain bare minimum information attached to them.

Generic Server Error Responses

All endpoints marked as BETA imply that they are in a pre-production release state. This means they are subject to change and may have limited support. BETA services are only available in the Sandbox environment for testing purposes. Please contact your account manager for more information or to provide feedback.

Updates to Bud's API documentation are made frequently. The current version of the documentation can be clearly viewed at the very top of this page.

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 response or request schemas may also become deprecated. Along with deprecated endpoints, these breaking changes will be clearly highlighted within the below changelog.

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

This changelog represents a list of the changes that have been made to Bud’s API documentation. This includes both backward-compatible and backward-incompatible changes.

Version 1.6.2: 19/04/2023

• Added format query parameter to Retrieve Categories.

Version 1.6.1: 16/03/2023

• Update amount descriptions

Version 1.5.2: 09/03/2023 The changes in this release carry no change to URLs, this is purely the name of the endpoint.

• Renamed List Categories to Retrieve Categories

Version 1.5.1: 05/08/2021

• Inclusion of the carbon tracking feature within the beta batched enrichment endpoint. The endpoint now takes in an optional mcc field withint the payload and if populated will return a co2 value in the reponse payload against that transaction.
• Inclusion of the merchant website URL field within the response of the batched enrichment endpoint (beta) when Bud's merchant identification service identifies a merchant associated with a given transaction.

In order to assess whether the environment is currently up, please make a GET HTTP Request to the /status endpoint.

Example cURL Request:

curl -w '%{http_code}\n' https://rocket-sandbox.thisisbud.com/status

Responses

The Customers API allows for the manipulation of a client's "Customers" as registered on the Bud platform. The API is built around resource-oriented URLs, returns JSON-encoded responses, uses standard HTTP response codes and authentication.

Manage the number of customers registered onto the Bud platform.

Add a layer of insightful context to financial data.

Retrieve information and different resources related to Bud's enrichment services.

Submit transactions to add detailed information and context to first and third-party data.

Submit customers corrections to help improve Bud's enrichment services.