The GET /api/financialAccounts/external/v2 method retrieves a list of external bank accounts linked to the user's profile. This API provides users with detailed information about each external account they have connected, offering an overview of account numbers, bank names, account types, and other relevant details. It is designed to help users efficiently manage and integrate external financial accounts with the banking application, ensuring they have a complete view of their financial ecosystem.
Purpose:
- External Account Overview: Helps users easily access and review all external bank accounts associated with their profile.
- Account Management: Provides structured data that can be used for managing linked accounts and integrating them with other financial services.
- Financial Aggregation: Facilitates financial data aggregation by providing a unified view of multiple external accounts in one place.
Response:
The response will contain a list of external bank accounts linked to the user's profile, along with key details such as account numbers, bank names, and account types.
Key Features:
- Comprehensive Account Information: Displays key details such as account numbers (masked), bank names, account types (e.g., checking, savings), and more, giving users full insight into their external accounts.
- Primary Account Indicator: Flags whether an external account is the user's primary account, helping with account prioritization and management.
- Linked Date: Provides the date when each external account was linked to the profile, which helps in tracking account history.
- Currency Information: Displays the currency type for each external account, allowing users to manage multi-currency accounts seamlessly.
Summary:
The GET /api/financialAccounts/external/v2 method offers a structured and secure way for users to retrieve a list of external bank accounts linked to their banking profile. By providing essential information such as account numbers (masked), bank names, account types, and currency details, this API enables efficient external account management and financial oversight. With strong security considerations and flexible response data, users can integrate and manage their external financial accounts with ease.