Get Client Accounts

Retrieves all accounts for a specific client, including both regular savings accounts and multi-currency accounts.

Multi-Currency Account Support:

When a client has multi-currency accounts, the response includes an additional multiCurrencyAccounts array that groups the parent account and its sub-accounts together.

Response Structure:

  • savingsAccounts: Array of all regular savings accounts (existing structure)
  • multiCurrencyAccounts: Array of multi-currency account groups, where each group contains:
    • parent: The primary FX account with accountSubType: "FX_PRIMARY_ACCOUNT"
    • subAccounts: Array of currency-specific sub-accounts with accountSubType: "FX_SUB_ACCOUNT"

Key Fields for Multi-Currency Accounts:

  • accountSubType: Indicates "FX_PRIMARY_ACCOUNT" for parent or "FX_SUB_ACCOUNT" for sub-accounts
  • primaryAccount: References the parent account ID and account number (present in sub-accounts)
  • accountNo: All accounts in a multi-currency group share the same account number

Note: This uses the same endpoint as the standard Get Client Accounts API (GET /v1/clients/{clientId}/accounts).

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!