Retrieve merchant-specific breakdown reports.

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 specific merchants.

For transactional analysis of particular aggregate, please refer to the transactions reference found within the
_links properties.

Query Params
string

A comma-separated list of insight types to check for. If not specified, a default list will be used, which may be added to over time.

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.

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
string
required

The API Client Identifier (Service Application Identifier).

string
required

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

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

Language
Credentials
OAuth2
Choose an example:
application/json