From 48d043e3d37dba4b59599e9d285099643e9cb0c2 Mon Sep 17 00:00:00 2001 From: dhruvmisra Date: Tue, 3 Sep 2024 18:07:21 +0530 Subject: [PATCH 1/3] Add transaction-service API reference to DI --- api-references/data/insights.json | 3757 ++++++++++++++++++++--------- 1 file changed, 2631 insertions(+), 1126 deletions(-) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index 290a1af9..a37a0fcc 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -1,1177 +1,2682 @@ { - "openapi": "3.0.2", - "info": { - "title": "Setu Insights", - "description": "Setu’s Insights API gives you actionable insights from a customer's bank statement about their income, expenditure and financial history.", - "version": "0.1.0" + "openapi": "3.0.2", + "info": { + "title": "Setu Insights", + "description": "Setu’s Insights API gives you actionable insights from a customer's bank statement about their income, expenditure and financial history.", + "version": "0.1.0" + }, + "servers": [ + { + "url": "https://di-uat.setu.co/", + "description": "Sandbox" }, - "servers": [ - { - "url": "https://di-uat.setu.co/", - "description": "Sandbox" - }, - { - "url": "https://insights.setu.co/", - "description": "Production" - } - ], - "paths": { - "/v1/fiData": { - "post": { - "tags": ["Data ingestion"], - "summary": "Create FIData block (FIU Webhook)", - "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 in the future.", - "operationId": "create_fi_data_v1_fiData_post", - "parameters": [ - { - "required": false, - "schema": { "title": "Refid", "type": "string" }, - "name": "refId", - "in": "query" - }, - { - "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" - }, - { - "required": true, - "schema": { - "title": "x-product-instance-id", - "type": "string" - }, - "name": "x-product-instance-id", - "in": "header" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "title": "FI Data as defined by ReBIT schema", - "allOf": [ - { "$ref": "#/components/schemas/FIData" } - ] - } - } - }, - "required": true + { + "url": "https://insights.setu.co/", + "description": "Production" + } + ], + "paths": { + "/v1/fiData": { + "post": { + "tags": [ + "Data ingestion" + ], + "summary": "Create FIData block (FIU Webhook)", + "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 in the future.", + "operationId": "create_fi_data_v1_fiData_post", + "parameters": [ + { + "required": false, + "schema": { + "title": "Refid", + "type": "string" + }, + "name": "refId", + "in": "query" + }, + { + "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" + }, + { + "required": true, + "schema": { + "title": "x-product-instance-id", + "type": "string" + }, + "name": "x-product-instance-id", + "in": "header" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "FI Data as defined by ReBIT schema", + "allOf": [ + { + "$ref": "#/components/schemas/FIData" + } + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FIDataBlockCreateResponse" }, - "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" - } - } - } - } - } + "examples": { + "FIDataBlockCreateResponse": { + "summary": "FIDataBlockCreateResponse", + "value": { + "status": "Success", + "body": { + "dataId": "57ee04ae-6540-4ba9-a314-082c9f9cd793", + "fiSchema": "deposit", + "expiryDate": "2023-03-11T06:52:36.457745" + } } + } } + } } - }, - "/v1/insight": { - "get": { - "tags": ["Insight generation"], - "summary": "Get Insights", - "description": "Call this API with the report-id to get the created Insights", - "operationId": "get_insights_v1_insight_get", - "parameters": [ - { - "required": true, - "schema": { - "title": "Report ID for which insights are needed", - "type": "string" - }, - "name": "reportId", - "in": "query" - }, - { - "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" - }, - { - "required": true, - "schema": { - "title": "x-product-instance-id", - "type": "string" - }, - "name": "x-product-instance-id", - "in": "header" - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "title": "Response 200 Get Insights V1 Insight Get", - "anyOf": [ - { - "$ref": "#/components/schemas/ReportJobCreateResponse" - }, - { - "$ref": "#/components/schemas/InsightGetResponse" - } - ] - }, - "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 } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } + }, + "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" } + } } - }, - "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_v1_insight_post", - "parameters": [ - { - "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" - }, - { - "required": true, - "schema": { - "title": "x-product-instance-id", - "type": "string" - }, - "name": "x-product-instance-id", - "in": "header" + } + } + }, + "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" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Body_process_insights_v1_insight_post" - } - } - }, - "required": true + } + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" }, - "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" - } - } - } - } - } - } - }, - "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" - } - } - } - } - } + "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" } + } } + } } + } } + } }, - "components": { - "schemas": { - "Account": { - "title": "Account", - "type": "object", - "properties": { - "profile": { "$ref": "#/components/schemas/Profile" }, - "summary": { "$ref": "#/components/schemas/Summary" }, - "transactions": { - "$ref": "#/components/schemas/Transactions" - }, - "type": { - "title": "Type", - "type": "string", - "default": "deposit" - }, - "maskedAccNumber": { - "title": "Maskedaccnumber", - "type": "string" - }, - "version": { "title": "Version", "type": "number" }, - "linkedAccRef": { - "title": "Linkedaccref", - "type": "string" - } - } - }, - "AccountType": { - "title": "AccountType", - "enum": ["SAVINGS", "CURRENT"], - "type": "string", - "description": "An enumeration." - }, - "Body_process_insights_v1_insight_post": { - "title": "Body_process_insights_v1_insight_post", - "required": ["templateId"], - "type": "object", - "properties": { - "templateId": { - "title": "Template ID for which insights are needed", - "type": "string" - }, - "dataIds": { - "title": "List of data blocks to process", - "type": "array", - "items": { "type": "string" } - }, - "refIds": { - "title": "Refids", - "type": "array", - "items": { "type": "string" } - }, - "linkedAccRefs": { - "title": "Linkedaccrefs", - "type": "array", - "items": { "type": "string" } - } - } - }, - "Body_process_pdf_insights_v1_insight_post": { - "title": "Body_process_pdf_insights_v1_insight_post", - "required": [ - "template_id", - "bankName", - "applicantName", - "dataFile" - ], - "type": "object", - "properties": { - "template_id": { - "title": "Template ID for which insights are needed", - "type": "string" - }, - "bankName": { - "title": "Name of Bank of associated PDF", - "type": "string", - "description": "Bank name is case sensitive and should be in list pf supported banks. Supported banks can be fetched from /pdf/supported_banks" - }, - "applicantName": { - "title": "Name of Account Holder in associated PDF", - "type": "string", - "description": "Can be any place holder string, But it is suggested to provide unique applicant name, to trace references in future in case of repeated usage" - }, - "password": { - "title": "Password for reading associated PDF", - "type": "string", - "description": "The field is Optional, but if the PDF document is password protected, then password should be provided for reading the file." - }, - "dataFile": { - "multipart/form-data": { - "schema": { - "required": ["file", "name"], - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Name of file uploaded" - } - } - } - } - } - } + "/v1/insight": { + "get": { + "tags": [ + "Insight generation" + ], + "summary": "Get Insights", + "description": "Call this API with the report-id to get the created Insights", + "operationId": "get_insights_v1_insight_get", + "parameters": [ + { + "required": true, + "schema": { + "title": "Report ID for which insights are needed", + "type": "string" }, - "DepositData": { - "title": "DepositData", - "required": ["account"], - "type": "object", - "properties": { - "account": { "$ref": "#/components/schemas/Account" } - } + "name": "reportId", + "in": "query" + }, + { + "required": true, + "schema": { + "title": "x-client-id", + "type": "string" }, - "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" - }, - "ver": { "title": "Ver", "type": "string", "default": "1" }, - "txnid": { - "title": "Txnid", - "type": "string", - "default": "" - } - } + "name": "x-client-id", + "in": "header" + }, + { + "required": true, + "schema": { + "title": "x-client-secret", + "type": "string" }, - "FIData": { - "$ref": "#/components/schemas/DepositData", - "title": "FIData" + "name": "x-client-secret", + "in": "header" + }, + { + "required": true, + "schema": { + "title": "x-product-instance-id", + "type": "string" }, - "FIDataBlockCreateResponse": { - "title": "FIDataBlockCreateResponse", - "required": ["body"], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" + "name": "x-product-instance-id", + "in": "header" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "title": "Response 200 Get Insights V1 Insight Get", + "anyOf": [ + { + "$ref": "#/components/schemas/ReportJobCreateResponse" }, - "body": { - "$ref": "#/components/schemas/FIDataBlockResponse" + { + "$ref": "#/components/schemas/InsightGetResponse" } - } - }, - "FIDataBlockGetResponse": { - "title": "FIDataBlockGetResponse", - "required": ["body"], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "title": "Body", - "type": "array", - "items": { - "$ref": "#/components/schemas/FIDataBlockResponse" + ] + }, + "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 + } } + } } + } } - }, - "FIDataBlockResponse": { - "title": "FIDataBlockResponse", - "required": ["dataId", "fiSchema", "expiryDate"], - "type": "object", - "properties": { - "dataId": { - "title": "Dataid", - "type": "string", - "format": "uuid" - }, - "refId": { "type": "string", "title": "Refid" }, - "fiSchema": { "title": "Fischema", "type": "string" }, - "expiryDate": { - "title": "Expirydate", - "type": "string", - "format": "date-time" + } + } + }, + "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" } + } } - }, - "Holder": { - "title": "Holder", - "required": ["nominee", "ckycCompliance"], - "type": "object", - "properties": { - "name": { "title": "Name", "type": "string" }, - "dob": { - "title": "Dob", - "type": "string", - "format": "date" - }, - "mobile": { "title": "Mobile", "type": "integer" }, - "nominee": { - "$ref": "#/components/schemas/HoldingNominee" - }, - "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" + } + } + }, + "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" } + } } - }, - "Holders": { - "title": "Holders", - "required": ["holder", "type"], - "type": "object", - "properties": { - "holder": { - "title": "Holder", - "type": "array", - "items": { "$ref": "#/components/schemas/Holder" } - }, - "type": { "$ref": "#/components/schemas/HoldersType" } - } - }, - "HoldersType": { - "title": "HoldersType", - "enum": ["SINGLE", "JOINT"], - "type": "string", - "description": "An enumeration." - }, - "HoldingNominee": { - "title": "HoldingNominee", - "enum": ["REGISTERED", "NOT-REGISTERED"], - "type": "string", - "description": "An enumeration." - }, - "InsightGetResponse": { - "title": "InsightGetResponse", - "required": ["body"], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { "title": "Body", "type": "object" } - } - }, - "Pending": { - "title": "Pending", - "required": ["amount"], - "type": "object", - "properties": { - "transactionType": { - "$ref": "#/components/schemas/TransactionType" - }, - "amount": { "title": "Amount", "type": "number" } - } - }, - "Profile": { - "title": "Profile", - "type": "object", - "properties": { - "holders": { "$ref": "#/components/schemas/Holders" } - } - }, - "ReportJob": { - "title": "ReportJob", - "required": ["reportId", "status"], - "type": "object", - "properties": { - "reportId": { - "title": "Reportid", - "type": "string", - "format": "uuid" - }, - "status": { "title": "Status", "type": "string" } - } - }, - "ReportJobCreateResponse": { - "title": "ReportJobCreateResponse", - "required": ["body"], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { "$ref": "#/components/schemas/ReportJob" } - } - }, - "StatusTypes": { - "title": "StatusTypes", - "enum": ["ACTIVE", "INACTIVE"], - "type": "string", - "description": "An enumeration." - }, - "Summary": { - "title": "Summary", - "type": "object", - "properties": { - "pending": { "$ref": "#/components/schemas/Pending" }, - "currentBalance": { - "title": "Currentbalance", - "type": "string" - }, - "currency": { "title": "Currency", "type": "string" }, - "exchgeRate": { "title": "Exchgerate", "type": "string" }, - "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", - "type": "string", - "format": "date" - }, - "currentODLimit": { - "title": "Currentodlimit", - "type": "string" - }, - "drawingLimit": { - "title": "Drawinglimit", - "type": "string" - }, - "status": { "$ref": "#/components/schemas/StatusTypes" } - } - }, - "SummaryFacility": { - "title": "SummaryFacility", - "enum": ["OD", "CC"], - "type": "string", - "description": "An enumeration." - }, - "Transaction": { - "title": "Transaction", - "required": [ - "type", - "mode", - "amount", - "currentBalance", - "transactionTimestamp", - "valueDate", - "txnId", - "narration" - ], - "type": "object", - "properties": { - "type": { "$ref": "#/components/schemas/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", - "type": "string", - "format": "date" - }, - "txnId": { "title": "Txnid", "type": "string" }, - "narration": { "title": "Narration", "type": "string" }, - "reference": { "title": "Reference", "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" + } + } } + } + } + } + } + }, + "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_v1_insight_post", + "parameters": [ + { + "required": true, + "schema": { + "title": "x-client-id", + "type": "string" }, - "TransactionMode": { - "title": "TransactionMode", - "enum": ["CASH", "ATM", "CARD", "UPI", "FT", "OTHERS"], - "type": "string", - "description": "An enumeration." + "name": "x-client-id", + "in": "header" + }, + { + "required": true, + "schema": { + "title": "x-client-secret", + "type": "string" }, - "TransactionType": { - "title": "TransactionType", - "enum": ["CREDIT", "DEBIT"], - "type": "string", - "description": "An enumeration." + "name": "x-client-secret", + "in": "header" + }, + { + "required": true, + "schema": { + "title": "x-product-instance-id", + "type": "string" }, - "Transactions": { - "title": "Transactions", - "type": "object", - "properties": { - "transaction": { - "title": "Transaction", - "type": "array", - "items": { "$ref": "#/components/schemas/Transaction" } - }, - "startDate": { - "title": "Startdate", - "type": "string", - "format": "date" - }, - "endDate": { - "title": "Enddate", - "type": "string", - "format": "date" + "name": "x-product-instance-id", + "in": "header" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Body_process_insights_v1_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" + } } + } } - }, - "TransactionGetResponse": { - "title": "TransactionGetResponse", - "required": ["body"], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "$ref": "#/components/schemas/TransactionResponse" + } + } + }, + "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" } + } } - }, - "TransactionResponse": { - "title": "TransactionResponse", - "required": ["totalCount", "transactions"], - "type": "object", - "properties": { - "totalCount": { - "title": "Totalcount", - "type": "integer" - }, - "dataIdStatus": { - "title": "Dataidstatus", - "type": "array", - "items": { - "$ref": "#/components/schemas/TransactionJobStatus" - } - }, - "transactions": { - "title": "Transactions", - "type": "array", - "items": { - "$ref": "#/components/schemas/DepositTransaction" - } + } + } + }, + "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" } + } } - }, - "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": "" + } + } + }, + "404": { + "description": "Not Found Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" }, - "password": { - "type": "string", - "title": "Password for associated PDF", - "default": "" + "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" }, - "dataFile": { - "type": "string", - "format": "binary", - "title": "PDF Bank Statement", - "description": "Upload the pdf-file to process" + "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" }, - "type": "object", - "required": [ - "templateId", - "applicantName", - "dataFile" - ], - "title": "Body_process_pdf_insights_v1_insight_pdf_post" - }, - "TransactionJobStatus": { - "title": "TransactionJobStatus", - "required": ["dataId", "status"], - "type": "object", - "properties": { - "dataId": { - "title": "Dataid", - "type": "string" - }, - "status": { - "title": "Status", - "type": "string" + "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" } + } } - }, - "DepositTransaction": { - "title": "DepositTransaction", - "type": "object", - "properties": { - "fiuId": { - "title": "Fiuid", - "type": "string", - "format": "uuid" - }, - "dataId": { - "title": "Dataid", - "type": "string", - "format": "uuid" - }, - "refId": { - "type": "string", - "title": "Refid" - }, - "linkedAccRef": { - "type": "string", - "title": "Linkedaccref" - }, - "narration": { - "title": "Narration", - "type": "string" - }, - "amount": { - "title": "Amount", - "type": "string" - }, - "currentBalance": { - "title": "Currentbalance", - "type": "string" - }, - "txnMode": { - "title": "Txnmode", - "type": "string" - }, - "reference": { - "title": "Reference", - "type": "string" - }, - "txnId": { - "title": "Txnid", - "type": "string" - }, - "txnType": { - "title": "Txntype", - "type": "string" - }, - "txnValueDate": { - "title": "Txnvaluedate", - "type": "string", - "format": "date" - }, - "txnTimestamp": { - "title": "Txntimestamp", - "type": "string", - "format": "date-time" - }, - "categoryL1": { - "title": "Categoryl1", - "type": "string" - }, - "categoryL2": { - "title": "Categoryl2", - "type": "string" - } - } - }, - "SupportedBanksGetResponse": { - "title": "SupportedBanksGetResponse", - "required": ["body"], + } + } + } + } + } + }, + "/v1/accounts": { + "post": { + "description": "List accounts", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "List accounts" + ], + "summary": "List accounts", + "operationId": "accounts-list", + "parameters": [ + { + "description": "account identifiers and filters", + "name": "params", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/requests.ListAccountsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/responses.ListAccountsResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/responses.Error" + } + } + } + } + }, + "/v1/deposit/transactions": { + "post": { + "description": "List deposit transactions", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "List transactions" + ], + "summary": "List deposit transactions", + "operationId": "list-deposit-transactions", + "parameters": [ + { + "description": "Query details", + "name": "params", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/requests.ListDepositTransactionsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/responses.ListDepositTransactionsResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/responses.Error" + } + } + } + } + }, + "/v1/equities/transactions": { + "post": { + "description": "List equities transactions", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "List transactions" + ], + "summary": "List equities transactions", + "operationId": "list-equities-transactions", + "parameters": [ + { + "description": "Query details", + "name": "params", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/requests.ListEquitiesTransactionsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/responses.ListEquitiesTransactionsResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/responses.Error" + } + } + } + } + }, + "/v1/etf/transactions": { + "post": { + "description": "List ETF transactions", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "List transactions" + ], + "summary": "List ETF transactions", + "operationId": "list-etf-transactions", + "parameters": [ + { + "description": "Query details", + "name": "params", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/requests.ListETFTransactionsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/responses.ListETFTransactionsResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/responses.Error" + } + } + } + } + }, + "/v1/mutual-funds/transactions": { + "post": { + "description": "List mutual-funds transactions", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "List transactions" + ], + "summary": "List mutual-funds transactions", + "operationId": "list-mutual-funds-transactions", + "parameters": [ + { + "description": "Query details", + "name": "params", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/requests.ListMutualFundsTransactionsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/responses.ListMutualFundsTransactionsResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/responses.Error" + } + } + } + } + }, + "/v1/purge": { + "delete": { + "description": "Purge account and transactions data", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Purge" + ], + "summary": "Purge data", + "operationId": "data-purge", + "parameters": [ + { + "description": "purging identifiers", + "name": "params", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/requests.PurgeDataRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/responses.PurgeDataResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/responses.Error" + } + } + } + } + } + }, + "definitions": { + "requests.AccountData": { + "type": "object", + "properties": { + "decryptedFI": { + "$ref": "#/definitions/requests.DecryptedFI" + }, + "linkRefNumber": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "refId": { + "type": "string" + } + } + }, + "requests.DecryptedFI": { + "type": "object", + "properties": { + "account": { + "$ref": "#/definitions/requests.DecryptedFIAccount" + } + } + }, + "requests.DecryptedFIAccount": { + "type": "object", + "properties": { + "linkedAccRef": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "profile": { + "type": "object", + "additionalProperties": true + }, + "summary": { + "type": "object", + "additionalProperties": true + }, + "transactions": { + "$ref": "#/definitions/requests.DecryptedFIAccountTransactions" + }, + "type": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "requests.DecryptedFIAccountTransactions": { + "type": "object", + "properties": { + "endDate": { + "type": "string" + }, + "startDate": { + "type": "string" + }, + "transaction": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + }, + "requests.FIData": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.AccountData" + } + }, + "fipID": { + "type": "string" + } + } + }, + "requests.Identifiers": { + "type": "object", + "properties": { + "consentIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "linkAccRefs": { + "type": "array", + "items": { + "type": "string" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "requests.IngestFIDataRequest": { + "type": "object", + "properties": { + "consentId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "fiData": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.FIData" + } + }, + "refId": { + "type": "string" + } + } + }, + "requests.ListAccountRequestFilters": { + "type": "object", + "properties": { + "fiTypes": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "requests.ListAccountsRequest": { + "type": "object", + "properties": { + "filters": { + "$ref": "#/definitions/requests.ListAccountRequestFilters" + }, + "identifiers": { + "$ref": "#/definitions/requests.Identifiers" + } + } + }, + "requests.ListDepositTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + } + }, + "requests.ListDepositTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "orderBy": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListDepositTransactionsOrderBy" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "where": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListDepositTransactionsWhere" + } + } + } + }, + "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" + } + } + }, + "requests.ListETFTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + } + }, + "requests.ListETFTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "orderBy": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListETFTransactionsOrderBy" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "where": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListETFTransactionsWhere" + } + } + } + }, + "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" + } + } + }, + "requests.ListEquitiesTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + } + }, + "requests.ListEquitiesTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "orderBy": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListEquitiesTransactionsOrderBy" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "where": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListEquitiesTransactionsWhere" + } + } + } + }, + "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" + } + } + }, + "requests.ListMutualFundsTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + } + }, + "requests.ListMutualFundsTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "orderBy": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListMutualFundsTransactionsOrderBy" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "where": { + "type": "array", + "items": { + "$ref": "#/definitions/requests.ListMutualFundsTransactionsWhere" + } + } + } + }, + "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" + } + } + }, + "requests.PurgeDataRequest": { + "type": "object", + "properties": { + "identifiers": { + "$ref": "#/definitions/requests.Identifiers" + } + } + }, + "responses.Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "responses.FIDataResponseData": { + "type": "object", + "properties": { + "fipId": { + "type": "string" + }, + "profileStatus": { + "type": "string" + }, + "summaryStatus": { + "type": "string" + }, + "transactions": { + "$ref": "#/definitions/responses.TransactionsResponseData" + } + } + }, + "responses.ListAccountsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/responses.ListAccountsResponseData" + } + }, + "totalCount": { + "type": "integer" + } + } + }, + "responses.ListAccountsResponseData": { + "type": "object", + "properties": { + "consentId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "fiType": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "profile": { + "type": "object", + "additionalProperties": true + }, + "refId": { + "type": "string" + }, + "summary": { + "type": "object", + "additionalProperties": true + }, + "txnsEndDate": { + "type": "string" + }, + "txnsStartDate": { + "type": "string" + } + } + }, + "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" + } + } + }, + "responses.ListDepositTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/responses.ListDepositTransactionsData" + } + }, + "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" + } + } + }, + "responses.ListETFTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/responses.ListETFTransactionsData" + } + }, + "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" + } + } + }, + "responses.ListEquitiesTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/responses.ListEquitiesTransactionsData" + } + }, + "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.ListMutualFundsTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/responses.ListMutualFundsTransactionsData" + } + }, + "totalCount": { + "type": "integer" + } + } + }, + "responses.PurgeDataResponse": { + "type": "object", + "properties": { + "purgedCounts": { + "$ref": "#/definitions/responses.PurgeDataResponseCounts" + } + } + }, + "responses.PurgeDataResponseCounts": { + "type": "object", + "properties": { + "accounts": { + "type": "integer" + }, + "depositTransactions": { + "type": "integer" + }, + "equitiesTransactions": { + "type": "integer" + }, + "etfTransactions": { + "type": "integer" + }, + "mutualFundsTransactions": { + "type": "integer" + } + } + }, + "responses.TransactionsResponseData": { + "type": "object", + "properties": { + "insertedCount": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "updatedCount": { + "type": "integer" + } + } + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "components": { + "schemas": { + "Account": { + "title": "Account", + "type": "object", + "properties": { + "profile": { + "$ref": "#/components/schemas/Profile" + }, + "summary": { + "$ref": "#/components/schemas/Summary" + }, + "transactions": { + "$ref": "#/components/schemas/Transactions" + }, + "type": { + "title": "Type", + "type": "string", + "default": "deposit" + }, + "maskedAccNumber": { + "title": "Maskedaccnumber", + "type": "string" + }, + "version": { + "title": "Version", + "type": "number" + }, + "linkedAccRef": { + "title": "Linkedaccref", + "type": "string" + } + } + }, + "AccountType": { + "title": "AccountType", + "enum": [ + "SAVINGS", + "CURRENT" + ], + "type": "string", + "description": "An enumeration." + }, + "Body_process_insights_v1_insight_post": { + "title": "Body_process_insights_v1_insight_post", + "required": [ + "templateId" + ], + "type": "object", + "properties": { + "templateId": { + "title": "Template ID for which insights are needed", + "type": "string" + }, + "dataIds": { + "title": "List of data blocks to process", + "type": "array", + "items": { + "type": "string" + } + }, + "refIds": { + "title": "Refids", + "type": "array", + "items": { + "type": "string" + } + }, + "linkedAccRefs": { + "title": "Linkedaccrefs", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Body_process_pdf_insights_v1_insight_post": { + "title": "Body_process_pdf_insights_v1_insight_post", + "required": [ + "template_id", + "bankName", + "applicantName", + "dataFile" + ], + "type": "object", + "properties": { + "template_id": { + "title": "Template ID for which insights are needed", + "type": "string" + }, + "bankName": { + "title": "Name of Bank of associated PDF", + "type": "string", + "description": "Bank name is case sensitive and should be in list pf supported banks. Supported banks can be fetched from /pdf/supported_banks" + }, + "applicantName": { + "title": "Name of Account Holder in associated PDF", + "type": "string", + "description": "Can be any place holder string, But it is suggested to provide unique applicant name, to trace references in future in case of repeated usage" + }, + "password": { + "title": "Password for reading associated PDF", + "type": "string", + "description": "The field is Optional, but if the PDF document is password protected, then password should be provided for reading the file." + }, + "dataFile": { + "multipart/form-data": { + "schema": { + "required": [ + "file", + "name" + ], "type": "object", "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "title": "Body", - "type": "array", - "items": { - "type": "string" - } - } + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string", + "description": "Name of file uploaded" + } } + } + } + } + } + }, + "DepositData": { + "title": "DepositData", + "required": [ + "account" + ], + "type": "object", + "properties": { + "account": { + "$ref": "#/components/schemas/Account" + } + } + }, + "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" + }, + "ver": { + "title": "Ver", + "type": "string", + "default": "1" + }, + "txnid": { + "title": "Txnid", + "type": "string", + "default": "" + } + } + }, + "FIData": { + "$ref": "#/components/schemas/DepositData", + "title": "FIData" + }, + "FIDataBlockCreateResponse": { + "title": "FIDataBlockCreateResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "$ref": "#/components/schemas/FIDataBlockResponse" + } + } + }, + "FIDataBlockGetResponse": { + "title": "FIDataBlockGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "title": "Body", + "type": "array", + "items": { + "$ref": "#/components/schemas/FIDataBlockResponse" + } + } + } + }, + "FIDataBlockResponse": { + "title": "FIDataBlockResponse", + "required": [ + "dataId", + "fiSchema", + "expiryDate" + ], + "type": "object", + "properties": { + "dataId": { + "title": "Dataid", + "type": "string", + "format": "uuid" + }, + "refId": { + "type": "string", + "title": "Refid" + }, + "fiSchema": { + "title": "Fischema", + "type": "string" + }, + "expiryDate": { + "title": "Expirydate", + "type": "string", + "format": "date-time" + } + } + }, + "Holder": { + "title": "Holder", + "required": [ + "nominee", + "ckycCompliance" + ], + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "dob": { + "title": "Dob", + "type": "string", + "format": "date" + }, + "mobile": { + "title": "Mobile", + "type": "integer" + }, + "nominee": { + "$ref": "#/components/schemas/HoldingNominee" + }, + "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" + } + } + }, + "Holders": { + "title": "Holders", + "required": [ + "holder", + "type" + ], + "type": "object", + "properties": { + "holder": { + "title": "Holder", + "type": "array", + "items": { + "$ref": "#/components/schemas/Holder" + } + }, + "type": { + "$ref": "#/components/schemas/HoldersType" + } + } + }, + "HoldersType": { + "title": "HoldersType", + "enum": [ + "SINGLE", + "JOINT" + ], + "type": "string", + "description": "An enumeration." + }, + "HoldingNominee": { + "title": "HoldingNominee", + "enum": [ + "REGISTERED", + "NOT-REGISTERED" + ], + "type": "string", + "description": "An enumeration." + }, + "InsightGetResponse": { + "title": "InsightGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "title": "Body", + "type": "object" + } + } + }, + "Pending": { + "title": "Pending", + "required": [ + "amount" + ], + "type": "object", + "properties": { + "transactionType": { + "$ref": "#/components/schemas/TransactionType" + }, + "amount": { + "title": "Amount", + "type": "number" + } + } + }, + "Profile": { + "title": "Profile", + "type": "object", + "properties": { + "holders": { + "$ref": "#/components/schemas/Holders" + } + } + }, + "ReportJob": { + "title": "ReportJob", + "required": [ + "reportId", + "status" + ], + "type": "object", + "properties": { + "reportId": { + "title": "Reportid", + "type": "string", + "format": "uuid" + }, + "status": { + "title": "Status", + "type": "string" + } + } + }, + "ReportJobCreateResponse": { + "title": "ReportJobCreateResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "$ref": "#/components/schemas/ReportJob" + } + } + }, + "StatusTypes": { + "title": "StatusTypes", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string", + "description": "An enumeration." + }, + "Summary": { + "title": "Summary", + "type": "object", + "properties": { + "pending": { + "$ref": "#/components/schemas/Pending" + }, + "currentBalance": { + "title": "Currentbalance", + "type": "string" + }, + "currency": { + "title": "Currency", + "type": "string" + }, + "exchgeRate": { + "title": "Exchgerate", + "type": "string" + }, + "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", + "type": "string", + "format": "date" + }, + "currentODLimit": { + "title": "Currentodlimit", + "type": "string" + }, + "drawingLimit": { + "title": "Drawinglimit", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/StatusTypes" + } + } + }, + "SummaryFacility": { + "title": "SummaryFacility", + "enum": [ + "OD", + "CC" + ], + "type": "string", + "description": "An enumeration." + }, + "Transaction": { + "title": "Transaction", + "required": [ + "type", + "mode", + "amount", + "currentBalance", + "transactionTimestamp", + "valueDate", + "txnId", + "narration" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/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", + "type": "string", + "format": "date" + }, + "txnId": { + "title": "Txnid", + "type": "string" + }, + "narration": { + "title": "Narration", + "type": "string" + }, + "reference": { + "title": "Reference", + "type": "string" + } + } + }, + "TransactionMode": { + "title": "TransactionMode", + "enum": [ + "CASH", + "ATM", + "CARD", + "UPI", + "FT", + "OTHERS" + ], + "type": "string", + "description": "An enumeration." + }, + "TransactionType": { + "title": "TransactionType", + "enum": [ + "CREDIT", + "DEBIT" + ], + "type": "string", + "description": "An enumeration." + }, + "Transactions": { + "title": "Transactions", + "type": "object", + "properties": { + "transaction": { + "title": "Transaction", + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + } + }, + "startDate": { + "title": "Startdate", + "type": "string", + "format": "date" + }, + "endDate": { + "title": "Enddate", + "type": "string", + "format": "date" + } + } + }, + "TransactionGetResponse": { + "title": "TransactionGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + }, + "TransactionResponse": { + "title": "TransactionResponse", + "required": [ + "totalCount", + "transactions" + ], + "type": "object", + "properties": { + "totalCount": { + "title": "Totalcount", + "type": "integer" + }, + "dataIdStatus": { + "title": "Dataidstatus", + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionJobStatus" + } + }, + "transactions": { + "title": "Transactions", + "type": "array", + "items": { + "$ref": "#/components/schemas/DepositTransaction" + } + } + } + }, + "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" + }, + "TransactionJobStatus": { + "title": "TransactionJobStatus", + "required": [ + "dataId", + "status" + ], + "type": "object", + "properties": { + "dataId": { + "title": "Dataid", + "type": "string" + }, + "status": { + "title": "Status", + "type": "string" + } + } + }, + "DepositTransaction": { + "title": "DepositTransaction", + "type": "object", + "properties": { + "fiuId": { + "title": "Fiuid", + "type": "string", + "format": "uuid" + }, + "dataId": { + "title": "Dataid", + "type": "string", + "format": "uuid" + }, + "refId": { + "type": "string", + "title": "Refid" + }, + "linkedAccRef": { + "type": "string", + "title": "Linkedaccref" + }, + "narration": { + "title": "Narration", + "type": "string" + }, + "amount": { + "title": "Amount", + "type": "string" + }, + "currentBalance": { + "title": "Currentbalance", + "type": "string" + }, + "txnMode": { + "title": "Txnmode", + "type": "string" + }, + "reference": { + "title": "Reference", + "type": "string" + }, + "txnId": { + "title": "Txnid", + "type": "string" + }, + "txnType": { + "title": "Txntype", + "type": "string" + }, + "txnValueDate": { + "title": "Txnvaluedate", + "type": "string", + "format": "date" + }, + "txnTimestamp": { + "title": "Txntimestamp", + "type": "string", + "format": "date-time" + }, + "categoryL1": { + "title": "Categoryl1", + "type": "string" + }, + "categoryL2": { + "title": "Categoryl2", + "type": "string" + } + } + }, + "SupportedBanksGetResponse": { + "title": "SupportedBanksGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "title": "Body", + "type": "array", + "items": { + "type": "string" } + } } + } } + } } + From 7cdd55dd1816911ebe80112d8046d54b7467625b Mon Sep 17 00:00:00 2001 From: dhruvmisra Date: Wed, 4 Sep 2024 10:41:13 +0530 Subject: [PATCH 2/3] Remove definitions in favour of existing schema block --- api-references/data/insights.json | 3043 ++++++++++++++--------------- 1 file changed, 1517 insertions(+), 1526 deletions(-) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index a37a0fcc..ce8844cb 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -584,7 +584,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/requests.ListAccountsRequest" + "$ref": "#/components/schemas/requests.ListAccountsRequest" } } ], @@ -592,13 +592,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/responses.ListAccountsResponse" + "$ref": "#/components/schemas/responses.ListAccountsResponse" } }, "400": { "description": "Bad Request", "schema": { - "$ref": "#/definitions/responses.Error" + "$ref": "#/components/schemas/responses.Error" } } } @@ -625,7 +625,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/requests.ListDepositTransactionsRequest" + "$ref": "#/components/schemas/requests.ListDepositTransactionsRequest" } } ], @@ -633,13 +633,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/responses.ListDepositTransactionsResponse" + "$ref": "#/components/schemas/responses.ListDepositTransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { - "$ref": "#/definitions/responses.Error" + "$ref": "#/components/schemas/responses.Error" } } } @@ -666,7 +666,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/requests.ListEquitiesTransactionsRequest" + "$ref": "#/components/schemas/requests.ListEquitiesTransactionsRequest" } } ], @@ -674,13 +674,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/responses.ListEquitiesTransactionsResponse" + "$ref": "#/components/schemas/responses.ListEquitiesTransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { - "$ref": "#/definitions/responses.Error" + "$ref": "#/components/schemas/responses.Error" } } } @@ -707,7 +707,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/requests.ListETFTransactionsRequest" + "$ref": "#/components/schemas/requests.ListETFTransactionsRequest" } } ], @@ -715,13 +715,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/responses.ListETFTransactionsResponse" + "$ref": "#/components/schemas/responses.ListETFTransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { - "$ref": "#/definitions/responses.Error" + "$ref": "#/components/schemas/responses.Error" } } } @@ -748,7 +748,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/requests.ListMutualFundsTransactionsRequest" + "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsRequest" } } ], @@ -756,13 +756,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/responses.ListMutualFundsTransactionsResponse" + "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { - "$ref": "#/definitions/responses.Error" + "$ref": "#/components/schemas/responses.Error" } } } @@ -789,7 +789,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/requests.PurgeDataRequest" + "$ref": "#/components/schemas/requests.PurgeDataRequest" } } ], @@ -797,746 +797,1063 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/responses.PurgeDataResponse" + "$ref": "#/components/schemas/responses.PurgeDataResponse" } }, "400": { "description": "Bad Request", "schema": { - "$ref": "#/definitions/responses.Error" + "$ref": "#/components/schemas/responses.Error" } } } } } }, - "definitions": { - "requests.AccountData": { - "type": "object", - "properties": { - "decryptedFI": { - "$ref": "#/definitions/requests.DecryptedFI" - }, - "linkRefNumber": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "refId": { - "type": "string" - } - } - }, - "requests.DecryptedFI": { - "type": "object", - "properties": { - "account": { - "$ref": "#/definitions/requests.DecryptedFIAccount" - } - } - }, - "requests.DecryptedFIAccount": { - "type": "object", - "properties": { - "linkedAccRef": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "profile": { - "type": "object", - "additionalProperties": true - }, - "summary": { - "type": "object", - "additionalProperties": true - }, - "transactions": { - "$ref": "#/definitions/requests.DecryptedFIAccountTransactions" - }, - "type": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "requests.DecryptedFIAccountTransactions": { - "type": "object", - "properties": { - "endDate": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "transaction": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - }, - "requests.FIData": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.AccountData" - } - }, - "fipID": { - "type": "string" - } - } - }, - "requests.Identifiers": { - "type": "object", - "properties": { - "consentIds": { - "type": "array", - "items": { + "components": { + "schemas": { + "Account": { + "title": "Account", + "type": "object", + "properties": { + "profile": { + "$ref": "#/components/schemas/Profile" + }, + "summary": { + "$ref": "#/components/schemas/Summary" + }, + "transactions": { + "$ref": "#/components/schemas/Transactions" + }, + "type": { + "title": "Type", + "type": "string", + "default": "deposit" + }, + "maskedAccNumber": { + "title": "Maskedaccnumber", "type": "string" - } - }, - "linkAccRefs": { - "type": "array", - "items": { + }, + "version": { + "title": "Version", + "type": "number" + }, + "linkedAccRef": { + "title": "Linkedaccref", "type": "string" } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "AccountType": { + "title": "AccountType", + "enum": [ + "SAVINGS", + "CURRENT" + ], + "type": "string", + "description": "An enumeration." + }, + "Body_process_insights_v1_insight_post": { + "title": "Body_process_insights_v1_insight_post", + "required": [ + "templateId" + ], + "type": "object", + "properties": { + "templateId": { + "title": "Template ID for which insights are needed", "type": "string" + }, + "dataIds": { + "title": "List of data blocks to process", + "type": "array", + "items": { + "type": "string" + } + }, + "refIds": { + "title": "Refids", + "type": "array", + "items": { + "type": "string" + } + }, + "linkedAccRefs": { + "title": "Linkedaccrefs", + "type": "array", + "items": { + "type": "string" + } } } - } - }, - "requests.IngestFIDataRequest": { - "type": "object", - "properties": { - "consentId": { - "type": "string" - }, - "dataId": { - "type": "string" - }, - "fiData": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.FIData" + }, + "Body_process_pdf_insights_v1_insight_post": { + "title": "Body_process_pdf_insights_v1_insight_post", + "required": [ + "template_id", + "bankName", + "applicantName", + "dataFile" + ], + "type": "object", + "properties": { + "template_id": { + "title": "Template ID for which insights are needed", + "type": "string" + }, + "bankName": { + "title": "Name of Bank of associated PDF", + "type": "string", + "description": "Bank name is case sensitive and should be in list pf supported banks. Supported banks can be fetched from /pdf/supported_banks" + }, + "applicantName": { + "title": "Name of Account Holder in associated PDF", + "type": "string", + "description": "Can be any place holder string, But it is suggested to provide unique applicant name, to trace references in future in case of repeated usage" + }, + "password": { + "title": "Password for reading associated PDF", + "type": "string", + "description": "The field is Optional, but if the PDF document is password protected, then password should be provided for reading the file." + }, + "dataFile": { + "multipart/form-data": { + "schema": { + "required": [ + "file", + "name" + ], + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string", + "description": "Name of file uploaded" + } + } + } + } } - }, - "refId": { - "type": "string" } - } - }, - "requests.ListAccountRequestFilters": { - "type": "object", - "properties": { - "fiTypes": { - "type": "array", - "items": { - "type": "string" + }, + "DepositData": { + "title": "DepositData", + "required": [ + "account" + ], + "type": "object", + "properties": { + "account": { + "$ref": "#/components/schemas/Account" } } - } - }, - "requests.ListAccountsRequest": { - "type": "object", - "properties": { - "filters": { - "$ref": "#/definitions/requests.ListAccountRequestFilters" - }, - "identifiers": { - "$ref": "#/definitions/requests.Identifiers" - } - } - }, - "requests.ListDepositTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" - } - } - }, - "requests.ListDepositTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListDepositTransactionsOrderBy" - } - }, - "refIds": { - "type": "array", - "items": { + }, + "ErrorResponse": { + "title": "ErrorResponse", + "required": [ + "errorCode", + "errorMsg" + ], + "type": "object", + "properties": { + "errorCode": { + "title": "Errorcode", "type": "string" - } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListDepositTransactionsWhere" - } - } - } - }, - "requests.ListDepositTransactionsWhere": { - "type": "object", - "properties": { - "amount": { - "type": "number" - }, - "amount_gte": { - "type": "number" - }, - "amount_lte": { - "type": "number" - }, - "categoryL1": { - "type": "string" - }, - "categoryL1_list": { - "type": "array", - "items": { + }, + "errorMsg": { + "title": "Errormsg", "type": "string" + }, + "timestamp": { + "title": "Timestamp", + "type": "string", + "format": "date-time" + }, + "ver": { + "title": "Ver", + "type": "string", + "default": "1" + }, + "txnid": { + "title": "Txnid", + "type": "string", + "default": "" } - }, - "categoryL2": { - "type": "string" - }, - "categoryL2_list": { - "type": "array", - "items": { + } + }, + "FIData": { + "$ref": "#/components/schemas/DepositData", + "title": "FIData" + }, + "FIDataBlockCreateResponse": { + "title": "FIDataBlockCreateResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", "type": "string" + }, + "body": { + "$ref": "#/components/schemas/FIDataBlockResponse" } - }, - "categoryManual": { - "type": "string" - }, - "categoryManual_list": { - "type": "array", - "items": { + } + }, + "FIDataBlockGetResponse": { + "title": "FIDataBlockGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", "type": "string" + }, + "body": { + "title": "Body", + "type": "array", + "items": { + "$ref": "#/components/schemas/FIDataBlockResponse" + } } - }, - "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" - } - } - }, - "requests.ListETFTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" } - } - }, - "requests.ListETFTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListETFTransactionsOrderBy" - } - }, - "refIds": { - "type": "array", - "items": { + }, + "FIDataBlockResponse": { + "title": "FIDataBlockResponse", + "required": [ + "dataId", + "fiSchema", + "expiryDate" + ], + "type": "object", + "properties": { + "dataId": { + "title": "Dataid", + "type": "string", + "format": "uuid" + }, + "refId": { + "type": "string", + "title": "Refid" + }, + "fiSchema": { + "title": "Fischema", "type": "string" - } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListETFTransactionsWhere" + }, + "expiryDate": { + "title": "Expirydate", + "type": "string", + "format": "date-time" } } - } - }, - "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" + }, + "Holder": { + "title": "Holder", + "required": [ + "nominee", + "ckycCompliance" + ], + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "dob": { + "title": "Dob", + "type": "string", + "format": "date" + }, + "mobile": { + "title": "Mobile", + "type": "integer" + }, + "nominee": { + "$ref": "#/components/schemas/HoldingNominee" + }, + "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" + } } - } - }, - "requests.ListEquitiesTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" + }, + "Holders": { + "title": "Holders", + "required": [ + "holder", + "type" + ], + "type": "object", + "properties": { + "holder": { + "title": "Holder", + "type": "array", + "items": { + "$ref": "#/components/schemas/Holder" + } + }, + "type": { + "$ref": "#/components/schemas/HoldersType" + } } - } - }, - "requests.ListEquitiesTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListEquitiesTransactionsOrderBy" + }, + "HoldersType": { + "title": "HoldersType", + "enum": [ + "SINGLE", + "JOINT" + ], + "type": "string", + "description": "An enumeration." + }, + "HoldingNominee": { + "title": "HoldingNominee", + "enum": [ + "REGISTERED", + "NOT-REGISTERED" + ], + "type": "string", + "description": "An enumeration." + }, + "InsightGetResponse": { + "title": "InsightGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "title": "Body", + "type": "object" } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "Pending": { + "title": "Pending", + "required": [ + "amount" + ], + "type": "object", + "properties": { + "transactionType": { + "$ref": "#/components/schemas/TransactionType" + }, + "amount": { + "title": "Amount", + "type": "number" + } + } + }, + "Profile": { + "title": "Profile", + "type": "object", + "properties": { + "holders": { + "$ref": "#/components/schemas/Holders" + } + } + }, + "ReportJob": { + "title": "ReportJob", + "required": [ + "reportId", + "status" + ], + "type": "object", + "properties": { + "reportId": { + "title": "Reportid", + "type": "string", + "format": "uuid" + }, + "status": { + "title": "Status", "type": "string" } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListEquitiesTransactionsWhere" + } + }, + "ReportJobCreateResponse": { + "title": "ReportJobCreateResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "$ref": "#/components/schemas/ReportJob" } } - } - }, - "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" - } - } - }, - "requests.ListMutualFundsTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" - } - } - }, - "requests.ListMutualFundsTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListMutualFundsTransactionsOrderBy" + }, + "StatusTypes": { + "title": "StatusTypes", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string", + "description": "An enumeration." + }, + "Summary": { + "title": "Summary", + "type": "object", + "properties": { + "pending": { + "$ref": "#/components/schemas/Pending" + }, + "currentBalance": { + "title": "Currentbalance", + "type": "string" + }, + "currency": { + "title": "Currency", + "type": "string" + }, + "exchgeRate": { + "title": "Exchgerate", + "type": "string" + }, + "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", + "type": "string", + "format": "date" + }, + "currentODLimit": { + "title": "Currentodlimit", + "type": "string" + }, + "drawingLimit": { + "title": "Drawinglimit", + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/StatusTypes" } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "SummaryFacility": { + "title": "SummaryFacility", + "enum": [ + "OD", + "CC" + ], + "type": "string", + "description": "An enumeration." + }, + "Transaction": { + "title": "Transaction", + "required": [ + "type", + "mode", + "amount", + "currentBalance", + "transactionTimestamp", + "valueDate", + "txnId", + "narration" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/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", + "type": "string", + "format": "date" + }, + "txnId": { + "title": "Txnid", + "type": "string" + }, + "narration": { + "title": "Narration", + "type": "string" + }, + "reference": { + "title": "Reference", "type": "string" } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/definitions/requests.ListMutualFundsTransactionsWhere" + } + }, + "TransactionMode": { + "title": "TransactionMode", + "enum": [ + "CASH", + "ATM", + "CARD", + "UPI", + "FT", + "OTHERS" + ], + "type": "string", + "description": "An enumeration." + }, + "TransactionType": { + "title": "TransactionType", + "enum": [ + "CREDIT", + "DEBIT" + ], + "type": "string", + "description": "An enumeration." + }, + "Transactions": { + "title": "Transactions", + "type": "object", + "properties": { + "transaction": { + "title": "Transaction", + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + } + }, + "startDate": { + "title": "Startdate", + "type": "string", + "format": "date" + }, + "endDate": { + "title": "Enddate", + "type": "string", + "format": "date" } } - } - }, - "requests.ListMutualFundsTransactionsWhere": { + }, + "TransactionGetResponse": { + "title": "TransactionGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + }, + "TransactionResponse": { + "title": "TransactionResponse", + "required": [ + "totalCount", + "transactions" + ], + "type": "object", + "properties": { + "totalCount": { + "title": "Totalcount", + "type": "integer" + }, + "dataIdStatus": { + "title": "Dataidstatus", + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionJobStatus" + } + }, + "transactions": { + "title": "Transactions", + "type": "array", + "items": { + "$ref": "#/components/schemas/DepositTransaction" + } + } + } + }, + "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" + }, + "TransactionJobStatus": { + "title": "TransactionJobStatus", + "required": [ + "dataId", + "status" + ], + "type": "object", + "properties": { + "dataId": { + "title": "Dataid", + "type": "string" + }, + "status": { + "title": "Status", + "type": "string" + } + } + }, + "DepositTransaction": { + "title": "DepositTransaction", + "type": "object", + "properties": { + "fiuId": { + "title": "Fiuid", + "type": "string", + "format": "uuid" + }, + "dataId": { + "title": "Dataid", + "type": "string", + "format": "uuid" + }, + "refId": { + "type": "string", + "title": "Refid" + }, + "linkedAccRef": { + "type": "string", + "title": "Linkedaccref" + }, + "narration": { + "title": "Narration", + "type": "string" + }, + "amount": { + "title": "Amount", + "type": "string" + }, + "currentBalance": { + "title": "Currentbalance", + "type": "string" + }, + "txnMode": { + "title": "Txnmode", + "type": "string" + }, + "reference": { + "title": "Reference", + "type": "string" + }, + "txnId": { + "title": "Txnid", + "type": "string" + }, + "txnType": { + "title": "Txntype", + "type": "string" + }, + "txnValueDate": { + "title": "Txnvaluedate", + "type": "string", + "format": "date" + }, + "txnTimestamp": { + "title": "Txntimestamp", + "type": "string", + "format": "date-time" + }, + "categoryL1": { + "title": "Categoryl1", + "type": "string" + }, + "categoryL2": { + "title": "Categoryl2", + "type": "string" + } + } + }, + "SupportedBanksGetResponse": { + "title": "SupportedBanksGetResponse", + "required": [ + "body" + ], + "type": "object", + "properties": { + "status": { + "title": "Status", + "type": "string", + "default": "Success" + }, + "statusDescription": { + "title": "Statusdescription", + "type": "string" + }, + "body": { + "title": "Body", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "requests.AccountData": { "type": "object", "properties": { - "amc": { + "decryptedFI": { + "$ref": "#/components/schemas/requests.DecryptedFI" + }, + "linkRefNumber": { "type": "string" }, - "amcFullName": { + "maskedAccNumber": { "type": "string" }, - "amfiCode": { + "refId": { + "type": "string" + } + } + }, + "requests.DecryptedFI": { + "type": "object", + "properties": { + "account": { + "$ref": "#/components/schemas/requests.DecryptedFIAccount" + } + } + }, + "requests.DecryptedFIAccount": { + "type": "object", + "properties": { + "linkedAccRef": { "type": "string" }, - "amount": { - "type": "number" + "maskedAccNumber": { + "type": "string" }, - "amount_gte": { - "type": "number" + "profile": { + "type": "object", + "additionalProperties": true }, - "amount_lte": { - "type": "number" + "summary": { + "type": "object", + "additionalProperties": true }, - "isin": { - "type": "string" + "transactions": { + "$ref": "#/components/schemas/requests.DecryptedFIAccountTransactions" }, - "isinDescription": { + "type": { "type": "string" }, - "lockInDays": { + "version": { "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": { + } + } + }, + "requests.DecryptedFIAccountTransactions": { + "type": "object", + "properties": { + "endDate": { "type": "string" }, - "ucc": { + "startDate": { "type": "string" }, - "units": { - "type": "number" - }, - "units_gte": { - "type": "number" - }, - "units_lte": { - "type": "number" + "transaction": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } } } }, - "requests.PurgeDataRequest": { + "requests.FIData": { "type": "object", "properties": { - "identifiers": { - "$ref": "#/definitions/requests.Identifiers" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.AccountData" + } + }, + "fipID": { + "type": "string" } } }, - "responses.Error": { + "requests.Identifiers": { "type": "object", "properties": { - "message": { - "type": "string" + "consentIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "linkAccRefs": { + "type": "array", + "items": { + "type": "string" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } } } }, - "responses.FIDataResponseData": { + "requests.IngestFIDataRequest": { "type": "object", "properties": { - "fipId": { + "consentId": { "type": "string" }, - "profileStatus": { + "dataId": { "type": "string" }, - "summaryStatus": { - "type": "string" + "fiData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.FIData" + } }, - "transactions": { - "$ref": "#/definitions/responses.TransactionsResponseData" + "refId": { + "type": "string" } } }, - "responses.ListAccountsResponse": { + "requests.ListAccountRequestFilters": { "type": "object", "properties": { - "data": { + "fiTypes": { "type": "array", "items": { - "$ref": "#/definitions/responses.ListAccountsResponseData" + "type": "string" } - }, - "totalCount": { - "type": "integer" } } }, - "responses.ListAccountsResponseData": { + "requests.ListAccountsRequest": { "type": "object", "properties": { - "consentId": { - "type": "string" - }, - "dataId": { - "type": "string" - }, - "fiType": { - "type": "string" - }, - "fipId": { - "type": "string" - }, - "id": { - "type": "string" + "filters": { + "$ref": "#/components/schemas/requests.ListAccountRequestFilters" }, - "linkedAccRef": { + "identifiers": { + "$ref": "#/components/schemas/requests.Identifiers" + } + } + }, + "requests.ListDepositTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { "type": "string" }, - "maskedAccNumber": { + "order": { "type": "string" + } + } + }, + "requests.ListDepositTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" }, - "profile": { - "type": "object", - "additionalProperties": true - }, - "refId": { - "type": "string" + "offset": { + "type": "integer" }, - "summary": { - "type": "object", - "additionalProperties": true + "orderBy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.ListDepositTransactionsOrderBy" + } }, - "txnsEndDate": { - "type": "string" + "refIds": { + "type": "array", + "items": { + "type": "string" + } }, - "txnsStartDate": { - "type": "string" + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.ListDepositTransactionsWhere" + } } } }, - "responses.ListDepositTransactionsData": { + "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" }, - "consentId": { - "type": "string" + "categoryManual_list": { + "type": "array", + "items": { + "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" }, @@ -1549,6 +1866,12 @@ "txnTimestamp": { "type": "string" }, + "txnTimestamp_gte": { + "type": "string" + }, + "txnTimestamp_lte": { + "type": "string" + }, "txnType": { "type": "string" }, @@ -1557,42 +1880,62 @@ } } }, - "responses.ListDepositTransactionsResponse": { + "requests.ListETFTransactionsOrderBy": { "type": "object", "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/responses.ListDepositTransactionsData" - } + "field": { + "type": "string" }, - "totalCount": { - "type": "integer" + "order": { + "type": "string" } } }, - "responses.ListETFTransactionsData": { + "requests.ListETFTransactionsRequest": { "type": "object", "properties": { - "amount": { - "type": "number" - }, - "brokerCode": { - "type": "string" + "limit": { + "type": "integer" }, - "consentId": { - "type": "string" + "offset": { + "type": "integer" }, - "dataId": { - "type": "string" + "orderBy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.ListETFTransactionsOrderBy" + } }, - "dematId": { - "type": "string" + "refIds": { + "type": "array", + "items": { + "type": "string" + } }, - "fipId": { + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.ListETFTransactionsWhere" + } + } + } + }, + "requests.ListETFTransactionsWhere": { + "type": "object", + "properties": { + "amount": { + "type": "number" + }, + "amount_gte": { + "type": "number" + }, + "amount_lte": { + "type": "number" + }, + "brokerCode": { "type": "string" }, - "id": { + "dematId": { "type": "string" }, "isin": { @@ -1601,21 +1944,27 @@ "isinDescription": { "type": "string" }, - "linkedAccRef": { - "type": "string" - }, "narration": { "type": "string" }, "nav": { "type": "number" }, - "refId": { - "type": "string" + "nav_gte": { + "type": "number" + }, + "nav_lte": { + "type": "number" }, "transactionDateTime": { "type": "string" }, + "transactionDateTime_gte": { + "type": "string" + }, + "transactionDateTime_lte": { + "type": "string" + }, "txnId": { "type": "string" }, @@ -1624,35 +1973,61 @@ }, "units": { "type": "number" + }, + "units_gte": { + "type": "number" + }, + "units_lte": { + "type": "number" } } }, - "responses.ListETFTransactionsResponse": { + "requests.ListEquitiesTransactionsOrderBy": { "type": "object", "properties": { - "data": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + } + }, + "requests.ListEquitiesTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "orderBy": { "type": "array", "items": { - "$ref": "#/definitions/responses.ListETFTransactionsData" + "$ref": "#/components/schemas/requests.ListEquitiesTransactionsOrderBy" } }, - "totalCount": { - "type": "integer" + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.ListEquitiesTransactionsWhere" + } } } }, - "responses.ListEquitiesTransactionsData": { + "requests.ListEquitiesTransactionsWhere": { "type": "object", "properties": { "companyName": { "type": "string" }, - "consentId": { - "type": "string" - }, - "dataId": { - "type": "string" - }, "dematId": { "type": "string" }, @@ -1665,11 +2040,11 @@ "exchangeRate": { "type": "number" }, - "fipId": { - "type": "string" + "exchangeRate_gte": { + "type": "number" }, - "id": { - "type": "string" + "exchangeRate_lte": { + "type": "number" }, "isin": { "type": "string" @@ -1677,16 +2052,16 @@ "isinDescription": { "type": "string" }, - "linkedAccRef": { - "type": "string" - }, "narration": { "type": "string" }, "orderId": { "type": "string" }, - "refId": { + "transactionDateTime_gte": { + "type": "string" + }, + "transactionDateTime_lte": { "type": "string" }, "txnDateTime": { @@ -1700,24 +2075,56 @@ }, "units": { "type": "number" + }, + "units_gte": { + "type": "number" + }, + "units_lte": { + "type": "number" } } }, - "responses.ListEquitiesTransactionsResponse": { + "requests.ListMutualFundsTransactionsOrderBy": { "type": "object", "properties": { - "data": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } + } + }, + "requests.ListMutualFundsTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "orderBy": { "type": "array", "items": { - "$ref": "#/definitions/responses.ListEquitiesTransactionsData" + "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsOrderBy" } }, - "totalCount": { - "type": "integer" + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsWhere" + } } } }, - "responses.ListMutualFundsTransactionsData": { + "requests.ListMutualFundsTransactionsWhere": { "type": "object", "properties": { "amc": { @@ -1732,17 +2139,11 @@ "amount": { "type": "number" }, - "consentId": { - "type": "string" - }, - "dataId": { - "type": "string" - }, - "fipId": { - "type": "string" + "amount_gte": { + "type": "number" }, - "id": { - "type": "string" + "amount_lte": { + "type": "number" }, "isin": { "type": "string" @@ -1750,9 +2151,6 @@ "isinDescription": { "type": "string" }, - "linkedAccRef": { - "type": "string" - }, "lockInDays": { "type": "string" }, @@ -1771,8 +2169,11 @@ "navDate": { "type": "string" }, - "refId": { - "type": "string" + "nav_gte": { + "type": "number" + }, + "nav_lte": { + "type": "number" }, "registrar": { "type": "string" @@ -1786,6 +2187,12 @@ "txnDate": { "type": "string" }, + "txnDate_gte": { + "type": "string" + }, + "txnDate_lte": { + "type": "string" + }, "txnId": { "type": "string" }, @@ -1800,883 +2207,467 @@ }, "units": { "type": "number" + }, + "units_gte": { + "type": "number" + }, + "units_lte": { + "type": "number" } } }, - "responses.ListMutualFundsTransactionsResponse": { + "requests.PurgeDataRequest": { "type": "object", "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/responses.ListMutualFundsTransactionsData" - } - }, - "totalCount": { - "type": "integer" + "identifiers": { + "$ref": "#/components/schemas/requests.Identifiers" } } }, - "responses.PurgeDataResponse": { + "responses.Error": { "type": "object", "properties": { - "purgedCounts": { - "$ref": "#/definitions/responses.PurgeDataResponseCounts" + "message": { + "type": "string" } } }, - "responses.PurgeDataResponseCounts": { + "responses.FIDataResponseData": { "type": "object", "properties": { - "accounts": { - "type": "integer" - }, - "depositTransactions": { - "type": "integer" + "fipId": { + "type": "string" }, - "equitiesTransactions": { - "type": "integer" + "profileStatus": { + "type": "string" }, - "etfTransactions": { - "type": "integer" + "summaryStatus": { + "type": "string" }, - "mutualFundsTransactions": { - "type": "integer" + "transactions": { + "$ref": "#/components/schemas/responses.TransactionsResponseData" } } }, - "responses.TransactionsResponseData": { + "responses.ListAccountsResponse": { "type": "object", "properties": { - "insertedCount": { - "type": "integer" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListAccountsResponseData" + } }, "totalCount": { "type": "integer" - }, - "updatedCount": { - "type": "integer" } } - } - }, - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, - "components": { - "schemas": { - "Account": { - "title": "Account", - "type": "object", - "properties": { - "profile": { - "$ref": "#/components/schemas/Profile" - }, - "summary": { - "$ref": "#/components/schemas/Summary" - }, - "transactions": { - "$ref": "#/components/schemas/Transactions" - }, - "type": { - "title": "Type", - "type": "string", - "default": "deposit" - }, - "maskedAccNumber": { - "title": "Maskedaccnumber", - "type": "string" - }, - "version": { - "title": "Version", - "type": "number" - }, - "linkedAccRef": { - "title": "Linkedaccref", - "type": "string" - } - } - }, - "AccountType": { - "title": "AccountType", - "enum": [ - "SAVINGS", - "CURRENT" - ], - "type": "string", - "description": "An enumeration." - }, - "Body_process_insights_v1_insight_post": { - "title": "Body_process_insights_v1_insight_post", - "required": [ - "templateId" - ], - "type": "object", - "properties": { - "templateId": { - "title": "Template ID for which insights are needed", - "type": "string" - }, - "dataIds": { - "title": "List of data blocks to process", - "type": "array", - "items": { - "type": "string" - } - }, - "refIds": { - "title": "Refids", - "type": "array", - "items": { - "type": "string" - } - }, - "linkedAccRefs": { - "title": "Linkedaccrefs", - "type": "array", - "items": { - "type": "string" - } - } + }, + "responses.ListAccountsResponseData": { + "type": "object", + "properties": { + "consentId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "fiType": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "profile": { + "type": "object", + "additionalProperties": true + }, + "refId": { + "type": "string" + }, + "summary": { + "type": "object", + "additionalProperties": true + }, + "txnsEndDate": { + "type": "string" + }, + "txnsStartDate": { + "type": "string" } - }, - "Body_process_pdf_insights_v1_insight_post": { - "title": "Body_process_pdf_insights_v1_insight_post", - "required": [ - "template_id", - "bankName", - "applicantName", - "dataFile" - ], - "type": "object", - "properties": { - "template_id": { - "title": "Template ID for which insights are needed", - "type": "string" - }, - "bankName": { - "title": "Name of Bank of associated PDF", - "type": "string", - "description": "Bank name is case sensitive and should be in list pf supported banks. Supported banks can be fetched from /pdf/supported_banks" - }, - "applicantName": { - "title": "Name of Account Holder in associated PDF", - "type": "string", - "description": "Can be any place holder string, But it is suggested to provide unique applicant name, to trace references in future in case of repeated usage" - }, - "password": { - "title": "Password for reading associated PDF", - "type": "string", - "description": "The field is Optional, but if the PDF document is password protected, then password should be provided for reading the file." - }, - "dataFile": { - "multipart/form-data": { - "schema": { - "required": [ - "file", - "name" - ], - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Name of file uploaded" - } - } - } - } - } + } + }, + "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" } - }, - "DepositData": { - "title": "DepositData", - "required": [ - "account" - ], - "type": "object", - "properties": { - "account": { - "$ref": "#/components/schemas/Account" + } + }, + "responses.ListDepositTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListDepositTransactionsData" } + }, + "totalCount": { + "type": "integer" } - }, - "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" - }, - "ver": { - "title": "Ver", - "type": "string", - "default": "1" - }, - "txnid": { - "title": "Txnid", - "type": "string", - "default": "" - } + } + }, + "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" } - }, - "FIData": { - "$ref": "#/components/schemas/DepositData", - "title": "FIData" - }, - "FIDataBlockCreateResponse": { - "title": "FIDataBlockCreateResponse", - "required": [ - "body" - ], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "$ref": "#/components/schemas/FIDataBlockResponse" + } + }, + "responses.ListETFTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListETFTransactionsData" } + }, + "totalCount": { + "type": "integer" } - }, - "FIDataBlockGetResponse": { - "title": "FIDataBlockGetResponse", - "required": [ - "body" - ], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "title": "Body", - "type": "array", - "items": { - "$ref": "#/components/schemas/FIDataBlockResponse" - } - } + } + }, + "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" } - }, - "FIDataBlockResponse": { - "title": "FIDataBlockResponse", - "required": [ - "dataId", - "fiSchema", - "expiryDate" - ], - "type": "object", - "properties": { - "dataId": { - "title": "Dataid", - "type": "string", - "format": "uuid" - }, - "refId": { - "type": "string", - "title": "Refid" - }, - "fiSchema": { - "title": "Fischema", - "type": "string" - }, - "expiryDate": { - "title": "Expirydate", - "type": "string", - "format": "date-time" + } + }, + "responses.ListEquitiesTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListEquitiesTransactionsData" } + }, + "totalCount": { + "type": "integer" } - }, - "Holder": { - "title": "Holder", - "required": [ - "nominee", - "ckycCompliance" - ], - "type": "object", - "properties": { - "name": { - "title": "Name", - "type": "string" - }, - "dob": { - "title": "Dob", - "type": "string", - "format": "date" - }, - "mobile": { - "title": "Mobile", - "type": "integer" - }, - "nominee": { - "$ref": "#/components/schemas/HoldingNominee" - }, - "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" - } - } - }, - "Holders": { - "title": "Holders", - "required": [ - "holder", - "type" - ], - "type": "object", - "properties": { - "holder": { - "title": "Holder", - "type": "array", - "items": { - "$ref": "#/components/schemas/Holder" - } - }, - "type": { - "$ref": "#/components/schemas/HoldersType" - } - } - }, - "HoldersType": { - "title": "HoldersType", - "enum": [ - "SINGLE", - "JOINT" - ], - "type": "string", - "description": "An enumeration." - }, - "HoldingNominee": { - "title": "HoldingNominee", - "enum": [ - "REGISTERED", - "NOT-REGISTERED" - ], - "type": "string", - "description": "An enumeration." - }, - "InsightGetResponse": { - "title": "InsightGetResponse", - "required": [ - "body" - ], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "title": "Body", - "type": "object" - } - } - }, - "Pending": { - "title": "Pending", - "required": [ - "amount" - ], - "type": "object", - "properties": { - "transactionType": { - "$ref": "#/components/schemas/TransactionType" - }, - "amount": { - "title": "Amount", - "type": "number" - } - } - }, - "Profile": { - "title": "Profile", - "type": "object", - "properties": { - "holders": { - "$ref": "#/components/schemas/Holders" - } - } - }, - "ReportJob": { - "title": "ReportJob", - "required": [ - "reportId", - "status" - ], - "type": "object", - "properties": { - "reportId": { - "title": "Reportid", - "type": "string", - "format": "uuid" - }, - "status": { - "title": "Status", - "type": "string" - } - } - }, - "ReportJobCreateResponse": { - "title": "ReportJobCreateResponse", - "required": [ - "body" - ], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "$ref": "#/components/schemas/ReportJob" - } - } - }, - "StatusTypes": { - "title": "StatusTypes", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string", - "description": "An enumeration." - }, - "Summary": { - "title": "Summary", - "type": "object", - "properties": { - "pending": { - "$ref": "#/components/schemas/Pending" - }, - "currentBalance": { - "title": "Currentbalance", - "type": "string" - }, - "currency": { - "title": "Currency", - "type": "string" - }, - "exchgeRate": { - "title": "Exchgerate", - "type": "string" - }, - "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", - "type": "string", - "format": "date" - }, - "currentODLimit": { - "title": "Currentodlimit", - "type": "string" - }, - "drawingLimit": { - "title": "Drawinglimit", - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/StatusTypes" - } - } - }, - "SummaryFacility": { - "title": "SummaryFacility", - "enum": [ - "OD", - "CC" - ], - "type": "string", - "description": "An enumeration." - }, - "Transaction": { - "title": "Transaction", - "required": [ - "type", - "mode", - "amount", - "currentBalance", - "transactionTimestamp", - "valueDate", - "txnId", - "narration" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/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", - "type": "string", - "format": "date" - }, - "txnId": { - "title": "Txnid", - "type": "string" - }, - "narration": { - "title": "Narration", - "type": "string" - }, - "reference": { - "title": "Reference", - "type": "string" - } - } - }, - "TransactionMode": { - "title": "TransactionMode", - "enum": [ - "CASH", - "ATM", - "CARD", - "UPI", - "FT", - "OTHERS" - ], - "type": "string", - "description": "An enumeration." - }, - "TransactionType": { - "title": "TransactionType", - "enum": [ - "CREDIT", - "DEBIT" - ], - "type": "string", - "description": "An enumeration." - }, - "Transactions": { - "title": "Transactions", - "type": "object", - "properties": { - "transaction": { - "title": "Transaction", - "type": "array", - "items": { - "$ref": "#/components/schemas/Transaction" - } - }, - "startDate": { - "title": "Startdate", - "type": "string", - "format": "date" - }, - "endDate": { - "title": "Enddate", - "type": "string", - "format": "date" - } + } + }, + "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" } - }, - "TransactionGetResponse": { - "title": "TransactionGetResponse", - "required": [ - "body" - ], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "$ref": "#/components/schemas/TransactionResponse" + } + }, + "responses.ListMutualFundsTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsData" } + }, + "totalCount": { + "type": "integer" } - }, - "TransactionResponse": { - "title": "TransactionResponse", - "required": [ - "totalCount", - "transactions" - ], - "type": "object", - "properties": { - "totalCount": { - "title": "Totalcount", - "type": "integer" - }, - "dataIdStatus": { - "title": "Dataidstatus", - "type": "array", - "items": { - "$ref": "#/components/schemas/TransactionJobStatus" - } - }, - "transactions": { - "title": "Transactions", - "type": "array", - "items": { - "$ref": "#/components/schemas/DepositTransaction" - } - } + } + }, + "responses.PurgeDataResponse": { + "type": "object", + "properties": { + "purgedCounts": { + "$ref": "#/components/schemas/responses.PurgeDataResponseCounts" } - }, - "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" - } + } + }, + "responses.PurgeDataResponseCounts": { + "type": "object", + "properties": { + "accounts": { + "type": "integer" }, - "type": "object", - "required": [ - "templateId", - "applicantName", - "dataFile" - ], - "title": "Body_process_pdf_insights_v1_insight_pdf_post" - }, - "TransactionJobStatus": { - "title": "TransactionJobStatus", - "required": [ - "dataId", - "status" - ], - "type": "object", - "properties": { - "dataId": { - "title": "Dataid", - "type": "string" - }, - "status": { - "title": "Status", - "type": "string" - } - } - }, - "DepositTransaction": { - "title": "DepositTransaction", - "type": "object", - "properties": { - "fiuId": { - "title": "Fiuid", - "type": "string", - "format": "uuid" - }, - "dataId": { - "title": "Dataid", - "type": "string", - "format": "uuid" - }, - "refId": { - "type": "string", - "title": "Refid" - }, - "linkedAccRef": { - "type": "string", - "title": "Linkedaccref" - }, - "narration": { - "title": "Narration", - "type": "string" - }, - "amount": { - "title": "Amount", - "type": "string" - }, - "currentBalance": { - "title": "Currentbalance", - "type": "string" - }, - "txnMode": { - "title": "Txnmode", - "type": "string" - }, - "reference": { - "title": "Reference", - "type": "string" - }, - "txnId": { - "title": "Txnid", - "type": "string" - }, - "txnType": { - "title": "Txntype", - "type": "string" - }, - "txnValueDate": { - "title": "Txnvaluedate", - "type": "string", - "format": "date" - }, - "txnTimestamp": { - "title": "Txntimestamp", - "type": "string", - "format": "date-time" - }, - "categoryL1": { - "title": "Categoryl1", - "type": "string" - }, - "categoryL2": { - "title": "Categoryl2", - "type": "string" - } + "depositTransactions": { + "type": "integer" + }, + "equitiesTransactions": { + "type": "integer" + }, + "etfTransactions": { + "type": "integer" + }, + "mutualFundsTransactions": { + "type": "integer" } - }, - "SupportedBanksGetResponse": { - "title": "SupportedBanksGetResponse", - "required": [ - "body" - ], - "type": "object", - "properties": { - "status": { - "title": "Status", - "type": "string", - "default": "Success" - }, - "statusDescription": { - "title": "Statusdescription", - "type": "string" - }, - "body": { - "title": "Body", - "type": "array", - "items": { - "type": "string" - } - } + } + }, + "responses.TransactionsResponseData": { + "type": "object", + "properties": { + "insertedCount": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "updatedCount": { + "type": "integer" } } } + } } } From e3c5c4cfe7b6aa33cd19e0967f632fe53fea550e Mon Sep 17 00:00:00 2001 From: dhruvmisra Date: Thu, 5 Sep 2024 17:08:08 +0530 Subject: [PATCH 3/3] Update spec to OpenAPI 3.0 --- api-references/data/insights.json | 2402 ++++++++++++++--------------- 1 file changed, 1165 insertions(+), 1237 deletions(-) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index ce8844cb..aee374f5 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -18,9 +18,7 @@ "paths": { "/v1/fiData": { "post": { - "tags": [ - "Data ingestion" - ], + "tags": ["Data ingestion"], "summary": "Create FIData block (FIU Webhook)", "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 in the future.", "operationId": "create_fi_data_v1_fiData_post", @@ -172,9 +170,7 @@ }, "/v1/insight": { "get": { - "tags": [ - "Insight generation" - ], + "tags": ["Insight generation"], "summary": "Get Insights", "description": "Call this API with the report-id to get the created Insights", "operationId": "get_insights_v1_insight_get", @@ -383,9 +379,7 @@ } }, "post": { - "tags": [ - "Insight generation" - ], + "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_v1_insight_post", @@ -566,39 +560,39 @@ "/v1/accounts": { "post": { "description": "List accounts", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "List accounts" - ], + "tags": ["List accounts"], "summary": "List accounts", "operationId": "accounts-list", - "parameters": [ - { - "description": "account identifiers and filters", - "name": "params", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/requests.ListAccountsRequest" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/requests.ListAccountsRequest" + } } - } - ], + }, + "description": "account identifiers and filters", + "required": true + }, "responses": { "200": { "description": "OK", - "schema": { - "$ref": "#/components/schemas/responses.ListAccountsResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.ListAccountsResponse" + } + } } }, "400": { "description": "Bad Request", - "schema": { - "$ref": "#/components/schemas/responses.Error" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.Error" + } + } } } } @@ -607,39 +601,39 @@ "/v1/deposit/transactions": { "post": { "description": "List deposit transactions", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "List transactions" - ], + "tags": ["List transactions"], "summary": "List deposit transactions", "operationId": "list-deposit-transactions", - "parameters": [ - { - "description": "Query details", - "name": "params", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/requests.ListDepositTransactionsRequest" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/requests.ListDepositTransactionsRequest" + } } - } - ], + }, + "description": "Query details", + "required": true + }, "responses": { "200": { "description": "OK", - "schema": { - "$ref": "#/components/schemas/responses.ListDepositTransactionsResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.ListDepositTransactionsResponse" + } + } } }, "400": { "description": "Bad Request", - "schema": { - "$ref": "#/components/schemas/responses.Error" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.Error" + } + } } } } @@ -648,39 +642,39 @@ "/v1/equities/transactions": { "post": { "description": "List equities transactions", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "List transactions" - ], + "tags": ["List transactions"], "summary": "List equities transactions", "operationId": "list-equities-transactions", - "parameters": [ - { - "description": "Query details", - "name": "params", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/requests.ListEquitiesTransactionsRequest" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/requests.ListEquitiesTransactionsRequest" + } } - } - ], + }, + "description": "Query details", + "required": true + }, "responses": { "200": { "description": "OK", - "schema": { - "$ref": "#/components/schemas/responses.ListEquitiesTransactionsResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.ListEquitiesTransactionsResponse" + } + } } }, "400": { "description": "Bad Request", - "schema": { - "$ref": "#/components/schemas/responses.Error" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.Error" + } + } } } } @@ -688,81 +682,82 @@ }, "/v1/etf/transactions": { "post": { - "description": "List ETF transactions", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "List transactions" - ], - "summary": "List ETF transactions", + "description": "List etf transactions", + "tags": ["List transactions"], + "summary": "List etf transactions", "operationId": "list-etf-transactions", - "parameters": [ - { - "description": "Query details", - "name": "params", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/requests.ListETFTransactionsRequest" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/requests.ListETFTransactionsRequest" + } } - } - ], + }, + "description": "Query details", + "required": true + }, "responses": { "200": { "description": "OK", - "schema": { - "$ref": "#/components/schemas/responses.ListETFTransactionsResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.ListETFTransactionsResponse" + } + } } }, "400": { "description": "Bad Request", - "schema": { - "$ref": "#/components/schemas/responses.Error" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.Error" + } + } } } } } }, + "/v1/mutual-funds/transactions": { "post": { "description": "List mutual-funds transactions", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "List transactions" - ], + "tags": ["List transactions"], "summary": "List mutual-funds transactions", "operationId": "list-mutual-funds-transactions", - "parameters": [ - { - "description": "Query details", - "name": "params", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsRequest" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsRequest" + } } - } - ], + }, + "description": "Query details", + "required": true + }, "responses": { "200": { "description": "OK", - "schema": { - "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsResponse" + } + } } }, "400": { "description": "Bad Request", - "schema": { - "$ref": "#/components/schemas/responses.Error" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.Error" + } + } } } } @@ -771,39 +766,39 @@ "/v1/purge": { "delete": { "description": "Purge account and transactions data", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Purge" - ], + "tags": ["Purge"], "summary": "Purge data", "operationId": "data-purge", - "parameters": [ - { - "description": "purging identifiers", - "name": "params", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/requests.PurgeDataRequest" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/requests.PurgeDataRequest" + } } - } - ], + }, + "description": "purging identifiers", + "required": true + }, "responses": { "200": { "description": "OK", - "schema": { - "$ref": "#/components/schemas/responses.PurgeDataResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.PurgeDataResponse" + } + } } }, "400": { "description": "Bad Request", - "schema": { - "$ref": "#/components/schemas/responses.Error" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/responses.Error" + } + } } } } @@ -846,18 +841,13 @@ }, "AccountType": { "title": "AccountType", - "enum": [ - "SAVINGS", - "CURRENT" - ], + "enum": ["SAVINGS", "CURRENT"], "type": "string", "description": "An enumeration." }, "Body_process_insights_v1_insight_post": { "title": "Body_process_insights_v1_insight_post", - "required": [ - "templateId" - ], + "required": ["templateId"], "type": "object", "properties": { "templateId": { @@ -889,12 +879,7 @@ }, "Body_process_pdf_insights_v1_insight_post": { "title": "Body_process_pdf_insights_v1_insight_post", - "required": [ - "template_id", - "bankName", - "applicantName", - "dataFile" - ], + "required": ["template_id", "bankName", "applicantName", "dataFile"], "type": "object", "properties": { "template_id": { @@ -919,10 +904,7 @@ "dataFile": { "multipart/form-data": { "schema": { - "required": [ - "file", - "name" - ], + "required": ["file", "name"], "type": "object", "properties": { "file": { @@ -944,9 +926,7 @@ }, "DepositData": { "title": "DepositData", - "required": [ - "account" - ], + "required": ["account"], "type": "object", "properties": { "account": { @@ -956,10 +936,7 @@ }, "ErrorResponse": { "title": "ErrorResponse", - "required": [ - "errorCode", - "errorMsg" - ], + "required": ["errorCode", "errorMsg"], "type": "object", "properties": { "errorCode": { @@ -993,9 +970,7 @@ }, "FIDataBlockCreateResponse": { "title": "FIDataBlockCreateResponse", - "required": [ - "body" - ], + "required": ["body"], "type": "object", "properties": { "status": { @@ -1014,9 +989,7 @@ }, "FIDataBlockGetResponse": { "title": "FIDataBlockGetResponse", - "required": [ - "body" - ], + "required": ["body"], "type": "object", "properties": { "status": { @@ -1039,11 +1012,7 @@ }, "FIDataBlockResponse": { "title": "FIDataBlockResponse", - "required": [ - "dataId", - "fiSchema", - "expiryDate" - ], + "required": ["dataId", "fiSchema", "expiryDate"], "type": "object", "properties": { "dataId": { @@ -1068,10 +1037,7 @@ }, "Holder": { "title": "Holder", - "required": [ - "nominee", - "ckycCompliance" - ], + "required": ["nominee", "ckycCompliance"], "type": "object", "properties": { "name": { @@ -1114,10 +1080,7 @@ }, "Holders": { "title": "Holders", - "required": [ - "holder", - "type" - ], + "required": ["holder", "type"], "type": "object", "properties": { "holder": { @@ -1134,27 +1097,19 @@ }, "HoldersType": { "title": "HoldersType", - "enum": [ - "SINGLE", - "JOINT" - ], + "enum": ["SINGLE", "JOINT"], "type": "string", "description": "An enumeration." }, "HoldingNominee": { "title": "HoldingNominee", - "enum": [ - "REGISTERED", - "NOT-REGISTERED" - ], + "enum": ["REGISTERED", "NOT-REGISTERED"], "type": "string", "description": "An enumeration." }, "InsightGetResponse": { "title": "InsightGetResponse", - "required": [ - "body" - ], + "required": ["body"], "type": "object", "properties": { "status": { @@ -1174,9 +1129,7 @@ }, "Pending": { "title": "Pending", - "required": [ - "amount" - ], + "required": ["amount"], "type": "object", "properties": { "transactionType": { @@ -1199,10 +1152,7 @@ }, "ReportJob": { "title": "ReportJob", - "required": [ - "reportId", - "status" - ], + "required": ["reportId", "status"], "type": "object", "properties": { "reportId": { @@ -1218,9 +1168,7 @@ }, "ReportJobCreateResponse": { "title": "ReportJobCreateResponse", - "required": [ - "body" - ], + "required": ["body"], "type": "object", "properties": { "status": { @@ -1239,10 +1187,7 @@ }, "StatusTypes": { "title": "StatusTypes", - "enum": [ - "ACTIVE", - "INACTIVE" - ], + "enum": ["ACTIVE", "INACTIVE"], "type": "string", "description": "An enumeration." }, @@ -1308,10 +1253,7 @@ }, "SummaryFacility": { "title": "SummaryFacility", - "enum": [ - "OD", - "CC" - ], + "enum": ["OD", "CC"], "type": "string", "description": "An enumeration." }, @@ -1369,23 +1311,13 @@ }, "TransactionMode": { "title": "TransactionMode", - "enum": [ - "CASH", - "ATM", - "CARD", - "UPI", - "FT", - "OTHERS" - ], + "enum": ["CASH", "ATM", "CARD", "UPI", "FT", "OTHERS"], "type": "string", "description": "An enumeration." }, "TransactionType": { "title": "TransactionType", - "enum": [ - "CREDIT", - "DEBIT" - ], + "enum": ["CREDIT", "DEBIT"], "type": "string", "description": "An enumeration." }, @@ -1414,9 +1346,7 @@ }, "TransactionGetResponse": { "title": "TransactionGetResponse", - "required": [ - "body" - ], + "required": ["body"], "type": "object", "properties": { "status": { @@ -1435,10 +1365,7 @@ }, "TransactionResponse": { "title": "TransactionResponse", - "required": [ - "totalCount", - "transactions" - ], + "required": ["totalCount", "transactions"], "type": "object", "properties": { "totalCount": { @@ -1499,19 +1426,12 @@ } }, "type": "object", - "required": [ - "templateId", - "applicantName", - "dataFile" - ], + "required": ["templateId", "applicantName", "dataFile"], "title": "Body_process_pdf_insights_v1_insight_pdf_post" }, "TransactionJobStatus": { "title": "TransactionJobStatus", - "required": [ - "dataId", - "status" - ], + "required": ["dataId", "status"], "type": "object", "properties": { "dataId": { @@ -1596,9 +1516,7 @@ }, "SupportedBanksGetResponse": { "title": "SupportedBanksGetResponse", - "required": [ - "body" - ], + "required": ["body"], "type": "object", "properties": { "status": { @@ -1619,1055 +1537,1065 @@ } } }, - "requests.AccountData": { - "type": "object", - "properties": { - "decryptedFI": { - "$ref": "#/components/schemas/requests.DecryptedFI" - }, - "linkRefNumber": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "refId": { - "type": "string" - } - } - }, - "requests.DecryptedFI": { - "type": "object", - "properties": { - "account": { - "$ref": "#/components/schemas/requests.DecryptedFIAccount" - } - } - }, - "requests.DecryptedFIAccount": { - "type": "object", - "properties": { - "linkedAccRef": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "profile": { - "type": "object", - "additionalProperties": true - }, - "summary": { - "type": "object", - "additionalProperties": true - }, - "transactions": { - "$ref": "#/components/schemas/requests.DecryptedFIAccountTransactions" - }, - "type": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "requests.DecryptedFIAccountTransactions": { - "type": "object", - "properties": { - "endDate": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "transaction": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true + "requests.AccountData": { + "type": "object", + "properties": { + "decryptedFI": { + "$ref": "#/components/schemas/requests.DecryptedFI" + }, + "linkRefNumber": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "refId": { + "type": "string" } } - } - }, - "requests.FIData": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.AccountData" - } - }, - "fipID": { - "type": "string" + }, + "requests.DecryptedFI": { + "type": "object", + "properties": { + "account": { + "$ref": "#/components/schemas/requests.DecryptedFIAccount" + } } - } - }, - "requests.Identifiers": { - "type": "object", - "properties": { - "consentIds": { - "type": "array", - "items": { + }, + "requests.DecryptedFIAccount": { + "type": "object", + "properties": { + "linkedAccRef": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "profile": { + "type": "object", + "additionalProperties": true + }, + "summary": { + "type": "object", + "additionalProperties": true + }, + "transactions": { + "$ref": "#/components/schemas/requests.DecryptedFIAccountTransactions" + }, + "type": { + "type": "string" + }, + "version": { "type": "string" } - }, - "linkAccRefs": { - "type": "array", - "items": { + } + }, + "requests.DecryptedFIAccountTransactions": { + "type": "object", + "properties": { + "endDate": { + "type": "string" + }, + "startDate": { "type": "string" + }, + "transaction": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "requests.FIData": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.AccountData" + } + }, + "fipID": { "type": "string" } } - } - }, - "requests.IngestFIDataRequest": { - "type": "object", - "properties": { - "consentId": { - "type": "string" - }, - "dataId": { - "type": "string" - }, - "fiData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.FIData" + }, + "requests.Identifiers": { + "type": "object", + "properties": { + "consentIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "linkAccRefs": { + "type": "array", + "items": { + "type": "string" + } + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } } - }, - "refId": { - "type": "string" } - } - }, - "requests.ListAccountRequestFilters": { - "type": "object", - "properties": { - "fiTypes": { - "type": "array", - "items": { + }, + "requests.IngestFIDataRequest": { + "type": "object", + "properties": { + "consentId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "fiData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/requests.FIData" + } + }, + "refId": { "type": "string" } } - } - }, - "requests.ListAccountsRequest": { - "type": "object", - "properties": { - "filters": { - "$ref": "#/components/schemas/requests.ListAccountRequestFilters" - }, - "identifiers": { - "$ref": "#/components/schemas/requests.Identifiers" - } - } - }, - "requests.ListDepositTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" + }, + "requests.ListAccountRequestFilters": { + "type": "object", + "properties": { + "fiTypes": { + "type": "array", + "items": { + "type": "string" + } + } } - } - }, - "requests.ListDepositTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListDepositTransactionsOrderBy" + }, + "requests.ListAccountsRequest": { + "type": "object", + "properties": { + "filters": { + "$ref": "#/components/schemas/requests.ListAccountRequestFilters" + }, + "identifiers": { + "$ref": "#/components/schemas/requests.Identifiers" } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "requests.ListDepositTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { "type": "string" } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListDepositTransactionsWhere" + } + }, + "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.ListDepositTransactionsWhere": { - "type": "object", - "properties": { - "amount": { - "type": "number" - }, - "amount_gte": { - "type": "number" - }, - "amount_lte": { - "type": "number" - }, - "categoryL1": { - "type": "string" - }, - "categoryL1_list": { - "type": "array", - "items": { + }, + "requests.ListDepositTransactionsWhere": { + "type": "object", + "properties": { + "amount": { + "type": "number" + }, + "amount_gte": { + "type": "number" + }, + "amount_lte": { + "type": "number" + }, + "categoryL1": { "type": "string" - } - }, - "categoryL2": { - "type": "string" - }, - "categoryL2_list": { - "type": "array", - "items": { + }, + "categoryL1_list": { + "type": "array", + "items": { + "type": "string" + } + }, + "categoryL2": { "type": "string" - } - }, - "categoryManual": { - "type": "string" - }, - "categoryManual_list": { - "type": "array", - "items": { + }, + "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" } - }, - "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" - } - } - }, - "requests.ListETFTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" } - } - }, - "requests.ListETFTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListETFTransactionsOrderBy" - } - }, - "refIds": { - "type": "array", - "items": { + }, + "requests.ListETFTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { "type": "string" - } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListETFTransactionsWhere" } } - } - }, - "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" - } - } - }, - "requests.ListEquitiesTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" + }, + "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.ListEquitiesTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListEquitiesTransactionsOrderBy" + }, + "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" } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "requests.ListEquitiesTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { "type": "string" } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListEquitiesTransactionsWhere" + } + }, + "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.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" + }, + "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" + } } - } - }, - "requests.ListMutualFundsTransactionsOrderBy": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" + }, + "requests.ListMutualFundsTransactionsOrderBy": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + } } - } - }, - "requests.ListMutualFundsTransactionsRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "orderBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsOrderBy" + }, + "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" + } } - }, - "refIds": { - "type": "array", - "items": { + } + }, + "requests.ListMutualFundsTransactionsWhere": { + "type": "object", + "properties": { + "amc": { "type": "string" - } - }, - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/requests.ListMutualFundsTransactionsWhere" + }, + "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" } } - } - }, - "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" + }, + "requests.PurgeDataRequest": { + "type": "object", + "properties": { + "identifiers": { + "$ref": "#/components/schemas/requests.Identifiers" + } } - } - }, - "requests.PurgeDataRequest": { - "type": "object", - "properties": { - "identifiers": { - "$ref": "#/components/schemas/requests.Identifiers" + }, + "responses.Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } } - } - }, - "responses.Error": { - "type": "object", - "properties": { - "message": { - "type": "string" + }, + "responses.FIDataResponseData": { + "type": "object", + "properties": { + "fipId": { + "type": "string" + }, + "profileStatus": { + "type": "string" + }, + "summaryStatus": { + "type": "string" + }, + "transactions": { + "$ref": "#/components/schemas/responses.TransactionsResponseData" + } } - } - }, - "responses.FIDataResponseData": { - "type": "object", - "properties": { - "fipId": { - "type": "string" - }, - "profileStatus": { - "type": "string" - }, - "summaryStatus": { - "type": "string" - }, - "transactions": { - "$ref": "#/components/schemas/responses.TransactionsResponseData" + }, + "responses.IngestFIDataResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/responses.FIDataResponseData" + } + } } - } - }, - "responses.ListAccountsResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/responses.ListAccountsResponseData" + }, + "responses.ListAccountsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListAccountsResponseData" + } + }, + "totalCount": { + "type": "integer" } - }, - "totalCount": { - "type": "integer" } - } - }, - "responses.ListAccountsResponseData": { - "type": "object", - "properties": { - "consentId": { - "type": "string" - }, - "dataId": { - "type": "string" - }, - "fiType": { - "type": "string" - }, - "fipId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "linkedAccRef": { - "type": "string" - }, - "maskedAccNumber": { - "type": "string" - }, - "profile": { - "type": "object", - "additionalProperties": true - }, - "refId": { - "type": "string" - }, - "summary": { - "type": "object", - "additionalProperties": true - }, - "txnsEndDate": { - "type": "string" - }, - "txnsStartDate": { - "type": "string" + }, + "responses.ListAccountsResponseData": { + "type": "object", + "properties": { + "consentId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "fiType": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "maskedAccNumber": { + "type": "string" + }, + "profile": { + "type": "object", + "additionalProperties": true + }, + "refId": { + "type": "string" + }, + "summary": { + "type": "object", + "additionalProperties": true + }, + "txnsEndDate": { + "type": "string" + }, + "txnsStartDate": { + "type": "string" + } } - } - }, - "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" + }, + "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" + } } - } - }, - "responses.ListDepositTransactionsResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/responses.ListDepositTransactionsData" + }, + "responses.ListDepositTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListDepositTransactionsData" + } + }, + "totalCount": { + "type": "integer" } - }, - "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" + }, + "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" + } } - } - }, - "responses.ListETFTransactionsResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/responses.ListETFTransactionsData" + }, + "responses.ListETFTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListETFTransactionsData" + } + }, + "totalCount": { + "type": "integer" } - }, - "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" + }, + "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" + } } - } - }, - "responses.ListEquitiesTransactionsResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/responses.ListEquitiesTransactionsData" + }, + "responses.ListEquitiesTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListEquitiesTransactionsData" + } + }, + "totalCount": { + "type": "integer" } - }, - "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.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.ListMutualFundsTransactionsResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsData" + }, + "responses.ListMutualFundsTransactionsResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/responses.ListMutualFundsTransactionsData" + } + }, + "totalCount": { + "type": "integer" } - }, - "totalCount": { - "type": "integer" } - } - }, - "responses.PurgeDataResponse": { - "type": "object", - "properties": { - "purgedCounts": { - "$ref": "#/components/schemas/responses.PurgeDataResponseCounts" + }, + "responses.PurgeDataResponse": { + "type": "object", + "properties": { + "purgedCounts": { + "$ref": "#/components/schemas/responses.PurgeDataResponseCounts" + } } - } - }, - "responses.PurgeDataResponseCounts": { - "type": "object", - "properties": { - "accounts": { - "type": "integer" - }, - "depositTransactions": { - "type": "integer" - }, - "equitiesTransactions": { - "type": "integer" - }, - "etfTransactions": { - "type": "integer" - }, - "mutualFundsTransactions": { - "type": "integer" + }, + "responses.PurgeDataResponseCounts": { + "type": "object", + "properties": { + "accounts": { + "type": "integer" + }, + "depositTransactions": { + "type": "integer" + }, + "equitiesTransactions": { + "type": "integer" + }, + "etfTransactions": { + "type": "integer" + }, + "mutualFundsTransactions": { + "type": "integer" + } } - } - }, - "responses.TransactionsResponseData": { - "type": "object", - "properties": { - "insertedCount": { - "type": "integer" - }, - "totalCount": { - "type": "integer" - }, - "updatedCount": { - "type": "integer" + }, + "responses.TransactionsResponseData": { + "type": "object", + "properties": { + "insertedCount": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "updatedCount": { + "type": "integer" + } } } } - } } } -