Skip to main content

Retrieve Customer Accounts with Transactions

Loading...
API endpoint path: /ux-users/v1/customers/{customerId}:accounts

Returns a unified view of a customer’s accounts with embedded transactions by aggregating data from the Accounts and Transactions APIs. This endpoint is primarily intended for use during new customer registration to retrieve and associate existing account and transaction data.

If the service fails to retrieve transactions for any account, the entire request will fail. To ensure transactions are returned for all accounts, the isHistoryEnabled flag must be set to true for each account.

The response includes account identifiers and classifications, status and balance details, regulatory and contribution attributes where applicable, ownership and account holder information, and transactions nested within each account. This endpoint is available for retail customers only.

Use this endpoint to:

  • Retrieve all accounts and their transactions in a single call
  • Access balances, status, and account classification details
  • View ownership and account holder information
  • Simplify client logic by using backend aggregation

Behavior and capabilities:

  • Retrieves accounts in a single call to the Accounts service, then invokes the Transactions service once per account to enrich each with transaction data
  • Embeds transaction data within each account object for simplified client consumption
  • Requires a token with permission to access both account and transaction data, and validates that the customerId matches the authenticated user's customerId
  • Returns 200 OK with aggregated data or 204 No Content when no accounts are found

Request​

Responses​

Success