Retrieve Accounts V2

Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below.

Deprecation:

Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Accounts V3 endpoint by that point in time. For further details, contact your Bud account manager or email [email protected].

Query Params
string

Use this parameter to filter the results returned on the currency associated with each result. Multiple values are accepted. If this parameter is not provided then results of any currency will be returned.

string

Use this parameter to filter the results returned on the provider associated with each result. Multiple values are accepted. If this parameter is not provided then results of any provider will be returned.

string

Use this parameter to filter the results returned on the account_type associated with each result. Multiple values are accepted. If this parameter is not provided then results of any account_type will be returned. Currently supported values include (but are not necessarily limited to):

  • charge_card
  • credit_card
  • current_account
  • e_money
  • investment
  • loan
  • mortgage
  • other
  • pre_paid_card
  • savings
string

Use this parameter to filter the results returned on the usage_type associated with each result. Multiple values are accepted. If this parameter is not provided then results of any usage_type will be returned. Currently supported values include (but are not necessarily limited to):

  • personal
  • business
string

Use this parameter to filter the results returned on the holder_relationship_type associated with each result. Multiple values are accepted. If this parameter is not provided then results of any holder_relationship_type will be returned. Currently supported values include (but are not necessarily limited to):

  • sole
  • joint
  • delegate
  • unknown
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

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

Responses

Language
Credentials
OAuth2
Response
Choose an example:
application/json