Ingest Transactions

post

https://api-sandbox.thisisbud.com/v2/ingest/transactions

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 'X-Disable-Synchronous' header. Please refer to the following guide to ensure you set up First Party Ingestion correctly for your organisation based on your use case.

We accept a maximum of 1.000 transactions. If this threshold is not respected, a 400 error is returned.

We support the ingestion of transactions for multiple customers as part of the same request.

The detailed location enrichment response is an additional addon, otherwise only tokens are returned (read more about this in the location guide).

An ingestion request with an empty transaction list and provided transaction windows will be treated as a request to clear persisted transactions in the specified windows.

Note:

The enrichment values returned in the synchronous response of this endpoint may differ from those returned when fetching the ingested data from Retrieve Transactions V2.

The synchronous response provides an initial enrichment based solely on the submitted transaction data. During asynchronous ingestion, the data is re-enriched using the customer's existing transaction history and additional enrichment services, producing a more accurate and comprehensive result.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Bud V3 Transactions Request

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

Content-Type

string

enum

required

Define the transactions' format for this request.

Allowed:

X-Disable-Synchronous

boolean

If provided as true, the task will not be processed synchronously.

If false or the header is not included, the task will be processed synchronously.

X-Generate-Transaction-IDs

string

enum

Enable transaction ID generation based on the contents of the transaction data. The transaction ID field still needs to be provided, but it will not be validated or checked for uniqueness and instead overwritten with a generated value. When generating IDs from transaction data, the following fields are taken into account: account ID, description, amount, currency and date.

Allowed:

X-Bud-Categorisation-Model

string

Overrides the default categorisation model for both the returned enrichment and the persisted enrichment.

Possible values can be retrieved from the Retrieve Available Categorisation Models V2 endpoint.

It should be noted that only models for the customers region will be used. For example, if a customer is created with the region "GB", then only "uk-v*" models will be utilised. If a model is specified that cannot be used, then the default model will be used instead.

X-No-Customer

boolean

If provided as true, the customer_id is not required in the request. This is only available with X-Disable-Synchronous not set or set to false. Note: This functionality is not available by default. In order to use it, please raise a Support request.

Responses

401

Unauthorized (BearerToken in 'Authorization' header fails the authentication)

503

An unexpected error occurred on the enrichment server. Sync Only

504

An unexpected timeout occurred on the enrichment server. Sync Only

5XX

An unexpected error occurred on the server side

Callbacks

202A new Task has been created to ingest the given transactions. The generated task_id can be used to check the Task's status

400The server will not process the request due to a client error.