Analytics Report
Welcome to the analytics report API documentation. This API is designed to analyze and extract valuable insights from raw financial data obtained through the Account Aggregator framework. By leveraging this API, FIUs can efficiently process, interpret, and visualize financial information, enabling the creation of powerful applications for financial management, planning, and reporting.
Parameter | Type | Mandatory/ Optional | Description |
consentHandleId | String | Mandatory | Consent handle Id for which the report needs to be generated |
sessionId | String | Mandatory | Session Id to identify the time period for the report needs to be generated |
linkRefNo | String | Mandatory | Unique Number to identify an account in the complete response of AA |
Boolean | Optional | Boolean indicating whether the user requests a PDF version of the report (true for PDF, false otherwise). | |
excel | Boolean | Optional | Boolean indicating whether the user requests an Excel version of the report (true for Excel, false otherwise). |
Key | Data Type | Description |
result | Object | Contains the overall result of the operation. |
result.data | Object | Contains the main data returned by the operation. |
result.data | Object | Contains the main body of the data, including various sections and details. |
result.data.customerInfo | Object | Contains information about the customer, such as name, address, etc. |
result.data.statementDetails | Array | Contains details of the customer's statements. |
result.data.summaryInfo | Object | Provides summary information about the customer's financial data. |
result.data.monthlyDetails | Array | Contains detailed information about monthly transactions. |
result.data.monthlyXnsDetails | Array | Provides detailed information about monthly transactions. |
result.data.eODBalances | Array | Contains end-of-day balances for the customer's accounts. |
result.data.top5FundsReceivedOverAllXns | Array | Lists the top 5 funds received over all transactions. |
result.data.top5FundsTransferredOverAllXns | Array | Lists the top 5 funds transferred over all transactions. |
result.data.body.top5FundsReceivedXns | Array | Lists the top 5 funds received in transactions. |
result.data.top5FundsTransferredXns | Array | Lists the top 5 funds transferred in transactions. |
result.data.highValueCreditXns | Array | Lists high-value credit transactions. |
result.data.highValueDebitXns | Array | Lists high-value debit transactions. |
result.data.regularCredits | Array | Lists regular credit transactions. |
result.data.regularDebits | Array | Lists regular debit transactions. |
result.data.incomeXns | Array | Lists income transactions. |
result.data.incomeXnsAll | Array | Lists all income transactions. |
result.data.loanDisbursalXns | Array | Lists loan disbursal transactions. |
result.data.loanDisbursalXnsAll | Array | Lists all loan disbursal transactions. |
result.data.loanXns | Array | Lists loan transactions. |
result.data.loanXnsAll | Array | Lists all loan transactions. |
result.data.bouncedOrPenalXns | Array | Lists bounced or penal transactions. |
result.data.bouncedOrPenalXnsAll | Array | Lists all bounced or penal transactions. |
result.data.chargesXns | Array | Lists charge transactions. |
result.data.chargesXnsAll | Array | Lists all charge transactions. |
result.data.fCUAnalysis | Object | Provides analysis of the customer's financial health. |
result.data.accountXns | Array | Lists transactions related to the customer's account. |
result.pdf | String | Contains the link to the PDF file. |
result.excel | String | Contains the link to the Excel file. |
Error Code | Description |
400 | Bad Request: In case the request is not as per required schema or any other case |
401 | Unauthorized: Authentication failed or user does not have permissions for requested operation. |
404 | When the linkRefNo is incorrect, sessionId is incorrect or consentHandleId is incorrect |
409 | Upstream Error/Conflict: Something wrong on vendor side. |
500 | Internal Server Error: An error occurred on the server. |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].