Retrieve Income Transactions V2

Provides a list of a customer's income based transactions found within their connected accounts, and predicts whether each income transaction is related to a customer's salary_or_wages. Any income which is not salary or wages is given the type other_incoming, which can include other income sources such as investments or pension income.

When X-From is omitted from the request, a default value of 9 months from before today's date will be used. When X-To is omitted from the request, a default value of today's date will be used.

Notes:

  • Transactions with multiple currencies are supported, but the statistics are currently only calculated for one currency. The endpoint takes the currency of the first transaction and ignores non-matching currencies in its calculations.
  • In contrast to the V1 endpoint, Income Finder V2 no longer filters income transactions to only return the latest per reference.
Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

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

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

string

Transaction from date, this works in pair with the 'X-To' parameter

string

Transaction to date, this works in pair with the 'X-From' parameter

Responses

204

No transactions

400

Bad request

401

Unauthorised request

404

No transactions found

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

Language
Credentials
OAuth2
Response
Choose an example:
application/json