Skip to main content
POST
/
analytics
/
json
Error
A valid request URL is required to generate request examples
{
  "ver": "1.21.0",
  "status": "success",
  "data": {
    "status": "SUCCESS",
    "message": "Success",
    "status_code": "success",
    "transaction_id": "4aeb3514-ca16-4bfe-9233-ec165292b6c2",
    "journey_transaction_id": "EQ.GT.7af207ef-5b08-484e-a63f-045777ee322f#orchestration_complete_analytics_json_v1#363efd17e49b47f29847ba08c5413bd7",
    "journey_id": "orchestration_complete_analytics_json_v1",
    "data": {
      "bankingAnalysis": {
        "overallAnalysis": {
          "totalNetDebitTransactionAmount": 30175.44,
          "totalNetCreditTransactionAmount": 21918.66,
          "averageBalanceLast3Months": 43634.46,
          "maximumBalance": 11046.26,
          "minimumEodBalance": 39366.54,
          "volatilityOfBalance": 0.13,
          "monthlyAvgNetCreditAmount": 3131.24,
          "totalOutwardUpiAmount": 29698.38,
          "totalLoanCreditAmount": 0,
          "totalCashDepositAmount": 0,
          "totalEmiTxns": 0,
          "bankPenaltiesDetected": false
        },
        "completeCategoryWiseAnalysis": {},
        "accountProfiles": [],
        "fcuIndicators": {},
        "bounceAnalysis": {},
        "investmentAnalysis": {},
        "loanCreditsAnalysis": {},
        "nudges": {},
        "abbTables": {},
        "paymentTypeAnalytics": {}
      },
      "rawData": {}
    }
  }
}

Overview

The Analytics JSON API allows you to retrieve analytics and insights data in JSON format for a specific consent journey. This API provides processed analytical data based on the financial information collected through the Account Aggregator framework.

Key Use Cases

  • Journey Analytics: Retrieve analytics data associated with a specific consent journey.
  • Consent-Level Insights: Get analytical insights tied to a particular consent ID.
  • JSON Format: Receive structured analytics data in JSON format for easy integration.

Important Notes

  • The consent journey must be completed before calling this API.
  • Both consentID and journeyID are required to identify the specific analytics dataset.

Authentication

This API requires authentication using the following headers:
client_id
string
required
Your unique client identifier provided by FinPro during onboarding. This ID is used to authenticate your application.
client_secret
string
required
Your confidential client secret key provided by FinPro. This must be kept secure and never exposed in client-side code.
appIdentifier
string
required
The unique identifier for your application (e.g., your application’s package name or bundle ID). This helps FinPro identify which application is making the request.
organisationId
string
required
Your organization’s unique identifier assigned by FinPro. This identifies your organization in the FinPro system.
content-Type
string
required
Must be set to application/json to indicate that the request body contains JSON data and that the response will be in JSON format.

Request Body

The unique consent identifier provided by the Account Aggregator after consent approval. This must be a valid consent ID.
journeyID
string
required
The unique journey identifier associated with the consent flow. This identifies the specific journey for which analytics data is requested.

Request Example

{
  "consentID": "84001bb6-b1d0-4443-aeff-dd482255a058",
  "journeyID": "journey-12345-abcde"
}

Response

Success Response Example

