/Report/externalAccounts

This API endpoint retrieves a list of external accounts associated with specific users or agents, allowing you to query and manage external financial accounts linked to the Netevia banking system.

Body Parameters:

• name (string | null): Optional filter by the name associated with the external account.
• bankName (string | null): Optional filter by the external bank name.
• profileIds (array of int32s | null): Optional list of profile IDs to filter external accounts by specific user profiles.
• agentIds (array of int32s | null): Optional list of agent IDs to filter external accounts by specific agents.
• active (boolean | null): Filter by the active status of the external accounts.
• skip (int32): Number of records to skip (for pagination).
• take (int32): Number of records to return (for pagination).

Response Structure: The response is an array of objects containing detailed information about external accounts.

[
  {
    "id": 0,                          // Unique external account ID
    "agentId": 0,                     // ID of the agent associated with the external account
    "name": "string",                 // Name associated with the external account
    "status": "string",               // Status of the external account (e.g., Active, Inactive)
    "provider": "string",             // The external account provider
    "last4": "string",                // Last 4 digits of the external account number
    "bankName": "string",             // Bank name of the external account
    "createdDate": "2024-10-09T14:27:45.963Z",  // Date the account was created
    "updatedDate": "2024-10-09T14:27:45.963Z",  // Date the account was last updated
    "financialAccountId": "string",   // The internal financial account ID associated with this external account
    "verificationState": 0,           // Verification state of the external account
    "verificationDate": "2024-10-09T14:27:45.963Z",  // Date of account verification
    "verificationMessage": "string"   // Additional message related to the verification status
  }
]

Key Features:

• Flexible Filtering: Filters allow retrieving external accounts based on specific criteria such as profile IDs, agent
• IDs, bank names, and account statuses.
• Verification Tracking: Provides details about the verification status and messages for each external account.
• Paginated Results: Supports pagination with skip and take parameters to handle large datasets efficiently.

📘

Summary:

The POST /Report/externalAccounts API allows you to retrieve and manage a list of external financial accounts associated with users or agents in the Netevia banking system. With its flexible filtering options and detailed account data, it is useful for managing external account integration, status monitoring, and financial operations.