The GET /api/financialAccounts/external/balance method retrieves the current balance of a linked external financial account. This API allows users to view up-to-date balance information from their external accounts that have been integrated into the banking application. By refreshing the data from the external account, the method ensures that users have access to the most recent financial information.

Purpose:

Provide real-time balance updates for external accounts linked to a user's banking profile.
Improve financial management by allowing users to monitor balances across multiple accounts from different financial institutions.
Simplify external account management by consolidating financial data within the banking application.

Response:

The response provides the current balance of the specified external account, including relevant metadata such as the currency type and the date/time the balance was last refreshed.

Key Features:

Real-Time Balance Information: Retrieves the most recent balance of the external account, ensuring the data is up-to-date.
Currency Details: Includes the currency type for each balance, making it easier to manage multi-currency accounts.
Account Metadata: Displays additional information such as the masked account number and bank name for reference.
Last Refreshed Timestamp: Provides the date and time when the balance was last updated, ensuring transparency on data freshness.

📘
Summary:
The GET /api/financialAccounts/external/balance API method provides a real-time view of the balance for an external financial account linked to a user's profile. With up-to-date balance information, users can efficiently manage their external accounts within the banking application. The method is designed with strong security measures, real-time data retrieval, and error handling, ensuring safe and efficient management of financial accounts.

200Success