Get FI Data

​

Overview

​

Use Cases

• Spend analysis and categorization: Applications that analyze user spending patterns, categorize transactions automatically, and provide insights into financial behavior.
• Account aggregation dashboards: Personal Finance Management (PFM) platforms that display transaction history and account details for individual accounts in a unified interface.
• Transaction reconciliation: Systems that match transactions against invoices, receipts, or expected payments for accounting or expense management purposes.
• Financial insights and reporting: Services that generate reports on cash flow, income patterns, expense tracking, and budget adherence based on actual transaction data.
• Periodic data updates: Implementations that fetch transaction data at scheduled intervals to keep local databases synchronized with source financial institutions.

​

Authentication

​

HTTP Request

POST {{Base_URL}}/getfidata

​

Query Parameters (Optional)

​

Request Parameters

​

Request Body Example

{
    "linkReferenceNumber": "7f8227f1-697f-40d3-a4af-0508f5d0a1dd",
    "consentID": "3c92001e-57ea-4320-bbb8-66d524bfb435"
}

​

Response Format

​

Success Response

​

Response Parameters

​

Response Example

{
    "ver": "1.21.0",
    "status": "success",
    "timestamp": "2025-11-14T10:30:00.000Z",
    "data": {
        "linkReferenceNumber": "7f8227f1-697f-40d3-a4af-0508f5d0a1dd",
        "maskedAccountNumber": "XXXXXXXX3900",
        "balance": "101666.33",
        "fipName": "FinShareBankServer",
        "fipId": "finsharebank",
        "fiType": "DEPOSIT",
        "fiData": [
            {
                "transactionTimestamp": "2025-11-13T14:25:30.000Z",
                "txnId": "TXN123456789",
                "type": "CREDIT",
                "amount": "5000.00",
                "currentBalance": "101666.33",
                "mode": "UPI",
                "narration": "UPI/SALARY CREDIT/REF123",
                "reference": "REF123",
                "valueDate": "2025-11-13"
            },
            {
                "transactionTimestamp": "2025-11-12T09:15:00.000Z",
                "txnId": "TXN123456788",
                "type": "DEBIT",
                "amount": "1500.00",
                "currentBalance": "96666.33",
                "mode": "CARD",
                "narration": "POS Purchase - Retail Store",
                "reference": "CARD5678",
                "valueDate": "2025-11-12"
            }
        ]
    }
}

​

Error Handling

​

Error Response Format

​

Common Error Codes

​

Error Response Example

{
    "ver": "1.21.0",
    "timestamp": "2025-11-14T11:51:28.773Z",
    "errorCode": "InvalidLinkReference",
    "errorMsg": "Link Reference Number not associated with this consent.",
    "status": "failure"
}

​

Supported Account Types

• Current Account: Business or high-transaction-volume checking accounts with no balance restrictions.
• Savings Account: Personal deposit accounts that typically earn interest and have transaction limits.
• Fixed Deposit (Term Deposit): Time-bound deposits with fixed interest rates and maturity dates.
• Recurring Deposit: Regular installment-based deposits that build savings over time with predefined contributions.

​

Usage Notes and Best Practices

​

Consent and Account Linking Prerequisites

• Before calling this API, ensure that you have received a DATA_READY webhook notification for the specific linkReferenceNumber you want to query.
• The linkReferenceNumber is generated and provided by the Account Aggregator when a user successfully links an account during the consent approval flow.
• Store linkReferenceNumber values from webhook notifications in your database, indexed by consent ID, to enable efficient data retrieval.

​

Data Freshness and Timing

• The data returned reflects the information available at the time of the last successful data fetch from the Financial Information Provider (FIP).
• For PERIODIC consents, data is refreshed according to the fetch frequency configured in your consent template (e.g., daily, weekly).
• For ONETIME consents, data represents a snapshot at the time of consent approval and will not update automatically.
• Do not assume real-time data; transaction information may be delayed by several hours or days depending on the FIP’s data provision schedule.

​

Pagination for Large Transaction Sets

• When dealing with accounts that have extensive transaction histories, use the optional limit and offset query parameters to paginate results.
• Implement pagination logic to fetch data in chunks, preventing memory issues and improving application responsiveness.
• Store the pagination state (offset value) between requests to systematically retrieve complete transaction histories.

​

Transaction Data Processing

• Transactions are typically ordered reverse chronologically (most recent first), but always verify the ordering by checking transactionTimestamp values.
• The narration field contains unstructured text that varies significantly across different banks and transaction types; implement robust parsing logic to extract meaningful information.
• Transaction categorization (merchant names, expense categories) should be performed in your application logic, as this information is not standardized across FIPs.

​

Balance Reconciliation

• Use the currentBalance field in transaction records to verify the accuracy of your balance calculations when processing transaction sequences.
• Discrepancies between calculated and reported balances may indicate missing transactions or data quality issues that should be logged for investigation.
• The top-level balance field represents the most current balance available, which may be more recent than the latest transaction timestamp.

​

Performance Optimization

• Cache account profile data (masked account number, FIP details) as this information rarely changes, reducing redundant API calls.
• For applications displaying multiple accounts, make parallel API requests (respecting rate limits) to improve overall data loading performance.
• Monitor the size of transaction response payloads and adjust pagination parameters to balance between number of API calls and payload sizes.

​

Error Handling and Retry Logic

• Implement exponential backoff with jitter for retry logic to handle transient network errors or temporary service unavailability.
• Distinguish between retryable errors (rate limits, temporary unavailability) and permanent errors (invalid credentials, non-existent references) to avoid unnecessary API calls.
• Log all error responses with full context (consent ID, link reference, timestamp) to facilitate troubleshooting and support escalation.

​

Compliance and Data Security

• Financial transaction data contains sensitive personal information; ensure compliance with data protection regulations (GDPR, DPDPA, etc.) in how you store and process this data.
• Implement data retention policies aligned with regulatory requirements and delete transaction data when it is no longer needed or consent is revoked.
• Use encrypted storage for cached transaction data and ensure secure transmission (TLS 1.2+) for all API communications.

​

Related Endpoints

• Get All FI Data: Retrieves transaction data for all accounts linked to a consent in a single API call, useful for bulk data retrieval.
• Get FI Data XML: Provides the same transaction data in XML format for systems that require XML parsing or have XML-based integration requirements.
• Get All Latest Data: Fetches only incremental updates for PERIODIC consents, optimizing bandwidth and processing for regularly updated data.
• Get FI Balance: Retrieves only the current balance for an account without transaction details, ideal for dashboard displays and quick balance checks.