diff --git a/api-references/data/insights.json b/api-references/data/insights.json
index 68293d9c..8b1c539d 100644
--- a/api-references/data/insights.json
+++ b/api-references/data/insights.json
@@ -1,4991 +1,5051 @@
{
- "openapi": "3.1.0",
- "info": {
- "title": "Setu Insights API",
- "description": "Setu’s Insights API gives you actionable insights from a customer's bank statement about their income, expenditure, and financial history.",
- "version": "1.0.0"
- },
- "servers": [
- {
- "url": "https://di-uat.setu.co/",
- "description": "Sandbox"
+ "openapi": "3.1.0",
+ "info": {
+ "title": "Setu Insights API",
+ "description": "Setu's Insights API gives you actionable insights from a customer's bank statement about their income, expenditure, and financial history.",
+ "version": "1.0.0"
},
- {
- "url": "https://insights.setu.co/",
- "description": "Production"
- }
- ],
- "paths": {
- "/v2/template": {
- "post": {
- "tags": ["Template"],
- "summary": "Create a new Template",
- "description": "Call this API to create a new template containing static and configurable insights.",
- "operationId": "create_template_v2_post",
- "parameters": [
- {
- "name": "x-product-instance-id",
- "in": "header",
- "required": true,
- "schema": { "type": "string" }
- },
- {
- "name": "x-client-id",
- "in": "header",
- "required": true,
- "schema": { "type": "string" }
- },
- {
- "name": "x-client-secret",
- "in": "header",
- "required": true,
- "schema": { "type": "string" }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TemplateCreateRequest"
- }
- }
- }
+ "servers": [
+ {
+ "url": "https://di-uat.setu.co/",
+ "description": "Sandbox"
},
- "responses": {
- "201": {
- "description": "Template created successfully",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TemplatePostResponse"
- },
- "examples": {
- "TemplatePostResponse": {
- "value": {
- "status": "Success",
- "version": "0.72.0",
- "statusDescription": null,
- "body": {
- "templateId": "7a86d5f8-8434-421f-8df6-828f3fe9ddd8",
- "name": "Sample Template",
- "staticInsights": [
- {
- "insightId": "81654386-d574-40a6-a49f-e04c9d980e3b",
- "name": "closing_balance",
- "title": "Account Closing Balance",
- "description": null
- }
- ],
- "configurableInsights": [
- {
- "refKey": "monthly_total_debits_value",
- "title": "explainer",
- "description": null,
- "params": {
- "refKey": null,
- "lastNMonths": null,
- "offsetMonths": 0,
- "aggregateFunction": "SUM",
- "transactionType": "DEBIT",
- "transactionMode": null,
- "transactionCategory": null,
- "transactionSubcategory": null,
- "transactionCategoryExclusions": null,
- "transactionSubcategoryExclusions": null,
- "startDate": null,
- "endDate": null,
- "periodicity": "MONTHLY",
- "minAmount": null,
- "groupBy": null,
- "day": null,
- "top": null
- },
- "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
- "insight": {
- "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
- "name": "amt_last_n_mon",
- "title": "Operations on Transaction Amounts of last n months",
- "description": null
+ {
+ "url": "https://insights.setu.co/",
+ "description": "Production"
+ }
+ ],
+ "paths": {
+ "/v3/template": {
+ "get": {
+ "tags": [
+ "Templates"
+ ],
+ "summary": "Get Templates",
+ "description": "Get a list of configured templates for the FIU",
+ "operationId": "get_templates_v3_template_get",
+ "parameters": [
+ {
+ "required": false,
+ "schema": {
+ "title": "Template ID for which insights are needed",
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": "templateId",
+ "in": "query"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "authorization",
+ "type": "string"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "x-product-instance-id",
+ "type": "string"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-id",
+ "type": "string"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-secret",
+ "type": "string"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TemplateGetResponseV3"
+ },
+ "examples": {
+ "TemplateGetResponseV3": {
+ "summary": "TemplateGetResponseV3",
+ "value": {
+ "status": "Success",
+ "body": [
+ {
+ "templateId": "b6418647-6397-47a8-8219-1bff5f7ddfe5",
+ "fiuId": "1d2a3127-53f3-4ce7-bb53-663886d330cf",
+ "name": "Mixed Analysis Template",
+ "insights": [
+ {
+ "insight": "static_fraud_flags",
+ "refKey": "fraud_flags",
+ "title": "Fraud Flags",
+ "description": "",
+ "insightId": "43b410fd-a148-4c17-80fe-6c0278965173"
+ },
+ {
+ "insight": "static_mutualfunds_holdings_summary",
+ "refKey": "mutualfunds_holdings_summary",
+ "title": "Mutual Funds holdings summary",
+ "description": "",
+ "insightId": "d28364e2-9f5b-4a6d-aa10-0528e2271991"
+ },
+ {
+ "insight": "configurable_trend_on_balances",
+ "refKey": "balance_analysis_monthly_max",
+ "title": "Balance Trend Analysis",
+ "description": "",
+ "params": {
+ "offsetMonths": 0,
+ "aggregateFunction": "MAX",
+ "groupBy": "MONTH"
+ },
+ "insightId": "58564db1-60c6-450f-93ba-8ca8b642c936"
+ }
+ ],
+ "categorisationMode": "INCLUSIVE",
+ "keywordMaps": [],
+ "isLineageRequired": false
+ }
+ ]
+ }
+ }
+ }
}
- }
- ],
- "categorisationMode": "INCLUSIVE",
- "keywordMaps": [],
- "compoundInsights": [],
- "isLineageRequired": false
- }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
}
- }
}
- }
- }
- },
- "400": {
- "description": "Invalid request payload",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/ErrorResponse" }
- }
- }
- },
- "401": {
- "description": "Unauthorized access",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/ErrorResponse" }
- }
- }
- },
- "500": {
- "description": "Internal server error",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/ErrorResponse" }
- }
- }
- }
- }
- },
- "get": {
- "tags": ["Template"],
- "summary": "Fetch all templates",
- "description": "Call this API to retrieve all existing templates.",
- "operationId": "get_templates_v2_get",
- "parameters": [
- {
- "name": "x-product-instance-id",
- "in": "header",
- "required": true,
- "schema": { "type": "string" }
- },
- {
- "name": "x-client-id",
- "in": "header",
- "required": true,
- "schema": { "type": "string" }
- },
- {
- "name": "x-client-secret",
- "in": "header",
- "required": true,
- "schema": { "type": "string" }
- }
- ],
- "responses": {
- "200": {
- "description": "List of templates",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TemplateListResponse"
+ },
+ "post": {
+ "tags": [
+ "Templates"
+ ],
+ "summary": "Create Template",
+ "description": "Create a template with a list Keyword Maps, Categorisation Mode and Configurable/Static Insights",
+ "operationId": "create_template_v3_template_post",
+ "parameters": [
+ {
+ "required": false,
+ "schema": {
+ "title": "authorization",
+ "type": "string"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "x-product-instance-id",
+ "type": "string"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-id",
+ "type": "string"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-secret",
+ "type": "string"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_create_template_v3_template_post"
+ }
+ }
+ },
+ "required": true
},
- "examples": {
- "TemplateListResponse": {
- "value": {
- "status": "Success",
- "version": "0.72.0",
- "statusDescription": null,
- "body": [
- {
- "templateId": "7a86d5f8-8434-421f-8df6-828f3fe9ddd8",
- "name": "Sample Template",
- "staticInsights": [
- {
- "insightId": "81654386-d574-40a6-a49f-e04c9d980e3b",
- "name": "closing_balance",
- "title": "Account Closing Balance",
- "description": null
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TemplateCreateResponseV3"
+ },
+ "examples": {
+ "TemplateCreateResponseV3": {
+ "summary": "TemplateCreateResponseV3",
+ "value": {
+ "status": "Success",
+ "body": {
+ "templateId": "b6418647-6397-47a8-8219-1bff5f7ddfe5",
+ "fiuId": "1d2a3127-53f3-4ce7-bb53-663886d330cf",
+ "name": "Mixed Analysis Template",
+ "insights": [
+ {
+ "insight": "static_fraud_flags",
+ "refKey": "fraud_flags",
+ "title": "Fraud Flags",
+ "description": "",
+ "insightId": "43b410fd-a148-4c17-80fe-6c0278965173"
+ },
+ {
+ "insight": "static_mutualfunds_holdings_summary",
+ "refKey": "mutualfunds_holdings_summary",
+ "title": "Mutual Funds holdings summary",
+ "description": "",
+ "insightId": "d28364e2-9f5b-4a6d-aa10-0528e2271991"
+ },
+ {
+ "insight": "configurable_trend_on_balances",
+ "refKey": "balance_analysis_monthly_max",
+ "title": "Balance Trend Analysis",
+ "description": "",
+ "params": {
+ "offsetMonths": 0,
+ "aggregateFunction": "MAX",
+ "groupBy": "MONTH"
+ },
+ "insightId": "58564db1-60c6-450f-93ba-8ca8b642c936"
+ }
+ ],
+ "categorisationMode": "INCLUSIVE",
+ "keywordMaps": [],
+ "isLineageRequired": false
+ }
+ }
+ }
+ }
}
- ],
- "configurableInsights": [
- {
- "refKey": "monthly_total_debits_value",
- "title": "explainer",
- "description": null,
- "params": {
- "refKey": null,
- "lastNMonths": null,
- "offsetMonths": 0,
- "aggregateFunction": "SUM",
- "transactionType": "DEBIT",
- "transactionMode": null,
- "transactionCategory": null,
- "transactionSubcategory": null,
- "transactionCategoryExclusions": null,
- "transactionSubcategoryExclusions": null,
- "startDate": null,
- "endDate": null,
- "periodicity": "MONTHLY",
- "minAmount": null,
- "groupBy": null,
- "day": null,
- "top": null
- },
- "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
- "insight": {
- "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
- "name": "amt_last_n_mon",
- "title": "Operations on Transaction Amounts of last n months",
- "description": null
- }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
}
- ],
- "categorisationMode": "INCLUSIVE",
- "keywordMaps": [],
- "compoundInsights": [],
- "isLineageRequired": false
}
- ]
}
- }
}
- }
- }
- },
- "401": {
- "description": "Unauthorized access",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/ErrorResponse" }
- }
}
- },
- "500": {
- "description": "Internal server error",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/ErrorResponse" }
- }
- }
- }
- }
- }
- },
- "/v2/fiData": {
- "post": {
- "tags": [
- "Fi Data Ingestion (JSON)"
- ],
- "summary": "Create FIData block",
- "description": "Call this API with the data received from FIP's notification as payload, to create an FI DataBlock. Note: This data can be auto-fetched from FIP with FIU's consent.",
- "operationId": "create_fi_data_v2_fiData_post",
- "parameters": [
- {
- "required": false,
- "schema": {
- "type": "string",
- "title": "Refid"
- },
- "name": "refId",
- "in": "query"
- },
- {
- "required": false,
- "schema": {
- "type": "string",
- "title": "authorization"
- },
- "name": "authorization",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-product-instance-id"
- },
- "name": "x-product-instance-id",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-id"
- },
- "name": "x-client-id",
- "in": "header"
},
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-secret"
- },
- "name": "x-client-secret",
- "in": "header"
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FIDataList"
- },
- "examples": {
- "DepositAccountExample": {
- "summary": "Example of deposit account data",
- "value": {
- "account": {
- "profile": {
- "holders": {
- "holder": [
- {
- "name": "PRATIK JAIN",
- "dob": "1991-12-27",
- "mobile": "00919650033947",
- "nominee": "REGISTERED",
- "landline": null,
- "address": "420, TOWER 10, PURVANCHAL ROYAL PARK, NOIDA, UTTAR PRADESH, INDIA, 201305",
- "email": "tunetopj@gmail.com",
- "pan": "AXXPJ2898M",
- "ckycCompliance": "false"
- }
- ],
- "type": "SINGLE"
- }
+ "/v3/fiData": {
+ "post": {
+ "tags": [
+ "Data ingestion"
+ ],
+ "summary": "Create FIData block with mixed types support (FIU Webhook)",
+ "description": "Call this API with the data received from FIP's notification as payload, to create an FI DataBlock. Supports multiple account types in single request.",
+ "operationId": "create_fi_data_v3_fiData_post",
+ "parameters": [
+ {
+ "required": false,
+ "schema": {
+ "title": "Refid",
+ "type": "string"
+ },
+ "name": "refId",
+ "in": "query"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "authorization",
+ "type": "string"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "x-product-instance-id",
+ "type": "string"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
},
- "summary": {
- "pending": null,
- "currentBalance": "1360773.36",
- "currency": "INR",
- "exchgeRate": null,
- "balanceDateTime": "2025-05-26 10:35:44.219",
- "type": "SAVINGS",
- "branch": "DLF CAPITOL POI DEL DL",
- "facility": null,
- "ifscCode": "UTIB0005140",
- "micrCode": null,
- "openingDate": "2014-01-18",
- "currentODLimit": "",
- "drawingLimit": "0",
- "status": "ACTIVE"
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-id",
+ "type": "string"
+ },
+ "name": "x-client-id",
+ "in": "header"
},
- "transactions": {
- "transaction": [
- {
- "type": "CREDIT",
- "mode": "OTHERS",
- "amount": 500.0,
- "currentBalance": "517802.52",
- "transactionTimestamp": "2024-05-02 18:30:00.0",
- "valueDate": "2024-05-03",
- "txnId": "1",
- "narration": "IMPS OUTWARD REV",
- "reference": "0"
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-secret",
+ "type": "string"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "FI Data as defined by ReBIT schema",
+ "$ref": "#/components/schemas/FIDataListV2"
+ }
}
- ],
- "startDate": "2024-05-02",
- "endDate": "2025-05-02"
},
- "type": "deposit",
- "maskedAccNumber": "XXXXXX0226",
- "version": null,
- "linkedAccRef": "2ec65d0b-0da5-4601-93cc-b6be384d383e",
- "fipId": "03a66b0c-f5c1-41fb-a5dd-207183803256"
- }
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FIDataBlockCreateResponse"
+ },
+ "examples": {
+ "FIDataBlockCreateResponseV3": {
+ "summary": "FIDataBlockCreateResponseV3",
+ "value": {
+ "status": "Success",
+ "body": {
+ "refId": "test-single-account-15",
+ "fiSchema": [
+ "deposit"
+ ],
+ "expiryDate": "2025-07-06 07:03:12.312"
+ }
+ }
+ },
+ "FIDataBlockCreateResponseV3Multiple": {
+ "summary": "FIDataBlockCreateResponseV3Multiple",
+ "value": {
+ "status": "Success",
+ "body": {
+ "refId": "testing_fi_data_map_105",
+ "fiSchema": [
+ "deposit",
+ "deposit"
+ ],
+ "expiryDate": "2025-07-06 06:56:38.713"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
}
- }
}
- }
},
- "required": true,
- "description": "FI Data as defined by ReBIT schema"
- },
- "responses": {
- "201": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FIDataBlockCreateResponse"
- },
- "examples": {
- "FIDataBlockCreateResponse": {
- "summary": "FIDataBlockCreateResponse",
- "value": {
- "status": "Success",
- "body": {
- "dataId": "57ee04ae-6540-4ba9-a314-082c9f9cd793",
- "fiSchema": "deposit",
- "expiryDate": "2023-03-11T06:52:36.457745"
+ "/v3/insight": {
+ "get": {
+ "tags": [
+ "Insight generation"
+ ],
+ "summary": "Get Insights",
+ "description": "Call this API with the report-id to get the created Insights",
+ "operationId": "get_insights_v3_insight_get",
+ "parameters": [
+ {
+ "required": true,
+ "schema": {
+ "title": "Report ID for which insights are needed",
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": "reportId",
+ "in": "query"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "authorization",
+ "type": "string"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "x-product-instance-id",
+ "type": "string"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-id",
+ "type": "string"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-secret",
+ "type": "string"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetInsightsResponseV3"
+ },
+ "examples": {
+ "GetInsightsResponseV3": {
+ "summary": "GetInsightsResponseV3",
+ "value": {
+ "status": "Success",
+ "body": {
+ "accounts": [
+ {
+ "accountIdentifierKey": "8a467ff9-51a5-4c8e-9cec-396d56acda13",
+ "insights": [
+ {
+ "indicatorName": "fraud_flags",
+ "value": [
+ {
+ "title": "Mostly Cash Mode",
+ "description": "Maximum transactions (80%) involving cash deposit or withdrawals",
+ "value": "100% of transactions were cash based"
+ }
+ ]
+ },
+ {
+ "indicatorName": "balance_analysis_monthly_max",
+ "value": [
+ {
+ "year": 2021,
+ "value": 19000.0,
+ "month": 9
+ },
+ {
+ "year": 2021,
+ "value": 20000.0,
+ "month": 10
+ }
+ ],
+ "meta": {
+ "refKey": "balance_analysis_monthly_max",
+ "offsetMonths": 0,
+ "aggregateFunction": "MAX",
+ "groupBy": "MONTH",
+ "indicatorName": "trend_on_balances"
+ }
+ }
+ ],
+ "status": "success",
+ "reason": "NA",
+ "fiType": "deposit"
+ },
+ {
+ "accountIdentifierKey": "99967ff9-51a5-4c8e-9cec-396d56acda13",
+ "insights": [
+ {
+ "indicatorName": "fraud_flags",
+ "value": []
+ },
+ {
+ "indicatorName": "balance_analysis_monthly_max",
+ "value": [
+ {
+ "year": 2021,
+ "value": 19000.0,
+ "month": 9
+ },
+ {
+ "year": 2021,
+ "value": 20000.0,
+ "month": 10
+ }
+ ],
+ "meta": {
+ "refKey": "balance_analysis_monthly_max",
+ "offsetMonths": 0,
+ "aggregateFunction": "MAX",
+ "groupBy": "MONTH",
+ "indicatorName": "trend_on_balances"
+ }
+ }
+ ],
+ "status": "success",
+ "reason": "NA",
+ "fiType": "deposit"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Insight generation"
+ ],
+ "summary": "Create Insights",
+ "description": "Call this API with the template-id received from Setu along with a ref_id, to trigger an Report generation job. The created Report will be shared via a notification to the endpoint configured by the FIU.This API will respond with a report-id, which can also be used to fetch the generated Report.",
+ "operationId": "process_insights_v3_insight_post",
+ "parameters": [
+ {
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/QueueBindingKey",
+ "default": "priority"
+ },
+ "name": "x-request-type",
+ "in": "header"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "authorization",
+ "type": "string"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": false,
+ "schema": {
+ "title": "x-product-instance-id",
+ "type": "string"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-id",
+ "type": "string"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "title": "x-client-secret",
+ "type": "string"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_process_insights_v3_insight_post"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "202": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportJobCreateResponse"
+ },
+ "examples": {
+ "ReportJobCreateResponseV3": {
+ "summary": "ReportJobCreateResponseV3",
+ "value": {
+ "status": "Success",
+ "body": {
+ "reportId": "05a5a389-b922-4197-be03-b309cdcc575a",
+ "status": "queued",
+ "reason": "NA"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "RequestErrorResponse": {
+ "summary": "RequestErrorResponse",
+ "value": {
+ "errorCode": "400",
+ "errorMsg": "Empty data_ids input",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "NotFoundResponse": {
+ "summary": "NotFoundResponse",
+ "value": {
+ "errorCode": "404",
+ "errorMsg": "Unable to find FIData with id: 4e8e6d50-2dd4-43d0-a79a-5348b935ecf4",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
}
- }
}
- }
}
- }
},
- "401": {
- "description": "Authentication Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "AuthenticationErrorResponse": {
- "summary": "AuthenticationErrorResponse",
- "value": {
- "errorCode": "401",
- "errorMsg": "Unable to fetch FIU config",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "/v3/pdfData/supported_banks": {
+ "get": {
+ "tags": [
+ "Fi Data Ingestion (PDF)"
+ ],
+ "summary": "Get supported banks for PDF processing",
+ "description": "Retrieve a list of banks supported for PDF statement processing",
+ "operationId": "get_supported_banks_v2_pdf_supported_banks_get",
+ "parameters": [
+ {
+ "name": "x-client-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-client-secret",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-product-instance-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "SupportedBanksResponse": {
+ "summary": "SupportedBanksResponse",
+ "value": [
+ "HDFC Bank",
+ "ICICI Bank",
+ "Kotak Mahindra Bank"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
}
- }
}
- }
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ValidationErrorResponse": {
- "summary": "ValidationErrorResponse",
- "value": {
- "errorCode": "422",
- "errorMsg": "field required -> account",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "/v3/pdfData": {
+ "post": {
+ "tags": [
+ "Fi Data Ingestion (PDF)"
+ ],
+ "summary": "Upload PDF bank statement for processing",
+ "description": "Call this API to upload a PDF bank statement for processing and data extraction",
+ "operationId": "upload_pdf_statement_v2_pdf_post",
+ "parameters": [
+ {
+ "name": "refId",
+ "in": "query",
+ "description": "Reference ID for tracking the PDF upload",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-client-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-client-secret",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-product-instance-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "bankName": {
+ "type": "string",
+ "description": "Name of the bank that issued the statement"
+ },
+ "password": {
+ "type": "string",
+ "description": "Password for the PDF if it's encrypted"
+ },
+ "dataFile": {
+ "type": "string",
+ "format": "binary",
+ "description": "PDF bank statement file"
+ }
+ },
+ "required": [
+ "bankName",
+ "dataFile"
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "PDF uploaded and processing started successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FIDataBlockCreateResponse"
+ },
+ "examples": {
+ "PDFUploadSuccessResponse": {
+ "summary": "PDFUploadSuccessResponse",
+ "value": {
+ "status": "Success",
+ "body": {
+ "dataId": "57ee04ae-6540-4ba9-a314-082c9f9cd793",
+ "fiSchema": "pdf",
+ "expiryDate": "2023-03-11T06:52:36.457745"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid PDF or unsupported bank",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
}
- }
}
- }
},
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ServerErrorResponse": {
- "summary": "ServerErrorResponse",
- "value": {
- "errorCode": "500",
- "errorMsg": "Internal Server Error",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "/v3/purge": {
+ "delete": {
+ "tags": [
+ "Purge"
+ ],
+ "summary": "Purge data by reference ID",
+ "description": "Call this API to delete all data associated with a specific reference ID (refId). This operation cannot be undone.",
+ "operationId": "purge_data_v2_purge_delete",
+ "parameters": [
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Reference ID"
+ },
+ "name": "refId",
+ "in": "query",
+ "description": "The reference ID for which data should be purged"
+ },
+ {
+ "required": false,
+ "schema": {
+ "type": "string",
+ "title": "authorization"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-product-instance-id"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-id"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-secret"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Purge",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PurgeSuccessResponse"
+ },
+ "examples": {
+ "PurgeSuccessResponse": {
+ "summary": "PurgeSuccessResponse",
+ "value": {
+ "status": "Success",
+ "version": "0.72.0",
+ "statusDescription": null,
+ "body": {
+ "insight_reports": 1,
+ "depositTransactions": 1,
+ "equitiesTransactions": 0,
+ "etfTransactions": 0,
+ "mutualFundsTransactions": 0
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "RequestErrorResponse": {
+ "summary": "RequestErrorResponse",
+ "value": {
+ "errorCode": "400",
+ "errorMsg": "Missing required parameter: refId",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to authenticate with provided credentials",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "NotFoundResponse": {
+ "summary": "NotFoundResponse",
+ "value": {
+ "errorCode": "404",
+ "errorMsg": "No data found for the provided refId",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
}
- }
- }
- }
- }
- }
- }
- },
- "/v2/pdfData/supported_banks": {
- "get": {
- "tags": ["Fi Data Ingestion (PDF)"],
- "summary": "Get supported banks for PDF processing",
- "description": "Retrieve a list of banks supported for PDF statement processing",
- "operationId": "get_supported_banks_v2_pdf_supported_banks_get",
- "parameters": [
- {
- "name": "x-client-id",
- "in": "header",
- "required": true,
- "schema": {
- "type": "string"
}
- },
- {
- "name": "x-client-secret",
- "in": "header",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "x-product-instance-id",
- "in": "header",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
+ },
+ "/v1/deposit/transactions": {
+ "post": {
+ "description": "List deposit transactions",
+ "tags": ["List transactions"],
+ "summary": "List deposit transactions",
+ "operationId": "list-deposit-transactions",
+ "requestBody": {
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "examples": {
- "SupportedBanksResponse": {
- "summary": "SupportedBanksResponse",
- "value": ["HDFC Bank", "ICICI Bank", "Kotak Mahindra Bank"]
- }
+ "$ref": "#/components/schemas/requests.ListDepositTransactionsRequest"
}
}
- }
- },
- "401": {
- "description": "Authentication Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListDepositTransactionsResponse"
+ }
}
}
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
}
}
}
}
}
- }
- },
- "/v2/pdfData": {
- "post": {
- "tags": ["Fi Data Ingestion (PDF)"],
- "summary": "Upload PDF bank statement for processing",
- "description": "Call this API to upload a PDF bank statement for processing and data extraction",
- "operationId": "upload_pdf_statement_v2_pdf_post",
- "parameters": [
- {
- "name": "refId",
- "in": "query",
- "description": "Reference ID for tracking the PDF upload",
- "required": false,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "x-client-id",
- "in": "header",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "x-client-secret",
- "in": "header",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "x-product-instance-id",
- "in": "header",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "bankName": {
- "type": "string",
- "description": "Name of the bank that issued the statement"
- },
- "password": {
- "type": "string",
- "description": "Password for the PDF if it's encrypted"
- },
- "dataFile": {
- "type": "string",
- "format": "binary",
- "description": "PDF bank statement file"
- }
- },
- "required": ["bankName", "dataFile"]
- }
- }
- },
- "required": true
},
- "responses": {
- "201": {
- "description": "PDF uploaded and processing started successfully",
+ "/v1/equities/transactions": {
+ "post": {
+ "description": "List equities transactions",
+ "tags": ["List transactions"],
+ "summary": "List equities transactions",
+ "operationId": "list-equities-transactions",
+ "requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FIDataBlockCreateResponse"
- },
- "examples": {
- "PDFUploadSuccessResponse": {
- "summary": "PDFUploadSuccessResponse",
- "value": {
- "status": "Success",
- "body": {
- "dataId": "57ee04ae-6540-4ba9-a314-082c9f9cd793",
- "fiSchema": "pdf",
- "expiryDate": "2023-03-11T06:52:36.457745"
- }
- }
+ "$ref": "#/components/schemas/requests.ListEquitiesTransactionsRequest"
+ }
+ }
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListEquitiesTransactionsResponse"
}
}
}
- }
- },
- "400": {
- "description": "Invalid PDF or unsupported bank",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
}
}
}
- },
- "401": {
- "description": "Authentication Error",
+ }
+ }
+ },
+ "/v1/etf/transactions": {
+ "post": {
+ "description": "List etf transactions",
+ "tags": ["List transactions"],
+ "summary": "List etf transactions",
+ "operationId": "list-etf-transactions",
+ "requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ "$ref": "#/components/schemas/requests.ListETFTransactionsRequest"
}
}
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListETFTransactionsResponse"
+ }
}
}
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
}
}
}
}
}
- }
- },
- "/v2/insight": {
- "post": {
- "tags": [
- "Insight Generation"
- ],
- "summary": "Create Insights",
- "description": "Call this API with the template-id received from Setu along with a list of data-ids, to trigger an Report generation job. The FI Datablocks can belong to multiple bank accounts.The created Report will be shared via a notification to the endpoint configured by the FIU.This API will respond with a report-id, which can also be used to fetch the generated Report.",
- "operationId": "process_insights_v2_insight_post",
- "parameters": [
- {
- "required": false,
- "schema": {
- "type": "string",
- "title": "authorization"
- },
- "name": "authorization",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-product-instance-id"
- },
- "name": "x-product-instance-id",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-id"
- },
- "name": "x-client-id",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-secret"
- },
- "name": "x-client-secret",
- "in": "header"
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_process_insights_v2_insight_post"
- }
- }
- },
- "required": true
},
- "responses": {
- "202": {
- "description": "Successful Response",
+ "/v1/mutual-funds/transactions": {
+ "post": {
+ "description": "List mutual-funds transactions",
+ "tags": ["List transactions"],
+ "summary": "List mutual-funds transactions",
+ "operationId": "list-mutual-funds-transactions",
+ "requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReportJobCreateResponse"
- },
- "examples": {
- "ReportJobCreateResponse": {
- "summary": "ReportJobCreateResponse",
- "value": {
- "status": "Success",
- "body": {
- "reportId": "4b108e83-07b6-47a4-84cd-a77d0e9e2b3d"
- }
- }
- }
+ "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsRequest"
}
}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "RequestErrorResponse": {
- "summary": "RequestErrorResponse",
- "value": {
- "errorCode": "400",
- "errorMsg": "Empty data_ids input",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsResponse"
}
}
}
- }
- },
- "401": {
- "description": "Authentication Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "AuthenticationErrorResponse": {
- "summary": "AuthenticationErrorResponse",
- "value": {
- "errorCode": "401",
- "errorMsg": "Unable to fetch FIU config",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
- }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
}
}
}
- },
- "404": {
- "description": "Not Found Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "NotFoundResponse": {
- "summary": "NotFoundResponse",
- "value": {
- "errorCode": "404",
- "errorMsg": "Unable to find FIData with id: 4e8e6d50-2dd4-43d0-a79a-5348b935ecf4",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AccountInsight": {
+ "title": "AccountInsight",
+ "required": [
+ "indicatorName"
+ ],
+ "type": "object",
+ "properties": {
+ "indicatorName": {
+ "title": "Indicatorname",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value"
+ },
+ "meta": {
+ "title": "Meta",
+ "type": "object"
}
- }
}
- }
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ValidationErrorResponse": {
- "summary": "ValidationErrorResponse",
- "value": {
- "errorCode": "422",
- "errorMsg": "field required -> account",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "AccountInsights": {
+ "title": "AccountInsights",
+ "required": [
+ "accountIdentifierKey",
+ "insights"
+ ],
+ "type": "object",
+ "properties": {
+ "accountIdentifierKey": {
+ "title": "Accountidentifierkey",
+ "type": "string"
+ },
+ "insights": {
+ "title": "Insights",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AccountInsight"
+ }
+ },
+ "status": {
+ "title": "Status",
+ "type": "string"
+ },
+ "reason": {
+ "title": "Reason",
+ "type": "string"
+ },
+ "fiType": {
+ "title": "Fitype",
+ "type": "string"
}
- }
}
- }
},
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ServerErrorResponse": {
- "summary": "ServerErrorResponse",
- "value": {
- "errorCode": "500",
- "errorMsg": "Internal Server Error",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
- }
- }
- }
- }
- }
- }
- },
- "get": {
- "tags": [
- "Insights"
- ],
- "summary": "Get Insights",
- "description": "Call this API with the report-id to get the created Insights",
- "operationId": "get_insights_v2_insight_get",
- "parameters": [
- {
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Report ID for which insights are needed"
- },
- "name": "reportId",
- "in": "query"
+ "AccountTS": {
+ "title": "AccountTS",
+ "required": [
+ "linkedAccRef",
+ "version"
+ ],
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transactions"
+ },
+ "linkedAccRef": {
+ "title": "Linkedaccref",
+ "type": "string"
+ },
+ "maskedAccNumber": {
+ "title": "Maskedaccnumber",
+ "type": "string"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string"
+ },
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "default": "etf"
+ }
+ }
},
- {
- "required": false,
- "schema": {
+ "AccountType": {
+ "title": "AccountType",
+ "enum": [
+ "SAVINGS",
+ "CURRENT"
+ ],
"type": "string",
- "title": "authorization"
- },
- "name": "authorization",
- "in": "header"
+ "description": "An enumeration."
+ },
+ "AggregatedInsight": {
+ "title": "AggregatedInsight",
+ "required": [
+ "indicatorName"
+ ],
+ "type": "object",
+ "properties": {
+ "indicatorName": {
+ "title": "Indicatorname",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value"
+ },
+ "meta": {
+ "$ref": "#/components/schemas/AggregatedInsightMeta"
+ }
+ }
},
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-product-instance-id"
- },
- "name": "x-product-instance-id",
- "in": "header"
+ "AggregatedInsightMeta": {
+ "title": "AggregatedInsightMeta",
+ "required": [
+ "totalAccountsProcessed",
+ "failedAccounts",
+ "accountsProcessed",
+ "status",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "totalAccountsProcessed": {
+ "title": "Totalaccountsprocessed",
+ "type": "integer"
+ },
+ "failedAccounts": {
+ "title": "Failedaccounts",
+ "type": "integer"
+ },
+ "accountsProcessed": {
+ "title": "Accountsprocessed",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "status": {
+ "title": "Status",
+ "type": "string"
+ },
+ "message": {
+ "title": "Message",
+ "type": "string"
+ }
+ }
},
- {
- "required": true,
- "schema": {
+ "AggregationFunctions": {
+ "title": "AggregationFunctions",
+ "enum": [
+ "MIN",
+ "MAX",
+ "AVG",
+ "SUM",
+ "SD",
+ "COUNT",
+ "CV",
+ "AVG_RATIO",
+ "INC",
+ "DEC",
+ "COUNT_LT_10",
+ "MEDIAN"
+ ],
"type": "string",
- "title": "x-client-id"
- },
- "name": "x-client-id",
- "in": "header"
+ "description": "An enumeration."
+ },
+ "Body_create_template_v3_template_post": {
+ "title": "Body_create_template_v3_template_post",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "title": "Name",
+ "type": "string"
+ },
+ "keywordMaps": {
+ "title": "List of ids of keyword category maps to be included in the template",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ },
+ "default": []
+ },
+ "categorisationMode": {
+ "title": "Categorisation Mode to use client provided maps strictly or inclusively",
+ "$ref": "#/components/schemas/CategorisationMode",
+ "default": "INCLUSIVE"
+ },
+ "insights": {
+ "title": "List of insights to be included in the template",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InsightRequestV3"
+ },
+ "default": []
+ },
+ "isLineageRequired": {
+ "title": "Islineagerequired",
+ "type": "boolean",
+ "default": false
+ }
+ }
},
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-secret"
- },
- "name": "x-client-secret",
- "in": "header"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ReportJobCreateResponse"
- },
- {
- "$ref": "#/components/schemas/InsightGetResponse"
- }
- ],
- "title": "Response 200 Get Insights V2 Insight Get"
- },
- "examples": {
- "InsightGetResponse": {
- "summary": "InsightGetResponse",
- "value": {
- "status": "Success",
- "body": {
- "name": "Redacted Services",
- "dob": "2006-06-27",
- "email": "redacted@gmail.com",
- "pan": "redacted",
- "ckyc_compliance": false,
- "mobile": 9999912345,
- "bank_branch": "NARKATIAGANJ BH",
- "bank_account_number": "XXXXXXXXXXX1234",
- "bank_account_type": "CURRENT",
- "opening_date": "2019-02-26",
- "closing_balance": 27929.84,
- "end_of_month_balances": {
- "2021": {
- "9": 245676.89,
- "10": 48650.54,
- "11": 145487.41,
- "12": 97725.67
- },
- "2022": {
- "1": 9152.09,
- "2": 5957.19,
- "3": 545.59,
- "4": 1282299.18,
- "5": 134376.04,
- "6": 84468.46,
- "7": 135585.11,
- "8": 3346.11,
- "9": 268766.7,
- "10": 50049.84,
- "11": 27929.84
- }
- },
- "balances_on_10th": {
- "2021": {
- "12": 55387.41
- },
- "2022": {
- "1": 2426.67,
- "2": 9629.59,
- "3": 97487.45,
- "4": 1641.09,
- "5": 52517.54,
- "6": 72084.28,
- "7": 165864.04,
- "8": 63465.11,
- "9": 11226.11,
- "10": 418535.81,
- "11": 27929.84
- }
- },
- "average_end_of_day_balance": 297715.03,
- "maximum_end_of_day_balance": 1818766.7,
- "total_credits": 153,
- "total_credits_value": 44810341.06,
- "total_debits": 473,
- "total_debits_value": 45178088.11,
- "quarterly_salary_average": {
- "2021": {
- "4": 15072
- }
- },
- "cash_deposit_x_total_credit": {
- "2021": {
- "12": 0.0095
- },
- "2022": {
- "3": 0.0018
- }
- },
- "run_amt_last_1m_min_q2": {
- "meta": {
- "refKey": "run_amt_last_1m_min_q2",
- "lastNMonths": 5,
- "aggregateFunction": "COUNT"
- },
- "value": 125
- },
- "run_amt_last_1m_min_q3": {
- "meta": {
- "refKey": "run_amt_last_1m_min_q3",
- "lastNMonths": 5,
- "aggregateFunction": "SUM"
- },
- "value": 918017.6299999999
- },
- "ratio_run_amt_last_1m_min_q2_q3": {
- "meta": {
- "id": "cd81abf3-37df-4fcd-9a88-874884982f48",
- "name": "test",
- "formula": "run_amt_last_1m_min_q2 * run_amt_last_1m_min_q3",
- "refKey": "ratio_run_amt_last_1m_min_q2_q3",
- "description": "test",
- "reqInsights": [
- "run_amt_last_1m_min_q2",
- "run_amt_last_1m_min_q3"
- ],
- "insightId": "e2a127a0-6d0b-45e0-973d-430b16b99e79"
- },
- "value": 114752203.74999999
- }
+ "Body_process_insights_v3_insight_post": {
+ "title": "Body_process_insights_v3_insight_post",
+ "required": [
+ "templateId"
+ ],
+ "type": "object",
+ "properties": {
+ "templateId": {
+ "title": "Template ID for which insights are needed",
+ "type": "string",
+ "format": "uuid"
+ },
+ "refId": {
+ "title": "Refid",
+ "type": "string"
+ },
+ "additionalInfo": {
+ "title": "Additionalinfo",
+ "type": "object",
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ }
+ ]
}
- }
+ },
+ "filters": {
+ "title": "Filters for PFM",
+ "$ref": "#/components/schemas/CreateInsightsFilters",
+ "default": {}
}
- }
}
- }
},
- "401": {
- "description": "Authentication Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "AuthenticationErrorResponse": {
- "summary": "AuthenticationErrorResponse",
- "value": {
- "errorCode": "401",
- "errorMsg": "Unable to fetch FIU config",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "CategorisationMode": {
+ "title": "CategorisationMode",
+ "enum": [
+ "STRICT",
+ "STRICT_W_SALARY",
+ "KW_INCLUSIVE",
+ "INCLUSIVE"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "Category": {
+ "title": "Category",
+ "enum": [
+ "Cash Deposit",
+ "Cash Withdrawal",
+ "Bounced Cheque",
+ "Salary",
+ "Bank Charges",
+ "Credit Card",
+ "Dividend",
+ "Education",
+ "Entertainment",
+ "Food & Drinks",
+ "Health",
+ "Investments",
+ "Jewellery",
+ "Loan",
+ "Pension",
+ "Reimbursement",
+ "Shopping",
+ "Sports",
+ "Subsidy",
+ "Tax",
+ "Travel and Transport",
+ "Utility Payments",
+ "Others",
+ "Gifts, Celebrations",
+ "Charity",
+ "Business Expense",
+ "Interest",
+ "Transfer",
+ "Transfer to Individual",
+ "Cash Withdrawals",
+ "Rent",
+ "Vehicle",
+ "Groceries",
+ "Transportation",
+ "Insurance",
+ "Refunds",
+ "Professional Services",
+ "Counseling",
+ "Donations",
+ "Fines",
+ "Bonus",
+ "Business Income",
+ "Cheque",
+ "Bill",
+ "Gaming",
+ "Other Bank Charge",
+ "Fund Transfer",
+ "Account Verification",
+ "Self Transfer",
+ "ECS Bounces",
+ "Penalties"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "CreateInsightsFilters": {
+ "title": "CreateInsightsFilters",
+ "type": "object",
+ "properties": {
+ "dateRange": {
+ "$ref": "#/components/schemas/DateRangeFilter"
+ },
+ "accounts": {
+ "title": "Accounts",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- }
}
- }
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ValidationErrorResponse": {
- "summary": "ValidationErrorResponse",
- "value": {
- "errorCode": "422",
- "errorMsg": "field required -> account",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "DateRangeFilter": {
+ "title": "DateRangeFilter",
+ "required": [
+ "startDate",
+ "endDate"
+ ],
+ "type": "object",
+ "properties": {
+ "startDate": {
+ "title": "Startdate",
+ "type": "string",
+ "format": "date"
+ },
+ "endDate": {
+ "title": "Enddate",
+ "type": "string",
+ "format": "date"
}
- }
}
- }
},
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ServerErrorResponse": {
- "summary": "ServerErrorResponse",
- "value": {
- "errorCode": "500",
- "errorMsg": "Internal Server Error",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
- }
+ "DepositData": {
+ "title": "DepositData",
+ "required": [
+ "account"
+ ],
+ "type": "object",
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Account"
}
- }
}
- }
- }
- }
- }
- },
- "/v2/purge": {
- "delete": {
- "tags": ["Purge"],
- "summary": "Purge data by reference ID",
- "description": "Call this API to delete all data associated with a specific reference ID (refId). This operation cannot be undone.",
- "operationId": "purge_data_v2_purge_delete",
- "parameters": [
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "Reference ID"
- },
- "name": "refId",
- "in": "query",
- "description": "The reference ID for which data should be purged"
- },
- {
- "required": false,
- "schema": {
- "type": "string",
- "title": "authorization"
- },
- "name": "authorization",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-product-instance-id"
- },
- "name": "x-product-instance-id",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-id"
},
- "name": "x-client-id",
- "in": "header"
- },
- {
- "required": true,
- "schema": {
- "type": "string",
- "title": "x-client-secret"
- },
- "name": "x-client-secret",
- "in": "header"
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Purge",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PurgeSuccessResponse"
- },
- "examples": {
- "PurgeSuccessResponse": {
- "summary": "PurgeSuccessResponse",
- "value": {
- "status": "Success",
- "version": "0.72.0",
- "statusDescription": null,
- "body": {
- "insight_reports": 1,
- "depositTransactions": 1,
- "equitiesTransactions": 0,
- "etfTransactions": 0,
- "mutualFundsTransactions": 0
- }
+ "ETFData": {
+ "title": "ETFData",
+ "required": [
+ "account"
+ ],
+ "type": "object",
+ "properties": {
+ "account": {
+ "title": "Account",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Account"
+ },
+ {
+ "$ref": "#/components/schemas/AccountTS"
+ }
+ ]
}
- }
}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "RequestErrorResponse": {
- "summary": "RequestErrorResponse",
- "value": {
- "errorCode": "400",
- "errorMsg": "Missing required parameter: refId",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ },
+ "EquitiesData": {
+ "title": "EquitiesData",
+ "required": [
+ "account"
+ ],
+ "type": "object",
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Account"
}
- }
}
- }
- }
- },
- "401": {
- "description": "Authentication Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "AuthenticationErrorResponse": {
- "summary": "AuthenticationErrorResponse",
- "value": {
- "errorCode": "401",
- "errorMsg": "Unable to authenticate with provided credentials",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ },
+ "EquityCategory": {
+ "title": "EquityCategory",
+ "enum": [
+ "EQUITY"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "ErrorResponse": {
+ "title": "ErrorResponse",
+ "required": [
+ "errorCode",
+ "errorMsg"
+ ],
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "title": "Errorcode",
+ "type": "string"
+ },
+ "errorMsg": {
+ "title": "Errormsg",
+ "type": "string"
+ },
+ "timestamp": {
+ "title": "Timestamp",
+ "type": "string",
+ "format": "date-time"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "0.74.0"
+ },
+ "txnid": {
+ "title": "Txnid",
+ "type": "string",
+ "default": ""
}
- }
}
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "NotFoundResponse": {
- "summary": "NotFoundResponse",
- "value": {
- "errorCode": "404",
- "errorMsg": "No data found for the provided refId",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ },
+ "FIDataBlockCreateResponse": {
+ "title": "FIDataBlockCreateResponse",
+ "required": [
+ "body"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "title": "Status",
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "0.74.0"
+ },
+ "statusDescription": {
+ "title": "Statusdescription",
+ "type": "string"
+ },
+ "body": {
+ "$ref": "#/components/schemas/FIDataBlockResponse"
}
- }
}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- },
- "examples": {
- "ServerErrorResponse": {
- "summary": "ServerErrorResponse",
- "value": {
- "errorCode": "500",
- "errorMsg": "Internal Server Error",
- "timestamp": "2023-04-18T17:10:12.904153",
- "ver": "1",
- "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ },
+ "FIDataBlockResponse": {
+ "title": "FIDataBlockResponse",
+ "required": [
+ "fiSchema"
+ ],
+ "type": "object",
+ "properties": {
+ "dataId": {
+ "title": "Dataid",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "refId": {
+ "title": "Refid",
+ "type": "string"
+ },
+ "fiSchema": {
+ "title": "Fischema",
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "expiryDate": {
+ "title": "Expirydate",
+ "type": "string",
+ "format": "date-time"
}
- }
- }
- }
- }
- }
- }
- }
- },
- "/v1/deposit/transactions": {
- "post": {
- "description": "List deposit transactions",
- "tags": ["List transactions"],
- "summary": "List deposit transactions",
- "operationId": "list-deposit-transactions",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/requests.ListDepositTransactionsRequest"
}
- }
},
- "description": "Query details",
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/responses.ListDepositTransactionsResponse"
- }
- }
- }
+ "FIDataListV2": {
+ "title": "FIDataListV2",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/DepositData"
+ },
+ {
+ "$ref": "#/components/schemas/MutualFundsData"
+ },
+ {
+ "$ref": "#/components/schemas/EquitiesData"
+ },
+ {
+ "$ref": "#/components/schemas/ETFData"
+ },
+ {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/DepositData"
+ },
+ {
+ "$ref": "#/components/schemas/MutualFundsData"
+ },
+ {
+ "$ref": "#/components/schemas/EquitiesData"
+ },
+ {
+ "$ref": "#/components/schemas/ETFData"
+ }
+ ]
+ },
+ "title": "DepositData,MutualFundsData,EquitiesData,ETFData"
+ }
+ ]
},
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/responses.Error" }
- }
- }
- }
- }
- }
- },
- "/v1/equities/transactions": {
- "post": {
- "description": "List equities transactions",
- "tags": ["List transactions"],
- "summary": "List equities transactions",
- "operationId": "list-equities-transactions",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/requests.ListEquitiesTransactionsRequest"
+ "FIUConfig": {
+ "title": "FIUConfig",
+ "required": [
+ "fiuId",
+ "account_ids_path"
+ ],
+ "type": "object",
+ "properties": {
+ "fiuId": {
+ "title": "Fiuid",
+ "type": "string"
+ },
+ "notificationEndpoint": {
+ "title": "Notificationendpoint",
+ "type": "string"
+ },
+ "webhookId": {
+ "title": "Webhookid",
+ "type": "string"
+ },
+ "expiryDelta": {
+ "title": "Expirydelta",
+ "type": "integer",
+ "default": 30
+ },
+ "bertSalaryEnabled": {
+ "title": "Bertsalaryenabled",
+ "type": "boolean",
+ "default": true
+ },
+ "account_ids_path": {
+ "title": "Account Ids Path",
+ "type": "string"
+ },
+ "webhookAuthMechanism": {
+ "title": "Webhookauthmechanism",
+ "type": "string",
+ "default": "None"
+ },
+ "webhookAuthParams": {
+ "title": "Webhookauthparams",
+ "type": "object",
+ "default": {}
+ },
+ "isVLLMInferenceEnabled": {
+ "title": "Isvllminferenceenabled",
+ "type": "boolean",
+ "default": false
+ },
+ "transactionTTLDays": {
+ "title": "Transactionttldays",
+ "type": "integer"
+ },
+ "isCounterpartyEnabled": {
+ "title": "Iscounterpartyenabled",
+ "type": "boolean",
+ "default": true
+ },
+ "vpaCategorisationEnabled": {
+ "title": "Vpacategorisationenabled",
+ "type": "boolean",
+ "default": true
+ }
}
- }
},
- "description": "Query details",
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/responses.ListEquitiesTransactionsResponse"
- }
+ "GetInsightsResponseBodyV3": {
+ "title": "GetInsightsResponseBodyV3",
+ "required": [
+ "accounts"
+ ],
+ "type": "object",
+ "properties": {
+ "accounts": {
+ "title": "Accounts",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AccountInsights"
+ }
+ },
+ "aggregatedInsights": {
+ "title": "Aggregatedinsights",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AggregatedInsight"
+ }
+ }
}
- }
},
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/responses.Error" }
- }
- }
- }
- }
- }
- },
- "/v1/etf/transactions": {
- "post": {
- "description": "List etf transactions",
- "tags": ["List transactions"],
- "summary": "List etf transactions",
- "operationId": "list-etf-transactions",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/requests.ListETFTransactionsRequest"
+ "GetInsightsResponseV3": {
+ "title": "GetInsightsResponseV3",
+ "required": [
+ "body"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "title": "Status",
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "0.74.0"
+ },
+ "statusDescription": {
+ "title": "Statusdescription",
+ "type": "string"
+ },
+ "body": {
+ "$ref": "#/components/schemas/GetInsightsResponseBodyV3"
+ }
}
- }
},
- "description": "Query details",
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/responses.ListETFTransactionsResponse"
- }
+ "GroupBy": {
+ "title": "GroupBy",
+ "enum": [
+ "DAY",
+ "MONTH",
+ "YEAR",
+ "QUARTER",
+ "HALF_YEAR"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "HTTPValidationError": {
+ "title": "HTTPValidationError",
+ "type": "object",
+ "properties": {
+ "detail": {
+ "title": "Detail",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ValidationError"
+ }
+ }
}
- }
},
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/responses.Error" }
+ "HoldersType": {
+ "title": "HoldersType",
+ "enum": [
+ "SINGLE",
+ "JOINT",
+ "PROPRIETOR",
+ "OTHERS"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "InsightParam": {
+ "title": "InsightParam",
+ "type": "object",
+ "properties": {
+ "refKey": {
+ "title": "Refkey",
+ "type": "string"
+ },
+ "lastNMonths": {
+ "title": "Lastnmonths",
+ "type": "integer"
+ },
+ "offsetMonths": {
+ "title": "Offsetmonths",
+ "type": "integer",
+ "default": 0
+ },
+ "aggregateFunction": {
+ "$ref": "#/components/schemas/AggregationFunctions"
+ },
+ "transactionType": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "transactionMode": {
+ "title": "Transactionmode",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/TransferMode"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TransferMode"
+ }
+ }
+ ]
+ },
+ "transactionCategory": {
+ "title": "Transactioncategory",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Category"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Category"
+ }
+ }
+ ]
+ },
+ "transactionSubcategory": {
+ "title": "Transactionsubcategory",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SubCategory"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubCategory"
+ }
+ }
+ ]
+ },
+ "transactionCategoryExclusions": {
+ "title": "Transactioncategoryexclusions",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Category"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Category"
+ }
+ }
+ ]
+ },
+ "transactionSubcategoryExclusions": {
+ "title": "Transactionsubcategoryexclusions",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SubCategory"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubCategory"
+ }
+ }
+ ]
+ },
+ "startDate": {
+ "title": "Startdate",
+ "type": "string",
+ "format": "date"
+ },
+ "endDate": {
+ "title": "Enddate",
+ "type": "string",
+ "format": "date"
+ },
+ "periodicity": {
+ "$ref": "#/components/schemas/Periodicity"
+ },
+ "minAmount": {
+ "title": "Minamount",
+ "type": "number"
+ },
+ "groupBy": {
+ "$ref": "#/components/schemas/GroupBy"
+ },
+ "day": {
+ "title": "Day",
+ "type": "integer"
+ },
+ "top": {
+ "title": "Top",
+ "type": "integer"
+ },
+ "salaryType": {
+ "$ref": "#/components/schemas/SalaryType"
+ },
+ "amountVarianceThreshold": {
+ "title": "Amountvariancethreshold",
+ "type": "number",
+ "default": 0.2
+ },
+ "dateVarianceDays": {
+ "title": "Datevariancedays",
+ "type": "integer",
+ "default": 7
+ }
}
- }
- }
- }
- }
- },
- "/v1/mutual-funds/transactions": {
- "post": {
- "description": "List mutual-funds transactions",
- "tags": ["List transactions"],
- "summary": "List mutual-funds transactions",
- "operationId": "list-mutual-funds-transactions",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsRequest"
+ },
+ "InsightRequestV3": {
+ "title": "InsightRequestV3",
+ "required": [
+ "insight",
+ "refKey"
+ ],
+ "type": "object",
+ "properties": {
+ "insight": {
+ "title": "Insight",
+ "type": "string",
+ "description": "Insight name, must start with 'static_' or 'configurable_'"
+ },
+ "refKey": {
+ "title": "Refkey",
+ "type": "string",
+ "description": "Reference key for the insight"
+ },
+ "title": {
+ "title": "Title",
+ "type": "string",
+ "description": "Title for the insight",
+ "default": ""
+ },
+ "description": {
+ "title": "Description",
+ "type": "string",
+ "description": "Description for the insight",
+ "default": ""
+ },
+ "params": {
+ "title": "Params",
+ "type": "object",
+ "description": "Parameters for configurable insights",
+ "default": {}
+ }
}
- }
},
- "description": "Query details",
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsResponse"
- }
+ "InsightResponseV3": {
+ "title": "InsightResponseV3",
+ "required": [
+ "insight",
+ "refKey",
+ "title",
+ "insightId"
+ ],
+ "type": "object",
+ "properties": {
+ "insight": {
+ "title": "Insight",
+ "type": "string",
+ "description": "Full insight name with prefix"
+ },
+ "refKey": {
+ "title": "Refkey",
+ "type": "string",
+ "description": "Reference key for the insight"
+ },
+ "title": {
+ "title": "Title",
+ "type": "string",
+ "description": "Title for the insight"
+ },
+ "description": {
+ "title": "Description",
+ "type": "string",
+ "description": "Description for the insight",
+ "default": ""
+ },
+ "params": {
+ "title": "Params",
+ "$ref": "#/components/schemas/InsightParam",
+ "description": "Parameters for configurable insights"
+ },
+ "insightId": {
+ "title": "Insightid",
+ "type": "string",
+ "description": "Insight master ID",
+ "format": "uuid"
+ }
}
- }
},
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": { "$ref": "#/components/schemas/responses.Error" }
+ "KeywordMap": {
+ "title": "KeywordMap",
+ "required": [
+ "name",
+ "map"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "title": "Id",
+ "type": "integer"
+ },
+ "name": {
+ "title": "Name",
+ "type": "string"
+ },
+ "map": {
+ "title": "Map",
+ "type": "object",
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ }
+ },
+ {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ }
+ }
}
- }
- }
- }
- }
- }
- },
- "components": {
- "schemas": {
- "FIDataList": {
- "type": "object",
- "properties": {
- "account": {
- "type": "object",
- "properties": {
- "profile": {
- "type": "object",
- "properties": {
- "holders": {
- "type": "object",
- "properties": {
- "holder": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "dob": { "type": "string", "format": "date" },
- "mobile": { "type": "string" },
- "nominee": { "type": "string" },
- "landline": { "type": "string", "nullable": true },
- "address": { "type": "string" },
- "email": { "type": "string", "format": "email" },
- "pan": { "type": "string" },
- "ckycCompliance": { "type": "string" }
- },
- "required": ["name", "dob", "mobile", "address", "email"]
- }
- },
- "type": { "type": "string" }
- },
- "required": ["holder", "type"]
+ },
+ "MutualFundsData": {
+ "title": "MutualFundsData",
+ "required": [
+ "account"
+ ],
+ "type": "object",
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Account"
}
- },
- "required": ["holders"]
- },
- "summary": {
- "type": "object",
- "properties": {
- "pending": { "type": "string", "nullable": true },
- "currentBalance": { "type": "string" },
- "currency": { "type": "string" },
- "exchgeRate": { "type": "string", "nullable": true },
- "balanceDateTime": { "type": "string", "format": "date-time" },
- "type": { "type": "string" },
- "branch": { "type": "string" },
- "facility": { "type": "string", "nullable": true },
- "ifscCode": { "type": "string" },
- "micrCode": { "type": "string", "nullable": true },
- "openingDate": { "type": "string", "format": "date" },
- "currentODLimit": { "type": "string" },
- "drawingLimit": { "type": "string" },
- "status": { "type": "string" }
- },
- "required": ["currentBalance", "currency", "type", "ifscCode", "status"]
- },
- "transactions": {
- "type": "object",
- "properties": {
- "transaction": {
- "type": "array",
- "items": {
+ }
+ },
+ "NotificationSchema": {
+ "title": "NotificationSchema",
+ "required": [
+ "type",
+ "reportId"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "description": "Type of the notification"
+ },
+ "timestamp": {
+ "title": "Timestamp",
+ "type": "string",
+ "description": "Timestamp of sending the notification",
+ "format": "date-time"
+ },
+ "reportId": {
+ "title": "Reportid",
+ "type": "string",
+ "description": "Reference ID of the insights generation report",
+ "format": "uuid"
+ },
+ "success": {
+ "title": "Success",
+ "type": "boolean",
+ "description": "Signifies whether the notification is a successful one or not",
+ "default": true
+ },
+ "data": {
+ "title": "Data",
"type": "object",
- "properties": {
- "type": { "type": "string" },
- "mode": { "type": "string" },
- "amount": { "type": "number" },
- "currentBalance": { "type": "string" },
- "transactionTimestamp": { "type": "string", "format": "date-time" },
- "valueDate": { "type": "string", "format": "date" },
- "txnId": { "type": "string" },
- "narration": { "type": "string" },
- "reference": { "type": "string" }
- },
- "required": ["type", "amount", "transactionTimestamp", "txnId"]
- }
+ "description": "Data for the notification"
},
- "startDate": { "type": "string", "format": "date" },
- "endDate": { "type": "string", "format": "date" }
- },
- "required": ["transaction", "startDate", "endDate"]
- },
- "type": { "type": "string" },
- "maskedAccNumber": { "type": "string" },
- "version": { "type": "string", "nullable": true },
- "linkedAccRef": { "type": "string" },
- "fipId": { "type": "string" }
- },
- "required": ["profile", "summary", "type", "maskedAccNumber", "fipId"]
- }
- },
- "required": ["account"]
- },
- "FIDataBlockCreateResponse": {
- "type": "object",
- "properties": {
- "status": { "type": "string" },
- "body": {
- "type": "object",
- "properties": {
- "dataId": { "type": "string", "format": "uuid" },
- "fiSchema": { "type": "string" },
- "expiryDate": { "type": "string", "format": "date-time" }
- },
- "required": ["dataId", "fiSchema", "expiryDate"]
- }
- },
- "required": ["status", "body"]
- },
- "TemplateCreateRequest": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "staticInsights": {
- "type": "array",
- "items": { "type": "string" }
- },
- "configurableInsights": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ConfigurableInsightRequest"
- }
- }
- }
- },
- "ConfigurableInsightRequest": {
- "type": "object",
- "required": ["insight", "ref_key", "params", "title"],
- "properties": {
- "insight": { "type": "string" },
- "ref_key": { "type": "string" },
- "params": {
- "type": "object",
- "additionalProperties": true
- },
- "title": { "type": "string" },
- "description": { "type": "string", "nullable": true }
- }
- },
- "TemplatePostResponse": {
- "type": "object",
- "properties": {
- "status": { "type": "string", "default": "Success" },
- "version": { "type": "string" },
- "statusDescription": { "type": "string", "nullable": true },
- "body": { "$ref": "#/components/schemas/TemplateResponseBody" }
- },
- "required": ["status", "body"]
- },
- "TemplateListResponse": {
- "type": "object",
- "properties": {
- "status": { "type": "string", "default": "Success" },
- "version": { "type": "string" },
- "statusDescription": { "type": "string", "nullable": true },
- "body": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/TemplateResponseBody" }
- }
- },
- "required": ["status", "body"]
- },
- "TemplateResponseBody": {
- "type": "object",
- "properties": {
- "templateId": { "type": "string" },
- "name": { "type": "string" },
- "staticInsights": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/StaticInsight" }
- },
- "configurableInsights": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/ConfigurableInsight" }
- },
- "categorisationMode": {
- "type": "string",
- "enum": ["INCLUSIVE", "EXCLUSIVE"]
- },
- "keywordMaps": {
- "type": "array",
- "items": { "type": "object" }
- },
- "compoundInsights": {
- "type": "array",
- "items": { "type": "object" }
- },
- "isLineageRequired": { "type": "boolean" }
- },
- "required": ["templateId", "name"]
- },
- "StaticInsight": {
- "type": "object",
- "properties": {
- "insightId": { "type": "string" },
- "name": { "type": "string" },
- "title": { "type": "string" },
- "description": { "type": "string", "nullable": true }
- },
- "required": ["insightId", "name", "title"]
- },
- "ConfigurableInsight": {
- "type": "object",
- "properties": {
- "refKey": { "type": "string" },
- "title": { "type": "string" },
- "description": { "type": "string", "nullable": true },
- "params": { "type": "object", "additionalProperties": true },
- "insightId": { "type": "string" },
- "insight": { "$ref": "#/components/schemas/InsightDetails" }
- },
- "required": ["refKey", "title", "insightId", "insight"]
- },
- "InsightDetails": {
- "type": "object",
- "properties": {
- "insightId": { "type": "string" },
- "name": { "type": "string" },
- "title": { "type": "string" },
- "description": { "type": "string", "nullable": true }
- },
- "required": ["insightId", "name", "title"]
- },
- "AccountTS": {
- "properties": {
- "profile": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Profile"
- },
- "summary": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Summary"
- },
- "transactions": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transactions"
- },
- "linkedAccRef": {
- "type": "string",
- "title": "Linkedaccref"
- },
- "maskedAccNumber": {
- "type": "string",
- "title": "Maskedaccnumber"
- },
- "version": {
- "type": "string",
- "title": "Version"
- },
- "type": {
- "type": "string",
- "title": "Type",
- "default": "etf"
- }
- },
- "type": "object",
- "required": [
- "linkedAccRef",
- "maskedAccNumber",
- "version"
- ],
- "title": "AccountTS"
- },
- "AccountType": {
- "type": "string",
- "enum": [
- "SAVINGS",
- "CURRENT"
- ],
- "title": "AccountType",
- "description": "An enumeration."
- },
- "AggregationFunctions": {
- "type": "string",
- "enum": [
- "MIN",
- "MAX",
- "AVG",
- "SUM",
- "SD",
- "COUNT",
- "CV",
- "AVG_RATIO",
- "INC",
- "DEC",
- "COUNT_LT_10"
- ],
- "title": "AggregationFunctions",
- "description": "An enumeration."
- },
- "Body_create_template_v1_template_post": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "insights": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "List of Insight masters to be included in the template"
- }
- },
- "type": "object",
- "required": [
- "name",
- "insights"
- ],
- "title": "Body_create_template_v1_template_post"
- },
- "Body_create_template_v2_template_post": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "keywordMaps": {
- "items": {
- "type": "integer"
- },
- "type": "array",
- "title": "List of ids of keyword category maps to be included in the template",
- "default": []
- },
- "categorisationMode": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CategorisationMode"
+ "error": {
+ "title": "Error",
+ "type": "object",
+ "description": "Error for the notification"
+ }
}
- ],
- "title": "Categorisation Mode to use client provided maps strictly or inclusively",
- "default": "INCLUSIVE"
- },
- "staticInsights": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "List of Insight masters to be included in the template",
- "default": []
- },
- "configurableInsights": {
- "items": {
- "$ref": "#/components/schemas/InsightMap"
- },
- "type": "array",
- "title": "List of congurable insight masters with their configurations to be included in the template",
- "default": []
- },
- "compoundInsights": {
- "items": {
- "$ref": "#/components/schemas/CompoundMasterRequest"
- },
- "type": "array",
- "title": "List of compound insight masters with their formula to be included in the template",
- "default": []
- }
- },
- "type": "object",
- "required": [
- "name"
- ],
- "title": "Body_create_template_v2_template_post"
- },
- "Body_process_insights_v1_insight_post": {
- "properties": {
- "templateId": {
- "type": "string",
- "format": "uuid",
- "title": "Template ID for which insights are needed"
- },
- "dataIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "List of data blocks to process"
- },
- "refIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Refids"
},
- "linkedAccRefs": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Linkedaccrefs"
+ "Pending": {
+ "title": "Pending",
+ "required": [
+ "amount"
+ ],
+ "type": "object",
+ "properties": {
+ "transactionType": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "amount": {
+ "title": "Amount",
+ "type": "number"
+ }
+ }
},
- "additionalInfo": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": "object",
- "title": "Additionalinfo"
+ "Periodicity": {
+ "title": "Periodicity",
+ "enum": [
+ "MONTHLY",
+ "DAILY"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "QueueBindingKey": {
+ "title": "QueueBindingKey",
+ "enum": [
+ "batch",
+ "priority"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "ReportJobCreateResponse": {
+ "title": "ReportJobCreateResponse",
+ "required": [
+ "body"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "title": "Status",
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "0.74.0"
+ },
+ "statusDescription": {
+ "title": "Statusdescription",
+ "type": "string"
+ },
+ "body": {
+ "$ref": "#/components/schemas/ReportJobResponseBody"
+ }
+ }
},
- "filters": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CreateInsightsFilters"
+ "ReportJobResponseBody": {
+ "title": "ReportJobResponseBody",
+ "required": [
+ "reportId",
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "reportId": {
+ "title": "Reportid",
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "title": "Status",
+ "type": "string"
+ },
+ "reason": {
+ "title": "Reason",
+ "type": "string",
+ "default": "NA"
+ }
}
- ],
- "title": "Filters for PFM",
- "default": {}
- }
- },
- "type": "object",
- "required": [
- "templateId"
- ],
- "title": "Body_process_insights_v1_insight_post"
- },
- "Body_process_insights_v2_insight_post": {
- "properties": {
- "templateId": {
- "type": "string",
- "format": "uuid",
- "title": "Template ID for which insights are needed"
},
- "refIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Refids"
+ "SalaryType": {
+ "title": "SalaryType",
+ "enum": [
+ "TRUESALARY",
+ "PREDICTEDSALARY",
+ "ANY"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "SchemeCategory": {
+ "title": "SchemeCategory",
+ "enum": [
+ "MULTI_CAP_FUND",
+ "LARGE_CAP_FUND",
+ "LARGE_and_MID_CAP_FUND",
+ "MIDCAP_FUND",
+ "SMALL_CAP_FUND",
+ "DIVIDEND_YIELD_FUND",
+ "VALUE_FUND",
+ "CONTRA_FUND",
+ "FOCUSED_FUND",
+ "SECTORAL_OR_THEMATIC",
+ "ELSS",
+ "OVERNIGHT_FUND",
+ "LIQUID_FUND",
+ "ULTRA_SHORT_DURATION_FUND",
+ "LOW_DURATION_FUND",
+ "MONEY_MARKET_FUND",
+ "SHORT_DURATION_FUND",
+ "MEDIUM_DURATION_FUND",
+ "MEDIUM_TO_LONG_DURATION_FUND",
+ "LONG_DURATION_FUND",
+ "DYNAMIC_BOND",
+ "CORPORATE_BOND_FUND",
+ "CREDIT_RISK_FUND",
+ "BANKING_AND_PSU_FUND",
+ "GILT_FUND",
+ "GILT_FUND_WITH_10_YEAR_CONSTANT_DURATION",
+ "FLOATER_FUND",
+ "CONSERVATIVE_HYBRID_FUND",
+ "BALANCED_HYBRID_FUND",
+ "AGGRESSIVE_HYBRID_FUND",
+ "DYNAMIC_ASSET_ALLOCATION_OR_BALANCED_ADVANTAGE",
+ "MULTI_ASSET_ALLOCATION",
+ "ARBITRAGE_FUND",
+ "EQUITY_SAVINGS",
+ "RETIREMENT_FUND",
+ "CHILDREN'S_FUND",
+ "INDEX_FUNDS_OR_ETFS",
+ "FOFS_OVERSEAS_OR_DOMESTIC"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "SchemeOption": {
+ "title": "SchemeOption",
+ "enum": [
+ "REINVEST",
+ "PAYOUT",
+ "GROWTH_TYPE"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "SchemePlan": {
+ "title": "SchemePlan",
+ "enum": [
+ "DIRECT",
+ "REGULAR"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "SchemeTypes": {
+ "title": "SchemeTypes",
+ "enum": [
+ "EQUITY_SCHEMES",
+ "DEBT_SCHEMES",
+ "HYBRID_SCHEMES",
+ "SOLUTION_ORIENTED_SCHEMES",
+ "OTHER_SCHEMES"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "StatusTypes": {
+ "title": "StatusTypes",
+ "enum": [
+ "ACTIVE",
+ "INACTIVE"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "SubCategory": {
+ "title": "SubCategory",
+ "enum": [
+ "Gaming",
+ "Vacation",
+ "Food",
+ "Alcohol",
+ "Medical",
+ "Personal Care",
+ "Bank Interest",
+ "Bonds",
+ "Fixed Deposit",
+ "Crypto",
+ "Equities",
+ "Insurance",
+ "Mutual Fund",
+ "Apparel",
+ "Electronics",
+ "Electricity",
+ "Water",
+ "Groceries",
+ "Household",
+ "Rent Payment",
+ "Vehicle",
+ "Fuel",
+ "Handhelds",
+ "Cable",
+ "Internet",
+ "Subscriptions",
+ "Recreation, Vacation",
+ "Concerts",
+ "Public Transportation",
+ "Parking",
+ "Hotels",
+ "Salary Received",
+ "Salary Paid",
+ "P2P Inward",
+ "P2P Outward",
+ "P2M Inward",
+ "P2M Outward",
+ "P2A Inward",
+ "P2A Outward",
+ "Wallet",
+ "Inward Bounce Charges",
+ "Outward Bounce Charges",
+ "Inward Reversal",
+ "Outward Reversal",
+ "Loan",
+ "CreditCardSettlement",
+ "Education",
+ "Movie",
+ "Drinks",
+ "Travel",
+ "Hospital",
+ "Insurance Debit",
+ "Stationery",
+ "Sports",
+ "Tax Liability",
+ "Hotels and Stays",
+ "Tolls",
+ "Cab",
+ "Bus",
+ "Train",
+ "Flight",
+ "Courier",
+ "Rental",
+ "Purchase",
+ "Phone Recharge",
+ "Gas",
+ "Internet and DTH",
+ "Rent Paid",
+ "Vehicle Maintenance Expense",
+ "Professional Services",
+ "Cleaning Services",
+ "Charity Donation",
+ "Religious Donation",
+ "Political Donation",
+ "Fines",
+ "Loan EMI Paid",
+ "Loan Credit",
+ "Outward ECS Bounce Charges",
+ "Inward ECS Bounce Charges",
+ "Inward ECS Reversal",
+ "Outward ECS Reversal",
+ "Insufficient Balance Charges",
+ "Minimum Balance Charges"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "SummaryFacility": {
+ "title": "SummaryFacility",
+ "enum": [
+ "OD",
+ "CC",
+ "CURRENT",
+ "SAVING"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "TemplateCreateResponseV3": {
+ "title": "TemplateCreateResponseV3",
+ "required": [
+ "body"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "title": "Status",
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "0.74.0"
+ },
+ "statusDescription": {
+ "title": "Statusdescription",
+ "type": "string"
+ },
+ "body": {
+ "$ref": "#/components/schemas/TemplateV3"
+ }
+ }
},
- "linkedAccRefs": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Linkedaccrefs"
+ "TemplateGetResponseV3": {
+ "title": "TemplateGetResponseV3",
+ "required": [
+ "body"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "title": "Status",
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "0.74.0"
+ },
+ "statusDescription": {
+ "title": "Statusdescription",
+ "type": "string"
+ },
+ "body": {
+ "title": "Body",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TemplateV3"
+ }
+ }
+ }
},
- "additionalInfo": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": "object",
- "title": "Additionalinfo"
- },
- "filters": {
- "allOf": [
- {
- "$ref": "#/components/schemas/CreateInsightsFilters"
+ "TemplateV3": {
+ "title": "TemplateV3",
+ "required": [
+ "templateId",
+ "fiuId",
+ "name",
+ "insights"
+ ],
+ "type": "object",
+ "properties": {
+ "templateId": {
+ "title": "Templateid",
+ "type": "string",
+ "format": "uuid"
+ },
+ "fiuId": {
+ "title": "Fiuid",
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "title": "Name",
+ "type": "string"
+ },
+ "insights": {
+ "title": "Insights",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InsightResponseV3"
+ }
+ },
+ "categorisationMode": {
+ "$ref": "#/components/schemas/CategorisationMode"
+ },
+ "keywordMaps": {
+ "title": "Keywordmaps",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/KeywordMap"
+ }
+ },
+ "isLineageRequired": {
+ "title": "Islineagerequired",
+ "type": "boolean",
+ "default": false
+ },
+ "task": {
+ "title": "Task",
+ "type": "string"
+ },
+ "model": {
+ "title": "Model",
+ "type": "string"
+ }
}
- ],
- "title": "Filters for PFM",
- "default": {}
- }
- },
- "type": "object",
- "required": [
- "templateId"
- ],
- "title": "Body_process_insights_v2_insight_post"
- },
- "Body_process_pdf_insights_v1_insight_pdf_post": {
- "properties": {
- "templateId": {
- "type": "string",
- "title": "Template ID for which insights are needed"
- },
- "applicantName": {
- "type": "string",
- "title": "Applicant Name for associated PDF"
- },
- "applicantType": {
- "type": "string",
- "title": "Applicant Type for associated PDF",
- "default": "retail"
- },
- "bankCode": {
- "type": "string",
- "title": "Bank Code for associated PDF",
- "default": ""
- },
- "bankName": {
- "type": "string",
- "title": "Bank Name for associated PDF",
- "default": ""
- },
- "password": {
- "type": "string",
- "title": "Password for associated PDF",
- "default": ""
- },
- "dataFile": {
- "type": "string",
- "format": "binary",
- "title": "PDF Bank Statement",
- "description": "Upload the pdf-file to process"
- }
- },
- "type": "object",
- "required": [
- "templateId",
- "applicantName",
- "dataFile"
- ],
- "title": "Body_process_pdf_insights_v1_insight_pdf_post"
- },
- "Body_retry_report_v1_retry_post": {
- "properties": {
- "reportId": {
- "type": "string",
- "title": "Report ID which needs to be re-processed"
- }
- },
- "type": "object",
- "required": [
- "reportId"
- ],
- "title": "Body_retry_report_v1_retry_post"
- },
- "Body_update_fi_data_v1_fiData_put": {
- "properties": {
- "dataIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "List of data blocks to process"
- },
- "refId": {
- "type": "string",
- "title": "Refid"
- }
- },
- "type": "object",
- "required": [
- "refId"
- ],
- "title": "Body_update_fi_data_v1_fiData_put"
- },
- "CategorisationMode": {
- "type": "string",
- "enum": [
- "STRICT",
- "STRICT_W_SALARY",
- "KW_INCLUSIVE",
- "INCLUSIVE"
- ],
- "title": "CategorisationMode",
- "description": "An enumeration."
- },
- "Category": {
- "type": "string",
- "enum": [
- "Cash Deposit",
- "Cash Withdrawal",
- "Bounced Cheque",
- "Salary",
- "Salary Paid",
- "Bank Charges",
- "Credit Card",
- "Dividend",
- "Education",
- "Entertainment",
- "Food & Drinks",
- "Health",
- "Investments",
- "Jewellery",
- "Loan",
- "Pension",
- "Reimbursement",
- "Shopping",
- "Sports",
- "Subsidy",
- "Tax",
- "Travel and Transport",
- "Utility Payments",
- "Others",
- "Gifts, Celebrations",
- "Charity",
- "Business Expense",
- "Interest",
- "Transfer",
- "Transfer to Individual",
- "Cash Withdrawals",
- "Rent",
- "Vehicle",
- "Groceries",
- "Transportation",
- "Insurance",
- "Refunds",
- "Professional Services",
- "Counseling",
- "Donations",
- "Fines",
- "Bounced I/W Cheque",
- "Bounced O/W Cheque",
- "Bonus",
- "Business Income",
- "Bill",
- "Gaming",
- "Other Bank Charge",
- "Fund Transfer",
- "Account Verification",
- "Self Transfer"
- ],
- "title": "Category",
- "description": "An enumeration."
- },
- "CompoundMasterRequest": {
- "properties": {
- "fiu_id": {
- "type": "string",
- "format": "uuid",
- "title": "Fiu Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "formula": {
- "type": "string",
- "title": "Formula"
- },
- "ref_key": {
- "type": "string",
- "title": "Ref Key"
- },
- "description": {
- "type": "string",
- "title": "Description"
- },
- "req_insights": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Req Insights"
- },
- "insight": {
- "type": "string",
- "title": "Insight"
- }
- },
- "type": "object",
- "required": [
- "formula",
- "ref_key",
- "req_insights",
- "insight"
- ],
- "title": "CompoundMasterRequest"
- },
- "CreateInsightsFilters": {
- "properties": {
- "dateRange": {
- "$ref": "#/components/schemas/DateRangeFilter"
- },
- "accounts": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Accounts"
- }
- },
- "type": "object",
- "title": "CreateInsightsFilters"
- },
- "DateRangeFilter": {
- "properties": {
- "startDate": {
- "type": "string",
- "format": "date",
- "title": "Startdate"
},
- "endDate": {
- "type": "string",
- "format": "date",
- "title": "Enddate"
- }
- },
- "type": "object",
- "required": [
- "startDate",
- "endDate"
- ],
- "title": "DateRangeFilter"
- },
- "DepositData": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Account"
- }
- },
- "type": "object",
- "required": [
- "account"
- ],
- "title": "DepositData"
- },
- "ETFData": {
- "properties": {
- "account": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Account"
- },
- {
- "$ref": "#/components/schemas/AccountTS"
+ "TransactionMode": {
+ "title": "TransactionMode",
+ "enum": [
+ "CASH",
+ "ATM",
+ "CARD",
+ "UPI",
+ "FT",
+ "OTHERS",
+ "NEFT",
+ "IMPS",
+ "ONLINE",
+ "CHEQUE",
+ "BRANCH",
+ "INB",
+ "CARD_PAYMENT"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "TransactionSymbol": {
+ "title": "TransactionSymbol",
+ "enum": [
+ "BSE",
+ "NSE",
+ "OTHERS"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "TransactionTS": {
+ "title": "TransactionTS",
+ "required": [
+ "txnId",
+ "companyName",
+ "txnDateTime",
+ "isin",
+ "equityCategory",
+ "type",
+ "units"
+ ],
+ "type": "object",
+ "properties": {
+ "txnId": {
+ "title": "Txnid",
+ "type": "string"
+ },
+ "orderId": {
+ "title": "Orderid",
+ "type": "string"
+ },
+ "companyName": {
+ "title": "Companyname",
+ "type": "string"
+ },
+ "txnDateTime": {
+ "title": "Txndatetime",
+ "type": "string",
+ "format": "date-time"
+ },
+ "exchange": {
+ "$ref": "#/components/schemas/TransactionSymbol"
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string"
+ },
+ "equityCategory": {
+ "$ref": "#/components/schemas/EquityCategory"
+ },
+ "narration": {
+ "title": "Narration",
+ "type": "string"
+ },
+ "exchangeRate": {
+ "title": "Exchangerate",
+ "type": "string"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__TransactionType"
+ },
+ "units": {
+ "title": "Units",
+ "type": "integer"
+ }
}
- ],
- "title": "Account"
- }
- },
- "type": "object",
- "required": [
- "account"
- ],
- "title": "ETFData"
- },
- "EquitiesData": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Account"
- }
- },
- "type": "object",
- "required": [
- "account"
- ],
- "title": "EquitiesData"
- },
- "EquityCategory": {
- "type": "string",
- "enum": [
- "EQUITY"
- ],
- "title": "EquityCategory",
- "description": "An enumeration."
- },
- "ErrorResponse": {
- "properties": {
- "errorCode": {
- "type": "string",
- "title": "Errorcode"
- },
- "errorMsg": {
- "type": "string",
- "title": "Errormsg"
- },
- "timestamp": {
- "type": "string",
- "format": "date-time",
- "title": "Timestamp"
- },
- "ver": {
- "type": "string",
- "title": "Ver",
- "default": "1"
- },
- "txnid": {
- "type": "string",
- "title": "Txnid",
- "default": ""
- }
- },
- "type": "object",
- "required": [
- "errorCode",
- "errorMsg"
- ],
- "title": "ErrorResponse"
- },
- "FIData": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/DepositData"
- },
- {
- "$ref": "#/components/schemas/MutualFundsData"
},
- {
- "$ref": "#/components/schemas/EquitiesData"
- },
- {
- "$ref": "#/components/schemas/ETFData"
- }
- ],
- "title": "FIData"
- },
- "FIDataBlockResponse": {
- "properties": {
- "dataId": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "string"
+ "TransactionWithTSDetails": {
+ "title": "TransactionWithTSDetails",
+ "required": [
+ "type",
+ "mode",
+ "amount",
+ "currentBalance",
+ "transactionTimestamp",
+ "txnId"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "mode": {
+ "$ref": "#/components/schemas/TransactionMode"
+ },
+ "amount": {
+ "title": "Amount",
+ "type": "number"
+ },
+ "currentBalance": {
+ "title": "Currentbalance",
+ "type": "string"
+ },
+ "transactionTimestamp": {
+ "title": "Transactiontimestamp",
+ "type": "string",
+ "format": "date-time"
+ },
+ "valueDate": {
+ "title": "Valuedate",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "txnId": {
+ "title": "Txnid",
+ "type": "string"
+ },
+ "narration": {
+ "title": "Narration",
+ "type": "string"
+ },
+ "reference": {
+ "title": "Reference",
+ "type": "string"
+ },
+ "id": {
+ "title": "Id",
+ "type": "string"
+ },
+ "fipId": {
+ "title": "Fipid",
+ "type": "string"
+ },
+ "categoryL1": {
+ "title": "Categoryl1",
+ "type": "string"
+ },
+ "categoryL2": {
+ "title": "Categoryl2",
+ "type": "string"
+ },
+ "linkedAccRef": {
+ "title": "Linkedaccref",
+ "type": "string"
+ },
+ "transactionMode": {
+ "title": "Transactionmode",
+ "type": "string"
+ },
+ "refId": {
+ "title": "Refid",
+ "type": "string"
+ },
+ "categoryManual": {
+ "title": "Categorymanual",
+ "type": "string"
+ },
+ "counterparty": {
+ "title": "Counterparty",
+ "type": "string"
+ }
}
- ],
- "title": "Dataid"
},
- "refId": {
- "type": "string",
- "title": "Refid"
- },
- "fiSchema": {
- "type": "string",
- "title": "Fischema"
- },
- "expiryDate": {
- "type": "string",
- "format": "date-time",
- "title": "Expirydate"
- }
- },
- "type": "object",
- "required": [
- "fiSchema"
- ],
- "title": "FIDataBlockResponse"
- },
- "FIUConfig": {
- "properties": {
- "fiuId": {
- "type": "string",
- "title": "Fiuid"
- },
- "notificationEndpoint": {
- "type": "string",
- "title": "Notificationendpoint"
- },
- "webhookId": {
- "type": "string",
- "title": "Webhookid"
- },
- "expiryDelta": {
- "type": "integer",
- "title": "Expirydelta",
- "default": 30
- },
- "bertSalaryEnabled": {
- "type": "boolean",
- "title": "Bertsalaryenabled",
- "default": true
- },
- "account_ids_path": {
- "type": "string",
- "title": "Account Ids Path"
- },
- "webhookAuthMechanism": {
- "type": "string",
- "title": "Webhookauthmechanism",
- "default": "None"
- },
- "webhookAuthParams": {
- "type": "object",
- "title": "Webhookauthparams",
- "default": {}
- },
- "isVLLMInferenceEnabled": {
- "type": "boolean",
- "title": "Isvllminferenceenabled",
- "default": false
- },
- "transactionTTLDays": {
- "type": "integer",
- "title": "Transactionttldays"
- }
- },
- "type": "object",
- "required": [
- "fiuId",
- "notificationEndpoint",
- "account_ids_path"
- ],
- "title": "FIUConfig"
- },
- "HTTPValidationError": {
- "properties": {
- "detail": {
- "items": {
- "$ref": "#/components/schemas/ValidationError"
- },
- "type": "array",
- "title": "Detail"
- }
- },
- "type": "object",
- "title": "HTTPValidationError"
- },
- "HoldersType": {
- "type": "string",
- "enum": [
- "SINGLE",
- "JOINT",
- "PROPRIETOR",
- "OTHERS"
- ],
- "title": "HoldersType",
- "description": "An enumeration."
- },
- "InsightGetResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
- },
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
- },
- "body": {
- "type": "object",
- "title": "Body"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "InsightGetResponse"
- },
- "InsightMap": {
- "properties": {
- "ref_key": {
- "type": "string",
- "title": "Ref Key"
- },
- "title": {
- "type": "string",
- "title": "Title"
- },
- "description": {
- "type": "string",
- "title": "Description"
- },
- "params": {
- "$ref": "#/components/schemas/InsightParam"
- },
- "insight": {
- "type": "string",
- "title": "Insight"
- }
- },
- "type": "object",
- "required": [
- "ref_key",
- "title",
- "params",
- "insight"
- ],
- "title": "InsightMap"
- },
- "InsightMaster": {
- "properties": {
- "insightId": {
- "type": "string",
- "format": "uuid",
- "title": "Insightid"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "title": {
- "type": "string",
- "title": "Title"
- },
- "description": {
- "type": "string",
- "title": "Description"
- }
- },
- "type": "object",
- "required": [
- "insightId",
- "name",
- "title"
- ],
- "title": "InsightMaster"
- },
- "InsightMasterGetResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
- },
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
- },
- "body": {
- "items": {
- "$ref": "#/components/schemas/InsightMaster"
- },
- "type": "array",
- "title": "Body"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "InsightMasterGetResponse"
- },
- "InsightParam": {
- "properties": {
- "refKey": {
- "type": "string",
- "title": "Refkey"
- },
- "lastNMonths": {
- "type": "integer",
- "title": "Lastnmonths"
- },
- "offsetMonths": {
- "type": "integer",
- "title": "Offsetmonths",
- "default": 0
+ "TransferMode": {
+ "title": "TransferMode",
+ "enum": [
+ "ACH",
+ "CASH",
+ "CHEQUE",
+ "CMS",
+ "ECS",
+ "IMPS",
+ "NEFT",
+ "RTGS",
+ "TPT",
+ "UPI",
+ "POS",
+ "OTHERS",
+ "ONLINE"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "ValidationError": {
+ "title": "ValidationError",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "loc": {
+ "title": "Location",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ }
+ },
+ "msg": {
+ "title": "Message",
+ "type": "string"
+ },
+ "type": {
+ "title": "Error Type",
+ "type": "string"
+ }
+ }
},
- "aggregateFunction": {
- "$ref": "#/components/schemas/AggregationFunctions"
+ "VaultSecret": {
+ "title": "VaultSecret",
+ "required": [
+ "data"
+ ],
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/VaultSecretData"
+ }
+ }
},
- "transactionType": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ "VaultSecretData": {
+ "title": "VaultSecretData",
+ "required": [
+ "data"
+ ],
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/FIUConfig"
+ }
+ }
},
- "transactionMode": {
- "$ref": "#/components/schemas/TransactionMode"
+ "amon_amarth__schema__rebit__deposit__Account": {
+ "title": "Account",
+ "required": [
+ "maskedAccNumber"
+ ],
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Transactions"
+ },
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "default": "deposit"
+ },
+ "maskedAccNumber": {
+ "title": "Maskedaccnumber",
+ "type": "string"
+ },
+ "masked_account_number": {
+ "title": "Masked Account Number",
+ "type": "string"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string"
+ },
+ "linkedAccRef": {
+ "title": "Linkedaccref",
+ "type": "string"
+ },
+ "fipId": {
+ "title": "Fipid",
+ "type": "string"
+ }
+ }
},
- "transactionCategory": {
- "$ref": "#/components/schemas/Category"
+ "amon_amarth__schema__rebit__deposit__Holder": {
+ "title": "Holder",
+ "required": [
+ "name",
+ "ckycCompliance"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "title": "Name",
+ "type": "string"
+ },
+ "dob": {
+ "title": "Dob",
+ "type": "string",
+ "format": "date"
+ },
+ "mobile": {
+ "title": "Mobile",
+ "type": "string"
+ },
+ "nominee": {
+ "title": "Nominee",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__HoldingNominee"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "landline": {
+ "title": "Landline",
+ "type": "string"
+ },
+ "address": {
+ "title": "Address",
+ "type": "string"
+ },
+ "email": {
+ "title": "Email",
+ "type": "string"
+ },
+ "pan": {
+ "title": "Pan",
+ "type": "string"
+ },
+ "ckycCompliance": {
+ "title": "Ckyccompliance",
+ "type": "boolean"
+ }
+ }
},
- "startDate": {
- "type": "string",
- "format": "date",
- "title": "Startdate"
+ "amon_amarth__schema__rebit__deposit__Holders": {
+ "title": "Holders",
+ "required": [
+ "holder"
+ ],
+ "type": "object",
+ "properties": {
+ "holder": {
+ "title": "Holder",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Holder"
+ }
+ },
+ "type": {
+ "$ref": "#/components/schemas/HoldersType"
+ }
+ }
},
- "endDate": {
- "type": "string",
- "format": "date",
- "title": "Enddate"
- }
- },
- "type": "object",
- "title": "InsightParam"
- },
- "KeywordMap": {
- "properties": {
- "id": {
- "type": "integer",
- "title": "Id"
+ "amon_amarth__schema__rebit__deposit__HoldingNominee": {
+ "title": "HoldingNominee",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "type": "string",
+ "description": "An enumeration."
},
- "name": {
- "type": "string",
- "title": "Name"
+ "amon_amarth__schema__rebit__deposit__Profile": {
+ "title": "Profile",
+ "type": "object",
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Holders"
+ }
+ }
},
- "map": {
- "additionalProperties": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "type": "object"
- }
- ]
+ "amon_amarth__schema__rebit__deposit__Summary": {
+ "title": "Summary",
+ "required": [
+ "currentBalance"
+ ],
+ "type": "object",
+ "properties": {
+ "pending": {
+ "$ref": "#/components/schemas/Pending"
},
- "type": "array"
- },
- {
- "additionalProperties": {
- "items": {
+ "currentBalance": {
+ "title": "Currentbalance",
"type": "string"
- },
- "type": "array"
},
- "type": "object"
- }
- ]
- },
- "type": "object",
- "title": "Map"
- }
- },
- "type": "object",
- "required": [
- "name",
- "map"
- ],
- "title": "KeywordMap"
- },
- "KeywordMapCreate": {
- "properties": {
- "fiu_id": {
- "type": "string",
- "format": "uuid",
- "title": "Fiu Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "map": {
- "additionalProperties": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "type": "object"
- }
- ]
+ "currency": {
+ "title": "Currency",
+ "type": "string"
},
- "type": "array"
- },
- {
- "additionalProperties": {
- "items": {
+ "exchgeRate": {
+ "title": "Exchgerate",
"type": "string"
- },
- "type": "array"
},
- "type": "object"
- }
- ]
- },
- "type": "object",
- "title": "Map"
- }
- },
- "type": "object",
- "required": [
- "name",
- "map"
- ],
- "title": "KeywordMapCreate"
- },
- "KeywordMapCreateResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
- },
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
- },
- "body": {
- "$ref": "#/components/schemas/KeywordMap"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "KeywordMapCreateResponse"
- },
- "MutualFundsData": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Account"
- }
- },
- "type": "object",
- "required": [
- "account"
- ],
- "title": "MutualFundsData"
- },
- "NotificationSchema": {
- "properties": {
- "type": {
- "type": "string",
- "title": "Type",
- "description": "Type of the notification"
- },
- "timestamp": {
- "type": "string",
- "format": "date-time",
- "title": "Timestamp",
- "description": "Timestamp of sending the notification"
- },
- "reportId": {
- "type": "string",
- "format": "uuid",
- "title": "Reportid",
- "description": "Reference ID of the insights generation report"
- },
- "success": {
- "type": "boolean",
- "title": "Success",
- "description": "Signifies whether the notification is a successful one or not",
- "default": true
- },
- "data": {
- "type": "object",
- "title": "Data",
- "description": "Data for the notification"
- },
- "error": {
- "type": "object",
- "title": "Error",
- "description": "Error for the notification"
- }
- },
- "type": "object",
- "required": [
- "type",
- "reportId"
- ],
- "title": "NotificationSchema"
- },
- "Pending": {
- "properties": {
- "transactionType": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
- },
- "amount": {
- "type": "number",
- "title": "Amount"
- }
- },
- "type": "object",
- "required": [
- "amount"
- ],
- "title": "Pending"
- },
- "ReportJobCreateResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
- },
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
- },
- "body": {
- "$ref": "#/components/schemas/ReportJobResponseBody"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "ReportJobCreateResponse"
- },
- "ReportJobResponseBody": {
- "properties": {
- "reportId": {
- "type": "string",
- "format": "uuid",
- "title": "Reportid"
- },
- "status": {
- "type": "string",
- "title": "Status"
+ "balanceDateTime": {
+ "title": "Balancedatetime",
+ "type": "string",
+ "format": "date-time"
+ },
+ "type": {
+ "$ref": "#/components/schemas/AccountType"
+ },
+ "branch": {
+ "title": "Branch",
+ "type": "string"
+ },
+ "facility": {
+ "$ref": "#/components/schemas/SummaryFacility"
+ },
+ "ifscCode": {
+ "title": "Ifsccode",
+ "type": "string"
+ },
+ "micrCode": {
+ "title": "Micrcode",
+ "type": "string"
+ },
+ "openingDate": {
+ "title": "Openingdate",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "currentODLimit": {
+ "title": "Currentodlimit",
+ "type": "string"
+ },
+ "drawingLimit": {
+ "title": "Drawinglimit",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "#/components/schemas/StatusTypes"
+ }
+ }
},
- "reason": {
- "type": "string",
- "title": "Reason",
- "default": "NA"
- }
- },
- "type": "object",
- "required": [
- "reportId",
- "status"
- ],
- "title": "ReportJobResponseBody"
- },
- "SchemeOption": {
- "type": "string",
- "enum": [
- "REINVEST",
- "PAYOUT",
- "GROWTH_TYPE"
- ],
- "title": "SchemeOption",
- "description": "An enumeration."
- },
- "SchemePlan": {
- "type": "string",
- "enum": [
- "DIRECT",
- "REGULAR"
- ],
- "title": "SchemePlan",
- "description": "An enumeration."
- },
- "SchemeTypes": {
- "type": "string",
- "enum": [
- "EQUITY_SCHEMES",
- "DEBT_SCHEMES",
- "HYBRID_SCHEMES",
- "SOLUTION_ORIENTED_SCHEMES",
- "OTHER_SCHEMES"
- ],
- "title": "SchemeTypes",
- "description": "An enumeration."
- },
- "StatusTypes": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "INACTIVE"
- ],
- "title": "StatusTypes",
- "description": "An enumeration."
- },
- "SuccessResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
+ "amon_amarth__schema__rebit__deposit__Transaction": {
+ "title": "Transaction",
+ "required": [
+ "type",
+ "mode",
+ "amount",
+ "currentBalance",
+ "transactionTimestamp",
+ "txnId"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "mode": {
+ "$ref": "#/components/schemas/TransactionMode"
+ },
+ "amount": {
+ "title": "Amount",
+ "type": "number"
+ },
+ "currentBalance": {
+ "title": "Currentbalance",
+ "type": "string"
+ },
+ "transactionTimestamp": {
+ "title": "Transactiontimestamp",
+ "type": "string",
+ "format": "date-time"
+ },
+ "valueDate": {
+ "title": "Valuedate",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "txnId": {
+ "title": "Txnid",
+ "type": "string"
+ },
+ "narration": {
+ "title": "Narration",
+ "type": "string"
+ },
+ "reference": {
+ "title": "Reference",
+ "type": "string"
+ }
+ }
},
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
- }
- },
- "type": "object",
- "title": "SuccessResponse"
- },
- "SummaryFacility": {
- "type": "string",
- "enum": [
- "OD",
- "CC",
- "CURRENT",
- "SAVING"
- ],
- "title": "SummaryFacility",
- "description": "An enumeration."
- },
- "SupportedBanksGetResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
+ "amon_amarth__schema__rebit__deposit__TransactionType": {
+ "title": "TransactionType",
+ "enum": [
+ "CREDIT",
+ "DEBIT",
+ "REVERSAL"
+ ],
+ "type": "string",
+ "description": "An enumeration."
},
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
+ "amon_amarth__schema__rebit__deposit__Transactions": {
+ "title": "Transactions",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "title": "Transaction",
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TransactionWithTSDetails"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Transaction"
+ }
+ }
+ ]
+ },
+ "startDate": {
+ "title": "Startdate",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "endDate": {
+ "title": "Enddate",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ }
+ }
},
- "body": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Body"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "SupportedBanksGetResponse"
- },
- "TemplateCreateResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
+ "amon_amarth__schema__rebit__equities__Account": {
+ "title": "Account",
+ "required": [
+ "linkedAccRef",
+ "version"
+ ],
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Transactions"
+ },
+ "linkedAccRef": {
+ "title": "Linkedaccref",
+ "type": "string"
+ },
+ "maskedDematId": {
+ "title": "Maskeddematid",
+ "type": "string"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string"
+ },
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "default": "equities"
+ }
+ }
},
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
+ "amon_amarth__schema__rebit__equities__Holder": {
+ "title": "Holder",
+ "required": [
+ "name",
+ "mobile",
+ "dematId"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "title": "Name",
+ "type": "string"
+ },
+ "dob": {
+ "title": "Dob",
+ "type": "string",
+ "format": "date"
+ },
+ "mobile": {
+ "title": "Mobile",
+ "type": "integer"
+ },
+ "nominee": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__HoldingNominee"
+ },
+ "dematId": {
+ "title": "Dematid",
+ "type": "string"
+ },
+ "landline": {
+ "title": "Landline",
+ "type": "string"
+ },
+ "address": {
+ "title": "Address",
+ "type": "string"
+ },
+ "email": {
+ "title": "Email",
+ "type": "string"
+ },
+ "pan": {
+ "title": "Pan",
+ "type": "string"
+ },
+ "kycCompliance": {
+ "title": "Kyccompliance",
+ "type": "boolean"
+ },
+ "brokerName": {
+ "title": "Brokername",
+ "type": "string"
+ }
+ }
},
- "body": {
- "$ref": "#/components/schemas/TemplateResponse"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "TemplateCreateResponse"
- },
- "TemplateGetResponse": {
- "properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "Success"
+ "amon_amarth__schema__rebit__equities__Holders": {
+ "title": "Holders",
+ "required": [
+ "holder"
+ ],
+ "type": "object",
+ "properties": {
+ "holder": {
+ "title": "Holder",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holder"
+ }
+ }
+ }
},
- "statusDescription": {
- "type": "string",
- "title": "Statusdescription"
+ "amon_amarth__schema__rebit__equities__Holding": {
+ "title": "Holding",
+ "required": [
+ "isin",
+ "units"
+ ],
+ "type": "object",
+ "properties": {
+ "issuerName": {
+ "title": "Issuername",
+ "type": "string"
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string"
+ },
+ "units": {
+ "title": "Units",
+ "type": "integer"
+ },
+ "lastTradedPrice": {
+ "title": "Lasttradedprice",
+ "type": "string"
+ }
+ }
},
- "body": {
- "items": {
- "$ref": "#/components/schemas/TemplateResponse"
- },
- "type": "array",
- "title": "Body"
- }
- },
- "type": "object",
- "required": [
- "body"
- ],
- "title": "TemplateGetResponse"
- },
- "TemplateResponse": {
- "properties": {
- "templateId": {
- "type": "string",
- "format": "uuid",
- "title": "Templateid"
+ "amon_amarth__schema__rebit__equities__HoldingMode": {
+ "title": "HoldingMode",
+ "enum": [
+ "DEMAT",
+ "PHYSICAL"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__equities__HoldingNominee": {
+ "title": "HoldingNominee",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__equities__Holdings": {
+ "title": "Holdings",
+ "required": [
+ "holding"
+ ],
+ "type": "object",
+ "properties": {
+ "holding": {
+ "title": "Holding",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holding"
+ }
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__HoldingMode"
+ }
+ }
},
- "name": {
- "type": "string",
- "title": "Name"
+ "amon_amarth__schema__rebit__equities__Investment": {
+ "title": "Investment",
+ "required": [
+ "holdings"
+ ],
+ "type": "object",
+ "properties": {
+ "holdings": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holdings"
+ }
+ }
},
- "insights": {
- "items": {
- "$ref": "#/components/schemas/InsightMaster"
- },
- "type": "array",
- "title": "Insights"
- }
- },
- "type": "object",
- "required": [
- "templateId",
- "name",
- "insights"
- ],
- "title": "TemplateResponse"
- },
- "TransactionMode": {
- "type": "string",
- "enum": [
- "CASH",
- "ATM",
- "CARD",
- "UPI",
- "FT",
- "OTHERS",
- "NEFT",
- "IMPS",
- "ONLINE",
- "CHEQUE",
- "BRANCH",
- "INB",
- "CARD_PAYMENT"
- ],
- "title": "TransactionMode",
- "description": "An enumeration."
- },
- "TransactionSymbol": {
- "type": "string",
- "enum": [
- "BSE",
- "NSE",
- "OTHERS"
- ],
- "title": "TransactionSymbol",
- "description": "An enumeration."
- },
- "TransactionTS": {
- "properties": {
- "txnId": {
- "type": "string",
- "title": "Txnid"
+ "amon_amarth__schema__rebit__equities__Profile": {
+ "title": "Profile",
+ "required": [
+ "holders"
+ ],
+ "type": "object",
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holders"
+ }
+ }
},
- "orderId": {
- "type": "string",
- "title": "Orderid"
+ "amon_amarth__schema__rebit__equities__Summary": {
+ "title": "Summary",
+ "required": [
+ "investment"
+ ],
+ "type": "object",
+ "properties": {
+ "investment": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Investment"
+ },
+ "currentValue": {
+ "title": "Currentvalue",
+ "type": "string"
+ }
+ }
},
- "companyName": {
- "type": "string",
- "title": "Companyname"
+ "amon_amarth__schema__rebit__equities__Transaction": {
+ "title": "Transaction",
+ "required": [
+ "txnId",
+ "companyName",
+ "transactionDateTime",
+ "isin",
+ "equityCategory",
+ "type",
+ "units"
+ ],
+ "type": "object",
+ "properties": {
+ "txnId": {
+ "title": "Txnid",
+ "type": "string"
+ },
+ "orderId": {
+ "title": "Orderid",
+ "type": "string"
+ },
+ "companyName": {
+ "title": "Companyname",
+ "type": "string"
+ },
+ "transactionDateTime": {
+ "title": "Transactiondatetime",
+ "type": "string",
+ "format": "date-time"
+ },
+ "exchange": {
+ "$ref": "#/components/schemas/TransactionSymbol"
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string"
+ },
+ "equityCategory": {
+ "$ref": "#/components/schemas/EquityCategory"
+ },
+ "narration": {
+ "title": "Narration",
+ "type": "string"
+ },
+ "rate": {
+ "title": "Rate",
+ "type": "string"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__TransactionType"
+ },
+ "units": {
+ "title": "Units",
+ "type": "integer"
+ }
+ }
},
- "txnDateTime": {
- "type": "string",
- "format": "date-time",
- "title": "Txndatetime"
+ "amon_amarth__schema__rebit__equities__TransactionType": {
+ "title": "TransactionType",
+ "enum": [
+ "BUY",
+ "SELL",
+ "BONUS",
+ "SPLIT",
+ "DIVIDEND",
+ "RIGHTS",
+ "OTHERS"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__equities__Transactions": {
+ "title": "Transactions",
+ "required": [
+ "startDate",
+ "endDate"
+ ],
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "title": "Transaction",
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Transaction"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TransactionTS"
+ }
+ }
+ ]
+ },
+ "startDate": {
+ "title": "Startdate",
+ "type": "string",
+ "format": "date"
+ },
+ "endDate": {
+ "title": "Enddate",
+ "type": "string",
+ "format": "date"
+ }
+ }
},
- "exchange": {
- "$ref": "#/components/schemas/TransactionSymbol"
+ "amon_amarth__schema__rebit__etf__Account": {
+ "title": "Account",
+ "required": [
+ "linkedAccRef",
+ "version"
+ ],
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transactions"
+ },
+ "linkedAccRef": {
+ "title": "Linkedaccref",
+ "type": "string"
+ },
+ "maskedDematId": {
+ "title": "Maskeddematid",
+ "type": "string"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string"
+ },
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "default": "etf"
+ }
+ }
},
- "isin": {
- "type": "string",
- "title": "Isin"
+ "amon_amarth__schema__rebit__etf__Holder": {
+ "title": "Holder",
+ "required": [
+ "dematId",
+ "name",
+ "pan",
+ "address",
+ "mobile"
+ ],
+ "type": "object",
+ "properties": {
+ "dematId": {
+ "title": "Dematid",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "type": "string"
+ },
+ "pan": {
+ "title": "Pan",
+ "type": "string"
+ },
+ "dob": {
+ "title": "Dob",
+ "type": "string",
+ "format": "date"
+ },
+ "landline": {
+ "title": "Landline",
+ "type": "string"
+ },
+ "address": {
+ "title": "Address",
+ "type": "string"
+ },
+ "nominee": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__HoldingNominee"
+ },
+ "email": {
+ "title": "Email",
+ "type": "string"
+ },
+ "mobile": {
+ "title": "Mobile",
+ "type": "string"
+ },
+ "kycCompliance": {
+ "title": "Kyccompliance",
+ "type": "boolean"
+ },
+ "brokerName": {
+ "title": "Brokername",
+ "type": "string"
+ }
+ }
},
- "isinDescription": {
- "type": "string",
- "title": "Isindescription"
+ "amon_amarth__schema__rebit__etf__Holders": {
+ "title": "Holders",
+ "required": [
+ "holder"
+ ],
+ "type": "object",
+ "properties": {
+ "holder": {
+ "title": "Holder",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holder"
+ }
+ }
+ }
},
- "equityCategory": {
- "$ref": "#/components/schemas/EquityCategory"
+ "amon_amarth__schema__rebit__etf__Holding": {
+ "title": "Holding",
+ "required": [
+ "units",
+ "isin",
+ "isinDescription"
+ ],
+ "type": "object",
+ "properties": {
+ "folioNo": {
+ "title": "Foliono",
+ "type": "string"
+ },
+ "units": {
+ "title": "Units",
+ "type": "integer"
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string"
+ },
+ "nav": {
+ "title": "Nav",
+ "type": "string"
+ },
+ "lastNavDate": {
+ "title": "Lastnavdate",
+ "type": "string",
+ "format": "date"
+ }
+ }
},
- "narration": {
- "type": "string",
- "title": "Narration"
+ "amon_amarth__schema__rebit__etf__HoldingNominee": {
+ "title": "HoldingNominee",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__etf__Holdings": {
+ "title": "Holdings",
+ "required": [
+ "holding"
+ ],
+ "type": "object",
+ "properties": {
+ "holding": {
+ "title": "Holding",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holding"
+ }
+ }
+ }
},
- "exchangeRate": {
- "type": "string",
- "title": "Exchangerate"
+ "amon_amarth__schema__rebit__etf__Investment": {
+ "title": "Investment",
+ "type": "object",
+ "properties": {
+ "holdings": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holdings"
+ }
+ }
},
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__TransactionType"
+ "amon_amarth__schema__rebit__etf__Profile": {
+ "title": "Profile",
+ "required": [
+ "holders"
+ ],
+ "type": "object",
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holders"
+ }
+ }
},
- "units": {
- "type": "integer",
- "title": "Units"
- }
- },
- "type": "object",
- "required": [
- "txnId",
- "companyName",
- "txnDateTime",
- "isin",
- "equityCategory",
- "type",
- "units"
- ],
- "title": "TransactionTS"
- },
- "TransactionWithTSDetails": {
- "properties": {
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ "amon_amarth__schema__rebit__etf__Summary": {
+ "title": "Summary",
+ "required": [
+ "investment",
+ "currentValue"
+ ],
+ "type": "object",
+ "properties": {
+ "investment": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Investment"
+ },
+ "currentValue": {
+ "title": "Currentvalue",
+ "type": "number"
+ }
+ }
},
- "mode": {
- "$ref": "#/components/schemas/TransactionMode"
- },
- "amount": {
- "type": "number",
- "title": "Amount"
- },
- "currentBalance": {
- "type": "string",
- "title": "Currentbalance"
- },
- "transactionTimestamp": {
- "type": "string",
- "format": "date-time",
- "title": "Transactiontimestamp"
+ "amon_amarth__schema__rebit__etf__Transaction": {
+ "title": "Transaction",
+ "required": [
+ "txnId",
+ "isin",
+ "isinDescription",
+ "transactionDateTime",
+ "units",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "txnId": {
+ "title": "Txnid",
+ "type": "string"
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string"
+ },
+ "transactionDateTime": {
+ "title": "Transactiondatetime",
+ "type": "string",
+ "format": "date-time"
+ },
+ "units": {
+ "title": "Units",
+ "type": "number"
+ },
+ "amount": {
+ "title": "Amount",
+ "type": "number"
+ },
+ "nav": {
+ "title": "Nav",
+ "type": "number"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__TransactionType"
+ },
+ "narration": {
+ "title": "Narration",
+ "type": "string"
+ },
+ "brokerCode": {
+ "title": "Brokercode",
+ "type": "string"
+ }
+ }
},
- "valueDate": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "string",
- "format": "date-time"
+ "amon_amarth__schema__rebit__etf__TransactionType": {
+ "title": "TransactionType",
+ "enum": [
+ "BUY",
+ "SELL",
+ "BOUNS",
+ "SPLIT",
+ "OTHERS"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__etf__Transactions": {
+ "title": "Transactions",
+ "required": [
+ "startDate",
+ "endDate"
+ ],
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "title": "Transaction",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transaction"
+ },
+ "default": []
+ },
+ "startDate": {
+ "title": "Startdate",
+ "type": "string",
+ "format": "date"
+ },
+ "endDate": {
+ "title": "Enddate",
+ "type": "string",
+ "format": "date"
+ }
}
- ],
- "title": "Valuedate"
},
- "txnId": {
- "type": "string",
- "title": "Txnid"
+ "amon_amarth__schema__rebit__mutual_funds__Account": {
+ "title": "Account",
+ "required": [
+ "linkedAccRef"
+ ],
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Transactions"
+ },
+ "linkedAccRef": {
+ "title": "Linkedaccref",
+ "type": "string"
+ },
+ "version": {
+ "title": "Version",
+ "type": "string",
+ "default": "1.0.0"
+ },
+ "type": {
+ "title": "Type",
+ "type": "string",
+ "default": "mutualfunds"
+ },
+ "maskedDematID": {
+ "title": "Maskeddematid",
+ "type": "string",
+ "description": "Demat ID assigned or issued to investor"
+ },
+ "maskedFolioNo": {
+ "title": "Maskedfoliono",
+ "type": "string",
+ "description": "Folio Number of Investor"
+ }
+ }
},
- "narration": {
- "type": "string",
- "title": "Narration"
+ "amon_amarth__schema__rebit__mutual_funds__Holder": {
+ "title": "Holder",
+ "required": [
+ "name",
+ "address",
+ "pan"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "title": "Name",
+ "type": "string",
+ "description": "Name of primary holder operating the account"
+ },
+ "dob": {
+ "title": "Dob",
+ "type": "string",
+ "description": "Date of birth of primary account holder",
+ "format": "date"
+ },
+ "mobile": {
+ "title": "Mobile",
+ "type": "string",
+ "description": "Primary mobile number of account holder"
+ },
+ "nominee": {
+ "title": "Nominee",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__HoldingNominee"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "description": "This field will indicate whether a nominee is registered"
+ },
+ "dematId": {
+ "title": "Dematid",
+ "type": "string",
+ "description": "Demat ID assigned or issued to investor"
+ },
+ "folioNo": {
+ "title": "Foliono",
+ "type": "string",
+ "description": "Folio Number of Investor"
+ },
+ "landline": {
+ "title": "Landline",
+ "type": "string",
+ "description": "Landline number of primary account holder"
+ },
+ "address": {
+ "title": "Address",
+ "type": "string",
+ "description": "Address of primary account holder"
+ },
+ "email": {
+ "title": "Email",
+ "type": "string",
+ "description": "Email ID of primary account holder"
+ },
+ "pan": {
+ "title": "Pan",
+ "type": "string",
+ "description": "PAN number of primary account holder"
+ },
+ "kycCompliance": {
+ "title": "Kyccompliance",
+ "type": "string",
+ "description": "KYC status whether its completed or pending"
+ }
+ }
},
- "reference": {
- "type": "string",
- "title": "Reference"
+ "amon_amarth__schema__rebit__mutual_funds__Holders": {
+ "title": "Holders",
+ "required": [
+ "holder"
+ ],
+ "type": "object",
+ "properties": {
+ "holder": {
+ "title": "Holder",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holder"
+ }
+ }
+ }
},
- "id": {
- "type": "string",
- "title": "Id"
+ "amon_amarth__schema__rebit__mutual_funds__Holding": {
+ "title": "Holding",
+ "required": [
+ "amc",
+ "registrar",
+ "closingUnits",
+ "lienUnits",
+ "nav",
+ "navDate",
+ "lockinUnits"
+ ],
+ "type": "object",
+ "properties": {
+ "amc": {
+ "title": "Amc",
+ "type": "string",
+ "description": "Name of asset management company associated with investment"
+ },
+ "registrar": {
+ "title": "Registrar",
+ "type": "string",
+ "description": "Trust or institution registering and maintaining the detailed records"
+ },
+ "schemeCode": {
+ "title": "Schemecode",
+ "type": "string",
+ "description": "Code of scheme chosen by person for the investment"
+ },
+ "schemeOption": {
+ "title": "Schemeoption",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SchemeOption"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "schemeTypes": {
+ "title": "Schemetypes",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SchemeTypes"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "schemeCategory": {
+ "title": "Schemecategory",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SchemeCategory"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string",
+ "description": "International Securities Identification Number"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string",
+ "description": "Long Name of ISIN"
+ },
+ "ucc": {
+ "title": "Ucc",
+ "type": "string",
+ "description": "Unique Client Code generated by Stock Exchanges"
+ },
+ "amfiCode": {
+ "title": "Amficode",
+ "type": "string",
+ "description": "AMFI code associated with investment"
+ },
+ "folioNo": {
+ "title": "Foliono",
+ "type": "string",
+ "description": "Unique folio number associated with investment"
+ },
+ "FatcaStatus": {
+ "title": "Fatcastatus",
+ "type": "string",
+ "description": "FATCA compliance status"
+ },
+ "closingUnits": {
+ "title": "Closingunits",
+ "type": "string",
+ "description": "Units allotted in folio till date"
+ },
+ "lienUnits": {
+ "title": "Lienunits",
+ "type": "string",
+ "description": "The number of units which have been marked as Lien"
+ },
+ "nav": {
+ "title": "Nav",
+ "type": "number",
+ "description": "NAV is current market rate of security held as on date"
+ },
+ "navDate": {
+ "title": "Navdate",
+ "type": "string",
+ "description": "Last Available NAV date for the scheme of investment",
+ "format": "date"
+ },
+ "lockinUnits": {
+ "title": "Lockinunits",
+ "type": "string",
+ "description": "Units which are locked and not available for sale"
+ }
+ }
},
- "fipId": {
- "type": "string",
- "title": "Fipid"
+ "amon_amarth__schema__rebit__mutual_funds__HoldingMode": {
+ "title": "HoldingMode",
+ "enum": [
+ "DEMAT",
+ "PHYSICAL"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__mutual_funds__HoldingNominee": {
+ "title": "HoldingNominee",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Holdings": {
+ "title": "Holdings",
+ "type": "object",
+ "properties": {
+ "holding": {
+ "title": "Holding",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holding"
+ }
+ }
+ }
},
- "categoryL1": {
- "type": "string",
- "title": "Categoryl1"
+ "amon_amarth__schema__rebit__mutual_funds__Investment": {
+ "title": "Investment",
+ "required": [
+ "holdings"
+ ],
+ "type": "object",
+ "properties": {
+ "holdings": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holdings"
+ }
+ }
},
- "categoryL2": {
- "type": "string",
- "title": "Categoryl2"
+ "amon_amarth__schema__rebit__mutual_funds__Profile": {
+ "title": "Profile",
+ "required": [
+ "holders"
+ ],
+ "type": "object",
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holders"
+ }
+ }
},
- "linkedAccRef": {
- "type": "string",
- "title": "Linkedaccref"
+ "amon_amarth__schema__rebit__mutual_funds__Summary": {
+ "title": "Summary",
+ "required": [
+ "investment"
+ ],
+ "type": "object",
+ "properties": {
+ "investment": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Investment"
+ },
+ "costValue": {
+ "title": "Costvalue",
+ "type": "string",
+ "description": "Principal or Actual amount of investment"
+ },
+ "currentValue": {
+ "title": "Currentvalue",
+ "type": "string",
+ "description": "Current value of investment as on date"
+ }
+ }
},
- "transactionMode": {
- "type": "string",
- "title": "Transactionmode"
+ "amon_amarth__schema__rebit__mutual_funds__Transaction": {
+ "title": "Transaction",
+ "required": [
+ "txnId",
+ "amc",
+ "registrar",
+ "nav",
+ "navDate",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "txnId": {
+ "title": "Txnid",
+ "type": "string",
+ "description": "Transaction ID recorded or captured for investment made"
+ },
+ "amc": {
+ "title": "Amc",
+ "type": "string",
+ "description": "Asset Management company which is operating the fund"
+ },
+ "registrar": {
+ "title": "Registrar",
+ "type": "string"
+ },
+ "schemeCode": {
+ "title": "Schemecode",
+ "type": "string"
+ },
+ "schemePlan": {
+ "title": "Schemeplan",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SchemePlan"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "isin": {
+ "title": "Isin",
+ "type": "string"
+ },
+ "amfiCode": {
+ "title": "Amficode",
+ "type": "string"
+ },
+ "ucc": {
+ "title": "Ucc",
+ "type": "string"
+ },
+ "amount": {
+ "title": "Amount",
+ "type": "string"
+ },
+ "nav": {
+ "title": "Nav",
+ "type": "number"
+ },
+ "navDate": {
+ "title": "Navdate",
+ "type": "string",
+ "format": "date"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__TransactionType"
+ },
+ "lockInFlag": {
+ "title": "Lockinflag",
+ "type": "string"
+ },
+ "lockInDays": {
+ "title": "Lockindays",
+ "type": "string"
+ },
+ "mode": {
+ "title": "Mode",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__HoldingMode"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "narration": {
+ "title": "Narration",
+ "type": "string"
+ },
+ "isinDescription": {
+ "title": "Isindescription",
+ "type": "string"
+ },
+ "units": {
+ "title": "Units",
+ "type": "string"
+ },
+ "transactionDate": {
+ "title": "Transactiondate",
+ "type": "string"
+ }
+ }
},
- "refId": {
- "type": "string",
- "title": "Refid"
+ "amon_amarth__schema__rebit__mutual_funds__TransactionType": {
+ "title": "TransactionType",
+ "enum": [
+ "BUY",
+ "SELL",
+ "OTHERS"
+ ],
+ "type": "string",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Transactions": {
+ "title": "Transactions",
+ "required": [
+ "startDate",
+ "endDate"
+ ],
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "title": "Transaction",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Transaction"
+ },
+ "default": []
+ },
+ "startDate": {
+ "title": "Startdate",
+ "type": "string",
+ "description": "The date from which the Financial Information was requested",
+ "format": "date"
+ },
+ "endDate": {
+ "title": "Enddate",
+ "type": "string",
+ "description": "The date till which the Financial Information was requested",
+ "format": "date"
+ }
+ }
},
- "categoryManual": {
- "type": "string",
- "title": "Categorymanual"
- }
- },
- "type": "object",
- "required": [
- "type",
- "mode",
- "amount",
- "currentBalance",
- "transactionTimestamp",
- "txnId"
- ],
- "title": "TransactionWithTSDetails"
- },
- "ValidationError": {
- "properties": {
- "loc": {
- "items": {
- "anyOf": [
- {
- "type": "string"
+ "PurgeSuccessResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "type": "string"
+ },
+ "statusDescription": {
+ "type": "string",
+ "nullable": true
},
- {
- "type": "integer"
+ "body": {
+ "$ref": "#/components/schemas/PurgeResultBody"
}
- ]
- },
- "type": "array",
- "title": "Location"
- },
- "msg": {
- "type": "string",
- "title": "Message"
- },
- "type": {
- "type": "string",
- "title": "Error Type"
- }
- },
- "type": "object",
- "required": [
- "loc",
- "msg",
- "type"
- ],
- "title": "ValidationError"
- },
- "VaultSecret": {
- "properties": {
- "data": {
- "$ref": "#/components/schemas/VaultSecretData"
- }
- },
- "type": "object",
- "required": [
- "data"
- ],
- "title": "VaultSecret"
- },
- "VaultSecretData": {
- "properties": {
- "data": {
- "$ref": "#/components/schemas/FIUConfig"
- }
- },
- "type": "object",
- "required": [
- "data"
- ],
- "title": "VaultSecretData"
- },
- "amon_amarth__schema__rebit__deposit__Account": {
- "properties": {
- "profile": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Profile"
- },
- "summary": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Summary"
- },
- "transactions": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Transactions"
- },
- "type": {
- "type": "string",
- "title": "Type",
- "default": "deposit"
- },
- "maskedAccNumber": {
- "type": "string",
- "title": "Maskedaccnumber"
- },
- "masked_account_number": {
- "type": "string",
- "title": "Masked Account Number"
- },
- "version": {
- "type": "string",
- "title": "Version"
- },
- "linkedAccRef": {
- "type": "string",
- "title": "Linkedaccref"
- },
- "fipId": {
- "type": "string",
- "title": "Fipid"
- }
- },
- "type": "object",
- "required": [
- "maskedAccNumber"
- ],
- "title": "Account"
- },
- "amon_amarth__schema__rebit__deposit__Holder": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "dob": {
- "type": "string",
- "format": "date",
- "title": "Dob"
- },
- "mobile": {
- "type": "string",
- "title": "Mobile"
- },
- "nominee": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__HoldingNominee"
- },
- {
- "type": "string"
- }
- ],
- "title": "Nominee"
- },
- "landline": {
- "type": "string",
- "title": "Landline"
- },
- "address": {
- "type": "string",
- "title": "Address"
- },
- "email": {
- "type": "string",
- "title": "Email"
- },
- "pan": {
- "type": "string",
- "title": "Pan"
- },
- "ckycCompliance": {
- "type": "boolean",
- "title": "Ckyccompliance"
- }
- },
- "type": "object",
- "required": [
- "name",
- "ckycCompliance"
- ],
- "title": "Holder"
- },
- "amon_amarth__schema__rebit__deposit__Holders": {
- "properties": {
- "holder": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Holder"
},
- "type": "array",
- "title": "Holder"
- },
- "type": {
- "$ref": "#/components/schemas/HoldersType"
- }
- },
- "type": "object",
- "required": [
- "holder"
- ],
- "title": "Holders"
- },
- "amon_amarth__schema__rebit__deposit__HoldingNominee": {
- "type": "string",
- "enum": [
- "REGISTERED",
- "NOT-REGISTERED"
- ],
- "title": "HoldingNominee",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__deposit__Profile": {
- "properties": {
- "holders": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Holders"
- }
- },
- "type": "object",
- "title": "Profile"
- },
- "amon_amarth__schema__rebit__deposit__Summary": {
- "properties": {
- "pending": {
- "$ref": "#/components/schemas/Pending"
- },
- "currentBalance": {
- "type": "string",
- "title": "Currentbalance"
- },
- "currency": {
- "type": "string",
- "title": "Currency"
- },
- "exchgeRate": {
- "type": "string",
- "title": "Exchgerate"
- },
- "balanceDateTime": {
- "type": "string",
- "format": "date-time",
- "title": "Balancedatetime"
- },
- "type": {
- "$ref": "#/components/schemas/AccountType"
- },
- "branch": {
- "type": "string",
- "title": "Branch"
- },
- "facility": {
- "$ref": "#/components/schemas/SummaryFacility"
- },
- "ifscCode": {
- "type": "string",
- "title": "Ifsccode"
- },
- "micrCode": {
- "type": "string",
- "title": "Micrcode"
- },
- "openingDate": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "string",
- "format": "date-time"
- }
- ],
- "title": "Openingdate"
- },
- "currentODLimit": {
- "type": "string",
- "title": "Currentodlimit"
- },
- "drawingLimit": {
- "type": "string",
- "title": "Drawinglimit"
- },
- "status": {
- "$ref": "#/components/schemas/StatusTypes"
- }
- },
- "type": "object",
- "required": [
- "currentBalance"
- ],
- "title": "Summary"
- },
- "amon_amarth__schema__rebit__deposit__Transaction": {
- "properties": {
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
- },
- "mode": {
- "$ref": "#/components/schemas/TransactionMode"
- },
- "amount": {
- "type": "number",
- "title": "Amount"
- },
- "currentBalance": {
- "type": "string",
- "title": "Currentbalance"
- },
- "transactionTimestamp": {
- "type": "string",
- "format": "date-time",
- "title": "Transactiontimestamp"
- },
- "valueDate": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "string",
- "format": "date-time"
- }
+ "required": [
+ "status",
+ "body"
],
- "title": "Valuedate"
- },
- "txnId": {
- "type": "string",
- "title": "Txnid"
- },
- "narration": {
- "type": "string",
- "title": "Narration"
+ "title": "PurgeSuccessResponse"
},
- "reference": {
- "type": "string",
- "title": "Reference"
- }
- },
- "type": "object",
- "required": [
- "type",
- "mode",
- "amount",
- "currentBalance",
- "transactionTimestamp",
- "txnId"
- ],
- "title": "Transaction"
- },
- "amon_amarth__schema__rebit__deposit__TransactionType": {
- "type": "string",
- "enum": [
- "CREDIT",
- "DEBIT",
- "REVERSAL"
- ],
- "title": "TransactionType",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__deposit__Transactions": {
- "properties": {
- "transaction": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/TransactionWithTSDetails"
+ "PurgeResultBody": {
+ "type": "object",
+ "properties": {
+ "insight_reports": {
+ "type": "integer",
+ "minimum": 0
},
- "type": "array"
- },
- {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Transaction"
+ "depositTransactions": {
+ "type": "integer",
+ "minimum": 0
},
- "type": "array"
- }
+ "equitiesTransactions": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "etfTransactions": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "mutualFundsTransactions": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "insight_reports",
+ "depositTransactions",
+ "equitiesTransactions",
+ "etfTransactions",
+ "mutualFundsTransactions"
],
- "title": "Transaction"
+ "title": "PurgeResultBody"
},
- "startDate": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
+ "requests.ListDepositTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListDepositTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListDepositTransactionsWhere" }
+ }
+ }
},
- {
- "type": "string",
- "format": "date-time"
- }
- ],
- "title": "Startdate"
- },
- "endDate": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
+ "requests.ListDepositTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
},
- {
- "type": "string",
- "format": "date-time"
- }
- ],
- "title": "Enddate"
- }
- },
- "type": "object",
- "title": "Transactions"
- },
- "amon_amarth__schema__rebit__equities__Account": {
- "properties": {
- "profile": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Profile"
- },
- "summary": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Summary"
- },
- "transactions": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Transactions"
- },
- "linkedAccRef": {
- "type": "string",
- "title": "Linkedaccref"
- },
- "maskedDematId": {
- "type": "string",
- "title": "Maskeddematid"
- },
- "version": {
- "type": "string",
- "title": "Version"
- },
- "type": {
- "type": "string",
- "title": "Type",
- "default": "equities"
- }
- },
- "type": "object",
- "required": [
- "linkedAccRef",
- "version"
- ],
- "title": "Account"
- },
- "amon_amarth__schema__rebit__equities__Holder": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "dob": {
- "type": "string",
- "format": "date",
- "title": "Dob"
- },
- "mobile": {
- "type": "integer",
- "title": "Mobile"
- },
- "nominee": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__HoldingNominee"
- },
- "dematId": {
- "type": "string",
- "title": "Dematid"
- },
- "landline": {
- "type": "string",
- "title": "Landline"
- },
- "address": {
- "type": "string",
- "title": "Address"
- },
- "email": {
- "type": "string",
- "title": "Email"
- },
- "pan": {
- "type": "string",
- "title": "Pan"
- },
- "kycCompliance": {
- "type": "boolean",
- "title": "Kyccompliance"
- },
- "brokerName": {
- "type": "string",
- "title": "Brokername"
- }
- },
- "type": "object",
- "required": [
- "name",
- "mobile",
- "dematId"
- ],
- "title": "Holder"
- },
- "amon_amarth__schema__rebit__equities__Holders": {
- "properties": {
- "holder": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holder"
- },
- "type": "array",
- "title": "Holder"
- }
- },
- "type": "object",
- "required": [
- "holder"
- ],
- "title": "Holders"
- },
- "amon_amarth__schema__rebit__equities__Holding": {
- "properties": {
- "issuerName": {
- "type": "string",
- "title": "Issuername"
- },
- "isin": {
- "type": "string",
- "title": "Isin"
- },
- "isinDescription": {
- "type": "string",
- "title": "Isindescription"
- },
- "units": {
- "type": "integer",
- "title": "Units"
- },
- "lastTradedPrice": {
- "type": "string",
- "title": "Lasttradedprice"
- }
- },
- "type": "object",
- "required": [
- "isin",
- "units"
- ],
- "title": "Holding"
- },
- "amon_amarth__schema__rebit__equities__HoldingMode": {
- "type": "string",
- "enum": [
- "DEMAT",
- "PHYSICAL"
- ],
- "title": "HoldingMode",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__equities__HoldingNominee": {
- "type": "string",
- "enum": [
- "REGISTERED",
- "NOT-REGISTERED"
- ],
- "title": "HoldingNominee",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__equities__Holdings": {
- "properties": {
- "holding": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holding"
- },
- "type": "array",
- "title": "Holding"
- },
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__HoldingMode"
- }
- },
- "type": "object",
- "required": [
- "holding"
- ],
- "title": "Holdings"
- },
- "amon_amarth__schema__rebit__equities__Investment": {
- "properties": {
- "holdings": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holdings"
- }
- },
- "type": "object",
- "required": [
- "holdings"
- ],
- "title": "Investment"
- },
- "amon_amarth__schema__rebit__equities__Profile": {
- "properties": {
- "holders": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holders"
- }
- },
- "type": "object",
- "required": [
- "holders"
- ],
- "title": "Profile"
- },
- "amon_amarth__schema__rebit__equities__Summary": {
- "properties": {
- "investment": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Investment"
- },
- "currentValue": {
- "type": "string",
- "title": "Currentvalue"
- }
- },
- "type": "object",
- "required": [
- "investment"
- ],
- "title": "Summary"
- },
- "amon_amarth__schema__rebit__equities__Transaction": {
- "properties": {
- "txnId": {
- "type": "string",
- "title": "Txnid"
- },
- "orderId": {
- "type": "string",
- "title": "Orderid"
- },
- "companyName": {
- "type": "string",
- "title": "Companyname"
- },
- "transactionDateTime": {
- "type": "string",
- "format": "date-time",
- "title": "Transactiondatetime"
- },
- "exchange": {
- "$ref": "#/components/schemas/TransactionSymbol"
- },
- "isin": {
- "type": "string",
- "title": "Isin"
- },
- "isinDescription": {
- "type": "string",
- "title": "Isindescription"
- },
- "equityCategory": {
- "$ref": "#/components/schemas/EquityCategory"
- },
- "narration": {
- "type": "string",
- "title": "Narration"
- },
- "rate": {
- "type": "string",
- "title": "Rate"
- },
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__TransactionType"
- },
- "units": {
- "type": "integer",
- "title": "Units"
- }
- },
- "type": "object",
- "required": [
- "txnId",
- "companyName",
- "transactionDateTime",
- "isin",
- "equityCategory",
- "type",
- "units"
- ],
- "title": "Transaction"
- },
- "amon_amarth__schema__rebit__equities__TransactionType": {
- "type": "string",
- "enum": [
- "BUY",
- "SELL",
- "BONUS",
- "SPLIT",
- "DIVIDEND",
- "RIGHTS",
- "OTHERS"
- ],
- "title": "TransactionType",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__equities__Transactions": {
- "properties": {
- "transaction": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Transaction"
- },
- "type": "array"
+ "requests.ListDepositTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "amount_gte": { "type": "number" },
+ "amount_lte": { "type": "number" },
+ "categoryL1": { "type": "string" },
+ "categoryL1_list": { "type": "array", "items": { "type": "string" } },
+ "categoryL2": { "type": "string" },
+ "categoryL2_list": { "type": "array", "items": { "type": "string" } },
+ "categoryManual": { "type": "string" },
+ "categoryManual_list": { "type": "array", "items": { "type": "string" } },
+ "currentBalance": { "type": "number" },
+ "narration": { "type": "string" },
+ "reference": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnTimestamp": { "type": "string" },
+ "txnTimestamp_gte": { "type": "string" },
+ "txnTimestamp_lte": { "type": "string" },
+ "txnType": { "type": "string" },
+ "txnValueDate": { "type": "string" }
+ }
},
- {
- "items": {
- "$ref": "#/components/schemas/TransactionTS"
- },
- "type": "array"
- }
- ],
- "title": "Transaction"
- },
- "startDate": {
- "type": "string",
- "format": "date",
- "title": "Startdate"
- },
- "endDate": {
- "type": "string",
- "format": "date",
- "title": "Enddate"
- }
- },
- "type": "object",
- "required": [
- "startDate",
- "endDate"
- ],
- "title": "Transactions"
- },
- "amon_amarth__schema__rebit__etf__Account": {
- "properties": {
- "profile": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Profile"
- },
- "summary": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Summary"
- },
- "transactions": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transactions"
- },
- "linkedAccRef": {
- "type": "string",
- "title": "Linkedaccref"
- },
- "maskedDematId": {
- "type": "string",
- "title": "Maskeddematid"
- },
- "version": {
- "type": "string",
- "title": "Version"
- },
- "type": {
- "type": "string",
- "title": "Type",
- "default": "etf"
- }
- },
- "type": "object",
- "required": [
- "linkedAccRef",
- "maskedDematId",
- "version"
- ],
- "title": "Account"
- },
- "amon_amarth__schema__rebit__etf__Holder": {
- "properties": {
- "dematId": {
- "type": "string",
- "title": "Dematid"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "pan": {
- "type": "string",
- "title": "Pan"
- },
- "dob": {
- "type": "string",
- "format": "date",
- "title": "Dob"
- },
- "landline": {
- "type": "string",
- "title": "Landline"
- },
- "address": {
- "type": "string",
- "title": "Address"
- },
- "nominee": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__HoldingNominee"
- },
- "email": {
- "type": "string",
- "title": "Email"
- },
- "mobile": {
- "type": "string",
- "title": "Mobile"
- },
- "kycCompliance": {
- "type": "boolean",
- "title": "Kyccompliance"
- },
- "brokerName": {
- "type": "string",
- "title": "Brokername"
- }
- },
- "type": "object",
- "required": [
- "dematId",
- "name",
- "pan",
- "address",
- "mobile"
- ],
- "title": "Holder"
- },
- "amon_amarth__schema__rebit__etf__Holders": {
- "properties": {
- "holder": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holder"
- },
- "type": "array",
- "title": "Holder"
- }
- },
- "type": "object",
- "required": [
- "holder"
- ],
- "title": "Holders"
- },
- "amon_amarth__schema__rebit__etf__Holding": {
- "properties": {
- "folioNo": {
- "type": "string",
- "title": "Foliono"
- },
- "units": {
- "type": "integer",
- "title": "Units"
- },
- "isin": {
- "type": "string",
- "title": "Isin"
- },
- "isinDescription": {
- "type": "string",
- "title": "Isindescription"
- },
- "nav": {
- "type": "string",
- "title": "Nav"
- },
- "lastNavDate": {
- "type": "string",
- "format": "date",
- "title": "Lastnavdate"
- }
- },
- "type": "object",
- "required": [
- "units",
- "isin",
- "isinDescription"
- ],
- "title": "Holding"
- },
- "amon_amarth__schema__rebit__etf__HoldingNominee": {
- "type": "string",
- "enum": [
- "REGISTERED",
- "NOT-REGISTERED"
- ],
- "title": "HoldingNominee",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__etf__Holdings": {
- "properties": {
- "holding": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holding"
- },
- "type": "array",
- "title": "Holding"
- }
- },
- "type": "object",
- "required": [
- "holding"
- ],
- "title": "Holdings"
- },
- "amon_amarth__schema__rebit__etf__Investment": {
- "properties": {
- "holdings": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holdings"
- }
- },
- "type": "object",
- "title": "Investment"
- },
- "amon_amarth__schema__rebit__etf__Profile": {
- "properties": {
- "holders": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holders"
- }
- },
- "type": "object",
- "required": [
- "holders"
- ],
- "title": "Profile"
- },
- "amon_amarth__schema__rebit__etf__Summary": {
- "properties": {
- "investment": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Investment"
- },
- "currentValue": {
- "type": "number",
- "title": "Currentvalue"
- }
- },
- "type": "object",
- "required": [
- "investment",
- "currentValue"
- ],
- "title": "Summary"
- },
- "amon_amarth__schema__rebit__etf__Transaction": {
- "properties": {
- "txnId": {
- "type": "string",
- "title": "Txnid"
- },
- "isin": {
- "type": "string",
- "title": "Isin"
- },
- "isinDescription": {
- "type": "string",
- "title": "Isindescription"
- },
- "transactionDateTime": {
- "type": "string",
- "format": "date-time",
- "title": "Transactiondatetime"
- },
- "units": {
- "type": "number",
- "title": "Units"
- },
- "amount": {
- "type": "number",
- "title": "Amount"
- },
- "nav": {
- "type": "number",
- "title": "Nav"
- },
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__TransactionType"
- },
- "narration": {
- "type": "string",
- "title": "Narration"
- },
- "brokerCode": {
- "type": "string",
- "title": "Brokercode"
- }
- },
- "type": "object",
- "required": [
- "txnId",
- "isin",
- "isinDescription",
- "transactionDateTime",
- "units",
- "type"
- ],
- "title": "Transaction"
- },
- "amon_amarth__schema__rebit__etf__TransactionType": {
- "type": "string",
- "enum": [
- "BUY",
- "SELL",
- "BOUNS",
- "SPLIT",
- "OTHERS"
- ],
- "title": "TransactionType",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__etf__Transactions": {
- "properties": {
- "transaction": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transaction"
- },
- "type": "array",
- "title": "Transaction"
- },
- "startDate": {
- "type": "string",
- "format": "date",
- "title": "Startdate"
- },
- "endDate": {
- "type": "string",
- "format": "date",
- "title": "Enddate"
- }
- },
- "type": "object",
- "required": [
- "transaction",
- "startDate",
- "endDate"
- ],
- "title": "Transactions"
- },
- "amon_amarth__schema__rebit__mutual_funds__Account": {
- "properties": {
- "profile": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Profile"
- },
- "summary": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Summary"
- },
- "transactions": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Transactions"
- },
- "linkedAccRef": {
- "type": "string",
- "title": "Linkedaccref"
- },
- "version": {
- "type": "string",
- "title": "Version",
- "default": "1.0.0"
- },
- "type": {
- "type": "string",
- "title": "Type",
- "default": "mutualfunds"
- },
- "maskedDematID": {
- "type": "string",
- "title": "Maskeddematid",
- "description": "Demat ID assigned or issued to investor"
- },
- "maskedFolioNo": {
- "type": "string",
- "title": "Maskedfoliono",
- "description": "Folio Number of Investor"
- }
- },
- "type": "object",
- "required": [
- "linkedAccRef"
- ],
- "title": "Account"
- },
- "amon_amarth__schema__rebit__mutual_funds__Holder": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name",
- "description": "Name of primary holder operating the account"
- },
- "dob": {
- "type": "string",
- "format": "date",
- "title": "Dob",
- "description": "Date of birth of primary account holder"
- },
- "mobile": {
- "type": "string",
- "title": "Mobile",
- "description": "Primary mobile number of account holder"
- },
- "nominee": {
- "allOf": [
- {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__HoldingNominee"
+ "responses.ListDepositTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListDepositTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListDepositTransactionsData": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "categoryL1": { "type": "string" },
+ "categoryL2": { "type": "string" },
+ "categoryManual": { "type": "string" },
+ "consentId": { "type": "string" },
+ "currentBalance": { "type": "number" },
+ "dataId": { "type": "string" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "narration": { "type": "string" },
+ "refId": { "type": "string" },
+ "reference": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnTimestamp": { "type": "string" },
+ "txnType": { "type": "string" },
+ "txnValueDate": { "type": "string" }
+ }
+ },
+ "requests.ListEquitiesTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListEquitiesTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListEquitiesTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListEquitiesTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListEquitiesTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "companyName": { "type": "string" },
+ "dematId": { "type": "string" },
+ "equityCategory": { "type": "string" },
+ "exchange": { "type": "string" },
+ "exchangeRate": { "type": "number" },
+ "exchangeRate_gte": { "type": "number" },
+ "exchangeRate_lte": { "type": "number" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "narration": { "type": "string" },
+ "orderId": { "type": "string" },
+ "transactionDateTime_gte": { "type": "string" },
+ "transactionDateTime_lte": { "type": "string" },
+ "txnDateTime": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" },
+ "units_gte": { "type": "number" },
+ "units_lte": { "type": "number" }
+ }
+ },
+ "responses.ListEquitiesTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListEquitiesTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListEquitiesTransactionsData": {
+ "type": "object",
+ "properties": {
+ "companyName": { "type": "string" },
+ "consentId": { "type": "string" },
+ "dataId": { "type": "string" },
+ "dematId": { "type": "string" },
+ "equityCategory": { "type": "string" },
+ "exchange": { "type": "string" },
+ "exchangeRate": { "type": "number" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "narration": { "type": "string" },
+ "orderId": { "type": "string" },
+ "refId": { "type": "string" },
+ "txnDateTime": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" }
+ }
+ },
+ "requests.ListETFTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListETFTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListETFTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListETFTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListETFTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "amount_gte": { "type": "number" },
+ "amount_lte": { "type": "number" },
+ "brokerCode": { "type": "string" },
+ "dematId": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "nav_gte": { "type": "number" },
+ "nav_lte": { "type": "number" },
+ "transactionDateTime": { "type": "string" },
+ "transactionDateTime_gte": { "type": "string" },
+ "transactionDateTime_lte": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" },
+ "units_gte": { "type": "number" },
+ "units_lte": { "type": "number" }
+ }
+ },
+ "responses.ListETFTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListETFTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListETFTransactionsData": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "brokerCode": { "type": "string" },
+ "consentId": { "type": "string" },
+ "dataId": { "type": "string" },
+ "dematId": { "type": "string" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "refId": { "type": "string" },
+ "transactionDateTime": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" }
+ }
+ },
+ "requests.ListMutualFundsTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListMutualFundsTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListMutualFundsTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "amc": { "type": "string" },
+ "amcFullName": { "type": "string" },
+ "amfiCode": { "type": "string" },
+ "amount": { "type": "number" },
+ "amount_gte": { "type": "number" },
+ "amount_lte": { "type": "number" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "lockInDays": { "type": "string" },
+ "lockInFlag": { "type": "string" },
+ "mutualFundName": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "navDate": { "type": "string" },
+ "nav_gte": { "type": "number" },
+ "nav_lte": { "type": "number" },
+ "registrar": { "type": "string" },
+ "schemeCode": { "type": "string" },
+ "schemePlan": { "type": "string" },
+ "txnDate": { "type": "string" },
+ "txnDate_gte": { "type": "string" },
+ "txnDate_lte": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnType": { "type": "string" },
+ "ucc": { "type": "string" },
+ "units": { "type": "number" },
+ "units_gte": { "type": "number" },
+ "units_lte": { "type": "number" }
+ }
+ },
+ "responses.ListMutualFundsTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListMutualFundsTransactionsData": {
+ "type": "object",
+ "properties": {
+ "amc": { "type": "string" },
+ "amcFullName": { "type": "string" },
+ "amfiCode": { "type": "string" },
+ "amount": { "type": "number" },
+ "consentId": { "type": "string" },
+ "dataId": { "type": "string" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "lockInDays": { "type": "string" },
+ "lockInFlag": { "type": "string" },
+ "mutualFundName": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "navDate": { "type": "string" },
+ "refId": { "type": "string" },
+ "registrar": { "type": "string" },
+ "schemeCode": { "type": "string" },
+ "schemePlan": { "type": "string" },
+ "txnDate": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnType": { "type": "string" },
+ "ucc": { "type": "string" },
+ "units": { "type": "number" }
+ }
+ },
+ "responses.Error": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
}
- ],
- "description": "This field will indicate whether a nominee is registered"
- },
- "dematId": {
- "type": "string",
- "title": "Dematid",
- "description": "Demat ID assigned or issued to investor"
- },
- "folioNo": {
- "type": "string",
- "title": "Foliono",
- "description": "Folio Number of Investor"
- },
- "landline": {
- "type": "string",
- "title": "Landline",
- "description": "Landline number of primary account holder"
- },
- "address": {
- "type": "string",
- "title": "Address",
- "description": "Address of primary account holder"
- },
- "email": {
- "type": "string",
- "title": "Email",
- "description": "Email ID of primary account holder"
- },
- "pan": {
- "type": "string",
- "title": "Pan",
- "description": "PAN number of primary account holder"
- },
- "kycCompliance": {
- "type": "string",
- "title": "Kyccompliance",
- "description": "KYC status whether its completed or pending"
- }
- },
- "type": "object",
- "required": [
- "name",
- "address",
- "pan"
- ],
- "title": "Holder"
- },
- "amon_amarth__schema__rebit__mutual_funds__Holders": {
- "properties": {
- "holder": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holder"
- },
- "type": "array",
- "title": "Holder"
- }
- },
- "type": "object",
- "required": [
- "holder"
- ],
- "title": "Holders"
- },
- "amon_amarth__schema__rebit__mutual_funds__Holding": {
- "properties": {
- "amc": {
- "type": "string",
- "title": "Amc",
- "description": "Name of asset management company associated with investment"
- },
- "registrar": {
- "type": "string",
- "title": "Registrar",
- "description": "Trust or institution registering and maintaining the detailed records"
- },
- "schemeCode": {
- "type": "string",
- "title": "Schemecode",
- "description": "Code of scheme chosen by person for the investment"
- },
- "schemeOption": {
- "$ref": "#/components/schemas/SchemeOption"
- },
- "schemeTypes": {
- "$ref": "#/components/schemas/SchemeTypes"
- },
- "schemeCategory": {
- "type": "string",
- "title": "Schemecategory"
- },
- "isin": {
- "type": "string",
- "title": "Isin",
- "description": "International Securities Identification Number"
- },
- "isinDescription": {
- "type": "string",
- "title": "Isindescription",
- "description": "Long Name of ISIN"
- },
- "ucc": {
- "type": "string",
- "title": "Ucc",
- "description": "Unique Client Code generated by Stock Exchanges"
- },
- "amfiCode": {
- "type": "string",
- "title": "Amficode",
- "description": "AMFI code associated with investment"
- },
- "folioNo": {
- "type": "string",
- "title": "Foliono",
- "description": "Unique folio number associated with investment"
- },
- "FatcaStatus": {
- "type": "string",
- "title": "Fatcastatus",
- "description": "FATCA compliance status"
- },
- "closingUnits": {
- "type": "string",
- "title": "Closingunits",
- "description": "Units allotted in folio till date"
- },
- "lienUnits": {
- "type": "string",
- "title": "Lienunits",
- "description": "The number of units which have been marked as Lien"
- },
- "nav": {
- "type": "number",
- "title": "Nav",
- "description": "NAV is current market rate of security held as on date"
- },
- "navDate": {
- "type": "string",
- "format": "date",
- "title": "Navdate",
- "description": "Last Available NAV date for the scheme of investment"
- },
- "lockinUnits": {
- "type": "string",
- "title": "Lockinunits",
- "description": "Units which are locked and not available for sale"
- }
- },
- "type": "object",
- "required": [
- "amc",
- "registrar",
- "closingUnits",
- "lienUnits",
- "nav",
- "navDate",
- "lockinUnits"
- ],
- "title": "Holding"
- },
- "amon_amarth__schema__rebit__mutual_funds__HoldingMode": {
- "type": "string",
- "enum": [
- "DEMAT",
- "PHYSICAL"
- ],
- "title": "HoldingMode",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__mutual_funds__HoldingNominee": {
- "type": "string",
- "enum": [
- "REGISTERED",
- "NOT-REGISTERED"
- ],
- "title": "HoldingNominee",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__mutual_funds__Holdings": {
- "properties": {
- "holding": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holding"
- },
- "type": "array",
- "title": "Holding"
- }
- },
- "type": "object",
- "required": [
- "holding"
- ],
- "title": "Holdings"
- },
- "amon_amarth__schema__rebit__mutual_funds__Investment": {
- "properties": {
- "holdings": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holdings"
- }
- },
- "type": "object",
- "required": [
- "holdings"
- ],
- "title": "Investment"
- },
- "amon_amarth__schema__rebit__mutual_funds__Profile": {
- "properties": {
- "holders": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holders"
- }
- },
- "type": "object",
- "required": [
- "holders"
- ],
- "title": "Profile"
- },
- "amon_amarth__schema__rebit__mutual_funds__Summary": {
- "properties": {
- "investment": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Investment"
- },
- "costValue": {
- "type": "string",
- "title": "Costvalue",
- "description": "Principal or Actual amount of investment"
- },
- "currentValue": {
- "type": "string",
- "title": "Currentvalue",
- "description": "Current value of investment as on date"
- }
- },
- "type": "object",
- "required": [
- "investment"
- ],
- "title": "Summary"
- },
- "amon_amarth__schema__rebit__mutual_funds__Transaction": {
- "properties": {
- "txnId": {
- "type": "string",
- "title": "Txnid",
- "description": "Transaction ID recorded or captured for investment made"
- },
- "amc": {
- "type": "string",
- "title": "Amc",
- "description": "Asset Management company which is operating the fund"
- },
- "registrar": {
- "type": "string",
- "title": "Registrar"
- },
- "schemeCode": {
- "type": "string",
- "title": "Schemecode"
- },
- "schemePlan": {
- "$ref": "#/components/schemas/SchemePlan"
- },
- "isin": {
- "type": "string",
- "title": "Isin"
- },
- "amfiCode": {
- "type": "string",
- "title": "Amficode"
- },
- "ucc": {
- "type": "string",
- "title": "Ucc"
- },
- "amount": {
- "type": "string",
- "title": "Amount"
- },
- "nav": {
- "type": "number",
- "title": "Nav"
- },
- "navDate": {
- "type": "string",
- "format": "date",
- "title": "Navdate"
- },
- "type": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__TransactionType"
- },
- "lockInFlag": {
- "type": "string",
- "title": "Lockinflag"
- },
- "lockInDays": {
- "type": "string",
- "title": "Lockindays"
- },
- "mode": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__HoldingMode"
- },
- "narration": {
- "type": "string",
- "title": "Narration"
- },
- "isinDescription": {
- "type": "string",
- "title": "Isindescription"
- },
- "units": {
- "type": "string",
- "title": "Units"
- },
- "transactionDate": {
- "type": "string",
- "title": "Transactiondate"
- }
- },
- "type": "object",
- "required": [
- "txnId",
- "amc",
- "registrar",
- "nav",
- "navDate",
- "type",
- "lockInDays",
- "mode"
- ],
- "title": "Transaction"
- },
- "amon_amarth__schema__rebit__mutual_funds__TransactionType": {
- "type": "string",
- "enum": [
- "BUY",
- "SELL",
- "OTHERS"
- ],
- "title": "TransactionType",
- "description": "An enumeration."
- },
- "amon_amarth__schema__rebit__mutual_funds__Transactions": {
- "properties": {
- "transaction": {
- "items": {
- "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Transaction"
- },
- "type": "array",
- "title": "Transaction"
- },
- "startDate": {
- "type": "string",
- "format": "date",
- "title": "Startdate",
- "description": "The date from which the Financial Information was requested"
- },
- "endDate": {
- "type": "string",
- "format": "date",
- "title": "Enddate",
- "description": "The date till which the Financial Information was requested"
- }
- },
- "type": "object",
- "required": [
- "transaction",
- "startDate",
- "endDate"
- ],
- "title": "Transactions"
- },
- "PurgeSuccessResponse": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "default": "Success"
- },
- "version": {
- "type": "string"
- },
- "statusDescription": {
- "type": "string",
- "nullable": true
- },
- "body": {
- "$ref": "#/components/schemas/PurgeResultBody"
- }
- },
- "required": ["status", "body"],
- "title": "PurgeSuccessResponse"
- },
- "PurgeResultBody": {
- "type": "object",
- "properties": {
- "insight_reports": {
- "type": "integer",
- "minimum": 0
- },
- "depositTransactions": {
- "type": "integer",
- "minimum": 0
- },
- "equitiesTransactions": {
- "type": "integer",
- "minimum": 0
- },
- "etfTransactions": {
- "type": "integer",
- "minimum": 0
- },
- "mutualFundsTransactions": {
- "type": "integer",
- "minimum": 0
- }
- },
- "required": [
- "insight_reports",
- "depositTransactions",
- "equitiesTransactions",
- "etfTransactions",
- "mutualFundsTransactions"
- ],
- "title": "PurgeResultBody"
- },
- "requests.ListDepositTransactionsRequest": {
- "type": "object",
- "properties": {
- "limit": { "type": "integer" },
- "offset": { "type": "integer" },
- "orderBy": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListDepositTransactionsOrderBy" }
- },
- "refIds": {
- "type": "array",
- "items": { "type": "string" }
- },
- "where": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListDepositTransactionsWhere" }
- }
- }
- },
- "requests.ListDepositTransactionsOrderBy": {
- "type": "object",
- "properties": {
- "field": { "type": "string" },
- "order": { "type": "string" }
- }
- },
- "requests.ListDepositTransactionsWhere": {
- "type": "object",
- "properties": {
- "amount": { "type": "number" },
- "amount_gte": { "type": "number" },
- "amount_lte": { "type": "number" },
- "categoryL1": { "type": "string" },
- "categoryL1_list": { "type": "array", "items": { "type": "string" } },
- "categoryL2": { "type": "string" },
- "categoryL2_list": { "type": "array", "items": { "type": "string" } },
- "categoryManual": { "type": "string" },
- "categoryManual_list": { "type": "array", "items": { "type": "string" } },
- "currentBalance": { "type": "number" },
- "narration": { "type": "string" },
- "reference": { "type": "string" },
- "txnId": { "type": "string" },
- "txnMode": { "type": "string" },
- "txnTimestamp": { "type": "string" },
- "txnTimestamp_gte": { "type": "string" },
- "txnTimestamp_lte": { "type": "string" },
- "txnType": { "type": "string" },
- "txnValueDate": { "type": "string" }
- }
- },
- "responses.ListDepositTransactionsResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/responses.ListDepositTransactionsData" }
- },
- "totalCount": { "type": "integer" }
- }
- },
- "responses.ListDepositTransactionsData": {
- "type": "object",
- "properties": {
- "amount": { "type": "number" },
- "categoryL1": { "type": "string" },
- "categoryL2": { "type": "string" },
- "categoryManual": { "type": "string" },
- "consentId": { "type": "string" },
- "currentBalance": { "type": "number" },
- "dataId": { "type": "string" },
- "fipId": { "type": "string" },
- "id": { "type": "string" },
- "linkedAccRef": { "type": "string" },
- "narration": { "type": "string" },
- "refId": { "type": "string" },
- "reference": { "type": "string" },
- "txnId": { "type": "string" },
- "txnMode": { "type": "string" },
- "txnTimestamp": { "type": "string" },
- "txnType": { "type": "string" },
- "txnValueDate": { "type": "string" }
- }
- },
- "requests.ListEquitiesTransactionsRequest": {
- "type": "object",
- "properties": {
- "limit": { "type": "integer" },
- "offset": { "type": "integer" },
- "orderBy": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListEquitiesTransactionsOrderBy" }
- },
- "refIds": {
- "type": "array",
- "items": { "type": "string" }
- },
- "where": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListEquitiesTransactionsWhere" }
- }
- }
- },
- "requests.ListEquitiesTransactionsOrderBy": {
- "type": "object",
- "properties": {
- "field": { "type": "string" },
- "order": { "type": "string" }
- }
- },
- "requests.ListEquitiesTransactionsWhere": {
- "type": "object",
- "properties": {
- "companyName": { "type": "string" },
- "dematId": { "type": "string" },
- "equityCategory": { "type": "string" },
- "exchange": { "type": "string" },
- "exchangeRate": { "type": "number" },
- "exchangeRate_gte": { "type": "number" },
- "exchangeRate_lte": { "type": "number" },
- "isin": { "type": "string" },
- "isinDescription": { "type": "string" },
- "narration": { "type": "string" },
- "orderId": { "type": "string" },
- "transactionDateTime_gte": { "type": "string" },
- "transactionDateTime_lte": { "type": "string" },
- "txnDateTime": { "type": "string" },
- "txnId": { "type": "string" },
- "txnType": { "type": "string" },
- "units": { "type": "number" },
- "units_gte": { "type": "number" },
- "units_lte": { "type": "number" }
- }
- },
- "responses.ListEquitiesTransactionsResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/responses.ListEquitiesTransactionsData" }
- },
- "totalCount": { "type": "integer" }
- }
- },
- "responses.ListEquitiesTransactionsData": {
- "type": "object",
- "properties": {
- "companyName": { "type": "string" },
- "consentId": { "type": "string" },
- "dataId": { "type": "string" },
- "dematId": { "type": "string" },
- "equityCategory": { "type": "string" },
- "exchange": { "type": "string" },
- "exchangeRate": { "type": "number" },
- "fipId": { "type": "string" },
- "id": { "type": "string" },
- "isin": { "type": "string" },
- "isinDescription": { "type": "string" },
- "linkedAccRef": { "type": "string" },
- "narration": { "type": "string" },
- "orderId": { "type": "string" },
- "refId": { "type": "string" },
- "txnDateTime": { "type": "string" },
- "txnId": { "type": "string" },
- "txnType": { "type": "string" },
- "units": { "type": "number" }
- }
- },
- "requests.ListETFTransactionsRequest": {
- "type": "object",
- "properties": {
- "limit": { "type": "integer" },
- "offset": { "type": "integer" },
- "orderBy": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListETFTransactionsOrderBy" }
- },
- "refIds": {
- "type": "array",
- "items": { "type": "string" }
- },
- "where": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListETFTransactionsWhere" }
- }
- }
- },
- "requests.ListETFTransactionsOrderBy": {
- "type": "object",
- "properties": {
- "field": { "type": "string" },
- "order": { "type": "string" }
- }
- },
- "requests.ListETFTransactionsWhere": {
- "type": "object",
- "properties": {
- "amount": { "type": "number" },
- "amount_gte": { "type": "number" },
- "amount_lte": { "type": "number" },
- "brokerCode": { "type": "string" },
- "dematId": { "type": "string" },
- "isin": { "type": "string" },
- "isinDescription": { "type": "string" },
- "narration": { "type": "string" },
- "nav": { "type": "number" },
- "nav_gte": { "type": "number" },
- "nav_lte": { "type": "number" },
- "transactionDateTime": { "type": "string" },
- "transactionDateTime_gte": { "type": "string" },
- "transactionDateTime_lte": { "type": "string" },
- "txnId": { "type": "string" },
- "txnType": { "type": "string" },
- "units": { "type": "number" },
- "units_gte": { "type": "number" },
- "units_lte": { "type": "number" }
- }
- },
- "responses.ListETFTransactionsResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/responses.ListETFTransactionsData" }
- },
- "totalCount": { "type": "integer" }
- }
- },
- "responses.ListETFTransactionsData": {
- "type": "object",
- "properties": {
- "amount": { "type": "number" },
- "brokerCode": { "type": "string" },
- "consentId": { "type": "string" },
- "dataId": { "type": "string" },
- "dematId": { "type": "string" },
- "fipId": { "type": "string" },
- "id": { "type": "string" },
- "isin": { "type": "string" },
- "isinDescription": { "type": "string" },
- "linkedAccRef": { "type": "string" },
- "narration": { "type": "string" },
- "nav": { "type": "number" },
- "refId": { "type": "string" },
- "transactionDateTime": { "type": "string" },
- "txnId": { "type": "string" },
- "txnType": { "type": "string" },
- "units": { "type": "number" }
- }
- },
- "requests.ListMutualFundsTransactionsRequest": {
- "type": "object",
- "properties": {
- "limit": { "type": "integer" },
- "offset": { "type": "integer" },
- "orderBy": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsOrderBy" }
- },
- "refIds": {
- "type": "array",
- "items": { "type": "string" }
- },
- "where": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsWhere" }
- }
- }
- },
- "requests.ListMutualFundsTransactionsOrderBy": {
- "type": "object",
- "properties": {
- "field": { "type": "string" },
- "order": { "type": "string" }
- }
- },
- "requests.ListMutualFundsTransactionsWhere": {
- "type": "object",
- "properties": {
- "amc": { "type": "string" },
- "amcFullName": { "type": "string" },
- "amfiCode": { "type": "string" },
- "amount": { "type": "number" },
- "amount_gte": { "type": "number" },
- "amount_lte": { "type": "number" },
- "isin": { "type": "string" },
- "isinDescription": { "type": "string" },
- "lockInDays": { "type": "string" },
- "lockInFlag": { "type": "string" },
- "mutualFundName": { "type": "string" },
- "narration": { "type": "string" },
- "nav": { "type": "number" },
- "navDate": { "type": "string" },
- "nav_gte": { "type": "number" },
- "nav_lte": { "type": "number" },
- "registrar": { "type": "string" },
- "schemeCode": { "type": "string" },
- "schemePlan": { "type": "string" },
- "txnDate": { "type": "string" },
- "txnDate_gte": { "type": "string" },
- "txnDate_lte": { "type": "string" },
- "txnId": { "type": "string" },
- "txnMode": { "type": "string" },
- "txnType": { "type": "string" },
- "ucc": { "type": "string" },
- "units": { "type": "number" },
- "units_gte": { "type": "number" },
- "units_lte": { "type": "number" }
- }
- },
- "responses.ListMutualFundsTransactionsResponse": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": { "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsData" }
- },
- "totalCount": { "type": "integer" }
- }
- },
- "responses.ListMutualFundsTransactionsData": {
- "type": "object",
- "properties": {
- "amc": { "type": "string" },
- "amcFullName": { "type": "string" },
- "amfiCode": { "type": "string" },
- "amount": { "type": "number" },
- "consentId": { "type": "string" },
- "dataId": { "type": "string" },
- "fipId": { "type": "string" },
- "id": { "type": "string" },
- "isin": { "type": "string" },
- "isinDescription": { "type": "string" },
- "linkedAccRef": { "type": "string" },
- "lockInDays": { "type": "string" },
- "lockInFlag": { "type": "string" },
- "mutualFundName": { "type": "string" },
- "narration": { "type": "string" },
- "nav": { "type": "number" },
- "navDate": { "type": "string" },
- "refId": { "type": "string" },
- "registrar": { "type": "string" },
- "schemeCode": { "type": "string" },
- "schemePlan": { "type": "string" },
- "txnDate": { "type": "string" },
- "txnId": { "type": "string" },
- "txnMode": { "type": "string" },
- "txnType": { "type": "string" },
- "ucc": { "type": "string" },
- "units": { "type": "number" }
- }
- },
- "responses.Error": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- }
}
}
- }
-}
\ No newline at end of file
+ }
\ No newline at end of file
diff --git a/api-references/data/insights_v2.json b/api-references/data/insights_v2.json
new file mode 100644
index 00000000..68293d9c
--- /dev/null
+++ b/api-references/data/insights_v2.json
@@ -0,0 +1,4991 @@
+{
+ "openapi": "3.1.0",
+ "info": {
+ "title": "Setu Insights API",
+ "description": "Setu’s Insights API gives you actionable insights from a customer's bank statement about their income, expenditure, and financial history.",
+ "version": "1.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://di-uat.setu.co/",
+ "description": "Sandbox"
+ },
+ {
+ "url": "https://insights.setu.co/",
+ "description": "Production"
+ }
+ ],
+ "paths": {
+ "/v2/template": {
+ "post": {
+ "tags": ["Template"],
+ "summary": "Create a new Template",
+ "description": "Call this API to create a new template containing static and configurable insights.",
+ "operationId": "create_template_v2_post",
+ "parameters": [
+ {
+ "name": "x-product-instance-id",
+ "in": "header",
+ "required": true,
+ "schema": { "type": "string" }
+ },
+ {
+ "name": "x-client-id",
+ "in": "header",
+ "required": true,
+ "schema": { "type": "string" }
+ },
+ {
+ "name": "x-client-secret",
+ "in": "header",
+ "required": true,
+ "schema": { "type": "string" }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TemplateCreateRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Template created successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TemplatePostResponse"
+ },
+ "examples": {
+ "TemplatePostResponse": {
+ "value": {
+ "status": "Success",
+ "version": "0.72.0",
+ "statusDescription": null,
+ "body": {
+ "templateId": "7a86d5f8-8434-421f-8df6-828f3fe9ddd8",
+ "name": "Sample Template",
+ "staticInsights": [
+ {
+ "insightId": "81654386-d574-40a6-a49f-e04c9d980e3b",
+ "name": "closing_balance",
+ "title": "Account Closing Balance",
+ "description": null
+ }
+ ],
+ "configurableInsights": [
+ {
+ "refKey": "monthly_total_debits_value",
+ "title": "explainer",
+ "description": null,
+ "params": {
+ "refKey": null,
+ "lastNMonths": null,
+ "offsetMonths": 0,
+ "aggregateFunction": "SUM",
+ "transactionType": "DEBIT",
+ "transactionMode": null,
+ "transactionCategory": null,
+ "transactionSubcategory": null,
+ "transactionCategoryExclusions": null,
+ "transactionSubcategoryExclusions": null,
+ "startDate": null,
+ "endDate": null,
+ "periodicity": "MONTHLY",
+ "minAmount": null,
+ "groupBy": null,
+ "day": null,
+ "top": null
+ },
+ "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
+ "insight": {
+ "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
+ "name": "amt_last_n_mon",
+ "title": "Operations on Transaction Amounts of last n months",
+ "description": null
+ }
+ }
+ ],
+ "categorisationMode": "INCLUSIVE",
+ "keywordMaps": [],
+ "compoundInsights": [],
+ "isLineageRequired": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid request payload",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ErrorResponse" }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized access",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ErrorResponse" }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ErrorResponse" }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": ["Template"],
+ "summary": "Fetch all templates",
+ "description": "Call this API to retrieve all existing templates.",
+ "operationId": "get_templates_v2_get",
+ "parameters": [
+ {
+ "name": "x-product-instance-id",
+ "in": "header",
+ "required": true,
+ "schema": { "type": "string" }
+ },
+ {
+ "name": "x-client-id",
+ "in": "header",
+ "required": true,
+ "schema": { "type": "string" }
+ },
+ {
+ "name": "x-client-secret",
+ "in": "header",
+ "required": true,
+ "schema": { "type": "string" }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of templates",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TemplateListResponse"
+ },
+ "examples": {
+ "TemplateListResponse": {
+ "value": {
+ "status": "Success",
+ "version": "0.72.0",
+ "statusDescription": null,
+ "body": [
+ {
+ "templateId": "7a86d5f8-8434-421f-8df6-828f3fe9ddd8",
+ "name": "Sample Template",
+ "staticInsights": [
+ {
+ "insightId": "81654386-d574-40a6-a49f-e04c9d980e3b",
+ "name": "closing_balance",
+ "title": "Account Closing Balance",
+ "description": null
+ }
+ ],
+ "configurableInsights": [
+ {
+ "refKey": "monthly_total_debits_value",
+ "title": "explainer",
+ "description": null,
+ "params": {
+ "refKey": null,
+ "lastNMonths": null,
+ "offsetMonths": 0,
+ "aggregateFunction": "SUM",
+ "transactionType": "DEBIT",
+ "transactionMode": null,
+ "transactionCategory": null,
+ "transactionSubcategory": null,
+ "transactionCategoryExclusions": null,
+ "transactionSubcategoryExclusions": null,
+ "startDate": null,
+ "endDate": null,
+ "periodicity": "MONTHLY",
+ "minAmount": null,
+ "groupBy": null,
+ "day": null,
+ "top": null
+ },
+ "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
+ "insight": {
+ "insightId": "842149c3-f80c-4fe7-a9f0-ab7a8244bb3c",
+ "name": "amt_last_n_mon",
+ "title": "Operations on Transaction Amounts of last n months",
+ "description": null
+ }
+ }
+ ],
+ "categorisationMode": "INCLUSIVE",
+ "keywordMaps": [],
+ "compoundInsights": [],
+ "isLineageRequired": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized access",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ErrorResponse" }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ErrorResponse" }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/fiData": {
+ "post": {
+ "tags": [
+ "Fi Data Ingestion (JSON)"
+ ],
+ "summary": "Create FIData block",
+ "description": "Call this API with the data received from FIP's notification as payload, to create an FI DataBlock. Note: This data can be auto-fetched from FIP with FIU's consent.",
+ "operationId": "create_fi_data_v2_fiData_post",
+ "parameters": [
+ {
+ "required": false,
+ "schema": {
+ "type": "string",
+ "title": "Refid"
+ },
+ "name": "refId",
+ "in": "query"
+ },
+ {
+ "required": false,
+ "schema": {
+ "type": "string",
+ "title": "authorization"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-product-instance-id"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-id"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-secret"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FIDataList"
+ },
+ "examples": {
+ "DepositAccountExample": {
+ "summary": "Example of deposit account data",
+ "value": {
+ "account": {
+ "profile": {
+ "holders": {
+ "holder": [
+ {
+ "name": "PRATIK JAIN",
+ "dob": "1991-12-27",
+ "mobile": "00919650033947",
+ "nominee": "REGISTERED",
+ "landline": null,
+ "address": "420, TOWER 10, PURVANCHAL ROYAL PARK, NOIDA, UTTAR PRADESH, INDIA, 201305",
+ "email": "tunetopj@gmail.com",
+ "pan": "AXXPJ2898M",
+ "ckycCompliance": "false"
+ }
+ ],
+ "type": "SINGLE"
+ }
+ },
+ "summary": {
+ "pending": null,
+ "currentBalance": "1360773.36",
+ "currency": "INR",
+ "exchgeRate": null,
+ "balanceDateTime": "2025-05-26 10:35:44.219",
+ "type": "SAVINGS",
+ "branch": "DLF CAPITOL POI DEL DL",
+ "facility": null,
+ "ifscCode": "UTIB0005140",
+ "micrCode": null,
+ "openingDate": "2014-01-18",
+ "currentODLimit": "",
+ "drawingLimit": "0",
+ "status": "ACTIVE"
+ },
+ "transactions": {
+ "transaction": [
+ {
+ "type": "CREDIT",
+ "mode": "OTHERS",
+ "amount": 500.0,
+ "currentBalance": "517802.52",
+ "transactionTimestamp": "2024-05-02 18:30:00.0",
+ "valueDate": "2024-05-03",
+ "txnId": "1",
+ "narration": "IMPS OUTWARD REV",
+ "reference": "0"
+ }
+ ],
+ "startDate": "2024-05-02",
+ "endDate": "2025-05-02"
+ },
+ "type": "deposit",
+ "maskedAccNumber": "XXXXXX0226",
+ "version": null,
+ "linkedAccRef": "2ec65d0b-0da5-4601-93cc-b6be384d383e",
+ "fipId": "03a66b0c-f5c1-41fb-a5dd-207183803256"
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": true,
+ "description": "FI Data as defined by ReBIT schema"
+ },
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FIDataBlockCreateResponse"
+ },
+ "examples": {
+ "FIDataBlockCreateResponse": {
+ "summary": "FIDataBlockCreateResponse",
+ "value": {
+ "status": "Success",
+ "body": {
+ "dataId": "57ee04ae-6540-4ba9-a314-082c9f9cd793",
+ "fiSchema": "deposit",
+ "expiryDate": "2023-03-11T06:52:36.457745"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/pdfData/supported_banks": {
+ "get": {
+ "tags": ["Fi Data Ingestion (PDF)"],
+ "summary": "Get supported banks for PDF processing",
+ "description": "Retrieve a list of banks supported for PDF statement processing",
+ "operationId": "get_supported_banks_v2_pdf_supported_banks_get",
+ "parameters": [
+ {
+ "name": "x-client-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-client-secret",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-product-instance-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "SupportedBanksResponse": {
+ "summary": "SupportedBanksResponse",
+ "value": ["HDFC Bank", "ICICI Bank", "Kotak Mahindra Bank"]
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/pdfData": {
+ "post": {
+ "tags": ["Fi Data Ingestion (PDF)"],
+ "summary": "Upload PDF bank statement for processing",
+ "description": "Call this API to upload a PDF bank statement for processing and data extraction",
+ "operationId": "upload_pdf_statement_v2_pdf_post",
+ "parameters": [
+ {
+ "name": "refId",
+ "in": "query",
+ "description": "Reference ID for tracking the PDF upload",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-client-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-client-secret",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-product-instance-id",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "bankName": {
+ "type": "string",
+ "description": "Name of the bank that issued the statement"
+ },
+ "password": {
+ "type": "string",
+ "description": "Password for the PDF if it's encrypted"
+ },
+ "dataFile": {
+ "type": "string",
+ "format": "binary",
+ "description": "PDF bank statement file"
+ }
+ },
+ "required": ["bankName", "dataFile"]
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "PDF uploaded and processing started successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FIDataBlockCreateResponse"
+ },
+ "examples": {
+ "PDFUploadSuccessResponse": {
+ "summary": "PDFUploadSuccessResponse",
+ "value": {
+ "status": "Success",
+ "body": {
+ "dataId": "57ee04ae-6540-4ba9-a314-082c9f9cd793",
+ "fiSchema": "pdf",
+ "expiryDate": "2023-03-11T06:52:36.457745"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid PDF or unsupported bank",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/insight": {
+ "post": {
+ "tags": [
+ "Insight Generation"
+ ],
+ "summary": "Create Insights",
+ "description": "Call this API with the template-id received from Setu along with a list of data-ids, to trigger an Report generation job. The FI Datablocks can belong to multiple bank accounts.The created Report will be shared via a notification to the endpoint configured by the FIU.This API will respond with a report-id, which can also be used to fetch the generated Report.",
+ "operationId": "process_insights_v2_insight_post",
+ "parameters": [
+ {
+ "required": false,
+ "schema": {
+ "type": "string",
+ "title": "authorization"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-product-instance-id"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-id"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-secret"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_process_insights_v2_insight_post"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "202": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportJobCreateResponse"
+ },
+ "examples": {
+ "ReportJobCreateResponse": {
+ "summary": "ReportJobCreateResponse",
+ "value": {
+ "status": "Success",
+ "body": {
+ "reportId": "4b108e83-07b6-47a4-84cd-a77d0e9e2b3d"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "RequestErrorResponse": {
+ "summary": "RequestErrorResponse",
+ "value": {
+ "errorCode": "400",
+ "errorMsg": "Empty data_ids input",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "NotFoundResponse": {
+ "summary": "NotFoundResponse",
+ "value": {
+ "errorCode": "404",
+ "errorMsg": "Unable to find FIData with id: 4e8e6d50-2dd4-43d0-a79a-5348b935ecf4",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Insights"
+ ],
+ "summary": "Get Insights",
+ "description": "Call this API with the report-id to get the created Insights",
+ "operationId": "get_insights_v2_insight_get",
+ "parameters": [
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Report ID for which insights are needed"
+ },
+ "name": "reportId",
+ "in": "query"
+ },
+ {
+ "required": false,
+ "schema": {
+ "type": "string",
+ "title": "authorization"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-product-instance-id"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-id"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-secret"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ReportJobCreateResponse"
+ },
+ {
+ "$ref": "#/components/schemas/InsightGetResponse"
+ }
+ ],
+ "title": "Response 200 Get Insights V2 Insight Get"
+ },
+ "examples": {
+ "InsightGetResponse": {
+ "summary": "InsightGetResponse",
+ "value": {
+ "status": "Success",
+ "body": {
+ "name": "Redacted Services",
+ "dob": "2006-06-27",
+ "email": "redacted@gmail.com",
+ "pan": "redacted",
+ "ckyc_compliance": false,
+ "mobile": 9999912345,
+ "bank_branch": "NARKATIAGANJ BH",
+ "bank_account_number": "XXXXXXXXXXX1234",
+ "bank_account_type": "CURRENT",
+ "opening_date": "2019-02-26",
+ "closing_balance": 27929.84,
+ "end_of_month_balances": {
+ "2021": {
+ "9": 245676.89,
+ "10": 48650.54,
+ "11": 145487.41,
+ "12": 97725.67
+ },
+ "2022": {
+ "1": 9152.09,
+ "2": 5957.19,
+ "3": 545.59,
+ "4": 1282299.18,
+ "5": 134376.04,
+ "6": 84468.46,
+ "7": 135585.11,
+ "8": 3346.11,
+ "9": 268766.7,
+ "10": 50049.84,
+ "11": 27929.84
+ }
+ },
+ "balances_on_10th": {
+ "2021": {
+ "12": 55387.41
+ },
+ "2022": {
+ "1": 2426.67,
+ "2": 9629.59,
+ "3": 97487.45,
+ "4": 1641.09,
+ "5": 52517.54,
+ "6": 72084.28,
+ "7": 165864.04,
+ "8": 63465.11,
+ "9": 11226.11,
+ "10": 418535.81,
+ "11": 27929.84
+ }
+ },
+ "average_end_of_day_balance": 297715.03,
+ "maximum_end_of_day_balance": 1818766.7,
+ "total_credits": 153,
+ "total_credits_value": 44810341.06,
+ "total_debits": 473,
+ "total_debits_value": 45178088.11,
+ "quarterly_salary_average": {
+ "2021": {
+ "4": 15072
+ }
+ },
+ "cash_deposit_x_total_credit": {
+ "2021": {
+ "12": 0.0095
+ },
+ "2022": {
+ "3": 0.0018
+ }
+ },
+ "run_amt_last_1m_min_q2": {
+ "meta": {
+ "refKey": "run_amt_last_1m_min_q2",
+ "lastNMonths": 5,
+ "aggregateFunction": "COUNT"
+ },
+ "value": 125
+ },
+ "run_amt_last_1m_min_q3": {
+ "meta": {
+ "refKey": "run_amt_last_1m_min_q3",
+ "lastNMonths": 5,
+ "aggregateFunction": "SUM"
+ },
+ "value": 918017.6299999999
+ },
+ "ratio_run_amt_last_1m_min_q2_q3": {
+ "meta": {
+ "id": "cd81abf3-37df-4fcd-9a88-874884982f48",
+ "name": "test",
+ "formula": "run_amt_last_1m_min_q2 * run_amt_last_1m_min_q3",
+ "refKey": "ratio_run_amt_last_1m_min_q2_q3",
+ "description": "test",
+ "reqInsights": [
+ "run_amt_last_1m_min_q2",
+ "run_amt_last_1m_min_q3"
+ ],
+ "insightId": "e2a127a0-6d0b-45e0-973d-430b16b99e79"
+ },
+ "value": 114752203.74999999
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to fetch FIU config",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ValidationErrorResponse": {
+ "summary": "ValidationErrorResponse",
+ "value": {
+ "errorCode": "422",
+ "errorMsg": "field required -> account",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/purge": {
+ "delete": {
+ "tags": ["Purge"],
+ "summary": "Purge data by reference ID",
+ "description": "Call this API to delete all data associated with a specific reference ID (refId). This operation cannot be undone.",
+ "operationId": "purge_data_v2_purge_delete",
+ "parameters": [
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Reference ID"
+ },
+ "name": "refId",
+ "in": "query",
+ "description": "The reference ID for which data should be purged"
+ },
+ {
+ "required": false,
+ "schema": {
+ "type": "string",
+ "title": "authorization"
+ },
+ "name": "authorization",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-product-instance-id"
+ },
+ "name": "x-product-instance-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-id"
+ },
+ "name": "x-client-id",
+ "in": "header"
+ },
+ {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "x-client-secret"
+ },
+ "name": "x-client-secret",
+ "in": "header"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Purge",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PurgeSuccessResponse"
+ },
+ "examples": {
+ "PurgeSuccessResponse": {
+ "summary": "PurgeSuccessResponse",
+ "value": {
+ "status": "Success",
+ "version": "0.72.0",
+ "statusDescription": null,
+ "body": {
+ "insight_reports": 1,
+ "depositTransactions": 1,
+ "equitiesTransactions": 0,
+ "etfTransactions": 0,
+ "mutualFundsTransactions": 0
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "RequestErrorResponse": {
+ "summary": "RequestErrorResponse",
+ "value": {
+ "errorCode": "400",
+ "errorMsg": "Missing required parameter: refId",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "AuthenticationErrorResponse": {
+ "summary": "AuthenticationErrorResponse",
+ "value": {
+ "errorCode": "401",
+ "errorMsg": "Unable to authenticate with provided credentials",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "NotFoundResponse": {
+ "summary": "NotFoundResponse",
+ "value": {
+ "errorCode": "404",
+ "errorMsg": "No data found for the provided refId",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "ServerErrorResponse": {
+ "summary": "ServerErrorResponse",
+ "value": {
+ "errorCode": "500",
+ "errorMsg": "Internal Server Error",
+ "timestamp": "2023-04-18T17:10:12.904153",
+ "ver": "1",
+ "txnid": "4e8e6d50-2dd4-43d0-a79a-5348b935ecf4"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/deposit/transactions": {
+ "post": {
+ "description": "List deposit transactions",
+ "tags": ["List transactions"],
+ "summary": "List deposit transactions",
+ "operationId": "list-deposit-transactions",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/requests.ListDepositTransactionsRequest"
+ }
+ }
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListDepositTransactionsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/equities/transactions": {
+ "post": {
+ "description": "List equities transactions",
+ "tags": ["List transactions"],
+ "summary": "List equities transactions",
+ "operationId": "list-equities-transactions",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/requests.ListEquitiesTransactionsRequest"
+ }
+ }
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListEquitiesTransactionsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/etf/transactions": {
+ "post": {
+ "description": "List etf transactions",
+ "tags": ["List transactions"],
+ "summary": "List etf transactions",
+ "operationId": "list-etf-transactions",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/requests.ListETFTransactionsRequest"
+ }
+ }
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListETFTransactionsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/mutual-funds/transactions": {
+ "post": {
+ "description": "List mutual-funds transactions",
+ "tags": ["List transactions"],
+ "summary": "List mutual-funds transactions",
+ "operationId": "list-mutual-funds-transactions",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsRequest"
+ }
+ }
+ },
+ "description": "Query details",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/responses.Error" }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "FIDataList": {
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "profile": {
+ "type": "object",
+ "properties": {
+ "holders": {
+ "type": "object",
+ "properties": {
+ "holder": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": { "type": "string" },
+ "dob": { "type": "string", "format": "date" },
+ "mobile": { "type": "string" },
+ "nominee": { "type": "string" },
+ "landline": { "type": "string", "nullable": true },
+ "address": { "type": "string" },
+ "email": { "type": "string", "format": "email" },
+ "pan": { "type": "string" },
+ "ckycCompliance": { "type": "string" }
+ },
+ "required": ["name", "dob", "mobile", "address", "email"]
+ }
+ },
+ "type": { "type": "string" }
+ },
+ "required": ["holder", "type"]
+ }
+ },
+ "required": ["holders"]
+ },
+ "summary": {
+ "type": "object",
+ "properties": {
+ "pending": { "type": "string", "nullable": true },
+ "currentBalance": { "type": "string" },
+ "currency": { "type": "string" },
+ "exchgeRate": { "type": "string", "nullable": true },
+ "balanceDateTime": { "type": "string", "format": "date-time" },
+ "type": { "type": "string" },
+ "branch": { "type": "string" },
+ "facility": { "type": "string", "nullable": true },
+ "ifscCode": { "type": "string" },
+ "micrCode": { "type": "string", "nullable": true },
+ "openingDate": { "type": "string", "format": "date" },
+ "currentODLimit": { "type": "string" },
+ "drawingLimit": { "type": "string" },
+ "status": { "type": "string" }
+ },
+ "required": ["currentBalance", "currency", "type", "ifscCode", "status"]
+ },
+ "transactions": {
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": { "type": "string" },
+ "mode": { "type": "string" },
+ "amount": { "type": "number" },
+ "currentBalance": { "type": "string" },
+ "transactionTimestamp": { "type": "string", "format": "date-time" },
+ "valueDate": { "type": "string", "format": "date" },
+ "txnId": { "type": "string" },
+ "narration": { "type": "string" },
+ "reference": { "type": "string" }
+ },
+ "required": ["type", "amount", "transactionTimestamp", "txnId"]
+ }
+ },
+ "startDate": { "type": "string", "format": "date" },
+ "endDate": { "type": "string", "format": "date" }
+ },
+ "required": ["transaction", "startDate", "endDate"]
+ },
+ "type": { "type": "string" },
+ "maskedAccNumber": { "type": "string" },
+ "version": { "type": "string", "nullable": true },
+ "linkedAccRef": { "type": "string" },
+ "fipId": { "type": "string" }
+ },
+ "required": ["profile", "summary", "type", "maskedAccNumber", "fipId"]
+ }
+ },
+ "required": ["account"]
+ },
+ "FIDataBlockCreateResponse": {
+ "type": "object",
+ "properties": {
+ "status": { "type": "string" },
+ "body": {
+ "type": "object",
+ "properties": {
+ "dataId": { "type": "string", "format": "uuid" },
+ "fiSchema": { "type": "string" },
+ "expiryDate": { "type": "string", "format": "date-time" }
+ },
+ "required": ["dataId", "fiSchema", "expiryDate"]
+ }
+ },
+ "required": ["status", "body"]
+ },
+ "TemplateCreateRequest": {
+ "type": "object",
+ "properties": {
+ "name": { "type": "string" },
+ "staticInsights": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "configurableInsights": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ConfigurableInsightRequest"
+ }
+ }
+ }
+ },
+ "ConfigurableInsightRequest": {
+ "type": "object",
+ "required": ["insight", "ref_key", "params", "title"],
+ "properties": {
+ "insight": { "type": "string" },
+ "ref_key": { "type": "string" },
+ "params": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "title": { "type": "string" },
+ "description": { "type": "string", "nullable": true }
+ }
+ },
+ "TemplatePostResponse": {
+ "type": "object",
+ "properties": {
+ "status": { "type": "string", "default": "Success" },
+ "version": { "type": "string" },
+ "statusDescription": { "type": "string", "nullable": true },
+ "body": { "$ref": "#/components/schemas/TemplateResponseBody" }
+ },
+ "required": ["status", "body"]
+ },
+ "TemplateListResponse": {
+ "type": "object",
+ "properties": {
+ "status": { "type": "string", "default": "Success" },
+ "version": { "type": "string" },
+ "statusDescription": { "type": "string", "nullable": true },
+ "body": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/TemplateResponseBody" }
+ }
+ },
+ "required": ["status", "body"]
+ },
+ "TemplateResponseBody": {
+ "type": "object",
+ "properties": {
+ "templateId": { "type": "string" },
+ "name": { "type": "string" },
+ "staticInsights": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/StaticInsight" }
+ },
+ "configurableInsights": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ConfigurableInsight" }
+ },
+ "categorisationMode": {
+ "type": "string",
+ "enum": ["INCLUSIVE", "EXCLUSIVE"]
+ },
+ "keywordMaps": {
+ "type": "array",
+ "items": { "type": "object" }
+ },
+ "compoundInsights": {
+ "type": "array",
+ "items": { "type": "object" }
+ },
+ "isLineageRequired": { "type": "boolean" }
+ },
+ "required": ["templateId", "name"]
+ },
+ "StaticInsight": {
+ "type": "object",
+ "properties": {
+ "insightId": { "type": "string" },
+ "name": { "type": "string" },
+ "title": { "type": "string" },
+ "description": { "type": "string", "nullable": true }
+ },
+ "required": ["insightId", "name", "title"]
+ },
+ "ConfigurableInsight": {
+ "type": "object",
+ "properties": {
+ "refKey": { "type": "string" },
+ "title": { "type": "string" },
+ "description": { "type": "string", "nullable": true },
+ "params": { "type": "object", "additionalProperties": true },
+ "insightId": { "type": "string" },
+ "insight": { "$ref": "#/components/schemas/InsightDetails" }
+ },
+ "required": ["refKey", "title", "insightId", "insight"]
+ },
+ "InsightDetails": {
+ "type": "object",
+ "properties": {
+ "insightId": { "type": "string" },
+ "name": { "type": "string" },
+ "title": { "type": "string" },
+ "description": { "type": "string", "nullable": true }
+ },
+ "required": ["insightId", "name", "title"]
+ },
+ "AccountTS": {
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transactions"
+ },
+ "linkedAccRef": {
+ "type": "string",
+ "title": "Linkedaccref"
+ },
+ "maskedAccNumber": {
+ "type": "string",
+ "title": "Maskedaccnumber"
+ },
+ "version": {
+ "type": "string",
+ "title": "Version"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "default": "etf"
+ }
+ },
+ "type": "object",
+ "required": [
+ "linkedAccRef",
+ "maskedAccNumber",
+ "version"
+ ],
+ "title": "AccountTS"
+ },
+ "AccountType": {
+ "type": "string",
+ "enum": [
+ "SAVINGS",
+ "CURRENT"
+ ],
+ "title": "AccountType",
+ "description": "An enumeration."
+ },
+ "AggregationFunctions": {
+ "type": "string",
+ "enum": [
+ "MIN",
+ "MAX",
+ "AVG",
+ "SUM",
+ "SD",
+ "COUNT",
+ "CV",
+ "AVG_RATIO",
+ "INC",
+ "DEC",
+ "COUNT_LT_10"
+ ],
+ "title": "AggregationFunctions",
+ "description": "An enumeration."
+ },
+ "Body_create_template_v1_template_post": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "insights": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "List of Insight masters to be included in the template"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "insights"
+ ],
+ "title": "Body_create_template_v1_template_post"
+ },
+ "Body_create_template_v2_template_post": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "keywordMaps": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array",
+ "title": "List of ids of keyword category maps to be included in the template",
+ "default": []
+ },
+ "categorisationMode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CategorisationMode"
+ }
+ ],
+ "title": "Categorisation Mode to use client provided maps strictly or inclusively",
+ "default": "INCLUSIVE"
+ },
+ "staticInsights": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "List of Insight masters to be included in the template",
+ "default": []
+ },
+ "configurableInsights": {
+ "items": {
+ "$ref": "#/components/schemas/InsightMap"
+ },
+ "type": "array",
+ "title": "List of congurable insight masters with their configurations to be included in the template",
+ "default": []
+ },
+ "compoundInsights": {
+ "items": {
+ "$ref": "#/components/schemas/CompoundMasterRequest"
+ },
+ "type": "array",
+ "title": "List of compound insight masters with their formula to be included in the template",
+ "default": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "title": "Body_create_template_v2_template_post"
+ },
+ "Body_process_insights_v1_insight_post": {
+ "properties": {
+ "templateId": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Template ID for which insights are needed"
+ },
+ "dataIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "List of data blocks to process"
+ },
+ "refIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Refids"
+ },
+ "linkedAccRefs": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Linkedaccrefs"
+ },
+ "additionalInfo": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "type": "object",
+ "title": "Additionalinfo"
+ },
+ "filters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateInsightsFilters"
+ }
+ ],
+ "title": "Filters for PFM",
+ "default": {}
+ }
+ },
+ "type": "object",
+ "required": [
+ "templateId"
+ ],
+ "title": "Body_process_insights_v1_insight_post"
+ },
+ "Body_process_insights_v2_insight_post": {
+ "properties": {
+ "templateId": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Template ID for which insights are needed"
+ },
+ "refIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Refids"
+ },
+ "linkedAccRefs": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Linkedaccrefs"
+ },
+ "additionalInfo": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "type": "object",
+ "title": "Additionalinfo"
+ },
+ "filters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateInsightsFilters"
+ }
+ ],
+ "title": "Filters for PFM",
+ "default": {}
+ }
+ },
+ "type": "object",
+ "required": [
+ "templateId"
+ ],
+ "title": "Body_process_insights_v2_insight_post"
+ },
+ "Body_process_pdf_insights_v1_insight_pdf_post": {
+ "properties": {
+ "templateId": {
+ "type": "string",
+ "title": "Template ID for which insights are needed"
+ },
+ "applicantName": {
+ "type": "string",
+ "title": "Applicant Name for associated PDF"
+ },
+ "applicantType": {
+ "type": "string",
+ "title": "Applicant Type for associated PDF",
+ "default": "retail"
+ },
+ "bankCode": {
+ "type": "string",
+ "title": "Bank Code for associated PDF",
+ "default": ""
+ },
+ "bankName": {
+ "type": "string",
+ "title": "Bank Name for associated PDF",
+ "default": ""
+ },
+ "password": {
+ "type": "string",
+ "title": "Password for associated PDF",
+ "default": ""
+ },
+ "dataFile": {
+ "type": "string",
+ "format": "binary",
+ "title": "PDF Bank Statement",
+ "description": "Upload the pdf-file to process"
+ }
+ },
+ "type": "object",
+ "required": [
+ "templateId",
+ "applicantName",
+ "dataFile"
+ ],
+ "title": "Body_process_pdf_insights_v1_insight_pdf_post"
+ },
+ "Body_retry_report_v1_retry_post": {
+ "properties": {
+ "reportId": {
+ "type": "string",
+ "title": "Report ID which needs to be re-processed"
+ }
+ },
+ "type": "object",
+ "required": [
+ "reportId"
+ ],
+ "title": "Body_retry_report_v1_retry_post"
+ },
+ "Body_update_fi_data_v1_fiData_put": {
+ "properties": {
+ "dataIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "List of data blocks to process"
+ },
+ "refId": {
+ "type": "string",
+ "title": "Refid"
+ }
+ },
+ "type": "object",
+ "required": [
+ "refId"
+ ],
+ "title": "Body_update_fi_data_v1_fiData_put"
+ },
+ "CategorisationMode": {
+ "type": "string",
+ "enum": [
+ "STRICT",
+ "STRICT_W_SALARY",
+ "KW_INCLUSIVE",
+ "INCLUSIVE"
+ ],
+ "title": "CategorisationMode",
+ "description": "An enumeration."
+ },
+ "Category": {
+ "type": "string",
+ "enum": [
+ "Cash Deposit",
+ "Cash Withdrawal",
+ "Bounced Cheque",
+ "Salary",
+ "Salary Paid",
+ "Bank Charges",
+ "Credit Card",
+ "Dividend",
+ "Education",
+ "Entertainment",
+ "Food & Drinks",
+ "Health",
+ "Investments",
+ "Jewellery",
+ "Loan",
+ "Pension",
+ "Reimbursement",
+ "Shopping",
+ "Sports",
+ "Subsidy",
+ "Tax",
+ "Travel and Transport",
+ "Utility Payments",
+ "Others",
+ "Gifts, Celebrations",
+ "Charity",
+ "Business Expense",
+ "Interest",
+ "Transfer",
+ "Transfer to Individual",
+ "Cash Withdrawals",
+ "Rent",
+ "Vehicle",
+ "Groceries",
+ "Transportation",
+ "Insurance",
+ "Refunds",
+ "Professional Services",
+ "Counseling",
+ "Donations",
+ "Fines",
+ "Bounced I/W Cheque",
+ "Bounced O/W Cheque",
+ "Bonus",
+ "Business Income",
+ "Bill",
+ "Gaming",
+ "Other Bank Charge",
+ "Fund Transfer",
+ "Account Verification",
+ "Self Transfer"
+ ],
+ "title": "Category",
+ "description": "An enumeration."
+ },
+ "CompoundMasterRequest": {
+ "properties": {
+ "fiu_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Fiu Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "formula": {
+ "type": "string",
+ "title": "Formula"
+ },
+ "ref_key": {
+ "type": "string",
+ "title": "Ref Key"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description"
+ },
+ "req_insights": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Req Insights"
+ },
+ "insight": {
+ "type": "string",
+ "title": "Insight"
+ }
+ },
+ "type": "object",
+ "required": [
+ "formula",
+ "ref_key",
+ "req_insights",
+ "insight"
+ ],
+ "title": "CompoundMasterRequest"
+ },
+ "CreateInsightsFilters": {
+ "properties": {
+ "dateRange": {
+ "$ref": "#/components/schemas/DateRangeFilter"
+ },
+ "accounts": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Accounts"
+ }
+ },
+ "type": "object",
+ "title": "CreateInsightsFilters"
+ },
+ "DateRangeFilter": {
+ "properties": {
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Startdate"
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Enddate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "startDate",
+ "endDate"
+ ],
+ "title": "DateRangeFilter"
+ },
+ "DepositData": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Account"
+ }
+ },
+ "type": "object",
+ "required": [
+ "account"
+ ],
+ "title": "DepositData"
+ },
+ "ETFData": {
+ "properties": {
+ "account": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Account"
+ },
+ {
+ "$ref": "#/components/schemas/AccountTS"
+ }
+ ],
+ "title": "Account"
+ }
+ },
+ "type": "object",
+ "required": [
+ "account"
+ ],
+ "title": "ETFData"
+ },
+ "EquitiesData": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Account"
+ }
+ },
+ "type": "object",
+ "required": [
+ "account"
+ ],
+ "title": "EquitiesData"
+ },
+ "EquityCategory": {
+ "type": "string",
+ "enum": [
+ "EQUITY"
+ ],
+ "title": "EquityCategory",
+ "description": "An enumeration."
+ },
+ "ErrorResponse": {
+ "properties": {
+ "errorCode": {
+ "type": "string",
+ "title": "Errorcode"
+ },
+ "errorMsg": {
+ "type": "string",
+ "title": "Errormsg"
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp"
+ },
+ "ver": {
+ "type": "string",
+ "title": "Ver",
+ "default": "1"
+ },
+ "txnid": {
+ "type": "string",
+ "title": "Txnid",
+ "default": ""
+ }
+ },
+ "type": "object",
+ "required": [
+ "errorCode",
+ "errorMsg"
+ ],
+ "title": "ErrorResponse"
+ },
+ "FIData": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/DepositData"
+ },
+ {
+ "$ref": "#/components/schemas/MutualFundsData"
+ },
+ {
+ "$ref": "#/components/schemas/EquitiesData"
+ },
+ {
+ "$ref": "#/components/schemas/ETFData"
+ }
+ ],
+ "title": "FIData"
+ },
+ "FIDataBlockResponse": {
+ "properties": {
+ "dataId": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "title": "Dataid"
+ },
+ "refId": {
+ "type": "string",
+ "title": "Refid"
+ },
+ "fiSchema": {
+ "type": "string",
+ "title": "Fischema"
+ },
+ "expiryDate": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Expirydate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "fiSchema"
+ ],
+ "title": "FIDataBlockResponse"
+ },
+ "FIUConfig": {
+ "properties": {
+ "fiuId": {
+ "type": "string",
+ "title": "Fiuid"
+ },
+ "notificationEndpoint": {
+ "type": "string",
+ "title": "Notificationendpoint"
+ },
+ "webhookId": {
+ "type": "string",
+ "title": "Webhookid"
+ },
+ "expiryDelta": {
+ "type": "integer",
+ "title": "Expirydelta",
+ "default": 30
+ },
+ "bertSalaryEnabled": {
+ "type": "boolean",
+ "title": "Bertsalaryenabled",
+ "default": true
+ },
+ "account_ids_path": {
+ "type": "string",
+ "title": "Account Ids Path"
+ },
+ "webhookAuthMechanism": {
+ "type": "string",
+ "title": "Webhookauthmechanism",
+ "default": "None"
+ },
+ "webhookAuthParams": {
+ "type": "object",
+ "title": "Webhookauthparams",
+ "default": {}
+ },
+ "isVLLMInferenceEnabled": {
+ "type": "boolean",
+ "title": "Isvllminferenceenabled",
+ "default": false
+ },
+ "transactionTTLDays": {
+ "type": "integer",
+ "title": "Transactionttldays"
+ }
+ },
+ "type": "object",
+ "required": [
+ "fiuId",
+ "notificationEndpoint",
+ "account_ids_path"
+ ],
+ "title": "FIUConfig"
+ },
+ "HTTPValidationError": {
+ "properties": {
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "HoldersType": {
+ "type": "string",
+ "enum": [
+ "SINGLE",
+ "JOINT",
+ "PROPRIETOR",
+ "OTHERS"
+ ],
+ "title": "HoldersType",
+ "description": "An enumeration."
+ },
+ "InsightGetResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "type": "object",
+ "title": "Body"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "InsightGetResponse"
+ },
+ "InsightMap": {
+ "properties": {
+ "ref_key": {
+ "type": "string",
+ "title": "Ref Key"
+ },
+ "title": {
+ "type": "string",
+ "title": "Title"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description"
+ },
+ "params": {
+ "$ref": "#/components/schemas/InsightParam"
+ },
+ "insight": {
+ "type": "string",
+ "title": "Insight"
+ }
+ },
+ "type": "object",
+ "required": [
+ "ref_key",
+ "title",
+ "params",
+ "insight"
+ ],
+ "title": "InsightMap"
+ },
+ "InsightMaster": {
+ "properties": {
+ "insightId": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Insightid"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "title": {
+ "type": "string",
+ "title": "Title"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description"
+ }
+ },
+ "type": "object",
+ "required": [
+ "insightId",
+ "name",
+ "title"
+ ],
+ "title": "InsightMaster"
+ },
+ "InsightMasterGetResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "items": {
+ "$ref": "#/components/schemas/InsightMaster"
+ },
+ "type": "array",
+ "title": "Body"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "InsightMasterGetResponse"
+ },
+ "InsightParam": {
+ "properties": {
+ "refKey": {
+ "type": "string",
+ "title": "Refkey"
+ },
+ "lastNMonths": {
+ "type": "integer",
+ "title": "Lastnmonths"
+ },
+ "offsetMonths": {
+ "type": "integer",
+ "title": "Offsetmonths",
+ "default": 0
+ },
+ "aggregateFunction": {
+ "$ref": "#/components/schemas/AggregationFunctions"
+ },
+ "transactionType": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "transactionMode": {
+ "$ref": "#/components/schemas/TransactionMode"
+ },
+ "transactionCategory": {
+ "$ref": "#/components/schemas/Category"
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Startdate"
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Enddate"
+ }
+ },
+ "type": "object",
+ "title": "InsightParam"
+ },
+ "KeywordMap": {
+ "properties": {
+ "id": {
+ "type": "integer",
+ "title": "Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "map": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "type": "array"
+ },
+ {
+ "additionalProperties": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "type": "object",
+ "title": "Map"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "map"
+ ],
+ "title": "KeywordMap"
+ },
+ "KeywordMapCreate": {
+ "properties": {
+ "fiu_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Fiu Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "map": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "type": "array"
+ },
+ {
+ "additionalProperties": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "type": "object",
+ "title": "Map"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "map"
+ ],
+ "title": "KeywordMapCreate"
+ },
+ "KeywordMapCreateResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "$ref": "#/components/schemas/KeywordMap"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "KeywordMapCreateResponse"
+ },
+ "MutualFundsData": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Account"
+ }
+ },
+ "type": "object",
+ "required": [
+ "account"
+ ],
+ "title": "MutualFundsData"
+ },
+ "NotificationSchema": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Type of the notification"
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "Timestamp of sending the notification"
+ },
+ "reportId": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Reportid",
+ "description": "Reference ID of the insights generation report"
+ },
+ "success": {
+ "type": "boolean",
+ "title": "Success",
+ "description": "Signifies whether the notification is a successful one or not",
+ "default": true
+ },
+ "data": {
+ "type": "object",
+ "title": "Data",
+ "description": "Data for the notification"
+ },
+ "error": {
+ "type": "object",
+ "title": "Error",
+ "description": "Error for the notification"
+ }
+ },
+ "type": "object",
+ "required": [
+ "type",
+ "reportId"
+ ],
+ "title": "NotificationSchema"
+ },
+ "Pending": {
+ "properties": {
+ "transactionType": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "amount": {
+ "type": "number",
+ "title": "Amount"
+ }
+ },
+ "type": "object",
+ "required": [
+ "amount"
+ ],
+ "title": "Pending"
+ },
+ "ReportJobCreateResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "$ref": "#/components/schemas/ReportJobResponseBody"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "ReportJobCreateResponse"
+ },
+ "ReportJobResponseBody": {
+ "properties": {
+ "reportId": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Reportid"
+ },
+ "status": {
+ "type": "string",
+ "title": "Status"
+ },
+ "reason": {
+ "type": "string",
+ "title": "Reason",
+ "default": "NA"
+ }
+ },
+ "type": "object",
+ "required": [
+ "reportId",
+ "status"
+ ],
+ "title": "ReportJobResponseBody"
+ },
+ "SchemeOption": {
+ "type": "string",
+ "enum": [
+ "REINVEST",
+ "PAYOUT",
+ "GROWTH_TYPE"
+ ],
+ "title": "SchemeOption",
+ "description": "An enumeration."
+ },
+ "SchemePlan": {
+ "type": "string",
+ "enum": [
+ "DIRECT",
+ "REGULAR"
+ ],
+ "title": "SchemePlan",
+ "description": "An enumeration."
+ },
+ "SchemeTypes": {
+ "type": "string",
+ "enum": [
+ "EQUITY_SCHEMES",
+ "DEBT_SCHEMES",
+ "HYBRID_SCHEMES",
+ "SOLUTION_ORIENTED_SCHEMES",
+ "OTHER_SCHEMES"
+ ],
+ "title": "SchemeTypes",
+ "description": "An enumeration."
+ },
+ "StatusTypes": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "INACTIVE"
+ ],
+ "title": "StatusTypes",
+ "description": "An enumeration."
+ },
+ "SuccessResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ }
+ },
+ "type": "object",
+ "title": "SuccessResponse"
+ },
+ "SummaryFacility": {
+ "type": "string",
+ "enum": [
+ "OD",
+ "CC",
+ "CURRENT",
+ "SAVING"
+ ],
+ "title": "SummaryFacility",
+ "description": "An enumeration."
+ },
+ "SupportedBanksGetResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Body"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "SupportedBanksGetResponse"
+ },
+ "TemplateCreateResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "$ref": "#/components/schemas/TemplateResponse"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "TemplateCreateResponse"
+ },
+ "TemplateGetResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "default": "Success"
+ },
+ "statusDescription": {
+ "type": "string",
+ "title": "Statusdescription"
+ },
+ "body": {
+ "items": {
+ "$ref": "#/components/schemas/TemplateResponse"
+ },
+ "type": "array",
+ "title": "Body"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ],
+ "title": "TemplateGetResponse"
+ },
+ "TemplateResponse": {
+ "properties": {
+ "templateId": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Templateid"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "insights": {
+ "items": {
+ "$ref": "#/components/schemas/InsightMaster"
+ },
+ "type": "array",
+ "title": "Insights"
+ }
+ },
+ "type": "object",
+ "required": [
+ "templateId",
+ "name",
+ "insights"
+ ],
+ "title": "TemplateResponse"
+ },
+ "TransactionMode": {
+ "type": "string",
+ "enum": [
+ "CASH",
+ "ATM",
+ "CARD",
+ "UPI",
+ "FT",
+ "OTHERS",
+ "NEFT",
+ "IMPS",
+ "ONLINE",
+ "CHEQUE",
+ "BRANCH",
+ "INB",
+ "CARD_PAYMENT"
+ ],
+ "title": "TransactionMode",
+ "description": "An enumeration."
+ },
+ "TransactionSymbol": {
+ "type": "string",
+ "enum": [
+ "BSE",
+ "NSE",
+ "OTHERS"
+ ],
+ "title": "TransactionSymbol",
+ "description": "An enumeration."
+ },
+ "TransactionTS": {
+ "properties": {
+ "txnId": {
+ "type": "string",
+ "title": "Txnid"
+ },
+ "orderId": {
+ "type": "string",
+ "title": "Orderid"
+ },
+ "companyName": {
+ "type": "string",
+ "title": "Companyname"
+ },
+ "txnDateTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Txndatetime"
+ },
+ "exchange": {
+ "$ref": "#/components/schemas/TransactionSymbol"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription"
+ },
+ "equityCategory": {
+ "$ref": "#/components/schemas/EquityCategory"
+ },
+ "narration": {
+ "type": "string",
+ "title": "Narration"
+ },
+ "exchangeRate": {
+ "type": "string",
+ "title": "Exchangerate"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__TransactionType"
+ },
+ "units": {
+ "type": "integer",
+ "title": "Units"
+ }
+ },
+ "type": "object",
+ "required": [
+ "txnId",
+ "companyName",
+ "txnDateTime",
+ "isin",
+ "equityCategory",
+ "type",
+ "units"
+ ],
+ "title": "TransactionTS"
+ },
+ "TransactionWithTSDetails": {
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "mode": {
+ "$ref": "#/components/schemas/TransactionMode"
+ },
+ "amount": {
+ "type": "number",
+ "title": "Amount"
+ },
+ "currentBalance": {
+ "type": "string",
+ "title": "Currentbalance"
+ },
+ "transactionTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Transactiontimestamp"
+ },
+ "valueDate": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ],
+ "title": "Valuedate"
+ },
+ "txnId": {
+ "type": "string",
+ "title": "Txnid"
+ },
+ "narration": {
+ "type": "string",
+ "title": "Narration"
+ },
+ "reference": {
+ "type": "string",
+ "title": "Reference"
+ },
+ "id": {
+ "type": "string",
+ "title": "Id"
+ },
+ "fipId": {
+ "type": "string",
+ "title": "Fipid"
+ },
+ "categoryL1": {
+ "type": "string",
+ "title": "Categoryl1"
+ },
+ "categoryL2": {
+ "type": "string",
+ "title": "Categoryl2"
+ },
+ "linkedAccRef": {
+ "type": "string",
+ "title": "Linkedaccref"
+ },
+ "transactionMode": {
+ "type": "string",
+ "title": "Transactionmode"
+ },
+ "refId": {
+ "type": "string",
+ "title": "Refid"
+ },
+ "categoryManual": {
+ "type": "string",
+ "title": "Categorymanual"
+ }
+ },
+ "type": "object",
+ "required": [
+ "type",
+ "mode",
+ "amount",
+ "currentBalance",
+ "transactionTimestamp",
+ "txnId"
+ ],
+ "title": "TransactionWithTSDetails"
+ },
+ "ValidationError": {
+ "properties": {
+ "loc": {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ },
+ "type": "array",
+ "title": "Location"
+ },
+ "msg": {
+ "type": "string",
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Error Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
+ },
+ "VaultSecret": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/VaultSecretData"
+ }
+ },
+ "type": "object",
+ "required": [
+ "data"
+ ],
+ "title": "VaultSecret"
+ },
+ "VaultSecretData": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/FIUConfig"
+ }
+ },
+ "type": "object",
+ "required": [
+ "data"
+ ],
+ "title": "VaultSecretData"
+ },
+ "amon_amarth__schema__rebit__deposit__Account": {
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Transactions"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "default": "deposit"
+ },
+ "maskedAccNumber": {
+ "type": "string",
+ "title": "Maskedaccnumber"
+ },
+ "masked_account_number": {
+ "type": "string",
+ "title": "Masked Account Number"
+ },
+ "version": {
+ "type": "string",
+ "title": "Version"
+ },
+ "linkedAccRef": {
+ "type": "string",
+ "title": "Linkedaccref"
+ },
+ "fipId": {
+ "type": "string",
+ "title": "Fipid"
+ }
+ },
+ "type": "object",
+ "required": [
+ "maskedAccNumber"
+ ],
+ "title": "Account"
+ },
+ "amon_amarth__schema__rebit__deposit__Holder": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "dob": {
+ "type": "string",
+ "format": "date",
+ "title": "Dob"
+ },
+ "mobile": {
+ "type": "string",
+ "title": "Mobile"
+ },
+ "nominee": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__HoldingNominee"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "title": "Nominee"
+ },
+ "landline": {
+ "type": "string",
+ "title": "Landline"
+ },
+ "address": {
+ "type": "string",
+ "title": "Address"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email"
+ },
+ "pan": {
+ "type": "string",
+ "title": "Pan"
+ },
+ "ckycCompliance": {
+ "type": "boolean",
+ "title": "Ckyccompliance"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "ckycCompliance"
+ ],
+ "title": "Holder"
+ },
+ "amon_amarth__schema__rebit__deposit__Holders": {
+ "properties": {
+ "holder": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Holder"
+ },
+ "type": "array",
+ "title": "Holder"
+ },
+ "type": {
+ "$ref": "#/components/schemas/HoldersType"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holder"
+ ],
+ "title": "Holders"
+ },
+ "amon_amarth__schema__rebit__deposit__HoldingNominee": {
+ "type": "string",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "title": "HoldingNominee",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__deposit__Profile": {
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Holders"
+ }
+ },
+ "type": "object",
+ "title": "Profile"
+ },
+ "amon_amarth__schema__rebit__deposit__Summary": {
+ "properties": {
+ "pending": {
+ "$ref": "#/components/schemas/Pending"
+ },
+ "currentBalance": {
+ "type": "string",
+ "title": "Currentbalance"
+ },
+ "currency": {
+ "type": "string",
+ "title": "Currency"
+ },
+ "exchgeRate": {
+ "type": "string",
+ "title": "Exchgerate"
+ },
+ "balanceDateTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Balancedatetime"
+ },
+ "type": {
+ "$ref": "#/components/schemas/AccountType"
+ },
+ "branch": {
+ "type": "string",
+ "title": "Branch"
+ },
+ "facility": {
+ "$ref": "#/components/schemas/SummaryFacility"
+ },
+ "ifscCode": {
+ "type": "string",
+ "title": "Ifsccode"
+ },
+ "micrCode": {
+ "type": "string",
+ "title": "Micrcode"
+ },
+ "openingDate": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ],
+ "title": "Openingdate"
+ },
+ "currentODLimit": {
+ "type": "string",
+ "title": "Currentodlimit"
+ },
+ "drawingLimit": {
+ "type": "string",
+ "title": "Drawinglimit"
+ },
+ "status": {
+ "$ref": "#/components/schemas/StatusTypes"
+ }
+ },
+ "type": "object",
+ "required": [
+ "currentBalance"
+ ],
+ "title": "Summary"
+ },
+ "amon_amarth__schema__rebit__deposit__Transaction": {
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__TransactionType"
+ },
+ "mode": {
+ "$ref": "#/components/schemas/TransactionMode"
+ },
+ "amount": {
+ "type": "number",
+ "title": "Amount"
+ },
+ "currentBalance": {
+ "type": "string",
+ "title": "Currentbalance"
+ },
+ "transactionTimestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Transactiontimestamp"
+ },
+ "valueDate": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ],
+ "title": "Valuedate"
+ },
+ "txnId": {
+ "type": "string",
+ "title": "Txnid"
+ },
+ "narration": {
+ "type": "string",
+ "title": "Narration"
+ },
+ "reference": {
+ "type": "string",
+ "title": "Reference"
+ }
+ },
+ "type": "object",
+ "required": [
+ "type",
+ "mode",
+ "amount",
+ "currentBalance",
+ "transactionTimestamp",
+ "txnId"
+ ],
+ "title": "Transaction"
+ },
+ "amon_amarth__schema__rebit__deposit__TransactionType": {
+ "type": "string",
+ "enum": [
+ "CREDIT",
+ "DEBIT",
+ "REVERSAL"
+ ],
+ "title": "TransactionType",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__deposit__Transactions": {
+ "properties": {
+ "transaction": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/TransactionWithTSDetails"
+ },
+ "type": "array"
+ },
+ {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__deposit__Transaction"
+ },
+ "type": "array"
+ }
+ ],
+ "title": "Transaction"
+ },
+ "startDate": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ],
+ "title": "Startdate"
+ },
+ "endDate": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ],
+ "title": "Enddate"
+ }
+ },
+ "type": "object",
+ "title": "Transactions"
+ },
+ "amon_amarth__schema__rebit__equities__Account": {
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Transactions"
+ },
+ "linkedAccRef": {
+ "type": "string",
+ "title": "Linkedaccref"
+ },
+ "maskedDematId": {
+ "type": "string",
+ "title": "Maskeddematid"
+ },
+ "version": {
+ "type": "string",
+ "title": "Version"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "default": "equities"
+ }
+ },
+ "type": "object",
+ "required": [
+ "linkedAccRef",
+ "version"
+ ],
+ "title": "Account"
+ },
+ "amon_amarth__schema__rebit__equities__Holder": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "dob": {
+ "type": "string",
+ "format": "date",
+ "title": "Dob"
+ },
+ "mobile": {
+ "type": "integer",
+ "title": "Mobile"
+ },
+ "nominee": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__HoldingNominee"
+ },
+ "dematId": {
+ "type": "string",
+ "title": "Dematid"
+ },
+ "landline": {
+ "type": "string",
+ "title": "Landline"
+ },
+ "address": {
+ "type": "string",
+ "title": "Address"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email"
+ },
+ "pan": {
+ "type": "string",
+ "title": "Pan"
+ },
+ "kycCompliance": {
+ "type": "boolean",
+ "title": "Kyccompliance"
+ },
+ "brokerName": {
+ "type": "string",
+ "title": "Brokername"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "mobile",
+ "dematId"
+ ],
+ "title": "Holder"
+ },
+ "amon_amarth__schema__rebit__equities__Holders": {
+ "properties": {
+ "holder": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holder"
+ },
+ "type": "array",
+ "title": "Holder"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holder"
+ ],
+ "title": "Holders"
+ },
+ "amon_amarth__schema__rebit__equities__Holding": {
+ "properties": {
+ "issuerName": {
+ "type": "string",
+ "title": "Issuername"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription"
+ },
+ "units": {
+ "type": "integer",
+ "title": "Units"
+ },
+ "lastTradedPrice": {
+ "type": "string",
+ "title": "Lasttradedprice"
+ }
+ },
+ "type": "object",
+ "required": [
+ "isin",
+ "units"
+ ],
+ "title": "Holding"
+ },
+ "amon_amarth__schema__rebit__equities__HoldingMode": {
+ "type": "string",
+ "enum": [
+ "DEMAT",
+ "PHYSICAL"
+ ],
+ "title": "HoldingMode",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__equities__HoldingNominee": {
+ "type": "string",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "title": "HoldingNominee",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__equities__Holdings": {
+ "properties": {
+ "holding": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holding"
+ },
+ "type": "array",
+ "title": "Holding"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__HoldingMode"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holding"
+ ],
+ "title": "Holdings"
+ },
+ "amon_amarth__schema__rebit__equities__Investment": {
+ "properties": {
+ "holdings": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holdings"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holdings"
+ ],
+ "title": "Investment"
+ },
+ "amon_amarth__schema__rebit__equities__Profile": {
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Holders"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holders"
+ ],
+ "title": "Profile"
+ },
+ "amon_amarth__schema__rebit__equities__Summary": {
+ "properties": {
+ "investment": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Investment"
+ },
+ "currentValue": {
+ "type": "string",
+ "title": "Currentvalue"
+ }
+ },
+ "type": "object",
+ "required": [
+ "investment"
+ ],
+ "title": "Summary"
+ },
+ "amon_amarth__schema__rebit__equities__Transaction": {
+ "properties": {
+ "txnId": {
+ "type": "string",
+ "title": "Txnid"
+ },
+ "orderId": {
+ "type": "string",
+ "title": "Orderid"
+ },
+ "companyName": {
+ "type": "string",
+ "title": "Companyname"
+ },
+ "transactionDateTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Transactiondatetime"
+ },
+ "exchange": {
+ "$ref": "#/components/schemas/TransactionSymbol"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription"
+ },
+ "equityCategory": {
+ "$ref": "#/components/schemas/EquityCategory"
+ },
+ "narration": {
+ "type": "string",
+ "title": "Narration"
+ },
+ "rate": {
+ "type": "string",
+ "title": "Rate"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__TransactionType"
+ },
+ "units": {
+ "type": "integer",
+ "title": "Units"
+ }
+ },
+ "type": "object",
+ "required": [
+ "txnId",
+ "companyName",
+ "transactionDateTime",
+ "isin",
+ "equityCategory",
+ "type",
+ "units"
+ ],
+ "title": "Transaction"
+ },
+ "amon_amarth__schema__rebit__equities__TransactionType": {
+ "type": "string",
+ "enum": [
+ "BUY",
+ "SELL",
+ "BONUS",
+ "SPLIT",
+ "DIVIDEND",
+ "RIGHTS",
+ "OTHERS"
+ ],
+ "title": "TransactionType",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__equities__Transactions": {
+ "properties": {
+ "transaction": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__equities__Transaction"
+ },
+ "type": "array"
+ },
+ {
+ "items": {
+ "$ref": "#/components/schemas/TransactionTS"
+ },
+ "type": "array"
+ }
+ ],
+ "title": "Transaction"
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Startdate"
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Enddate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "startDate",
+ "endDate"
+ ],
+ "title": "Transactions"
+ },
+ "amon_amarth__schema__rebit__etf__Account": {
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transactions"
+ },
+ "linkedAccRef": {
+ "type": "string",
+ "title": "Linkedaccref"
+ },
+ "maskedDematId": {
+ "type": "string",
+ "title": "Maskeddematid"
+ },
+ "version": {
+ "type": "string",
+ "title": "Version"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "default": "etf"
+ }
+ },
+ "type": "object",
+ "required": [
+ "linkedAccRef",
+ "maskedDematId",
+ "version"
+ ],
+ "title": "Account"
+ },
+ "amon_amarth__schema__rebit__etf__Holder": {
+ "properties": {
+ "dematId": {
+ "type": "string",
+ "title": "Dematid"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "pan": {
+ "type": "string",
+ "title": "Pan"
+ },
+ "dob": {
+ "type": "string",
+ "format": "date",
+ "title": "Dob"
+ },
+ "landline": {
+ "type": "string",
+ "title": "Landline"
+ },
+ "address": {
+ "type": "string",
+ "title": "Address"
+ },
+ "nominee": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__HoldingNominee"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email"
+ },
+ "mobile": {
+ "type": "string",
+ "title": "Mobile"
+ },
+ "kycCompliance": {
+ "type": "boolean",
+ "title": "Kyccompliance"
+ },
+ "brokerName": {
+ "type": "string",
+ "title": "Brokername"
+ }
+ },
+ "type": "object",
+ "required": [
+ "dematId",
+ "name",
+ "pan",
+ "address",
+ "mobile"
+ ],
+ "title": "Holder"
+ },
+ "amon_amarth__schema__rebit__etf__Holders": {
+ "properties": {
+ "holder": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holder"
+ },
+ "type": "array",
+ "title": "Holder"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holder"
+ ],
+ "title": "Holders"
+ },
+ "amon_amarth__schema__rebit__etf__Holding": {
+ "properties": {
+ "folioNo": {
+ "type": "string",
+ "title": "Foliono"
+ },
+ "units": {
+ "type": "integer",
+ "title": "Units"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription"
+ },
+ "nav": {
+ "type": "string",
+ "title": "Nav"
+ },
+ "lastNavDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Lastnavdate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "units",
+ "isin",
+ "isinDescription"
+ ],
+ "title": "Holding"
+ },
+ "amon_amarth__schema__rebit__etf__HoldingNominee": {
+ "type": "string",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "title": "HoldingNominee",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__etf__Holdings": {
+ "properties": {
+ "holding": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holding"
+ },
+ "type": "array",
+ "title": "Holding"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holding"
+ ],
+ "title": "Holdings"
+ },
+ "amon_amarth__schema__rebit__etf__Investment": {
+ "properties": {
+ "holdings": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holdings"
+ }
+ },
+ "type": "object",
+ "title": "Investment"
+ },
+ "amon_amarth__schema__rebit__etf__Profile": {
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Holders"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holders"
+ ],
+ "title": "Profile"
+ },
+ "amon_amarth__schema__rebit__etf__Summary": {
+ "properties": {
+ "investment": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Investment"
+ },
+ "currentValue": {
+ "type": "number",
+ "title": "Currentvalue"
+ }
+ },
+ "type": "object",
+ "required": [
+ "investment",
+ "currentValue"
+ ],
+ "title": "Summary"
+ },
+ "amon_amarth__schema__rebit__etf__Transaction": {
+ "properties": {
+ "txnId": {
+ "type": "string",
+ "title": "Txnid"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription"
+ },
+ "transactionDateTime": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Transactiondatetime"
+ },
+ "units": {
+ "type": "number",
+ "title": "Units"
+ },
+ "amount": {
+ "type": "number",
+ "title": "Amount"
+ },
+ "nav": {
+ "type": "number",
+ "title": "Nav"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__TransactionType"
+ },
+ "narration": {
+ "type": "string",
+ "title": "Narration"
+ },
+ "brokerCode": {
+ "type": "string",
+ "title": "Brokercode"
+ }
+ },
+ "type": "object",
+ "required": [
+ "txnId",
+ "isin",
+ "isinDescription",
+ "transactionDateTime",
+ "units",
+ "type"
+ ],
+ "title": "Transaction"
+ },
+ "amon_amarth__schema__rebit__etf__TransactionType": {
+ "type": "string",
+ "enum": [
+ "BUY",
+ "SELL",
+ "BOUNS",
+ "SPLIT",
+ "OTHERS"
+ ],
+ "title": "TransactionType",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__etf__Transactions": {
+ "properties": {
+ "transaction": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__etf__Transaction"
+ },
+ "type": "array",
+ "title": "Transaction"
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Startdate"
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Enddate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "transaction",
+ "startDate",
+ "endDate"
+ ],
+ "title": "Transactions"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Account": {
+ "properties": {
+ "profile": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Profile"
+ },
+ "summary": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Summary"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Transactions"
+ },
+ "linkedAccRef": {
+ "type": "string",
+ "title": "Linkedaccref"
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "1.0.0"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "default": "mutualfunds"
+ },
+ "maskedDematID": {
+ "type": "string",
+ "title": "Maskeddematid",
+ "description": "Demat ID assigned or issued to investor"
+ },
+ "maskedFolioNo": {
+ "type": "string",
+ "title": "Maskedfoliono",
+ "description": "Folio Number of Investor"
+ }
+ },
+ "type": "object",
+ "required": [
+ "linkedAccRef"
+ ],
+ "title": "Account"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Holder": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Name of primary holder operating the account"
+ },
+ "dob": {
+ "type": "string",
+ "format": "date",
+ "title": "Dob",
+ "description": "Date of birth of primary account holder"
+ },
+ "mobile": {
+ "type": "string",
+ "title": "Mobile",
+ "description": "Primary mobile number of account holder"
+ },
+ "nominee": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__HoldingNominee"
+ }
+ ],
+ "description": "This field will indicate whether a nominee is registered"
+ },
+ "dematId": {
+ "type": "string",
+ "title": "Dematid",
+ "description": "Demat ID assigned or issued to investor"
+ },
+ "folioNo": {
+ "type": "string",
+ "title": "Foliono",
+ "description": "Folio Number of Investor"
+ },
+ "landline": {
+ "type": "string",
+ "title": "Landline",
+ "description": "Landline number of primary account holder"
+ },
+ "address": {
+ "type": "string",
+ "title": "Address",
+ "description": "Address of primary account holder"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email",
+ "description": "Email ID of primary account holder"
+ },
+ "pan": {
+ "type": "string",
+ "title": "Pan",
+ "description": "PAN number of primary account holder"
+ },
+ "kycCompliance": {
+ "type": "string",
+ "title": "Kyccompliance",
+ "description": "KYC status whether its completed or pending"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "address",
+ "pan"
+ ],
+ "title": "Holder"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Holders": {
+ "properties": {
+ "holder": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holder"
+ },
+ "type": "array",
+ "title": "Holder"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holder"
+ ],
+ "title": "Holders"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Holding": {
+ "properties": {
+ "amc": {
+ "type": "string",
+ "title": "Amc",
+ "description": "Name of asset management company associated with investment"
+ },
+ "registrar": {
+ "type": "string",
+ "title": "Registrar",
+ "description": "Trust or institution registering and maintaining the detailed records"
+ },
+ "schemeCode": {
+ "type": "string",
+ "title": "Schemecode",
+ "description": "Code of scheme chosen by person for the investment"
+ },
+ "schemeOption": {
+ "$ref": "#/components/schemas/SchemeOption"
+ },
+ "schemeTypes": {
+ "$ref": "#/components/schemas/SchemeTypes"
+ },
+ "schemeCategory": {
+ "type": "string",
+ "title": "Schemecategory"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin",
+ "description": "International Securities Identification Number"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription",
+ "description": "Long Name of ISIN"
+ },
+ "ucc": {
+ "type": "string",
+ "title": "Ucc",
+ "description": "Unique Client Code generated by Stock Exchanges"
+ },
+ "amfiCode": {
+ "type": "string",
+ "title": "Amficode",
+ "description": "AMFI code associated with investment"
+ },
+ "folioNo": {
+ "type": "string",
+ "title": "Foliono",
+ "description": "Unique folio number associated with investment"
+ },
+ "FatcaStatus": {
+ "type": "string",
+ "title": "Fatcastatus",
+ "description": "FATCA compliance status"
+ },
+ "closingUnits": {
+ "type": "string",
+ "title": "Closingunits",
+ "description": "Units allotted in folio till date"
+ },
+ "lienUnits": {
+ "type": "string",
+ "title": "Lienunits",
+ "description": "The number of units which have been marked as Lien"
+ },
+ "nav": {
+ "type": "number",
+ "title": "Nav",
+ "description": "NAV is current market rate of security held as on date"
+ },
+ "navDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Navdate",
+ "description": "Last Available NAV date for the scheme of investment"
+ },
+ "lockinUnits": {
+ "type": "string",
+ "title": "Lockinunits",
+ "description": "Units which are locked and not available for sale"
+ }
+ },
+ "type": "object",
+ "required": [
+ "amc",
+ "registrar",
+ "closingUnits",
+ "lienUnits",
+ "nav",
+ "navDate",
+ "lockinUnits"
+ ],
+ "title": "Holding"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__HoldingMode": {
+ "type": "string",
+ "enum": [
+ "DEMAT",
+ "PHYSICAL"
+ ],
+ "title": "HoldingMode",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__mutual_funds__HoldingNominee": {
+ "type": "string",
+ "enum": [
+ "REGISTERED",
+ "NOT-REGISTERED"
+ ],
+ "title": "HoldingNominee",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Holdings": {
+ "properties": {
+ "holding": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holding"
+ },
+ "type": "array",
+ "title": "Holding"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holding"
+ ],
+ "title": "Holdings"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Investment": {
+ "properties": {
+ "holdings": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holdings"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holdings"
+ ],
+ "title": "Investment"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Profile": {
+ "properties": {
+ "holders": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Holders"
+ }
+ },
+ "type": "object",
+ "required": [
+ "holders"
+ ],
+ "title": "Profile"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Summary": {
+ "properties": {
+ "investment": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Investment"
+ },
+ "costValue": {
+ "type": "string",
+ "title": "Costvalue",
+ "description": "Principal or Actual amount of investment"
+ },
+ "currentValue": {
+ "type": "string",
+ "title": "Currentvalue",
+ "description": "Current value of investment as on date"
+ }
+ },
+ "type": "object",
+ "required": [
+ "investment"
+ ],
+ "title": "Summary"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Transaction": {
+ "properties": {
+ "txnId": {
+ "type": "string",
+ "title": "Txnid",
+ "description": "Transaction ID recorded or captured for investment made"
+ },
+ "amc": {
+ "type": "string",
+ "title": "Amc",
+ "description": "Asset Management company which is operating the fund"
+ },
+ "registrar": {
+ "type": "string",
+ "title": "Registrar"
+ },
+ "schemeCode": {
+ "type": "string",
+ "title": "Schemecode"
+ },
+ "schemePlan": {
+ "$ref": "#/components/schemas/SchemePlan"
+ },
+ "isin": {
+ "type": "string",
+ "title": "Isin"
+ },
+ "amfiCode": {
+ "type": "string",
+ "title": "Amficode"
+ },
+ "ucc": {
+ "type": "string",
+ "title": "Ucc"
+ },
+ "amount": {
+ "type": "string",
+ "title": "Amount"
+ },
+ "nav": {
+ "type": "number",
+ "title": "Nav"
+ },
+ "navDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Navdate"
+ },
+ "type": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__TransactionType"
+ },
+ "lockInFlag": {
+ "type": "string",
+ "title": "Lockinflag"
+ },
+ "lockInDays": {
+ "type": "string",
+ "title": "Lockindays"
+ },
+ "mode": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__HoldingMode"
+ },
+ "narration": {
+ "type": "string",
+ "title": "Narration"
+ },
+ "isinDescription": {
+ "type": "string",
+ "title": "Isindescription"
+ },
+ "units": {
+ "type": "string",
+ "title": "Units"
+ },
+ "transactionDate": {
+ "type": "string",
+ "title": "Transactiondate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "txnId",
+ "amc",
+ "registrar",
+ "nav",
+ "navDate",
+ "type",
+ "lockInDays",
+ "mode"
+ ],
+ "title": "Transaction"
+ },
+ "amon_amarth__schema__rebit__mutual_funds__TransactionType": {
+ "type": "string",
+ "enum": [
+ "BUY",
+ "SELL",
+ "OTHERS"
+ ],
+ "title": "TransactionType",
+ "description": "An enumeration."
+ },
+ "amon_amarth__schema__rebit__mutual_funds__Transactions": {
+ "properties": {
+ "transaction": {
+ "items": {
+ "$ref": "#/components/schemas/amon_amarth__schema__rebit__mutual_funds__Transaction"
+ },
+ "type": "array",
+ "title": "Transaction"
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Startdate",
+ "description": "The date from which the Financial Information was requested"
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "title": "Enddate",
+ "description": "The date till which the Financial Information was requested"
+ }
+ },
+ "type": "object",
+ "required": [
+ "transaction",
+ "startDate",
+ "endDate"
+ ],
+ "title": "Transactions"
+ },
+ "PurgeSuccessResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "default": "Success"
+ },
+ "version": {
+ "type": "string"
+ },
+ "statusDescription": {
+ "type": "string",
+ "nullable": true
+ },
+ "body": {
+ "$ref": "#/components/schemas/PurgeResultBody"
+ }
+ },
+ "required": ["status", "body"],
+ "title": "PurgeSuccessResponse"
+ },
+ "PurgeResultBody": {
+ "type": "object",
+ "properties": {
+ "insight_reports": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "depositTransactions": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "equitiesTransactions": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "etfTransactions": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "mutualFundsTransactions": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "insight_reports",
+ "depositTransactions",
+ "equitiesTransactions",
+ "etfTransactions",
+ "mutualFundsTransactions"
+ ],
+ "title": "PurgeResultBody"
+ },
+ "requests.ListDepositTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListDepositTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListDepositTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListDepositTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListDepositTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "amount_gte": { "type": "number" },
+ "amount_lte": { "type": "number" },
+ "categoryL1": { "type": "string" },
+ "categoryL1_list": { "type": "array", "items": { "type": "string" } },
+ "categoryL2": { "type": "string" },
+ "categoryL2_list": { "type": "array", "items": { "type": "string" } },
+ "categoryManual": { "type": "string" },
+ "categoryManual_list": { "type": "array", "items": { "type": "string" } },
+ "currentBalance": { "type": "number" },
+ "narration": { "type": "string" },
+ "reference": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnTimestamp": { "type": "string" },
+ "txnTimestamp_gte": { "type": "string" },
+ "txnTimestamp_lte": { "type": "string" },
+ "txnType": { "type": "string" },
+ "txnValueDate": { "type": "string" }
+ }
+ },
+ "responses.ListDepositTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListDepositTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListDepositTransactionsData": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "categoryL1": { "type": "string" },
+ "categoryL2": { "type": "string" },
+ "categoryManual": { "type": "string" },
+ "consentId": { "type": "string" },
+ "currentBalance": { "type": "number" },
+ "dataId": { "type": "string" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "narration": { "type": "string" },
+ "refId": { "type": "string" },
+ "reference": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnTimestamp": { "type": "string" },
+ "txnType": { "type": "string" },
+ "txnValueDate": { "type": "string" }
+ }
+ },
+ "requests.ListEquitiesTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListEquitiesTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListEquitiesTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListEquitiesTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListEquitiesTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "companyName": { "type": "string" },
+ "dematId": { "type": "string" },
+ "equityCategory": { "type": "string" },
+ "exchange": { "type": "string" },
+ "exchangeRate": { "type": "number" },
+ "exchangeRate_gte": { "type": "number" },
+ "exchangeRate_lte": { "type": "number" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "narration": { "type": "string" },
+ "orderId": { "type": "string" },
+ "transactionDateTime_gte": { "type": "string" },
+ "transactionDateTime_lte": { "type": "string" },
+ "txnDateTime": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" },
+ "units_gte": { "type": "number" },
+ "units_lte": { "type": "number" }
+ }
+ },
+ "responses.ListEquitiesTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListEquitiesTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListEquitiesTransactionsData": {
+ "type": "object",
+ "properties": {
+ "companyName": { "type": "string" },
+ "consentId": { "type": "string" },
+ "dataId": { "type": "string" },
+ "dematId": { "type": "string" },
+ "equityCategory": { "type": "string" },
+ "exchange": { "type": "string" },
+ "exchangeRate": { "type": "number" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "narration": { "type": "string" },
+ "orderId": { "type": "string" },
+ "refId": { "type": "string" },
+ "txnDateTime": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" }
+ }
+ },
+ "requests.ListETFTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListETFTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListETFTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListETFTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListETFTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "amount_gte": { "type": "number" },
+ "amount_lte": { "type": "number" },
+ "brokerCode": { "type": "string" },
+ "dematId": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "nav_gte": { "type": "number" },
+ "nav_lte": { "type": "number" },
+ "transactionDateTime": { "type": "string" },
+ "transactionDateTime_gte": { "type": "string" },
+ "transactionDateTime_lte": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" },
+ "units_gte": { "type": "number" },
+ "units_lte": { "type": "number" }
+ }
+ },
+ "responses.ListETFTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListETFTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListETFTransactionsData": {
+ "type": "object",
+ "properties": {
+ "amount": { "type": "number" },
+ "brokerCode": { "type": "string" },
+ "consentId": { "type": "string" },
+ "dataId": { "type": "string" },
+ "dematId": { "type": "string" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "refId": { "type": "string" },
+ "transactionDateTime": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnType": { "type": "string" },
+ "units": { "type": "number" }
+ }
+ },
+ "requests.ListMutualFundsTransactionsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": { "type": "integer" },
+ "offset": { "type": "integer" },
+ "orderBy": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsOrderBy" }
+ },
+ "refIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "where": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsWhere" }
+ }
+ }
+ },
+ "requests.ListMutualFundsTransactionsOrderBy": {
+ "type": "object",
+ "properties": {
+ "field": { "type": "string" },
+ "order": { "type": "string" }
+ }
+ },
+ "requests.ListMutualFundsTransactionsWhere": {
+ "type": "object",
+ "properties": {
+ "amc": { "type": "string" },
+ "amcFullName": { "type": "string" },
+ "amfiCode": { "type": "string" },
+ "amount": { "type": "number" },
+ "amount_gte": { "type": "number" },
+ "amount_lte": { "type": "number" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "lockInDays": { "type": "string" },
+ "lockInFlag": { "type": "string" },
+ "mutualFundName": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "navDate": { "type": "string" },
+ "nav_gte": { "type": "number" },
+ "nav_lte": { "type": "number" },
+ "registrar": { "type": "string" },
+ "schemeCode": { "type": "string" },
+ "schemePlan": { "type": "string" },
+ "txnDate": { "type": "string" },
+ "txnDate_gte": { "type": "string" },
+ "txnDate_lte": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnType": { "type": "string" },
+ "ucc": { "type": "string" },
+ "units": { "type": "number" },
+ "units_gte": { "type": "number" },
+ "units_lte": { "type": "number" }
+ }
+ },
+ "responses.ListMutualFundsTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsData" }
+ },
+ "totalCount": { "type": "integer" }
+ }
+ },
+ "responses.ListMutualFundsTransactionsData": {
+ "type": "object",
+ "properties": {
+ "amc": { "type": "string" },
+ "amcFullName": { "type": "string" },
+ "amfiCode": { "type": "string" },
+ "amount": { "type": "number" },
+ "consentId": { "type": "string" },
+ "dataId": { "type": "string" },
+ "fipId": { "type": "string" },
+ "id": { "type": "string" },
+ "isin": { "type": "string" },
+ "isinDescription": { "type": "string" },
+ "linkedAccRef": { "type": "string" },
+ "lockInDays": { "type": "string" },
+ "lockInFlag": { "type": "string" },
+ "mutualFundName": { "type": "string" },
+ "narration": { "type": "string" },
+ "nav": { "type": "number" },
+ "navDate": { "type": "string" },
+ "refId": { "type": "string" },
+ "registrar": { "type": "string" },
+ "schemeCode": { "type": "string" },
+ "schemePlan": { "type": "string" },
+ "txnDate": { "type": "string" },
+ "txnId": { "type": "string" },
+ "txnMode": { "type": "string" },
+ "txnType": { "type": "string" },
+ "ucc": { "type": "string" },
+ "units": { "type": "number" }
+ }
+ },
+ "responses.Error": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/content/data/insights/notifications.mdx b/content/data/insights/notifications.mdx
index bb5fae4f..34919472 100644
--- a/content/data/insights/notifications.mdx
+++ b/content/data/insights/notifications.mdx
@@ -24,19 +24,48 @@ Setu will post this payload to your notification endpoint when Insights report i
{`{
- "type": "INSIGHT_STATUS_UPDATE",
- "timestamp": 2018-12-06T11:39:57.153Z,
- "reportId": "d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
- "success": true,
- "data": {
- "status": "READY",
- "insights": {
- // ... insight_name : insight_value
+ "type": "INSIGHT_STATUS_UPDATE",
+ "timestamp": "2025-06-18 09:39:27.244",
+ "reportId": "8af477ff-d97e-4eda-a6c0-b5acd5714262",
+ "success": true,
+ "data": {
+ "status": "READY",
+ "insights": [
+ {
+ "linked_acc_ref": "a1f89fea-4075-4900-9a28-75d9f04b98de",
+ "insight_values": {
+ "mutualfunds_holdings_summary": {
+ "total_current_amount": "0.0",
+ "holdings": [
+ {
+ "isin": "INF277KA1CX6",
+ "current_value": "0.0",
+ "fund_name": null,
+ "amc": "Tata Asset Management Private Limited",
+ "units": "0.0"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "linked_acc_ref": "8a467ff9-51a5-4c8e-9cec-396dffffda13",
+ "insight_values": {
+ "bank_account_number": null,
+ "fraud_flags": [],
+ "insight_errors": {
+ "message": "We encountered an issue while calculating some of your financial insights.",
+ "affected_insights": [
+ "bank_account_number"
+ ]
+ }
+ }
+ }
+ ]
},
- "insight_errors": {}
- },
- "error": {}
-}`}
+ "error": {}
+}
+`}
diff --git a/content/data/insights/v2/api-reference.mdx b/content/data/insights/v2/api-reference.mdx
new file mode 100644
index 00000000..f909f016
--- /dev/null
+++ b/content/data/insights/v2/api-reference.mdx
@@ -0,0 +1,6 @@
+---
+sidebar_title: API reference
+page_title: Setu Insights API reference
+order: 4
+visible_in_sidebar: true
+---
diff --git a/content/data/insights/v2/insights.mdx b/content/data/insights/v2/insights.mdx
new file mode 100644
index 00000000..cc91f191
--- /dev/null
+++ b/content/data/insights/v2/insights.mdx
@@ -0,0 +1,52 @@
+---
+sidebar_title: List of insights
+page_title: All Setu insights
+order: 2
+visible_in_sidebar: true
+---
+
+## List of insights
+
+You can create templates by picking only those insights that you need. Below is a list of all available insights that Setu Insights can provide—
+
+| Insight name | Details |
+| ---------------------------------------- | ------------------------------------------------------------------- |
+| `name` | Name of the user |
+| `dob` | Date of Birth of the user |
+| `email` | E-Mail ID of the user |
+| `pan` | Permanent Account Number of the user |
+| `ckyc_compliance` | Checks if the bank has carried out the CKYC compliance for the user |
+| `mobile` | Mobile number of the user |
+| `bank_names` | Name of the bank |
+| `bank_branch` | Branch of the bank |
+| `bank_account_number` | Bank account number of the user |
+| `bank_account_type` | Bank account type of the user |
+| `opening_date` | Date on which the bank account was opened |
+| `closing_balance` | Amount value of the account as of the lastest date |
+| `od_cc_limit` | The portion of the sanctioned limit that is available to be drawn |
+| `current_quarterly_average_eod_balance` | Average end of day balance for the current quarter |
+| `previous_quarterly_average_eod_balance` | Average end of day balance for previous quarter |
+| `end_of_month_balances` | Balances as on the end of the month |
+| `balances_on_10th` | Balances as on the 10th of the month |
+| `balances_on_20th` | Balances as on the 20th of the month |
+| `end_of_day_balances` | End of day balances for everyday of the month |
+| `average_end_of_day_balance` | Average of the end of day balances |
+| `maximum_end_of_day_balance` | Maximum of the end of day balances |
+| `total_credits` | Total number of credits to the user's accounts |
+| `total_credits_value` | Total amount credited to the user's account |
+| `total_debits` | Total number of debits to the user's account |
+| `total_debits_value` | Total amount debited from the user's account |
+| `top_10_credits` | Top 10 credit transactions of the user |
+| `top_10_debits` | Top 10 debit transactions of the user |
+| `quarterly_salary_average` | The 3 month average salary of the user |
+| `semi_yearly_salary_average` | The 6 month average salary of the user |
+| `yearly_salary_average` | The 12 month average salary of the user |
+| `cash_deposit_x_total_credit` | The monthly cash deposit to total credit amount ratio |
+| `cash_withdrawals` | 10 recent cash withdrawals |
+| `inward_cheque_bounce_count` | Total number of inward cheque bounces |
+| `outward_cheque_bounce_count` | Total number of outward cheque bounces |
+| `cheque_bounces` | Summary of cheque bounces |
+| `expenses_monthly_summary` | Detailed classification of the user's monthly expenses |
+| `inflows_monthly_summary` | Detailed classificaiton of the user's monthly incomes |
+
+
diff --git a/content/data/insights/v2/notifications.mdx b/content/data/insights/v2/notifications.mdx
new file mode 100644
index 00000000..c962baf8
--- /dev/null
+++ b/content/data/insights/v2/notifications.mdx
@@ -0,0 +1,42 @@
+---
+sidebar_title: Notifications
+page_title: Setu Insights notifications
+order: 3
+visible_in_sidebar: true
+---
+
+## Notifications
+
+Notifications are webhooks from Setu that provide the data you requested.
+
+The `base_url` is the server URL configured to receive notifications, which is the **Notification endpoint** you shared during template creation step.
+
+
+
+#### Insights generated notification
+
+This notification is used to communicate the generated insights which was requested by you in
+Create Insight Report API.
+
+###### Notification payload
+
+Setu will post this payload to your notification endpoint when Insights report is successfully generated.
+
+
+ {`{
+ "type": "INSIGHT_STATUS_UPDATE",
+ "timestamp": 2018-12-06T11:39:57.153Z,
+ "reportId": "d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
+ "success": true,
+ "data": {
+ "status": "READY",
+ "insights": {
+ // ... insight_name : insight_value
+ },
+ "insight_errors": {}
+ },
+ "error": {}
+}`}
+
+
+
diff --git a/content/data/insights/v2/overview.mdx b/content/data/insights/v2/overview.mdx
new file mode 100644
index 00000000..26491b6a
--- /dev/null
+++ b/content/data/insights/v2/overview.mdx
@@ -0,0 +1,59 @@
+---
+sidebar_title: Overview
+page_title: Setu Insights overview
+order: 0
+visible_in_sidebar: true
+---
+
+## What is Setu Insights?
+
+Setu’s Insight API gives you actionable insights from a customer's bank statement about their income, expenditure and financial history.
+
+The Setu Insights API consumes financial data uploaded via the Account Aggregator(AA) as well as external sources like PDF. The insights generated can be tailor made to fulfill your specific requirements, ranging from underwriting use cases, to personal finance management.
+
+
+ Along with bank statement analysis, Setu Insights will support analysis of
+ various data sources such as GST, ITR, Insurance etc., as and when these data
+ types become available on AA.
+
+
+
+
+
+ Setu Insights provides output in various formats such as XML, JSON, XLS.
+ Output in the form of dashboard will be made available soon.
+
+
+
+
+### What can you do with this product?
+
+With Setu Insights, you can analyse various financial statements like bank statements, GST returns, securities accounts etc. Some possible use-cases include—
+- **Income verification and underwriting**—Verify applicant income and assess creditworthiness by analyzing bank statements. Extract income sources, evaluate financial stability and streamline the loan approval process.
+- **Loan monitoring**—Monitor borrower's financial health and loan obligations. Track cash flow, identify irregularities and manage loan portfolios effectively. Stay proactive with real-time insights into borrower's ability to meet loan obligations and mitigate risks.
+- **Personal finance management and wealth management**—Empower individuals to manage personal finances effectively. Categorise transactions, generate spending reports and gain insights to set financial goals and make informed decisions. For wealth managers, access holistic financial data to offer personalized advice and tailored investment strategies.
+
+
+
+### How does it work?
+
+
+
+1. **Feed data**—Once your customer gives consent to access their financial data, the FIP shares the finance data with you (FIU), via the AA gateway. You feed this data into Setu Insights for analysis. Refer AA docs for a quick explanation of FIU, FIP, AA.
+
+2. **Analyse financial data**—The raw data goes through a categorization model of Setu Insights and gets bucketed into various categories of incomes, expenses etc.
+
+3. **Get reports**—Post analysis, the insights are provided to you in the format of your choice.
+
+
+
+
diff --git a/content/data/insights/v2/quickstart.mdx b/content/data/insights/v2/quickstart.mdx
new file mode 100644
index 00000000..1e49b5e5
--- /dev/null
+++ b/content/data/insights/v2/quickstart.mdx
@@ -0,0 +1,85 @@
+---
+sidebar_title: Quickstart
+page_title: Setu Insights quickstart
+order: 1
+visible_in_sidebar: true
+---
+
+## Quickstart Guide
+
+Here is a quick summary of steps to help you integrate with Setu’s Insights API. Before you start, there are some key terms that will be referred to periodically in the documentation—
+
+- **FI Data block**—FI Data blocks are the data received from the FIP (Financial information provider), via the AA. Currently, we only support bank statement datablock.
+- **Template**—A template is a pre-configured format that determines the structure of the generated report, including which insights to generate. You can pick and choose exactly what insights should be added to a template, based on your needs. For example, if you only want to generate income and expense insights of a customer, the template can contain only those two insights.
+
+
+ Please refer to the Account Aggregator's{" "}
+
+ quickstart guide
+ {" "}
+ for key terms related to AA
+
+
+
+
+
+
+### Step 1—Template creation
+
+You need to send in the below information to [insights@setu.co](mailto:insights@setu.co), for setting up your template.
+
+| | |
+| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **FIU ID** | This can be obtained from your AA integration |
+| **Notification endpoint** | An endpoint where Setu will send you webhook notifications for events. See notifications. |
+| **Template name** | Choose a suitable name, which helps you easily recognise this template |
+| **Insights required** | A list of required Insights. See the full list **here**. |
+| **Output format** | Format in which you need the output — currently only `JSON` is supported
+
+
+Setu will create a template for you and share a `templateID`, which can be used
+in the API calls.
+
+
+
+### Step 2—Feed data
+
+Once you have the financial data of a user, you can feed this data into Setu Insights as a FI Data block. A `dataId` is assigned to to every FI Data block that is created. Refer API integration to integrate with Data ingestion APIs.
+
+
+
+### Step 3—Generate insights
+
+You can generate insights for each FI Data block that is created in the previous step. To generate insights, pass the `templateId` and `dataId` from the previous steps.
+
+An insight report is idenitified by a `reportId` and will be sent to you asynchronously on the notification URL you provide. You can also fetch a generated insight with the `reportId` at any point. Refer API integration to integrate with Insight generation APIs.
+
+
+
+## Test on Postman or integrate APIs
+
+If you are getting started with the integration, we recommend that you familiarise yourself with setting up Postman and configuring **credentials**. If you have already completed this step, you can integrate with the Setu Insights APIs directly.
+
+
+
+
+ ON POSTMAN
+
+ Set up Postman environment ->
+
+
+
+
+
+ FOR API INTEGRATION
+
+ Start API integration ->
+
+
+
+
+
+
diff --git a/content/endpoints.json b/content/endpoints.json
index 63529c4d..08d01f1c 100644
--- a/content/endpoints.json
+++ b/content/endpoints.json
@@ -89,8 +89,8 @@
"name": "Insights",
"path": "insights",
"order": 5,
- "versions": ["v1", "v2"],
- "default_version": "v2",
+ "versions": ["v1", "v2", "v3"],
+ "default_version": "v3",
"visible_in_sidebar": true
},
{
diff --git a/content/menuItems.json b/content/menuItems.json
index 2c4ea670..92ab8ad5 100644
--- a/content/menuItems.json
+++ b/content/menuItems.json
@@ -1 +1 @@
-{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":7},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Remitter Details","visible_in_sidebar":true,"page_title":"Remitter Details For Bill Payments Integration Guide","path":"remittance_flows_guide","order":6},{"name":"Integrating with UPMS","visible_in_sidebar":true,"page_title":"BBPS COU - Integrating with UPMS","path":"upms","order":8},{"name":"Migration Guide to v2","visible_in_sidebar":true,"page_title":"BBPS COU - Migration Guide to v2","path":"v2-migration","order":5},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Prepaid Recharge","visible_in_sidebar":true,"page_title":"BBPS Billpay Prepaid Recharge APIs","path":"mobile-prepaid-recharge","order":3,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge quickstart","path":"quickstart","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":5},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":false,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Remitter Details","visible_in_sidebar":true,"page_title":"Remitter Details For Bill Payments Integration Guide","path":"remitter-details","order":4},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Secure Data Add-On","visible_in_sidebar":true,"page_title":"Setu Encrypted APIs","path":"encryption","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar eSign","path":"esign","order":2,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":9},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":8},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":7},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"PDF templates","visible_in_sidebar":true,"page_title":"Integration guide with pdf templating API's","path":"pdf-templating","order":5},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Pull Driving Licence","visible_in_sidebar":true,"page_title":"Digilocker Quickstart","path":"pulldrivinglicense","order":2},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Multi AA gateway","visible_in_sidebar":true,"page_title":"Account Aggregator multi-AA gateway","path":"multi-aa-gateway","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"Reverse Penny drop","visible_in_sidebar":true,"page_title":"BAV using reverse penny drop","path":"reverse-penny-drop","order":3,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"RPD API integration","path":"api-integration","order":2},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV RPD API reference","path":"api-reference","order":4},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for reverse penny drop","path":"quickstart","order":1},{"name":"Webhook Auth","visible_in_sidebar":true,"page_title":"Webhook Authentication","path":"webhook-authentication","order":3}]}]},{"name":"Insights","path":"insights","order":5,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]},{"path":"v1","children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]}]},{"name":"ULI","path":"uli","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]},{"name":"eKYC","path":"ekyc","order":8,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"eKYC API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":1}]}]},{"name":"Dev tools","path":"dev-tools","order":2,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"Analytics and reports","visible_in_sidebar":true,"page_title":"Bridge analytics and reports","path":"analytics-and-reports","order":3},{"name":"Configure products","visible_in_sidebar":true,"page_title":"Bridge explore and configure products","path":"explore-and-configure-products","order":2},{"name":"Glossary","visible_in_sidebar":true,"page_title":"Bridge glossary","path":"glossary","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Settings","visible_in_sidebar":true,"page_title":"Bridge settings","path":"settings","order":4},{"name":"User profile","visible_in_sidebar":true,"page_title":"Bridge user profile","path":"user-profile","order":5},{"path":"v1","children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]}]},{"name":"Sample Category","path":"sample-category","order":3,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]}
\ No newline at end of file
+{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":7},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Remitter Details","visible_in_sidebar":true,"page_title":"Remitter Details For Bill Payments Integration Guide","path":"remittance_flows_guide","order":6},{"name":"Integrating with UPMS","visible_in_sidebar":true,"page_title":"BBPS COU - Integrating with UPMS","path":"upms","order":8},{"name":"Migration Guide to v2","visible_in_sidebar":true,"page_title":"BBPS COU - Migration Guide to v2","path":"v2-migration","order":5},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Prepaid Recharge","visible_in_sidebar":true,"page_title":"BBPS Billpay Prepaid Recharge APIs","path":"mobile-prepaid-recharge","order":3,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge quickstart","path":"quickstart","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":5},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":false,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Remitter Details","visible_in_sidebar":true,"page_title":"Remitter Details For Bill Payments Integration Guide","path":"remitter-details","order":4},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Secure Data Add-On","visible_in_sidebar":true,"page_title":"Setu Encrypted APIs","path":"encryption","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar eSign","path":"esign","order":2,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":9},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":8},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":7},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"PDF templates","visible_in_sidebar":true,"page_title":"Integration guide with pdf templating API's","path":"pdf-templating","order":5},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Pull Driving Licence","visible_in_sidebar":true,"page_title":"Digilocker Quickstart","path":"pulldrivinglicense","order":2},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Multi AA gateway","visible_in_sidebar":true,"page_title":"Account Aggregator multi-AA gateway","path":"multi-aa-gateway","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"Reverse Penny drop","visible_in_sidebar":true,"page_title":"BAV using reverse penny drop","path":"reverse-penny-drop","order":3,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"RPD API integration","path":"api-integration","order":2},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV RPD API reference","path":"api-reference","order":4},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for reverse penny drop","path":"quickstart","order":1},{"name":"Webhook Auth","visible_in_sidebar":true,"page_title":"Webhook Authentication","path":"webhook-authentication","order":3}]}]},{"name":"Insights","path":"insights","order":5,"versions":["v1","v2","v3"],"default_version":"v3","visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]},{"path":"v1","children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]},{"path":"v2","children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1}]}]},{"name":"ULI","path":"uli","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]},{"name":"eKYC","path":"ekyc","order":8,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"eKYC API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":1}]}]},{"name":"Dev tools","path":"dev-tools","order":2,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"Analytics and reports","visible_in_sidebar":true,"page_title":"Bridge analytics and reports","path":"analytics-and-reports","order":3},{"name":"Configure products","visible_in_sidebar":true,"page_title":"Bridge explore and configure products","path":"explore-and-configure-products","order":2},{"name":"Glossary","visible_in_sidebar":true,"page_title":"Bridge glossary","path":"glossary","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Settings","visible_in_sidebar":true,"page_title":"Bridge settings","path":"settings","order":4},{"name":"User profile","visible_in_sidebar":true,"page_title":"Bridge user profile","path":"user-profile","order":5},{"path":"v1","children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]}]},{"name":"Sample Category","path":"sample-category","order":3,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]}
\ No newline at end of file