Product List
Retrieve the list of consent templates (products) configured in the FinPro admin portal for your organization.
Overview
The Product List API provides access to all consent templates that have been created by your Financial Information User (FIU) organization in the FinPro admin portal. These consent templates, also referred to as products, define the parameters for consent requests including data types, validity periods, fetch modes, and other configuration settings that govern how financial data is collected from customers. This API is particularly useful when you need to:- Display available consent templates to users during the onboarding or application process
- Retrieve specific consent template details programmatically before initiating a consent request
- Audit and verify the consent configurations that are currently active in your organization
- Build dynamic consent selection interfaces that adapt based on available product configurations
Authentication
This API requires organization-level authentication credentials to be passed in the request headers. All credentials should be provisioned through the FinPro admin portal.Required Headers
| Header | Type | Description |
|---|---|---|
Content-Type | string | Must be set to application/json for proper request processing |
client_id | string | The unique client identifier assigned to your FIU organization during onboarding |
client_secret | string | The secret key paired with your client_id for secure authentication |
organisationId | string | Your organization’s unique identifier in the FinPro system |
appIdentifier | string | The application identifier that distinguishes different applications within your organization |
Request
Endpoint
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
productId | string | Optional | The specific consent template code to retrieve. If omitted, the API returns all active consent templates configured for your organization. Must contain only alphanumeric characters, underscores, hyphens, and periods. |
Request Examples
Response
Success Response (200 OK)
When the request is successfully processed, the API returns detailed information about the requested consent template(s).Response Fields
| Field | Type | Description |
|---|---|---|
ver | string | The version of the FinPro API that processed the request |
status | string | The outcome of the API call. Possible values: success, failure |
data | array | An array of consent template objects containing the configuration details |
data[].productName | string | The human-readable name of the consent template as configured in the admin portal |
data[].productCode | string | The unique identifier (template code) used to reference this consent template in API calls |
data[].productDescription | string | A descriptive text explaining the purpose or use case of this consent template |
data[].consentFrom | string (ISO 8601) | The start date and time from which the consent becomes valid |
data[].consentTo | string (ISO 8601) | The end date and time until which the consent remains valid. The duration between consentFrom and consentTo determines the consent validity period |
data[].consentMode | string | How the fetched data is handled. VIEW means data is not stored, STORE means data can be persisted |
data[].fetchType | string | The frequency pattern for data retrieval. ONETIME for single fetch, PERIODIC for recurring fetches |
data[].fiTypes | string | Comma-separated list of Financial Information schema types included in this consent template (e.g., DEPOSIT, MUTUAL_FUNDS, INSURANCE_POLICIES) |
data[].consentTypes | string | Comma-separated list indicating which sections of financial information are requested: PROFILE (account holder details), SUMMARY (aggregated data), TRANSACTIONS (detailed transaction history) |
data[].dataRangeFrom | string (ISO 8601) | The earliest date for which financial data should be retrieved |
data[].dataRangeTo | string (ISO 8601) | The most recent date for which financial data should be retrieved. The period between dataRangeFrom and dataRangeTo defines the historical data range |
data[].dataLifeUnit | string | The time unit for data retention. Possible values: DAY, MONTH, YEAR, INF (infinite) |
data[].dataLifeValue | number | The numeric value indicating how long data can be retained, measured in the unit specified by dataLifeUnit |
data[].frequencyUnit | string | The time unit for periodic data fetch frequency. Possible values: DAY, MONTH, YEAR, INF |
data[].frequencyValue | number | The numeric value indicating how often data should be fetched, measured in the unit specified by frequencyUnit |
data[].fiFetch | string | The mechanism for triggering data fetches. MANUAL requires explicit FIU API calls, AUTOMATIC fetches data automatically, AUTO MANUAL supports both modes |
data[].createdAt | string (ISO 8601) | The timestamp when this consent template was created in the FinPro admin portal |
Response Examples
Error Responses
Authentication Errors
401 Unauthorized - Invalid Organization
Returned when the providedorganisationId does not match any registered FIU organization in the FinPro system.
- The organisationId value is incorrect or contains typos
- The organization has been deactivated or not yet provisioned in FinPro
- Using UAT credentials in a production environment or vice versa
- Verify the organisationId matches the value provided in your FinPro admin portal
- Ensure you are using credentials from the correct environment (UAT vs Production)
- Contact MoneyOne support if the organization was recently onboarded
Usage Notes
Product Selection Best Practices
- Retrieve and cache the product list during application initialization to minimize API calls
- Map product codes to specific user journeys or workflows in your application for consistent consent request behavior
- Regularly refresh the product list to ensure your application reflects any updates made in the FinPro admin portal
- Use the productId parameter when you need to verify specific template configurations before initiating a consent flow
FI Types Reference
ThefiTypes field can contain any combination of the following Account Aggregator financial information schema types:
- Banking: DEPOSIT, TERM_DEPOSIT, RECURRING_DEPOSIT, CREDIT_CARD, CD (Certificate of Deposit)
- Investments: MUTUAL_FUNDS, SIP, EQUITIES, BONDS, DEBENTURES, ETF, GOVT_SECURITIES, CP (Commercial Paper), IDR, CIS, AIF, INVIT, REIT
- Insurance: INSURANCE_POLICIES, LIFE_INSURANCE, GENERAL_INSURANCE, ULIP
- Retirement: NPS, EPF, PPF
- Tax: GST_GSTR1, GST_GSTR2A, GST_GSTR3B, GSTR1_3B
- Other: OTHER (for custom or future FI types)
Rate Limiting
This API is subject to rate limiting controls to ensure fair usage across all FIU organizations:- Rate limit headers are included in every response to help you track your usage
X-RateLimit-Limit: The maximum number of requests allowed in the time windowX-RateLimit-Remaining: The number of requests remaining in the current windowX-RateLimit-Reset: The Unix timestamp when the rate limit window resets
Related APIs
- Consent Request V2 - Initiate consent requests using product IDs
- Consent Request V3 - Create FIP-specific consents with product templates
- Account Aggregator List - Get the list of integrated Account Aggregators
Authorizations
Your unique client identifier provided by MoneyOne during FIU onboarding
Your confidential client secret provided by MoneyOne
Your organization's unique identifier in the FinPro system
Application-specific identifier for tracking API calls
Body
Request body for retrieving consent templates (products) configured in the FinPro admin portal.
The specific consent template code to retrieve. If omitted, the API returns all active consent templates configured for your organization. Must contain only alphanumeric characters, underscores, hyphens, and periods.
^[a-zA-Z0-9_\-.]+$Response
Products retrieved successfully
Response containing the list of consent templates (products) configured for the organization.
