Retrieve transactions relating to a specific insight report section.

get https://api-sandbox.thisisbud.com/insights/beta/report/income-health/transactions/{reference}

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_balance_unauthorised_overdraft_get,
in combination with the unique reference, will return the raw transactions
list used to produce that aggregation. This is useful if requiring further investigation or analysis.
The reference can be found in the _links section of the insight reports.

NOTE:
Alterations to the to/from query properties will result in an alternative dataset being returned.

Path Params

reference

string

required

A unique reference used to identify a group of transactions in report for aggregation analysis

Query Params

from

string

A start time to check financial data for insights from. Configures the earliest financial data which may be used to generate insights. If omitted, defaults to the start of the sixth complete month prior to the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates.

string

An end time to check financial data for insights up to. Configures the latest financial data which may be used to generate insights. If omitted, defaults to the date of the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates. Insights relating to potential future events, such as cannot_cover_bills, may forecast them up to a month after this point.

currency

string

Used to limit the insight reports returned, to only those in the specified currency. The value should represent
a valid ISO currency code. an example would be "GBP" or "EUR".

Please refer to https://www.iso.org/iso-4217-currency-codes.html for more details.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

Response

Response body

object

operation_id

string

required

insights_beta_report_income_expenditure_transactions_get insights_beta_report_income_health_transactions_get insights_beta_report_merchants_transactions_get insights_beta_report_unauthorised_overdraft_transactions_get

data

array of objects

required

Transactions in the Bud Transactions V2 format that triggered the insight, for insights based on transaction data. If there are no specific relevant transactions, this will be an empty list.
For clients making use of the deprecated client taxonomy support, the categories in this response will be set to the client categories.

data*

object

transaction_id

string

required

Unique identifier for the transaction. May be mutable depending on original ingestion source.

account_id

string

required

Identifier for the account associated with the transaction.

provider

string

Name of the transaction source provider. Optional as it may not have been supplied when using first party data.

description

string

required

Description of the transaction.

credit_debit_indicator

string

required

Credit/Debit Indicator

credit debit

status

string

required

Status of the transaction. Defaults to booked.

Note: declined transactions are only available for transactions ingested by First Party Ingestion endpoints.

booked pending declined

amount

object

required

The monetary amount.

date_time

string

required

Date that the transaction occured compliant with RFC3339.

posted_date_time

string

Date the assets involved in the transaction transferred compliant with RFC3339. For credits this is the date that the asset becomes available, for debits this is the date that the asset ceased to be available

suggested_description

string

required

The description Bud suggests client apps show for a given transaction.

suggested_logo

string

The logo Bud suggests client apps show for a given transaction.

enrichments

object

Contextual enrichments associated with a Transaction

merchant_category_code

string

Merchant category code conforming to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

Value	Description
`benefit`	A government/non-profit benefit transaction
`debt-collection`	A transaction associated with a known debt-collector
`loan`	A transaction associated with a loan
`income`	A transaction associated with income
`pending`	A transaction which has not been booked
`regular-transaction`	A transaction predicted to occur with a regular frequency
`subscription`	A transaction associated with a subscription service
`online`	A transaction associated with an online merchant

200OK