The response contains comprehensive banking analytics data. Below is a trimmed example showing the key structure — the actual response includes many more categories and analysis sections.
{
  "ver": "1.21.0",
  "status": "success",
  "data": {
    "status": "SUCCESS",
    "message": "Success",
    "status_code": "success",
    "transaction_id": "4aeb3514-ca16-4bfe-9233-ec165292b6c2",
    "journey_transaction_id": "EQ.GT.7af207ef-5b08-484e-a63f-045777ee322f#orchestration_complete_analytics_json_v1#363efd17e49b47f29847ba08c5413bd7",
    "journey_id": "orchestration_complete_analytics_json_v1",
    "data": {
      "bankingAnalysis": {
        "overallAnalysis": {
          "totalNetDebitTransactionAmount": 30175.44,
          "totalNetCreditTransactionAmount": 21918.66,
          "averageBalanceLast3Months": 43634.46,
          "maximumBalance": 11046.26,
          "minimumEodBalance": 39366.54,
          "volatilityOfBalance": 0.13,
          "monthlyAvgNetCreditAmount": 3131.24,
          "totalOutwardUpiAmount": 29698.38,
          "totalLoanCreditAmount": 0,
          "totalCashDepositAmount": 0,
          "totalEmiTxns": 0,
          "bankPenaltiesDetected": false,
          "weeklyAnalytics": [
            {
              "week": 4,
              "year": 2025,
              "month": 8,
              "totalCreditAmount": 116.64,
              "totalDebitAmount": 0,
              "totalCreditTxn": 6,
              "totalDebitTxn": 0,
              "avgBalance": 52064.52,
              "closingBalance": 52161.72,
              "surplusAmount": 116.64
            }
          ]
        },
        "completeCategoryWiseAnalysis": {
          "overallCategoryWiseAnalysis": {
            "Transfer in": {
              "categoryCode": "TRANSFER_IN",
              "totalTransactions": 60,
              "totalCreditAmount": 21918.66,
              "totalDebitAmount": 0,
              "avgCreditAmount": 365.31,
              "avgMonthlyCredit": 3131.24,
              "last6MonthAvgCreditAmount": 3131.24,
              "volatilityCredit": 1.04,
              "maximumCreditAmount": 979.46,
              "minimumCreditAmount": 6.28
            },
            "Transfer out": {
              "categoryCode": "TRANSFER_OUT",
              "totalTransactions": 4,
              "totalCreditAmount": 0,
              "totalDebitAmount": 477.06,
              "avgDebitAmount": 119.27,
              "avgMonthlyDebit": 68.15,
              "last6MonthAvgDebitAmount": 68.15,
              "volatilityDebit": 2.25,
              "maximumDebitAmount": 400,
              "minimumDebitAmount": 2.36
            }
          },
          "monthlyCategoryWiseAnalysis": {
            "Transfer in": [
              {
                "month": 9,
                "year": 2025,
                "totalCreditAmount": 2653.72,
                "totalDebitAmount": 0,
                "totalCreditTxn": 10,
                "totalDebitTxn": 0
              }
            ]
          }
        },
        "accountProfiles": [
          {
            "summary": {
              "Status": "ACTIVE",
              "CurrentBalance": 7272.41,
              "AccountType": "SAVINGS",
              "Currency": "INR",
              "ifsc": "FNSB0004920",
              "branch": "Jayanagar 4th Block",
              "openingDate": "2017-10-23",
              "accountVintageInMonths": 102,
              "transactionStartDate": "2025-08-23",
              "transactionEndDate": "2026-02-23"
            },
            "holders": {
              "holder": {
                "name": "John Doe",
                "dob": "1990-01-01",
                "pan": "ABCDE1234F",
                "mobile": "9876543210",
                "email": "john.doe@example.com"
              }
            }
          }
        ],
        "fcuIndicators": { },
        "bounceAnalysis": { },
        "accountWiseAnalysis": { },
        "investmentAnalysis": { },
        "loanCreditsAnalysis": { },
        "counterPartyAnalysis": { },
        "nudges": { },
        "abbTables": { },
        "top5FundTransfer": { },
        "frequentCredits": { },
        "frequentDebits": { },
        "paymentTypeAnalytics": { }
      },
      "rawData": { }
    }
  }
}
The actual response is significantly larger and includes detailed breakdowns across 50+ transaction categories, account-wise analysis, monthly trends, EMI analytics, fraud/FCU indicators, and more. The example above is trimmed to illustrate the key structure.

Response Structure

FieldTypeDescription
verstringAPI version
statusstringOverall response status (success or failure)
data.statusstringProcessing status (SUCCESS)
data.transaction_idstringUnique transaction identifier
data.journey_idstringJourney identifier used for the analytics
data.data.bankingAnalysisobjectContains all banking analytics sections
data.data.bankingAnalysis.overallAnalysisobjectAggregate metrics — balances, credit/debit totals, volatility, weekly analytics
data.data.bankingAnalysis.completeCategoryWiseAnalysisobjectTransaction analysis broken down by 50+ categories (e.g., Transfer in, UPI, Salary, EMI)
data.data.bankingAnalysis.accountProfilesarrayAccount holder details, balances, and account metadata
data.data.bankingAnalysis.fcuIndicatorsobjectFraud and risk indicators
data.data.bankingAnalysis.bounceAnalysisobjectCheque and ECS bounce analysis
data.data.bankingAnalysis.investmentAnalysisobjectInvestment-related transaction analysis
data.data.bankingAnalysis.loanCreditsAnalysisobjectLoan credit transaction analysis
data.data.bankingAnalysis.nudgesobjectBehavioural insights and nudges
data.data.bankingAnalysis.abbTablesobjectAverage bank balance tables
data.data.rawDataobjectRaw financial data used to generate the analytics

Code Examples

curl --location --request POST '{{Base_URL}}/analytics/json' \
--header 'client_id: {{Client_Id}}' \
--header 'client_secret: {{Client_Secret}}' \
--header 'organisationId: {{Organisation_Id}}' \
--header 'appIdentifier: {{App_Identifier}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "consentID": "84001bb6-b1d0-4443-aeff-dd482255a058",
    "journeyID": "journey-12345-abcde"
}'

Authorizations

client_id
string
header
required

Your unique client identifier provided by MoneyOne during FIU onboarding

client_secret
string
header
required

Your confidential client secret provided by MoneyOne

organisationId
string
header
required

Your organization's unique identifier in the FinPro system

appIdentifier
string
header
required

Application-specific identifier for tracking API calls

Body

application/json

Request body for retrieving analytics data in JSON format.

The unique consent identifier provided by the Account Aggregator after consent approval.

Example:

"84001bb6-b1d0-4443-aeff-dd482255a058"

journeyID
string
required

The unique journey identifier associated with the consent flow.

Example:

"journey-12345-abcde"

Response

Analytics data retrieved successfully

Response containing analytics data for a consent journey.

ver
string

API version that processed the request.

Example:

"1.21.0"

status
string

Overall API call status.

Example:

"success"

data
object

Analytics response payload.