Retrieve Balances Actionable Insights

Generate balances actionable insights.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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

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.

number

A minimum percentage utilisation of the credit limit for this insight to trigger. If not specified, a configured value will be used.

number

A balance threshold such that balances lower than this will trigger the low balance insight. If not specified, a configured value will be used.

Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

Bud Customer identifier

string

The Bud Customer secret used to encrypt customer data. This is optional only if the customer secret is already stored with Bud (i.e. the host_secret was set to true in the Customer Context when the customer was created).

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json