From 825938b5b9536a779c541141648a8028d81b7ea4 Mon Sep 17 00:00:00 2001 From: rahul roy Date: Wed, 18 Sep 2024 16:45:49 +0530 Subject: [PATCH 1/8] add api-refernce for bav-penny less --- api-references/data/bav/penny-less.json | 823 ++++++++++++++++++++++++ 1 file changed, 823 insertions(+) create mode 100644 api-references/data/bav/penny-less.json diff --git a/api-references/data/bav/penny-less.json b/api-references/data/bav/penny-less.json new file mode 100644 index 00000000..1a769bdb --- /dev/null +++ b/api-references/data/bav/penny-less.json @@ -0,0 +1,823 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Data Gateway - BAV Penny Less", + "description": "Confirm the validity of an account from the account holder’s bank, with penny-drop done in real-time.", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } + ], + "paths": { + "/pennyless": { + "post": { + "tags": [ + "PennyLess Drop" + ], + "summary": "Verify PennyLess Drop", + "operationId": "VerifyPennyLessDrop", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{setu_bav_product_instance_id}}" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDropRequest" + }, + { + "example": { + "accountNumber": "50100221813167", + "ifsc": "HDFC0000839" + } + } + ] + }, + "example": { + "accountNumber": "50100221813167", + "ifsc": "HDFC0000839" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDropMerchant-Success" + }, + { + "example": { + "traceId": "ca782918-f701-4033-84eb-30611381cfb7", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "status": "SUCCESS" + } + } + ] + }, + "example": { + "traceId": "ca782918-f701-4033-84eb-30611381cfb7", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "status": "SUCCESS" + } + } + } + }, + "500": { + "description": "INTERNAL SERVER ERROR", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDrop-UpstreamError1" + }, + { + "example": { + "error": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" + } + } + } + ] + }, + "example": { + "error": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" + } + } + } + } + }, + "400": { + "description": "BAD REQUEST", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDrop-ValidationError1" + }, + { + "example": { + "error": { + "code": "bad_request", + "detail": "accountNumber is required", + "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" + } + } + } + ] + }, + "example": { + "error": { + "code": "bad_request", + "detail": "accountNumber is required", + "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" + } + } + } + } + } + }, + "deprecated": false, + "security": [] + } + } + }, + "components": { + "schemas": { + "VerifyPennyLessDropRequest": { + "title": "VerifyPennyLessDropRequest", + "required": [ + "accountNumber", + "ifsc" + ], + "type": "object", + "properties": { + "accountNumber": { + "type": "string" + }, + "ifsc": { + "type": "string" + } + }, + "example": { + "accountNumber": "50100221813167", + "ifsc": "HDFC0000839" + } + }, + "VerifyPennyLessDropMerchant-Success": { + "title": "VerifyPennyLessDropMerchant-Success", + "required": [ + "traceId", + "data", + "status" + ], + "type": "object", + "properties": { + "traceId": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data" + }, + "status": { + "type": "string" + } + }, + "example": { + "traceId": "ca782918-f701-4033-84eb-30611381cfb7", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "status": "SUCCESS" + } + }, + "Data": { + "title": "Data", + "required": [ + "bankAccountNumber", + "bankAccountName", + "bankAccountIfsc", + "entityType", + "ifscCrossCheck", + "ifscDetails", + "merchantDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "entityType": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + }, + "merchantDetails": { + "$ref": "#/components/schemas/MerchantDetails" + } + }, + "example": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + } + }, + "IfscDetails": { + "title": "IfscDetails", + "required": [ + "name", + "branch", + "center", + "district", + "state", + "address", + "contact", + "imps", + "rtgs", + "city", + "iso3166", + "neft", + "micr", + "upi", + "swift" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "center": { + "type": "string" + }, + "district": { + "type": "string" + }, + "state": { + "type": "string" + }, + "address": { + "type": "string" + }, + "contact": { + "type": "string" + }, + "imps": { + "type": "string" + }, + "rtgs": { + "type": "string" + }, + "city": { + "type": "string" + }, + "iso3166": { + "type": "string" + }, + "neft": { + "type": "string" + }, + "micr": { + "type": "string" + }, + "upi": { + "type": "string" + }, + "swift": { + "type": "string" + } + }, + "example": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + } + }, + "MerchantDetails": { + "title": "MerchantDetails", + "required": [ + "mccCode", + "identifier", + "name", + "ownership" + ], + "type": "object", + "properties": { + "mccCode": { + "type": "string" + }, + "identifier": { + "$ref": "#/components/schemas/Identifier" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "ownership": { + "$ref": "#/components/schemas/Ownership" + } + }, + "example": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "Identifier": { + "title": "Identifier", + "required": [ + "merchantType", + "merchantGenre", + "onBoardingType" + ], + "type": "object", + "properties": { + "merchantType": { + "type": "string" + }, + "merchantGenre": { + "type": "string" + }, + "onBoardingType": { + "type": "string" + } + }, + "example": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + } + }, + "Name": { + "title": "Name", + "required": [ + "brand", + "legal", + "franchise" + ], + "type": "object", + "properties": { + "brand": { + "type": "string" + }, + "legal": { + "type": "string" + }, + "franchise": { + "type": "string" + } + }, + "example": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + } + }, + "Ownership": { + "title": "Ownership", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + } + }, + "example": { + "type": "PRIVATE" + } + }, + "VerifyPennyLessDropIndividual-Success": { + "title": "VerifyPennyLessDropIndividual-Success", + "required": [ + "traceId", + "data", + "status" + ], + "type": "object", + "properties": { + "traceId": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data1" + }, + "status": { + "type": "string" + } + }, + "example": { + "traceId": "d0cc92a4-ca3f-4eb8-bbeb-4126620ec844", + "data": { + "bankAccountNumber": "1234567891", + "bankAccountName": "Pavankumar Kamat", + "bankAccountIfsc": "UTIB0002083", + "entityType": "INDIVIDUAL", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + } + }, + "status": "SUCCESS" + } + }, + "Data1": { + "title": "Data1", + "required": [ + "bankAccountNumber", + "bankAccountName", + "bankAccountIfsc", + "entityType", + "ifscCrossCheck", + "ifscDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "entityType": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + } + }, + "example": { + "bankAccountNumber": "1234567891", + "bankAccountName": "Pavankumar Kamat", + "bankAccountIfsc": "UTIB0002083", + "entityType": "INDIVIDUAL", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + } + } + }, + "VerifyPennyLessDrop-InvalidBankdetails": { + "title": "VerifyPennyLessDrop-InvalidBankdetails", + "required": [ + "traceId", + "message", + "status" + ], + "type": "object", + "properties": { + "traceId": { + "type": "string" + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "example": { + "traceId": "bda7cd75-a145-4138-82ad-257555501ed5", + "message": "Invalid bank details", + "status": "ERROR" + } + }, + "Error": { + "title": "Error", + "required": [ + "code", + "detail", + "traceId" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" + } + }, + "VerifyPennyLessDrop-UpstreamError1": { + "title": "VerifyPennyLessDrop-UpstreamError1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" + } + } + }, + "VerifyPennyLessDrop-ValidationError1": { + "title": "VerifyPennyLessDrop-ValidationError1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "bad_request", + "detail": "accountNumber is required", + "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" + } + } + } + }, + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "tags": [ + { + "name": "PennyLess Drop" + } + ] + } \ No newline at end of file From ed00557a34180f6d72b61acdcdf4a6746c2c7a20 Mon Sep 17 00:00:00 2001 From: rahul roy Date: Wed, 18 Sep 2024 16:47:44 +0530 Subject: [PATCH 2/8] correct description --- api-references/data/bav/penny-less.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-references/data/bav/penny-less.json b/api-references/data/bav/penny-less.json index 1a769bdb..34ce9611 100644 --- a/api-references/data/bav/penny-less.json +++ b/api-references/data/bav/penny-less.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Data Gateway - BAV Penny Less", - "description": "Confirm the validity of an account from the account holder’s bank, with penny-drop done in real-time.", + "description": "Confirm the validity of an account from the account holder’s bank, with penny-less drop done in real-time.", "contact": {}, "version": "1.0" }, From 8df286f588bfc002cb3f0d1ccc138732734a9875 Mon Sep 17 00:00:00 2001 From: rahul roy Date: Wed, 18 Sep 2024 17:16:13 +0530 Subject: [PATCH 3/8] add mdx path to api reference penny-less --- .../data/bav/{penny-less.json => pennyless-drop.json} | 6 ++++-- content/data/bav/pennyless-drop/api-reference.mdx | 6 ++++++ 2 files changed, 10 insertions(+), 2 deletions(-) rename api-references/data/bav/{penny-less.json => pennyless-drop.json} (99%) create mode 100644 content/data/bav/pennyless-drop/api-reference.mdx diff --git a/api-references/data/bav/penny-less.json b/api-references/data/bav/pennyless-drop.json similarity index 99% rename from api-references/data/bav/penny-less.json rename to api-references/data/bav/pennyless-drop.json index 34ce9611..f304aae7 100644 --- a/api-references/data/bav/penny-less.json +++ b/api-references/data/bav/pennyless-drop.json @@ -269,10 +269,12 @@ "type": "object", "properties": { "accountNumber": { - "type": "string" + "type": "string", + "description": "bank account number" }, "ifsc": { - "type": "string" + "type": "string", + "description": "bank ifsc code" } }, "example": { diff --git a/content/data/bav/pennyless-drop/api-reference.mdx b/content/data/bav/pennyless-drop/api-reference.mdx new file mode 100644 index 00000000..5e84fcd7 --- /dev/null +++ b/content/data/bav/pennyless-drop/api-reference.mdx @@ -0,0 +1,6 @@ +--- +sidebar_title: API reference +page_title: BAV Pennyless API reference +order: 2 +visible_in_sidebar: true +--- From 3e82dc79e7e0fa1837de8aa61c312de782a4b90d Mon Sep 17 00:00:00 2001 From: rahul roy Date: Wed, 18 Sep 2024 18:58:20 +0530 Subject: [PATCH 4/8] add api reference for setu-bav --- .../data/bav/pennydrop-pennyless.json | 1468 +++++++++++++++++ .../bav/pennydrop-pennyless/api-reference.mdx | 6 + 2 files changed, 1474 insertions(+) create mode 100644 api-references/data/bav/pennydrop-pennyless.json create mode 100644 content/data/bav/pennydrop-pennyless/api-reference.mdx diff --git a/api-references/data/bav/pennydrop-pennyless.json b/api-references/data/bav/pennydrop-pennyless.json new file mode 100644 index 00000000..7507b7cf --- /dev/null +++ b/api-references/data/bav/pennydrop-pennyless.json @@ -0,0 +1,1468 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Data Gateway Pennydrop-pennyless", + "description": "Confirm the validity of an account from the account holder’s bank, with pennyless as primary and penny-drop as fallback done in real-time.", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } + ], + "paths": { + "/async": { + "post": { + "tags": [ + "SETU BAV" + ], + "summary": "Create", + "operationId": "Create", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{setu_bav_product_instance_id}}" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateRequest" + }, + { + "example": { + "ifsc": "UTIB0002083", + "accountNumber": "1234567890" + } + } + ] + }, + "example": { + "ifsc": "UTIB0002083", + "accountNumber": "1234567890" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "CREATED", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Success" + }, + { + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "CREATED", + "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" + } + } + ] + }, + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "CREATED", + "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" + } + } + } + }, + "400": { + "description": "BAD REQUEST", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Failed1" + }, + { + "example": { + "error": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" + } + } + } + ] + }, + "example": { + "error": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" + } + } + } + } + } + }, + "deprecated": false + } + }, + "/{request_id}": { + "get": { + "tags": [ + "SETU BAV" + ], + "summary": "Get details", + "operationId": "Getdetails", + "parameters": [ + { + "name": "request_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{request_id}}" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{setu_bav_product_instance_id}}" + } + }, + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Content-Length": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "711" + } + } + } + }, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success-pennydrop" + }, + { + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "SUCCESS", + "fulfillmentType": "PENNYDROP", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + }, + "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + } + } + ] + }, + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "SUCCESS", + "fulfillmentType": "PENNYDROP", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + }, + "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + } + } + } + }, + "400": { + "description": "BAD REQUEST", + "headers": { + "Content-Length": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "112" + } + } + }, + "Connection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "keep-alive" + } + } + }, + "RateLimit-Remaining": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" + } + } + }, + "RateLimit-Limit": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" + } + } + }, + "X-RateLimit-Limit-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" + } + } + }, + "X-RateLimit-Remaining-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" + } + } + }, + "RateLimit-Reset": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1" + } + } + }, + "Server": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "SETU" + } + } + }, + "Date": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "Thu, 31 Aug 2023 14:11:02 GMT" + } + } + }, + "Permissions-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "interest-cohort=()" + } + } + }, + "X-Frame-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "DENY" + } + } + }, + "X-XSS-Protection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1; mode=block" + } + } + }, + "X-Content-Type-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "nosniff" + } + } + }, + "Content-Security-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "default-src 'self'; img-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com; script-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com 'unsafe-inline'; style-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com fonts.googleapis.com 'unsafe-inline'; font-src fonts.gstatic.com" + } + } + }, + "Referrer-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "strict-origin-when-cross-origin" + } + } + }, + "Strict-Transport-Security": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "max-age=31556926; includeSubDomains" + } + } + }, + "Cache-Control": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0, max-stale = 0" + } + } + }, + "Pragma": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-cache" + } + } + }, + "X-Kong-Upstream-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "19" + } + } + }, + "X-Kong-Proxy-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "39" + } + } + } + }, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/failed-invalidtxs1" + }, + { + "example": { + "error": { + "code": "BAV12", + "detail": "Invalid transaction", + "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" + } + } + } + ] + }, + "example": { + "error": { + "code": "BAV12", + "detail": "Invalid transaction", + "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" + } + } + } + } + }, + "500": { + "description": "INTERNAL SERVER ERROR", + "headers": { + "Content-Length": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "108" + } + } + }, + "Connection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "keep-alive" + } + } + }, + "RateLimit-Remaining": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" + } + } + }, + "RateLimit-Limit": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" + } + } + }, + "X-RateLimit-Limit-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" + } + } + }, + "X-RateLimit-Remaining-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" + } + } + }, + "RateLimit-Reset": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1" + } + } + }, + "Server": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "SETU" + } + } + }, + "Date": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "Thu, 31 Aug 2023 14:12:16 GMT" + } + } + }, + "Permissions-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "interest-cohort=()" + } + } + }, + "X-Frame-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "DENY" + } + } + }, + "X-XSS-Protection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1; mode=block" + } + } + }, + "X-Content-Type-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "nosniff" + } + } + }, + "Content-Security-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "default-src 'self'; img-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com; script-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com 'unsafe-inline'; style-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com fonts.googleapis.com 'unsafe-inline'; font-src fonts.gstatic.com" + } + } + }, + "Referrer-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "strict-origin-when-cross-origin" + } + } + }, + "Strict-Transport-Security": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "max-age=31556926; includeSubDomains" + } + } + }, + "Cache-Control": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0, max-stale = 0" + } + } + }, + "Pragma": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-cache" + } + } + }, + "X-Kong-Upstream-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "42" + } + } + }, + "X-Kong-Proxy-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "13" + } + } + } + }, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/upstreamerror1" + }, + { + "example": { + "error": { + "code": "BAV2000", + "detail": "Upsteam error", + "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" + } + } + } + ] + }, + "example": { + "error": { + "code": "BAV2000", + "detail": "Upsteam error", + "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "components": { + "schemas": { + "CreateRequest": { + "title": "CreateRequest", + "required": [ + "ifsc", + "accountNumber" + ], + "type": "object", + "properties": { + "ifsc": { + "type": "string" + }, + "accountNumber": { + "type": "string" + } + }, + "example": { + "ifsc": "UTIB0002083", + "accountNumber": "1234567890" + } + }, + "Success": { + "title": "Success", + "required": [ + "id", + "status", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "CREATED", + "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" + } + }, + "Error": { + "title": "Error", + "required": [ + "code", + "detail", + "traceId" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" + } + }, + "Failed1": { + "title": "Failed1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" + } + } + }, + "success-pennydrop": { + "title": "success-pennydrop", + "required": [ + "id", + "status", + "fulfillmentType", + "data", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "fulfillmentType": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "SUCCESS", + "fulfillmentType": "PENNYDROP", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + }, + "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + } + }, + "Data": { + "title": "Data", + "required": [ + "bankAccountNumber", + "bankAccountIfsc", + "bankAccountName", + "ifscCrossCheck", + "ifscDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + } + }, + "example": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + } + }, + "IfscDetails": { + "title": "IfscDetails", + "required": [ + "name", + "branch", + "center", + "district", + "state", + "address", + "contact", + "imps", + "rtgs", + "city", + "iso3166", + "neft", + "micr", + "upi", + "swift" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "center": { + "type": "string" + }, + "district": { + "type": "string" + }, + "state": { + "type": "string" + }, + "address": { + "type": "string" + }, + "contact": { + "type": "string" + }, + "imps": { + "type": "string" + }, + "rtgs": { + "type": "string" + }, + "city": { + "type": "string" + }, + "iso3166": { + "type": "string" + }, + "neft": { + "type": "string" + }, + "micr": { + "type": "string" + }, + "upi": { + "type": "string" + }, + "swift": { + "type": "string" + } + }, + "example": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + }, + "failed-invalidtxs1": { + "title": "failed-invalidtxs1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "BAV12", + "detail": "Invalid transaction", + "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" + } + } + }, + "upstreamerror1": { + "title": "upstreamerror1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "BAV2000", + "detail": "Upsteam error", + "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" + } + } + }, + "pennyless-INDIVIDUAL": { + "title": "pennyless-INDIVIDUAL", + "required": [ + "id", + "status", + "fulfillmentType", + "data", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "fulfillmentType": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data1" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "id": "36b2bb8e-af2b-4791-adf7-d8553d459de5", + "status": "SUCCESS", + "fulfillmentType": "PENNYLESS", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "UTIB0002084", + "bankAccountName": "PAVANKUMAR KAMAT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "BHADRAVATHI", + "center": "SHIMOGA", + "district": "SHIMOGA", + "state": "KARNATAKA", + "address": "AXIS BANK LTD POOJA BUILDING WARD NUMBER4, NEAR RANGAPPA CIRCLE, C N ROAD,BHADRAVATHI 577301", + "contact": "+919886464250", + "imps": "true", + "rtgs": "true", + "city": "BHADRAVATHI", + "iso3166": "IN-KA", + "neft": "true", + "micr": "577211203", + "upi": "true", + "swift": "" + }, + "entityType": "INDIVIDUAL" + }, + "traceId": "44fb1c9c-3af6-4961-8215-04fa6d1fcd52" + } + }, + "Data1": { + "title": "Data1", + "required": [ + "bankAccountNumber", + "bankAccountIfsc", + "bankAccountName", + "ifscCrossCheck", + "ifscDetails", + "entityType" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + }, + "entityType": { + "type": "string" + } + }, + "example": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "UTIB0002084", + "bankAccountName": "PAVANKUMAR KAMAT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "BHADRAVATHI", + "center": "SHIMOGA", + "district": "SHIMOGA", + "state": "KARNATAKA", + "address": "AXIS BANK LTD POOJA BUILDING WARD NUMBER4, NEAR RANGAPPA CIRCLE, C N ROAD,BHADRAVATHI 577301", + "contact": "+919886464250", + "imps": "true", + "rtgs": "true", + "city": "BHADRAVATHI", + "iso3166": "IN-KA", + "neft": "true", + "micr": "577211203", + "upi": "true", + "swift": "" + }, + "entityType": "INDIVIDUAL" + } + }, + "pennyless-MERCHANT": { + "title": "pennyless-MERCHANT", + "required": [ + "id", + "status", + "fulfillmentType", + "data", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "fulfillmentType": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data2" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "id": "50c4b0a4-7de2-4eb3-9d78-153fb4d9991d", + "status": "SUCCESS", + "fulfillmentType": "PENNYLESS", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "UTIB0002083", + "bankAccountName": "PAVANKUMAR KAMAT BIZ", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "+919824188896", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "entityType": "MERCHANT", + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "traceId": "1ab2fbc8-5b10-4358-8a87-a46592b89a6b" + } + }, + "Data2": { + "title": "Data2", + "required": [ + "bankAccountNumber", + "bankAccountIfsc", + "bankAccountName", + "ifscCrossCheck", + "ifscDetails", + "entityType", + "merchantDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + }, + "entityType": { + "type": "string" + }, + "merchantDetails": { + "$ref": "#/components/schemas/MerchantDetails" + } + }, + "example": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "UTIB0002083", + "bankAccountName": "PAVANKUMAR KAMAT BIZ", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "+919824188896", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "entityType": "MERCHANT", + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + } + }, + "MerchantDetails": { + "title": "MerchantDetails", + "required": [ + "mccCode", + "identifier", + "name", + "ownership" + ], + "type": "object", + "properties": { + "mccCode": { + "type": "string" + }, + "identifier": { + "$ref": "#/components/schemas/Identifier" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "ownership": { + "$ref": "#/components/schemas/Ownership" + } + }, + "example": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "Identifier": { + "title": "Identifier", + "required": [ + "merchantType", + "merchantGenre", + "onBoardingType" + ], + "type": "object", + "properties": { + "merchantType": { + "type": "string" + }, + "merchantGenre": { + "type": "string" + }, + "onBoardingType": { + "type": "string" + } + }, + "example": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + } + }, + "Name": { + "title": "Name", + "required": [ + "brand", + "legal", + "franchise" + ], + "type": "object", + "properties": { + "brand": { + "type": "string" + }, + "legal": { + "type": "string" + }, + "franchise": { + "type": "string" + } + }, + "example": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + } + }, + "Ownership": { + "title": "Ownership", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + } + }, + "example": { + "type": "PRIVATE" + } + } + }, + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "tags": [ + { + "name": "SETU BAV" + } + ] + } \ No newline at end of file diff --git a/content/data/bav/pennydrop-pennyless/api-reference.mdx b/content/data/bav/pennydrop-pennyless/api-reference.mdx new file mode 100644 index 00000000..24a70c83 --- /dev/null +++ b/content/data/bav/pennydrop-pennyless/api-reference.mdx @@ -0,0 +1,6 @@ +--- +sidebar_title: API reference +page_title: BAV Pennydrop-pennyless API reference +order: 2 +visible_in_sidebar: true +--- From ea53499d55fdadf09563d4fa98b9702e8e364675 Mon Sep 17 00:00:00 2001 From: Aditya Gannavarapu Date: Thu, 19 Sep 2024 14:32:08 +0530 Subject: [PATCH 5/8] Update description and pattern --- .../data/bav/pennydrop-pennyless.json | 2430 +++++++++-------- 1 file changed, 1217 insertions(+), 1213 deletions(-) diff --git a/api-references/data/bav/pennydrop-pennyless.json b/api-references/data/bav/pennydrop-pennyless.json index 7507b7cf..82f192ec 100644 --- a/api-references/data/bav/pennydrop-pennyless.json +++ b/api-references/data/bav/pennydrop-pennyless.json @@ -1,937 +1,888 @@ { - "openapi": "3.0.0", - "info": { - "title": "Data Gateway Pennydrop-pennyless", - "description": "Confirm the validity of an account from the account holder’s bank, with pennyless as primary and penny-drop as fallback done in real-time.", - "contact": {}, - "version": "1.0" - }, - "servers": [ - { - "url": "https://dg-sandbox.setu.co", - "description": "Sandbox" - }, - { - "url": "https://dg.setu.co", - "description": "Production" - } - ], - "paths": { - "/async": { - "post": { - "tags": [ - "SETU BAV" - ], - "summary": "Create", - "operationId": "Create", - "parameters": [ - { - "name": "x-client-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{client_id}}" - } - }, - { - "name": "x-client-secret", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{secret}}" - } - }, - { - "name": "x-product-instance-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", + "openapi": "3.0.0", + "info": { + "title": "Data Gateway Pennydrop-pennyless", + "description": "Confirm the validity of an account from the account holder’s bank, with pennyless as primary and penny-drop as fallback done in real-time.", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } + ], + "paths": { + "/async": { + "post": { + "tags": [ + "SETU BAV" + ], + "summary": "Create", + "operationId": "Create", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{setu_bav_product_instance_id}}" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { "schema": { - "type": "string", - "example": "{{setu_bav_product_instance_id}}" + "allOf": [ + { + "$ref": "#/components/schemas/CreateRequest" + }, + { + "example": { + "ifsc": "UTIB0002083", + "accountNumber": "1234567890" + } + } + ] + }, + "example": { + "ifsc": "UTIB0002083", + "accountNumber": "1234567890" } } - ], - "requestBody": { - "description": "", + }, + "required": true + }, + "responses": { + "201": { + "description": "CREATED", + "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateRequest" + "$ref": "#/components/schemas/Success" }, { "example": { - "ifsc": "UTIB0002083", - "accountNumber": "1234567890" + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "CREATED", + "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" } } ] }, "example": { - "ifsc": "UTIB0002083", - "accountNumber": "1234567890" + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "CREATED", + "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" } } - }, - "required": true - }, - "responses": { - "201": { - "description": "CREATED", - "headers": {}, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Success" - }, - { - "example": { - "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", - "status": "CREATED", - "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" - } - } - ] - }, - "example": { - "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", - "status": "CREATED", - "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" - } - } - } - }, - "400": { - "description": "BAD REQUEST", - "headers": {}, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Failed1" - }, - { - "example": { - "error": { - "code": "BAVM1", - "detail": "Either ifsc or bank account is invalid", - "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" - } + } + }, + "400": { + "description": "BAD REQUEST", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Failed1" + }, + { + "example": { + "error": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" } } - ] - }, - "example": { - "error": { - "code": "BAVM1", - "detail": "Either ifsc or bank account is invalid", - "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" } + ] + }, + "example": { + "error": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" } } } } + } + }, + "deprecated": false + } + }, + "/{request_id}": { + "get": { + "tags": [ + "SETU BAV" + ], + "summary": "Get details", + "operationId": "Getdetails", + "parameters": [ + { + "name": "request_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{request_id}}" + } }, - "deprecated": false - } - }, - "/{request_id}": { - "get": { - "tags": [ - "SETU BAV" - ], - "summary": "Get details", - "operationId": "Getdetails", - "parameters": [ - { - "name": "request_id", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{request_id}}" - } - }, - { - "name": "x-product-instance-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{setu_bav_product_instance_id}}" - } - }, - { - "name": "x-client-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{client_id}}" - } - }, - { - "name": "x-client-secret", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{secret}}" - } + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{setu_bav_product_instance_id}}" } - ], - "responses": { - "200": { - "description": "OK", - "headers": { - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "711" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success-pennydrop" - }, - { - "example": { - "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", - "status": "SUCCESS", - "fulfillmentType": "PENNYDROP", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountIfsc": "ABCD0123456", - "bankAccountName": "Test User Name", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "State Bank of India", - "branch": "CANTONMENT, BARODA", - "center": "BARODA", - "district": "BARODA", - "state": "GUJARAT", - "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", - "contact": "+912652795129", - "imps": "true", - "rtgs": "true", - "city": "VADODARA", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "390002022", - "upi": "true", - "swift": "" - } - }, - "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" - } - } - ] - }, - "example": { - "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", - "status": "SUCCESS", - "fulfillmentType": "PENNYDROP", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountIfsc": "ABCD0123456", - "bankAccountName": "Test User Name", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "State Bank of India", - "branch": "CANTONMENT, BARODA", - "center": "BARODA", - "district": "BARODA", - "state": "GUJARAT", - "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", - "contact": "+912652795129", - "imps": "true", - "rtgs": "true", - "city": "VADODARA", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "390002022", - "upi": "true", - "swift": "" - } + }, + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Content-Length": { + "content": { + "text/plain": { + "schema": { + "type": "string" }, - "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + "example": "711" } } } }, - "400": { - "description": "BAD REQUEST", - "headers": { - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "112" + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success-pennydrop" + }, + { + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "SUCCESS", + "fulfillmentType": "PENNYDROP", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + }, + "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + } } - } + ] }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "SUCCESS", + "fulfillmentType": "PENNYDROP", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" } + }, + "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + } + } + } + }, + "400": { + "description": "BAD REQUEST", + "headers": { + "Content-Length": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "112" } - }, - "RateLimit-Remaining": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1999" - } + } + }, + "Connection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "keep-alive" } - }, - "RateLimit-Limit": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "2000" - } + } + }, + "RateLimit-Remaining": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" } - }, - "X-RateLimit-Limit-Second": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "2000" - } + } + }, + "RateLimit-Limit": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" } - }, - "X-RateLimit-Remaining-Second": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1999" - } + } + }, + "X-RateLimit-Limit-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" } - }, - "RateLimit-Reset": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1" - } + } + }, + "X-RateLimit-Remaining-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "SETU" - } + } + }, + "RateLimit-Reset": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1" } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Thu, 31 Aug 2023 14:11:02 GMT" - } + } + }, + "Server": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "SETU" } - }, - "Permissions-Policy": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "interest-cohort=()" - } + } + }, + "Date": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "Thu, 31 Aug 2023 14:11:02 GMT" } - }, - "X-Frame-Options": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "DENY" - } + } + }, + "Permissions-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "interest-cohort=()" } - }, - "X-XSS-Protection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1; mode=block" - } + } + }, + "X-Frame-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "DENY" } - }, - "X-Content-Type-Options": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nosniff" - } + } + }, + "X-XSS-Protection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1; mode=block" } - }, - "Content-Security-Policy": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "default-src 'self'; img-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com; script-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com 'unsafe-inline'; style-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com fonts.googleapis.com 'unsafe-inline'; font-src fonts.gstatic.com" - } + } + }, + "X-Content-Type-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "nosniff" } - }, - "Referrer-Policy": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "strict-origin-when-cross-origin" - } + } + }, + "Content-Security-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "default-src 'self'; img-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com; script-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com 'unsafe-inline'; style-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com fonts.googleapis.com 'unsafe-inline'; font-src fonts.gstatic.com" } - }, - "Strict-Transport-Security": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "max-age=31556926; includeSubDomains" - } + } + }, + "Referrer-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "strict-origin-when-cross-origin" } - }, - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0, max-stale = 0" - } + } + }, + "Strict-Transport-Security": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "max-age=31556926; includeSubDomains" } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } + } + }, + "Cache-Control": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0, max-stale = 0" } - }, - "X-Kong-Upstream-Latency": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "19" - } + } + }, + "Pragma": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-cache" } - }, - "X-Kong-Proxy-Latency": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "39" - } + } + }, + "X-Kong-Upstream-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "19" } } }, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/failed-invalidtxs1" - }, - { - "example": { - "error": { - "code": "BAV12", - "detail": "Invalid transaction", - "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" - } - } - } - ] - }, - "example": { - "error": { - "code": "BAV12", - "detail": "Invalid transaction", - "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" - } + "X-Kong-Proxy-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "39" } } } }, - "500": { - "description": "INTERNAL SERVER ERROR", - "headers": { - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "108" + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/failed-invalidtxs1" + }, + { + "example": { + "error": { + "code": "BAV12", + "detail": "Invalid transaction", + "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" + } + } } - } + ] }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } + "example": { + "error": { + "code": "BAV12", + "detail": "Invalid transaction", + "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" } - }, - "RateLimit-Remaining": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1999" - } + } + } + } + }, + "500": { + "description": "INTERNAL SERVER ERROR", + "headers": { + "Content-Length": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "108" } - }, - "RateLimit-Limit": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "2000" - } + } + }, + "Connection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "keep-alive" } - }, - "X-RateLimit-Limit-Second": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "2000" - } + } + }, + "RateLimit-Remaining": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" } - }, - "X-RateLimit-Remaining-Second": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1999" - } + } + }, + "RateLimit-Limit": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" } - }, - "RateLimit-Reset": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1" - } + } + }, + "X-RateLimit-Limit-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "2000" } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "SETU" - } + } + }, + "X-RateLimit-Remaining-Second": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1999" } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Thu, 31 Aug 2023 14:12:16 GMT" - } + } + }, + "RateLimit-Reset": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1" } - }, - "Permissions-Policy": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "interest-cohort=()" - } + } + }, + "Server": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "SETU" } - }, - "X-Frame-Options": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "DENY" - } + } + }, + "Date": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "Thu, 31 Aug 2023 14:12:16 GMT" } - }, - "X-XSS-Protection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1; mode=block" - } + } + }, + "Permissions-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "interest-cohort=()" } - }, - "X-Content-Type-Options": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nosniff" - } + } + }, + "X-Frame-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "DENY" } - }, - "Content-Security-Policy": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "default-src 'self'; img-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com; script-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com 'unsafe-inline'; style-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com fonts.googleapis.com 'unsafe-inline'; font-src fonts.gstatic.com" - } + } + }, + "X-XSS-Protection": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "1; mode=block" } - }, - "Referrer-Policy": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "strict-origin-when-cross-origin" - } + } + }, + "X-Content-Type-Options": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "nosniff" } - }, - "Strict-Transport-Security": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "max-age=31556926; includeSubDomains" - } + } + }, + "Content-Security-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "default-src 'self'; img-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com; script-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com 'unsafe-inline'; style-src 'self' data-gateway-resources.s3.ap-south-1.amazonaws.com fonts.googleapis.com 'unsafe-inline'; font-src fonts.gstatic.com" + } + } + }, + "Referrer-Policy": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "strict-origin-when-cross-origin" } - }, - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0, max-stale = 0" - } + } + }, + "Strict-Transport-Security": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "max-age=31556926; includeSubDomains" } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } + } + }, + "Cache-Control": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0, max-stale = 0" } - }, - "X-Kong-Upstream-Latency": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "42" - } + } + }, + "Pragma": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "no-cache" } - }, - "X-Kong-Proxy-Latency": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "13" - } + } + }, + "X-Kong-Upstream-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "42" } } }, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/upstreamerror1" - }, - { - "example": { - "error": { - "code": "BAV2000", - "detail": "Upsteam error", - "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" - } + "X-Kong-Proxy-Latency": { + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "example": "13" + } + } + } + }, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/upstreamerror1" + }, + { + "example": { + "error": { + "code": "BAV2000", + "detail": "Upsteam error", + "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" } } - ] - }, - "example": { - "error": { - "code": "BAV2000", - "detail": "Upsteam error", - "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" } + ] + }, + "example": { + "error": { + "code": "BAV2000", + "detail": "Upsteam error", + "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" } } } } - }, - "deprecated": false - } + } + }, + "deprecated": false } - }, - "components": { - "schemas": { - "CreateRequest": { - "title": "CreateRequest", - "required": [ - "ifsc", - "accountNumber" - ], - "type": "object", - "properties": { - "ifsc": { - "type": "string" - }, - "accountNumber": { - "type": "string" - } + } + }, + "components": { + "schemas": { + "CreateRequest": { + "title": "CreateRequest", + "required": [ + "ifsc", + "accountNumber" + ], + "type": "object", + "properties": { + "accountNumber": { + "type": "string", + "description": "bank account number", + "pattern" : "^\\d{9,18}$" }, - "example": { - "ifsc": "UTIB0002083", - "accountNumber": "1234567890" + "ifsc": { + "type": "string", + "description": "bank ifsc code", + "pattern" : "^[A-Za-z]{4}0[A-Z0-9a-z]{6}$" } }, - "Success": { - "title": "Success", - "required": [ - "id", - "status", - "traceId" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "traceId": { - "type": "string" - } + "example": { + "ifsc": "UTIB0002083", + "accountNumber": "1234567890" + } + }, + "Success": { + "title": "Success", + "required": [ + "id", + "status", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" }, - "example": { - "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", - "status": "CREATED", - "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" + "traceId": { + "type": "string" } }, - "Error": { - "title": "Error", - "required": [ - "code", - "detail", - "traceId" - ], - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "detail": { - "type": "string" - }, - "traceId": { - "type": "string" - } + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "CREATED", + "traceId": "e99b6f9a-41bc-4063-adcf-cd27043785d4" + } + }, + "Error": { + "title": "Error", + "required": [ + "code", + "detail", + "traceId" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "detail": { + "type": "string" }, - "example": { + "traceId": { + "type": "string" + } + }, + "example": { + "code": "BAVM1", + "detail": "Either ifsc or bank account is invalid", + "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" + } + }, + "Failed1": { + "title": "Failed1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { "code": "BAVM1", "detail": "Either ifsc or bank account is invalid", "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" } - }, - "Failed1": { - "title": "Failed1", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } + } + }, + "success-pennydrop": { + "title": "success-pennydrop", + "required": [ + "id", + "status", + "fulfillmentType", + "data", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" }, - "example": { - "error": { - "code": "BAVM1", - "detail": "Either ifsc or bank account is invalid", - "traceId": "f8d0e4f2-674f-4192-863a-6e9c1f595bc3" - } - } - }, - "success-pennydrop": { - "title": "success-pennydrop", - "required": [ - "id", - "status", - "fulfillmentType", - "data", - "traceId" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "fulfillmentType": { - "type": "string" - }, - "data": { - "$ref": "#/components/schemas/Data" - }, - "traceId": { - "type": "string" - } + "status": { + "type": "string" }, - "example": { - "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", - "status": "SUCCESS", - "fulfillmentType": "PENNYDROP", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountIfsc": "ABCD0123456", - "bankAccountName": "Test User Name", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "State Bank of India", - "branch": "CANTONMENT, BARODA", - "center": "BARODA", - "district": "BARODA", - "state": "GUJARAT", - "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", - "contact": "+912652795129", - "imps": "true", - "rtgs": "true", - "city": "VADODARA", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "390002022", - "upi": "true", - "swift": "" - } - }, - "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + "fulfillmentType": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data" + }, + "traceId": { + "type": "string" } }, - "Data": { - "title": "Data", - "required": [ - "bankAccountNumber", - "bankAccountIfsc", - "bankAccountName", - "ifscCrossCheck", - "ifscDetails" - ], - "type": "object", - "properties": { - "bankAccountNumber": { - "type": "string" - }, - "bankAccountIfsc": { - "type": "string" - }, - "bankAccountName": { - "type": "string" - }, - "ifscCrossCheck": { - "type": "boolean" - }, - "ifscDetails": { - "$ref": "#/components/schemas/IfscDetails" - } - }, - "example": { + "example": { + "id": "3afb7ca0-535a-4d5a-9892-960c03c4e966", + "status": "SUCCESS", + "fulfillmentType": "PENNYDROP", + "data": { "bankAccountNumber": "1234567890", "bankAccountIfsc": "ABCD0123456", "bankAccountName": "Test User Name", @@ -953,76 +904,43 @@ "upi": "true", "swift": "" } + }, + "traceId": "cf7d0e36-1eb8-46b1-ac66-e0576d4d18f1" + } + }, + "Data": { + "title": "Data", + "required": [ + "bankAccountNumber", + "bankAccountIfsc", + "bankAccountName", + "ifscCrossCheck", + "ifscDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" } }, - "IfscDetails": { - "title": "IfscDetails", - "required": [ - "name", - "branch", - "center", - "district", - "state", - "address", - "contact", - "imps", - "rtgs", - "city", - "iso3166", - "neft", - "micr", - "upi", - "swift" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "center": { - "type": "string" - }, - "district": { - "type": "string" - }, - "state": { - "type": "string" - }, - "address": { - "type": "string" - }, - "contact": { - "type": "string" - }, - "imps": { - "type": "string" - }, - "rtgs": { - "type": "string" - }, - "city": { - "type": "string" - }, - "iso3166": { - "type": "string" - }, - "neft": { - "type": "string" - }, - "micr": { - "type": "string" - }, - "upi": { - "type": "string" - }, - "swift": { - "type": "string" - } - }, - "example": { + "example": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "ABCD0123456", + "bankAccountName": "Test User Name", + "ifscCrossCheck": true, + "ifscDetails": { "name": "State Bank of India", "branch": "CANTONMENT, BARODA", "center": "BARODA", @@ -1039,135 +957,163 @@ "upi": "true", "swift": "" } - }, - "failed-invalidtxs1": { - "title": "failed-invalidtxs1", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } + } + }, + "IfscDetails": { + "title": "IfscDetails", + "required": [ + "name", + "branch", + "center", + "district", + "state", + "address", + "contact", + "imps", + "rtgs", + "city", + "iso3166", + "neft", + "micr", + "upi", + "swift" + ], + "type": "object", + "properties": { + "name": { + "type": "string" }, - "example": { - "error": { - "code": "BAV12", - "detail": "Invalid transaction", - "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" - } + "branch": { + "type": "string" + }, + "center": { + "type": "string" + }, + "district": { + "type": "string" + }, + "state": { + "type": "string" + }, + "address": { + "type": "string" + }, + "contact": { + "type": "string" + }, + "imps": { + "type": "string" + }, + "rtgs": { + "type": "string" + }, + "city": { + "type": "string" + }, + "iso3166": { + "type": "string" + }, + "neft": { + "type": "string" + }, + "micr": { + "type": "string" + }, + "upi": { + "type": "string" + }, + "swift": { + "type": "string" } }, - "upstreamerror1": { - "title": "upstreamerror1", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "BAV2000", - "detail": "Upsteam error", - "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" - } + "example": { + "name": "State Bank of India", + "branch": "CANTONMENT, BARODA", + "center": "BARODA", + "district": "BARODA", + "state": "GUJARAT", + "address": "BARODA MUNICIPAL CORPN. SHOPPING COMPLEX,NEAR FATEHGUNJ PETROL PUMP ,FATEHGUNJ BARODA ,PIN - 390002", + "contact": "+912652795129", + "imps": "true", + "rtgs": "true", + "city": "VADODARA", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "390002022", + "upi": "true", + "swift": "" + } + }, + "failed-invalidtxs1": { + "title": "failed-invalidtxs1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" } }, - "pennyless-INDIVIDUAL": { - "title": "pennyless-INDIVIDUAL", - "required": [ - "id", - "status", - "fulfillmentType", - "data", - "traceId" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "fulfillmentType": { - "type": "string" - }, - "data": { - "$ref": "#/components/schemas/Data1" - }, - "traceId": { - "type": "string" - } - }, - "example": { - "id": "36b2bb8e-af2b-4791-adf7-d8553d459de5", - "status": "SUCCESS", - "fulfillmentType": "PENNYLESS", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountIfsc": "UTIB0002084", - "bankAccountName": "PAVANKUMAR KAMAT", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "Axis Bank", - "branch": "BHADRAVATHI", - "center": "SHIMOGA", - "district": "SHIMOGA", - "state": "KARNATAKA", - "address": "AXIS BANK LTD POOJA BUILDING WARD NUMBER4, NEAR RANGAPPA CIRCLE, C N ROAD,BHADRAVATHI 577301", - "contact": "+919886464250", - "imps": "true", - "rtgs": "true", - "city": "BHADRAVATHI", - "iso3166": "IN-KA", - "neft": "true", - "micr": "577211203", - "upi": "true", - "swift": "" - }, - "entityType": "INDIVIDUAL" - }, - "traceId": "44fb1c9c-3af6-4961-8215-04fa6d1fcd52" + "example": { + "error": { + "code": "BAV12", + "detail": "Invalid transaction", + "traceId": "38e6b7c5-7e64-47b0-975b-26bf07efbc58" + } + } + }, + "upstreamerror1": { + "title": "upstreamerror1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" } }, - "Data1": { - "title": "Data1", - "required": [ - "bankAccountNumber", - "bankAccountIfsc", - "bankAccountName", - "ifscCrossCheck", - "ifscDetails", - "entityType" - ], - "type": "object", - "properties": { - "bankAccountNumber": { - "type": "string" - }, - "bankAccountIfsc": { - "type": "string" - }, - "bankAccountName": { - "type": "string" - }, - "ifscCrossCheck": { - "type": "boolean" - }, - "ifscDetails": { - "$ref": "#/components/schemas/IfscDetails" - }, - "entityType": { - "type": "string" - } + "example": { + "error": { + "code": "BAV2000", + "detail": "Upsteam error", + "traceId": "a762f19a-e433-4d0a-9474-916e262f69ac" + } + } + }, + "pennyless-INDIVIDUAL": { + "title": "pennyless-INDIVIDUAL", + "required": [ + "id", + "status", + "fulfillmentType", + "data", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" }, - "example": { + "fulfillmentType": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data1" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "id": "36b2bb8e-af2b-4791-adf7-d8553d459de5", + "status": "SUCCESS", + "fulfillmentType": "PENNYLESS", + "data": { "bankAccountNumber": "1234567890", "bankAccountIfsc": "UTIB0002084", "bankAccountName": "PAVANKUMAR KAMAT", @@ -1190,118 +1136,98 @@ "swift": "" }, "entityType": "INDIVIDUAL" + }, + "traceId": "44fb1c9c-3af6-4961-8215-04fa6d1fcd52" + } + }, + "Data1": { + "title": "Data1", + "required": [ + "bankAccountNumber", + "bankAccountIfsc", + "bankAccountName", + "ifscCrossCheck", + "ifscDetails", + "entityType" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + }, + "entityType": { + "type": "string" } }, - "pennyless-MERCHANT": { - "title": "pennyless-MERCHANT", - "required": [ - "id", - "status", - "fulfillmentType", - "data", - "traceId" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "fulfillmentType": { - "type": "string" - }, - "data": { - "$ref": "#/components/schemas/Data2" - }, - "traceId": { - "type": "string" - } + "example": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "UTIB0002084", + "bankAccountName": "PAVANKUMAR KAMAT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "BHADRAVATHI", + "center": "SHIMOGA", + "district": "SHIMOGA", + "state": "KARNATAKA", + "address": "AXIS BANK LTD POOJA BUILDING WARD NUMBER4, NEAR RANGAPPA CIRCLE, C N ROAD,BHADRAVATHI 577301", + "contact": "+919886464250", + "imps": "true", + "rtgs": "true", + "city": "BHADRAVATHI", + "iso3166": "IN-KA", + "neft": "true", + "micr": "577211203", + "upi": "true", + "swift": "" }, - "example": { - "id": "50c4b0a4-7de2-4eb3-9d78-153fb4d9991d", - "status": "SUCCESS", - "fulfillmentType": "PENNYLESS", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountIfsc": "UTIB0002083", - "bankAccountName": "PAVANKUMAR KAMAT BIZ", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "Axis Bank", - "branch": "KAPODRA, SURAT", - "center": "SURAT", - "district": "SURAT", - "state": "GUJARAT", - "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", - "contact": "+919824188896", - "imps": "true", - "rtgs": "true", - "city": "SURAT", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "395211016", - "upi": "true", - "swift": "" - }, - "entityType": "MERCHANT", - "merchantDetails": { - "mccCode": "1520", - "identifier": { - "merchantType": "SMALL", - "merchantGenre": "OFFLINE", - "onBoardingType": "BANK" - }, - "name": { - "brand": "praimports", - "legal": "Indian", - "franchise": "rajababuimpor" - }, - "ownership": { - "type": "PRIVATE" - } - } - }, - "traceId": "1ab2fbc8-5b10-4358-8a87-a46592b89a6b" + "entityType": "INDIVIDUAL" + } + }, + "pennyless-MERCHANT": { + "title": "pennyless-MERCHANT", + "required": [ + "id", + "status", + "fulfillmentType", + "data", + "traceId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "fulfillmentType": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data2" + }, + "traceId": { + "type": "string" } }, - "Data2": { - "title": "Data2", - "required": [ - "bankAccountNumber", - "bankAccountIfsc", - "bankAccountName", - "ifscCrossCheck", - "ifscDetails", - "entityType", - "merchantDetails" - ], - "type": "object", - "properties": { - "bankAccountNumber": { - "type": "string" - }, - "bankAccountIfsc": { - "type": "string" - }, - "bankAccountName": { - "type": "string" - }, - "ifscCrossCheck": { - "type": "boolean" - }, - "ifscDetails": { - "$ref": "#/components/schemas/IfscDetails" - }, - "entityType": { - "type": "string" - }, - "merchantDetails": { - "$ref": "#/components/schemas/MerchantDetails" - } - }, - "example": { + "example": { + "id": "50c4b0a4-7de2-4eb3-9d78-153fb4d9991d", + "status": "SUCCESS", + "fulfillmentType": "PENNYLESS", + "data": { "bankAccountNumber": "1234567890", "bankAccountIfsc": "UTIB0002083", "bankAccountName": "PAVANKUMAR KAMAT BIZ", @@ -1340,32 +1266,69 @@ "type": "PRIVATE" } } + }, + "traceId": "1ab2fbc8-5b10-4358-8a87-a46592b89a6b" + } + }, + "Data2": { + "title": "Data2", + "required": [ + "bankAccountNumber", + "bankAccountIfsc", + "bankAccountName", + "ifscCrossCheck", + "ifscDetails", + "entityType", + "merchantDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + }, + "entityType": { + "type": "string" + }, + "merchantDetails": { + "$ref": "#/components/schemas/MerchantDetails" } }, - "MerchantDetails": { - "title": "MerchantDetails", - "required": [ - "mccCode", - "identifier", - "name", - "ownership" - ], - "type": "object", - "properties": { - "mccCode": { - "type": "string" - }, - "identifier": { - "$ref": "#/components/schemas/Identifier" - }, - "name": { - "$ref": "#/components/schemas/Name" - }, - "ownership": { - "$ref": "#/components/schemas/Ownership" - } + "example": { + "bankAccountNumber": "1234567890", + "bankAccountIfsc": "UTIB0002083", + "bankAccountName": "PAVANKUMAR KAMAT BIZ", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "+919824188896", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" }, - "example": { + "entityType": "MERCHANT", + "merchantDetails": { "mccCode": "1520", "identifier": { "merchantType": "SMALL", @@ -1381,88 +1344,129 @@ "type": "PRIVATE" } } - }, - "Identifier": { - "title": "Identifier", - "required": [ - "merchantType", - "merchantGenre", - "onBoardingType" - ], - "type": "object", - "properties": { - "merchantType": { - "type": "string" - }, - "merchantGenre": { - "type": "string" - }, - "onBoardingType": { - "type": "string" - } + } + }, + "MerchantDetails": { + "title": "MerchantDetails", + "required": [ + "mccCode", + "identifier", + "name", + "ownership" + ], + "type": "object", + "properties": { + "mccCode": { + "type": "string" + }, + "identifier": { + "$ref": "#/components/schemas/Identifier" }, - "example": { + "name": { + "$ref": "#/components/schemas/Name" + }, + "ownership": { + "$ref": "#/components/schemas/Ownership" + } + }, + "example": { + "mccCode": "1520", + "identifier": { "merchantType": "SMALL", "merchantGenre": "OFFLINE", "onBoardingType": "BANK" - } - }, - "Name": { - "title": "Name", - "required": [ - "brand", - "legal", - "franchise" - ], - "type": "object", - "properties": { - "brand": { - "type": "string" - }, - "legal": { - "type": "string" - }, - "franchise": { - "type": "string" - } }, - "example": { + "name": { "brand": "praimports", "legal": "Indian", "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "Identifier": { + "title": "Identifier", + "required": [ + "merchantType", + "merchantGenre", + "onBoardingType" + ], + "type": "object", + "properties": { + "merchantType": { + "type": "string" + }, + "merchantGenre": { + "type": "string" + }, + "onBoardingType": { + "type": "string" } }, - "Ownership": { - "title": "Ownership", - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - } + "example": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + } + }, + "Name": { + "title": "Name", + "required": [ + "brand", + "legal", + "franchise" + ], + "type": "object", + "properties": { + "brand": { + "type": "string" }, - "example": { - "type": "PRIVATE" + "legal": { + "type": "string" + }, + "franchise": { + "type": "string" } + }, + "example": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" } }, - "securitySchemes": { - "bearer": { - "type": "http", - "scheme": "bearer" + "Ownership": { + "title": "Ownership", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + } + }, + "example": { + "type": "PRIVATE" } } }, - "security": [ - { - "bearer": [] - } - ], - "tags": [ - { - "name": "SETU BAV" + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" } - ] - } \ No newline at end of file + } + }, + "security": [ + { + "bearer": [] + } + ], + "tags": [ + { + "name": "SETU BAV" + } + ] +} \ No newline at end of file From 62038299ffdec666ff126e798d5806773e7824ba Mon Sep 17 00:00:00 2001 From: Aditya Gannavarapu Date: Thu, 19 Sep 2024 14:32:27 +0530 Subject: [PATCH 6/8] Update desc and pattern --- api-references/data/bav/pennyless-drop.json | 1314 ++++++++++--------- 1 file changed, 658 insertions(+), 656 deletions(-) diff --git a/api-references/data/bav/pennyless-drop.json b/api-references/data/bav/pennyless-drop.json index f304aae7..63f0f406 100644 --- a/api-references/data/bav/pennyless-drop.json +++ b/api-references/data/bav/pennyless-drop.json @@ -1,387 +1,311 @@ { - "openapi": "3.0.0", - "info": { - "title": "Data Gateway - BAV Penny Less", - "description": "Confirm the validity of an account from the account holder’s bank, with penny-less drop done in real-time.", - "contact": {}, - "version": "1.0" - }, - "servers": [ - { - "url": "https://dg-sandbox.setu.co", - "description": "Sandbox" - }, - { - "url": "https://dg.setu.co", - "description": "Production" - } - ], - "paths": { - "/pennyless": { - "post": { - "tags": [ - "PennyLess Drop" - ], - "summary": "Verify PennyLess Drop", - "operationId": "VerifyPennyLessDrop", - "parameters": [ - { - "name": "x-client-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{client_id}}" - } - }, - { - "name": "x-client-secret", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "{{secret}}" - } - }, - { - "name": "x-product-instance-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", + "openapi": "3.0.0", + "info": { + "title": "Data Gateway - BAV Penny Less", + "description": "Confirm the validity of an account from the account holder’s bank, with penny-less drop done in real-time.", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } + ], + "paths": { + "/pennyless": { + "post": { + "tags": [ + "PennyLess Drop" + ], + "summary": "Verify PennyLess Drop", + "operationId": "VerifyPennyLessDrop", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{setu_bav_product_instance_id}}" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { "schema": { - "type": "string", - "example": "{{setu_bav_product_instance_id}}" + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDropRequest" + }, + { + "example": { + "accountNumber": "50100221813167", + "ifsc": "HDFC0000839" + } + } + ] + }, + "example": { + "accountNumber": "50100221813167", + "ifsc": "HDFC0000839" } } - ], - "requestBody": { - "description": "", + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/VerifyPennyLessDropRequest" + "$ref": "#/components/schemas/VerifyPennyLessDropMerchant-Success" }, { "example": { - "accountNumber": "50100221813167", - "ifsc": "HDFC0000839" + "traceId": "ca782918-f701-4033-84eb-30611381cfb7", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + }, + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + }, + "ownership": { + "type": "PRIVATE" + } + } + }, + "status": "SUCCESS" } } ] }, "example": { - "accountNumber": "50100221813167", - "ifsc": "HDFC0000839" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/VerifyPennyLessDropMerchant-Success" + "traceId": "ca782918-f701-4033-84eb-30611381cfb7", + "data": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + }, + "merchantDetails": { + "mccCode": "1520", + "identifier": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" }, - { - "example": { - "traceId": "ca782918-f701-4033-84eb-30611381cfb7", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountName": "Pavankumar Kamat Biz", - "bankAccountIfsc": "UTIB0002083", - "entityType": "MERCHANT", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "Axis Bank", - "branch": "KAPODRA, SURAT", - "center": "SURAT", - "district": "SURAT", - "state": "GUJARAT", - "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", - "contact": "", - "imps": "true", - "rtgs": "true", - "city": "SURAT", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "395211016", - "upi": "true", - "swift": "" - }, - "merchantDetails": { - "mccCode": "1520", - "identifier": { - "merchantType": "SMALL", - "merchantGenre": "OFFLINE", - "onBoardingType": "BANK" - }, - "name": { - "brand": "praimports", - "legal": "Indian", - "franchise": "rajababuimpor" - }, - "ownership": { - "type": "PRIVATE" - } - } - }, - "status": "SUCCESS" - } - } - ] - }, - "example": { - "traceId": "ca782918-f701-4033-84eb-30611381cfb7", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountName": "Pavankumar Kamat Biz", - "bankAccountIfsc": "UTIB0002083", - "entityType": "MERCHANT", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "Axis Bank", - "branch": "KAPODRA, SURAT", - "center": "SURAT", - "district": "SURAT", - "state": "GUJARAT", - "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", - "contact": "", - "imps": "true", - "rtgs": "true", - "city": "SURAT", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "395211016", - "upi": "true", - "swift": "" + "name": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" }, - "merchantDetails": { - "mccCode": "1520", - "identifier": { - "merchantType": "SMALL", - "merchantGenre": "OFFLINE", - "onBoardingType": "BANK" - }, - "name": { - "brand": "praimports", - "legal": "Indian", - "franchise": "rajababuimpor" - }, - "ownership": { - "type": "PRIVATE" - } + "ownership": { + "type": "PRIVATE" } - }, - "status": "SUCCESS" - } + } + }, + "status": "SUCCESS" } } - }, - "500": { - "description": "INTERNAL SERVER ERROR", - "headers": {}, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/VerifyPennyLessDrop-UpstreamError1" - }, - { - "example": { - "error": { - "code": "upstream_service_error", - "detail": "Upstream service error. Please reach out to support along with the traceId.", - "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" - } + } + }, + "500": { + "description": "INTERNAL SERVER ERROR", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDrop-UpstreamError1" + }, + { + "example": { + "error": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" } } - ] - }, - "example": { - "error": { - "code": "upstream_service_error", - "detail": "Upstream service error. Please reach out to support along with the traceId.", - "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" } + ] + }, + "example": { + "error": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" } } } - }, - "400": { - "description": "BAD REQUEST", - "headers": {}, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/VerifyPennyLessDrop-ValidationError1" - }, - { - "example": { - "error": { - "code": "bad_request", - "detail": "accountNumber is required", - "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" - } + } + }, + "400": { + "description": "BAD REQUEST", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/VerifyPennyLessDrop-ValidationError1" + }, + { + "example": { + "error": { + "code": "bad_request", + "detail": "accountNumber is required", + "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" } } - ] - }, - "example": { - "error": { - "code": "bad_request", - "detail": "accountNumber is required", - "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" } + ] + }, + "example": { + "error": { + "code": "bad_request", + "detail": "accountNumber is required", + "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" } } } } - }, - "deprecated": false, - "security": [] - } + } + }, + "deprecated": false, + "security": [] } - }, - "components": { - "schemas": { - "VerifyPennyLessDropRequest": { - "title": "VerifyPennyLessDropRequest", - "required": [ - "accountNumber", - "ifsc" - ], - "type": "object", - "properties": { - "accountNumber": { - "type": "string", - "description": "bank account number" - }, - "ifsc": { - "type": "string", - "description": "bank ifsc code" - } + } + }, + "components": { + "schemas": { + "VerifyPennyLessDropRequest": { + "title": "VerifyPennyLessDropRequest", + "required": [ + "accountNumber", + "ifsc" + ], + "type": "object", + "properties": { + "accountNumber": { + "type": "string", + "description": "bank account number", + "pattern" : "^\\d{9,18}$" }, - "example": { - "accountNumber": "50100221813167", - "ifsc": "HDFC0000839" + "ifsc": { + "type": "string", + "description": "bank ifsc code", + "pattern" : "^[A-Za-z]{4}0[A-Z0-9a-z]{6}$" } }, - "VerifyPennyLessDropMerchant-Success": { - "title": "VerifyPennyLessDropMerchant-Success", - "required": [ - "traceId", - "data", - "status" - ], - "type": "object", - "properties": { - "traceId": { - "type": "string" - }, - "data": { - "$ref": "#/components/schemas/Data" - }, - "status": { - "type": "string" - } + "example": { + "accountNumber": "50100221813167", + "ifsc": "HDFC0000839" + } + }, + "VerifyPennyLessDropMerchant-Success": { + "title": "VerifyPennyLessDropMerchant-Success", + "required": [ + "traceId", + "data", + "status" + ], + "type": "object", + "properties": { + "traceId": { + "type": "string" }, - "example": { - "traceId": "ca782918-f701-4033-84eb-30611381cfb7", - "data": { - "bankAccountNumber": "1234567890", - "bankAccountName": "Pavankumar Kamat Biz", - "bankAccountIfsc": "UTIB0002083", - "entityType": "MERCHANT", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "Axis Bank", - "branch": "KAPODRA, SURAT", - "center": "SURAT", - "district": "SURAT", - "state": "GUJARAT", - "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", - "contact": "", - "imps": "true", - "rtgs": "true", - "city": "SURAT", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "395211016", - "upi": "true", - "swift": "" - }, - "merchantDetails": { - "mccCode": "1520", - "identifier": { - "merchantType": "SMALL", - "merchantGenre": "OFFLINE", - "onBoardingType": "BANK" - }, - "name": { - "brand": "praimports", - "legal": "Indian", - "franchise": "rajababuimpor" - }, - "ownership": { - "type": "PRIVATE" - } - } - }, - "status": "SUCCESS" + "data": { + "$ref": "#/components/schemas/Data" + }, + "status": { + "type": "string" } }, - "Data": { - "title": "Data", - "required": [ - "bankAccountNumber", - "bankAccountName", - "bankAccountIfsc", - "entityType", - "ifscCrossCheck", - "ifscDetails", - "merchantDetails" - ], - "type": "object", - "properties": { - "bankAccountNumber": { - "type": "string" - }, - "bankAccountName": { - "type": "string" - }, - "bankAccountIfsc": { - "type": "string" - }, - "entityType": { - "type": "string" - }, - "ifscCrossCheck": { - "type": "boolean" - }, - "ifscDetails": { - "$ref": "#/components/schemas/IfscDetails" - }, - "merchantDetails": { - "$ref": "#/components/schemas/MerchantDetails" - } - }, - "example": { + "example": { + "traceId": "ca782918-f701-4033-84eb-30611381cfb7", + "data": { "bankAccountNumber": "1234567890", "bankAccountName": "Pavankumar Kamat Biz", "bankAccountIfsc": "UTIB0002083", @@ -420,76 +344,52 @@ "type": "PRIVATE" } } + }, + "status": "SUCCESS" + } + }, + "Data": { + "title": "Data", + "required": [ + "bankAccountNumber", + "bankAccountName", + "bankAccountIfsc", + "entityType", + "ifscCrossCheck", + "ifscDetails", + "merchantDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "entityType": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" + }, + "merchantDetails": { + "$ref": "#/components/schemas/MerchantDetails" } }, - "IfscDetails": { - "title": "IfscDetails", - "required": [ - "name", - "branch", - "center", - "district", - "state", - "address", - "contact", - "imps", - "rtgs", - "city", - "iso3166", - "neft", - "micr", - "upi", - "swift" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "branch": { - "type": "string" - }, - "center": { - "type": "string" - }, - "district": { - "type": "string" - }, - "state": { - "type": "string" - }, - "address": { - "type": "string" - }, - "contact": { - "type": "string" - }, - "imps": { - "type": "string" - }, - "rtgs": { - "type": "string" - }, - "city": { - "type": "string" - }, - "iso3166": { - "type": "string" - }, - "neft": { - "type": "string" - }, - "micr": { - "type": "string" - }, - "upi": { - "type": "string" - }, - "swift": { - "type": "string" - } - }, - "example": { + "example": { + "bankAccountNumber": "1234567890", + "bankAccountName": "Pavankumar Kamat Biz", + "bankAccountIfsc": "UTIB0002083", + "entityType": "MERCHANT", + "ifscCrossCheck": true, + "ifscDetails": { "name": "Axis Bank", "branch": "KAPODRA, SURAT", "center": "SURAT", @@ -505,32 +405,8 @@ "micr": "395211016", "upi": "true", "swift": "" - } - }, - "MerchantDetails": { - "title": "MerchantDetails", - "required": [ - "mccCode", - "identifier", - "name", - "ownership" - ], - "type": "object", - "properties": { - "mccCode": { - "type": "string" - }, - "identifier": { - "$ref": "#/components/schemas/Identifier" - }, - "name": { - "$ref": "#/components/schemas/Name" - }, - "ownership": { - "$ref": "#/components/schemas/Ownership" - } }, - "example": { + "merchantDetails": { "mccCode": "1520", "identifier": { "merchantType": "SMALL", @@ -546,152 +422,220 @@ "type": "PRIVATE" } } + } + }, + "IfscDetails": { + "title": "IfscDetails", + "required": [ + "name", + "branch", + "center", + "district", + "state", + "address", + "contact", + "imps", + "rtgs", + "city", + "iso3166", + "neft", + "micr", + "upi", + "swift" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "center": { + "type": "string" + }, + "district": { + "type": "string" + }, + "state": { + "type": "string" + }, + "address": { + "type": "string" + }, + "contact": { + "type": "string" + }, + "imps": { + "type": "string" + }, + "rtgs": { + "type": "string" + }, + "city": { + "type": "string" + }, + "iso3166": { + "type": "string" + }, + "neft": { + "type": "string" + }, + "micr": { + "type": "string" + }, + "upi": { + "type": "string" + }, + "swift": { + "type": "string" + } }, - "Identifier": { - "title": "Identifier", - "required": [ - "merchantType", - "merchantGenre", - "onBoardingType" - ], - "type": "object", - "properties": { - "merchantType": { - "type": "string" - }, - "merchantGenre": { - "type": "string" - }, - "onBoardingType": { - "type": "string" - } + "example": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + } + }, + "MerchantDetails": { + "title": "MerchantDetails", + "required": [ + "mccCode", + "identifier", + "name", + "ownership" + ], + "type": "object", + "properties": { + "mccCode": { + "type": "string" }, - "example": { + "identifier": { + "$ref": "#/components/schemas/Identifier" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "ownership": { + "$ref": "#/components/schemas/Ownership" + } + }, + "example": { + "mccCode": "1520", + "identifier": { "merchantType": "SMALL", "merchantGenre": "OFFLINE", "onBoardingType": "BANK" - } - }, - "Name": { - "title": "Name", - "required": [ - "brand", - "legal", - "franchise" - ], - "type": "object", - "properties": { - "brand": { - "type": "string" - }, - "legal": { - "type": "string" - }, - "franchise": { - "type": "string" - } }, - "example": { + "name": { "brand": "praimports", "legal": "Indian", "franchise": "rajababuimpor" - } - }, - "Ownership": { - "title": "Ownership", - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - } }, - "example": { + "ownership": { "type": "PRIVATE" } + } + }, + "Identifier": { + "title": "Identifier", + "required": [ + "merchantType", + "merchantGenre", + "onBoardingType" + ], + "type": "object", + "properties": { + "merchantType": { + "type": "string" + }, + "merchantGenre": { + "type": "string" + }, + "onBoardingType": { + "type": "string" + } }, - "VerifyPennyLessDropIndividual-Success": { - "title": "VerifyPennyLessDropIndividual-Success", - "required": [ - "traceId", - "data", - "status" - ], - "type": "object", - "properties": { - "traceId": { - "type": "string" - }, - "data": { - "$ref": "#/components/schemas/Data1" - }, - "status": { - "type": "string" - } + "example": { + "merchantType": "SMALL", + "merchantGenre": "OFFLINE", + "onBoardingType": "BANK" + } + }, + "Name": { + "title": "Name", + "required": [ + "brand", + "legal", + "franchise" + ], + "type": "object", + "properties": { + "brand": { + "type": "string" }, - "example": { - "traceId": "d0cc92a4-ca3f-4eb8-bbeb-4126620ec844", - "data": { - "bankAccountNumber": "1234567891", - "bankAccountName": "Pavankumar Kamat", - "bankAccountIfsc": "UTIB0002083", - "entityType": "INDIVIDUAL", - "ifscCrossCheck": true, - "ifscDetails": { - "name": "Axis Bank", - "branch": "KAPODRA, SURAT", - "center": "SURAT", - "district": "SURAT", - "state": "GUJARAT", - "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", - "contact": "", - "imps": "true", - "rtgs": "true", - "city": "SURAT", - "iso3166": "IN-GJ", - "neft": "true", - "micr": "395211016", - "upi": "true", - "swift": "" - } - }, - "status": "SUCCESS" + "legal": { + "type": "string" + }, + "franchise": { + "type": "string" } }, - "Data1": { - "title": "Data1", - "required": [ - "bankAccountNumber", - "bankAccountName", - "bankAccountIfsc", - "entityType", - "ifscCrossCheck", - "ifscDetails" - ], - "type": "object", - "properties": { - "bankAccountNumber": { - "type": "string" - }, - "bankAccountName": { - "type": "string" - }, - "bankAccountIfsc": { - "type": "string" - }, - "entityType": { - "type": "string" - }, - "ifscCrossCheck": { - "type": "boolean" - }, - "ifscDetails": { - "$ref": "#/components/schemas/IfscDetails" - } + "example": { + "brand": "praimports", + "legal": "Indian", + "franchise": "rajababuimpor" + } + }, + "Ownership": { + "title": "Ownership", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + } + }, + "example": { + "type": "PRIVATE" + } + }, + "VerifyPennyLessDropIndividual-Success": { + "title": "VerifyPennyLessDropIndividual-Success", + "required": [ + "traceId", + "data", + "status" + ], + "type": "object", + "properties": { + "traceId": { + "type": "string" }, - "example": { + "data": { + "$ref": "#/components/schemas/Data1" + }, + "status": { + "type": "string" + } + }, + "example": { + "traceId": "d0cc92a4-ca3f-4eb8-bbeb-4126620ec844", + "data": { "bankAccountNumber": "1234567891", "bankAccountName": "Pavankumar Kamat", "bankAccountIfsc": "UTIB0002083", @@ -714,112 +658,170 @@ "upi": "true", "swift": "" } + }, + "status": "SUCCESS" + } + }, + "Data1": { + "title": "Data1", + "required": [ + "bankAccountNumber", + "bankAccountName", + "bankAccountIfsc", + "entityType", + "ifscCrossCheck", + "ifscDetails" + ], + "type": "object", + "properties": { + "bankAccountNumber": { + "type": "string" + }, + "bankAccountName": { + "type": "string" + }, + "bankAccountIfsc": { + "type": "string" + }, + "entityType": { + "type": "string" + }, + "ifscCrossCheck": { + "type": "boolean" + }, + "ifscDetails": { + "$ref": "#/components/schemas/IfscDetails" } }, - "VerifyPennyLessDrop-InvalidBankdetails": { - "title": "VerifyPennyLessDrop-InvalidBankdetails", - "required": [ - "traceId", - "message", - "status" - ], - "type": "object", - "properties": { - "traceId": { - "type": "string" - }, - "message": { - "type": "string" - }, - "status": { - "type": "string" - } + "example": { + "bankAccountNumber": "1234567891", + "bankAccountName": "Pavankumar Kamat", + "bankAccountIfsc": "UTIB0002083", + "entityType": "INDIVIDUAL", + "ifscCrossCheck": true, + "ifscDetails": { + "name": "Axis Bank", + "branch": "KAPODRA, SURAT", + "center": "SURAT", + "district": "SURAT", + "state": "GUJARAT", + "address": "J R SQUARE, MAMTA PARK - 1 KAPODRA, VARACHHA MAIN ROAD, SURAT - 395 006", + "contact": "", + "imps": "true", + "rtgs": "true", + "city": "SURAT", + "iso3166": "IN-GJ", + "neft": "true", + "micr": "395211016", + "upi": "true", + "swift": "" + } + } + }, + "VerifyPennyLessDrop-InvalidBankdetails": { + "title": "VerifyPennyLessDrop-InvalidBankdetails", + "required": [ + "traceId", + "message", + "status" + ], + "type": "object", + "properties": { + "traceId": { + "type": "string" }, - "example": { - "traceId": "bda7cd75-a145-4138-82ad-257555501ed5", - "message": "Invalid bank details", - "status": "ERROR" + "message": { + "type": "string" + }, + "status": { + "type": "string" } }, - "Error": { - "title": "Error", - "required": [ - "code", - "detail", - "traceId" - ], - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "detail": { - "type": "string" - }, - "traceId": { - "type": "string" - } + "example": { + "traceId": "bda7cd75-a145-4138-82ad-257555501ed5", + "message": "Invalid bank details", + "status": "ERROR" + } + }, + "Error": { + "title": "Error", + "required": [ + "code", + "detail", + "traceId" + ], + "type": "object", + "properties": { + "code": { + "type": "string" }, - "example": { - "code": "upstream_service_error", - "detail": "Upstream service error. Please reach out to support along with the traceId.", - "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" + "detail": { + "type": "string" + }, + "traceId": { + "type": "string" } }, - "VerifyPennyLessDrop-UpstreamError1": { - "title": "VerifyPennyLessDrop-UpstreamError1", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "upstream_service_error", - "detail": "Upstream service error. Please reach out to support along with the traceId.", - "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" - } + "example": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" + } + }, + "VerifyPennyLessDrop-UpstreamError1": { + "title": "VerifyPennyLessDrop-UpstreamError1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" } }, - "VerifyPennyLessDrop-ValidationError1": { - "title": "VerifyPennyLessDrop-ValidationError1", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "bad_request", - "detail": "accountNumber is required", - "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" - } + "example": { + "error": { + "code": "upstream_service_error", + "detail": "Upstream service error. Please reach out to support along with the traceId.", + "traceId": "70541f30-0fb9-4ada-b197-3cfdf2ed1cda" } } }, - "securitySchemes": { - "bearer": { - "type": "http", - "scheme": "bearer" + "VerifyPennyLessDrop-ValidationError1": { + "title": "VerifyPennyLessDrop-ValidationError1", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "bad_request", + "detail": "accountNumber is required", + "traceId": "d039e5b4-1a06-45cb-9cc2-2d90933cdfeb" + } } } }, - "security": [ - { - "bearer": [] - } - ], - "tags": [ - { - "name": "PennyLess Drop" + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" } - ] - } \ No newline at end of file + } + }, + "security": [ + { + "bearer": [] + } + ], + "tags": [ + { + "name": "PennyLess Drop" + } + ] +} \ No newline at end of file From 9152b727750ed363c979265f65cb86d264e1095c Mon Sep 17 00:00:00 2001 From: Aditya Gannavarapu Date: Thu, 19 Sep 2024 14:36:56 +0530 Subject: [PATCH 7/8] Update menuitems --- content/data/bav/pennydrop-pennyless/api-reference.mdx | 4 ++-- content/menuItems.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/data/bav/pennydrop-pennyless/api-reference.mdx b/content/data/bav/pennydrop-pennyless/api-reference.mdx index 24a70c83..5ce5c331 100644 --- a/content/data/bav/pennydrop-pennyless/api-reference.mdx +++ b/content/data/bav/pennydrop-pennyless/api-reference.mdx @@ -1,6 +1,6 @@ --- sidebar_title: API reference -page_title: BAV Pennydrop-pennyless API reference -order: 2 +page_title: Pennydrop-pennyless API reference +order: 3 visible_in_sidebar: true --- diff --git a/content/menuItems.json b/content/menuItems.json index d3e5eeee..80888afd 100644 --- a/content/menuItems.json +++ b/content/menuItems.json @@ -1 +1 @@ -{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhook","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"FASTag","path":"fastag","order":5,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"FASTag API reference","path":"api-reference","order":0}]},{"name":"Plural","path":"plural","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Plural - API reference","path":"api-reference","order":9},{"name":"Get started","visible_in_sidebar":true,"page_title":"Plural - Get started","path":"get-started","order":2,"children":[{"name":"FAQs","visible_in_sidebar":true,"page_title":"Plural - FAQs and Troubleshooting","path":"faqs-and-troubleshooting","order":6},{"name":"Hash generation","visible_in_sidebar":true,"page_title":"Plural - Hash generation","path":"hash-generation-logic","order":7},{"name":"Integration modes","visible_in_sidebar":true,"page_title":"Plural - Integration modes","path":"integration-modes","order":2,"children":[{"name":"EMI flow","visible_in_sidebar":true,"page_title":"Plural - EMI flow","path":"emi-flow","order":3},{"name":"iFrame","visible_in_sidebar":true,"page_title":"Plural - iFrame","path":"iframe","order":2},{"name":"Redirect integration","visible_in_sidebar":true,"page_title":"Plural - Redirect integration","path":"redirect-flow","order":4},{"name":"Seamless flow","visible_in_sidebar":true,"page_title":"Plural - Seamless flow","path":"seamless-flow","order":1}]},{"name":"List of codes","visible_in_sidebar":true,"page_title":"Plural - Wallet and Bank codes","path":"list-of-codes","order":4},{"name":"List of status","visible_in_sidebar":true,"page_title":"Plural - Order & Transaction status","path":"list-of-status","order":4},{"name":"Onboarding","visible_in_sidebar":true,"page_title":"Plural - Onboarding","path":"onboarding","order":3},{"name":"Setup","visible_in_sidebar":true,"page_title":"Plural - Setup","path":"setup","order":1},{"name":"Tokenisation","visible_in_sidebar":true,"page_title":"Plural - Tokenisation","path":"tokenisation","order":8}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Plural - Overview","path":"overview","order":1}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar KYC","path":"okyc","order":1,"visible_in_sidebar":false,"children":[{"name":"Aadhaar Redundancy","visible_in_sidebar":true,"page_title":"Redundancy for Aadhaar OKYC","path":"aadhaar-redundancy","order":5,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"Aadhaar OKYC Redundancy API Integration","path":"api-integration","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Offline Aadhar API reference","path":"api-reference","order":6},{"name":"Auto OKYC","visible_in_sidebar":true,"page_title":"Auto OKYC API integration","path":"auto-okyc-api-integration","order":4},{"name":"OKYC","visible_in_sidebar":true,"page_title":"OKYC API integration","path":"okyc-api-integration","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Offline Aadhar KYC overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"Offline Aadhar pre-built screens","path":"pre-built-screens","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Offline Aadhar Quickstart","path":"quickstart","order":1}]},{"name":"Aadhaar eSign","path":"esign","order":2,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":8},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":7},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Analyse VPA","visible_in_sidebar":true,"page_title":"Analyse UPI VPA","path":"analyse-vpa","order":4,"children":[{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for Analyse UPI VPA","path":"quickstart","order":1}]},{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"Penny drop + PennyLess","visible_in_sidebar":true,"page_title":"Bank account verification using Penny drop + PennyLess","path":"pennydrop-pennyless","order":2,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess API Integration","path":"api-integration","order":1},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess Notifications","path":"notifications","order":2}]},{"path":"pennyless","children":[]},{"name":"PennyLess Drop","visible_in_sidebar":true,"page_title":"BAV using PennyLess Drop API","path":"pennyless-drop","order":5,"children":[{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for PennyLess drop API","path":"quickstart","order":1}]},{"name":"Reverse Penny drop","visible_in_sidebar":true,"page_title":"BAV using reverse penny drop","path":"reverse-penny-drop","order":3,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"RPD API integration","path":"api-integration","order":2},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV RPD API reference","path":"api-reference","order":4},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for reverse penny drop","path":"quickstart","order":1},{"name":"Webhook Auth","visible_in_sidebar":true,"page_title":"Webhook Authentication","path":"webhook-authentication","order":3}]}]},{"name":"Insights","path":"insights","order":5,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]}]},{"name":"Investments","path":"investments","order":2,"visible_in_sidebar":true,"children":[{"name":"Deposits","path":"deposits","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Deposits API reference","path":"api-reference","order":6},{"name":"FAQs","visible_in_sidebar":false,"page_title":"Deposits FAQs","path":"faqs","order":5},{"name":"Integrate via SDK","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide","path":"integrate-sdk","order":3,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide for Android","path":"android","order":2},{"name":"iOS","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide for iOS","path":"ios","order":3},{"name":"Web","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide for Web","path":"web","order":1}]},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Fixed Deposit Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Deposits overview","path":"overview","order":0},{"name":"Peripheral pages","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide","path":"peripheral-pages","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Deposits quickstart","path":"quickstart","order":1},{"name":"SDK Integration","visible_in_sidebar":false,"page_title":"Fixed Deposits SDK integration guide","path":"sdk-integration","order":2,"children":[{"name":"Generate Partner Token","visible_in_sidebar":false,"page_title":"Fixed Deposits SDK integration guide","path":"generate-partner-token","order":1},{"name":"Generate SDK Token","visible_in_sidebar":false,"page_title":"Fixed Deposits SDK integration guide","path":"generate-sdk-token","order":2}]}]}]},{"name":"Commerce","path":"commerce","order":3,"visible_in_sidebar":true,"children":[{"name":"ONDC","path":"ondc","order":0,"visible_in_sidebar":true,"children":[{"name":"API guide","visible_in_sidebar":true,"page_title":"API guide for ONDC","path":"api-guide","order":3,"children":[{"name":"Catalogue API","visible_in_sidebar":true,"page_title":"Catalogue API","path":"catalogue-api","order":3},{"name":"Inventory API","visible_in_sidebar":true,"page_title":"Inventory API","path":"inventory-api","order":4},{"name":"Order API","visible_in_sidebar":true,"page_title":"Order API","path":"order-api","order":5},{"name":"Seller API","visible_in_sidebar":true,"page_title":"Seller API","path":"seller-api","order":1},{"name":"Storefront API","visible_in_sidebar":true,"page_title":"Storefront API","path":"storefront-api","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"API reference - ONDC","path":"api-reference","order":4},{"name":"Issue & Grievance","visible_in_sidebar":false,"page_title":"ONDC Issue and Grievance Management Overview","path":"igm","order":3,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Issue & Grievance API reference","path":"api-reference","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"ONDC Overview","path":"overview","order":0},{"name":"Reconciliation","visible_in_sidebar":false,"page_title":"ONDC Reconciliation Overview","path":"reconciliation","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Reconciliation API reference","path":"api-reference","order":1}]},{"name":"Retail","visible_in_sidebar":false,"page_title":"ONDC Retail Overview","path":"retail","order":1,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Retail API reference","path":"api-reference","order":1}]},{"name":"Settlement","visible_in_sidebar":false,"page_title":"ONDC Settlement Overview","path":"settlement","order":3,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Settlements API reference","path":"api-reference","order":1}]},{"name":"Terminology and concepts","visible_in_sidebar":true,"page_title":"Terminology and concepts of ONDC","path":"terminology-and-concepts","order":2}]}]},{"name":"Dev tools","path":"dev-tools","order":4,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"visible_in_sidebar":true,"children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]},{"name":"Sample Category","path":"sample-category","order":5,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]} \ No newline at end of file +{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhook","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"FASTag","path":"fastag","order":5,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"FASTag API reference","path":"api-reference","order":0}]},{"name":"Plural","path":"plural","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Plural - API reference","path":"api-reference","order":9},{"name":"Get started","visible_in_sidebar":true,"page_title":"Plural - Get started","path":"get-started","order":2,"children":[{"name":"FAQs","visible_in_sidebar":true,"page_title":"Plural - FAQs and Troubleshooting","path":"faqs-and-troubleshooting","order":6},{"name":"Hash generation","visible_in_sidebar":true,"page_title":"Plural - Hash generation","path":"hash-generation-logic","order":7},{"name":"Integration modes","visible_in_sidebar":true,"page_title":"Plural - Integration modes","path":"integration-modes","order":2,"children":[{"name":"EMI flow","visible_in_sidebar":true,"page_title":"Plural - EMI flow","path":"emi-flow","order":3},{"name":"iFrame","visible_in_sidebar":true,"page_title":"Plural - iFrame","path":"iframe","order":2},{"name":"Redirect integration","visible_in_sidebar":true,"page_title":"Plural - Redirect integration","path":"redirect-flow","order":4},{"name":"Seamless flow","visible_in_sidebar":true,"page_title":"Plural - Seamless flow","path":"seamless-flow","order":1}]},{"name":"List of codes","visible_in_sidebar":true,"page_title":"Plural - Wallet and Bank codes","path":"list-of-codes","order":4},{"name":"List of status","visible_in_sidebar":true,"page_title":"Plural - Order & Transaction status","path":"list-of-status","order":4},{"name":"Onboarding","visible_in_sidebar":true,"page_title":"Plural - Onboarding","path":"onboarding","order":3},{"name":"Setup","visible_in_sidebar":true,"page_title":"Plural - Setup","path":"setup","order":1},{"name":"Tokenisation","visible_in_sidebar":true,"page_title":"Plural - Tokenisation","path":"tokenisation","order":8}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Plural - Overview","path":"overview","order":1}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar KYC","path":"okyc","order":1,"visible_in_sidebar":false,"children":[{"name":"Aadhaar Redundancy","visible_in_sidebar":true,"page_title":"Redundancy for Aadhaar OKYC","path":"aadhaar-redundancy","order":5,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"Aadhaar OKYC Redundancy API Integration","path":"api-integration","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Offline Aadhar API reference","path":"api-reference","order":6},{"name":"Auto OKYC","visible_in_sidebar":true,"page_title":"Auto OKYC API integration","path":"auto-okyc-api-integration","order":4},{"name":"OKYC","visible_in_sidebar":true,"page_title":"OKYC API integration","path":"okyc-api-integration","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Offline Aadhar KYC overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"Offline Aadhar pre-built screens","path":"pre-built-screens","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Offline Aadhar Quickstart","path":"quickstart","order":1}]},{"name":"Aadhaar eSign","path":"esign","order":2,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":8},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":7},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Analyse VPA","visible_in_sidebar":true,"page_title":"Analyse UPI VPA","path":"analyse-vpa","order":4,"children":[{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for Analyse UPI VPA","path":"quickstart","order":1}]},{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"Penny drop + PennyLess","visible_in_sidebar":true,"page_title":"Bank account verification using Penny drop + PennyLess","path":"pennydrop-pennyless","order":2,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess API Integration","path":"api-integration","order":1},{"name":"API reference","visible_in_sidebar":true,"page_title":"Pennydrop-pennyless API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess Notifications","path":"notifications","order":2}]},{"path":"pennyless","children":[]},{"name":"PennyLess Drop","visible_in_sidebar":true,"page_title":"BAV using PennyLess Drop API","path":"pennyless-drop","order":5,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV Pennyless API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for PennyLess drop API","path":"quickstart","order":1}]},{"name":"Reverse Penny drop","visible_in_sidebar":true,"page_title":"BAV using reverse penny drop","path":"reverse-penny-drop","order":3,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"RPD API integration","path":"api-integration","order":2},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV RPD API reference","path":"api-reference","order":4},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for reverse penny drop","path":"quickstart","order":1},{"name":"Webhook Auth","visible_in_sidebar":true,"page_title":"Webhook Authentication","path":"webhook-authentication","order":3}]}]},{"name":"Insights","path":"insights","order":5,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]}]},{"name":"Investments","path":"investments","order":2,"visible_in_sidebar":true,"children":[{"name":"Deposits","path":"deposits","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Deposits API reference","path":"api-reference","order":6},{"name":"FAQs","visible_in_sidebar":false,"page_title":"Deposits FAQs","path":"faqs","order":5},{"name":"Integrate via SDK","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide","path":"integrate-sdk","order":3,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide for Android","path":"android","order":2},{"name":"iOS","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide for iOS","path":"ios","order":3},{"name":"Web","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide for Web","path":"web","order":1}]},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Fixed Deposit Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Deposits overview","path":"overview","order":0},{"name":"Peripheral pages","visible_in_sidebar":true,"page_title":"Fixed Deposits SDK integration guide","path":"peripheral-pages","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Deposits quickstart","path":"quickstart","order":1},{"name":"SDK Integration","visible_in_sidebar":false,"page_title":"Fixed Deposits SDK integration guide","path":"sdk-integration","order":2,"children":[{"name":"Generate Partner Token","visible_in_sidebar":false,"page_title":"Fixed Deposits SDK integration guide","path":"generate-partner-token","order":1},{"name":"Generate SDK Token","visible_in_sidebar":false,"page_title":"Fixed Deposits SDK integration guide","path":"generate-sdk-token","order":2}]}]}]},{"name":"Commerce","path":"commerce","order":3,"visible_in_sidebar":true,"children":[{"name":"ONDC","path":"ondc","order":0,"visible_in_sidebar":true,"children":[{"name":"API guide","visible_in_sidebar":true,"page_title":"API guide for ONDC","path":"api-guide","order":3,"children":[{"name":"Catalogue API","visible_in_sidebar":true,"page_title":"Catalogue API","path":"catalogue-api","order":3},{"name":"Inventory API","visible_in_sidebar":true,"page_title":"Inventory API","path":"inventory-api","order":4},{"name":"Order API","visible_in_sidebar":true,"page_title":"Order API","path":"order-api","order":5},{"name":"Seller API","visible_in_sidebar":true,"page_title":"Seller API","path":"seller-api","order":1},{"name":"Storefront API","visible_in_sidebar":true,"page_title":"Storefront API","path":"storefront-api","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"API reference - ONDC","path":"api-reference","order":4},{"name":"Issue & Grievance","visible_in_sidebar":false,"page_title":"ONDC Issue and Grievance Management Overview","path":"igm","order":3,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Issue & Grievance API reference","path":"api-reference","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"ONDC Overview","path":"overview","order":0},{"name":"Reconciliation","visible_in_sidebar":false,"page_title":"ONDC Reconciliation Overview","path":"reconciliation","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Reconciliation API reference","path":"api-reference","order":1}]},{"name":"Retail","visible_in_sidebar":false,"page_title":"ONDC Retail Overview","path":"retail","order":1,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Retail API reference","path":"api-reference","order":1}]},{"name":"Settlement","visible_in_sidebar":false,"page_title":"ONDC Settlement Overview","path":"settlement","order":3,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"ONDC Settlements API reference","path":"api-reference","order":1}]},{"name":"Terminology and concepts","visible_in_sidebar":true,"page_title":"Terminology and concepts of ONDC","path":"terminology-and-concepts","order":2}]}]},{"name":"Dev tools","path":"dev-tools","order":4,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"visible_in_sidebar":true,"children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]},{"name":"Sample Category","path":"sample-category","order":5,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]} \ No newline at end of file From 3b0b3afd55c708be7de40d6d97871a441bf132d0 Mon Sep 17 00:00:00 2001 From: Aditya Gannavarapu Date: Thu, 19 Sep 2024 14:51:44 +0530 Subject: [PATCH 8/8] Fix payload of SQR and DQR --- content/payments/umap/payments/flash/create-dqr.mdx | 2 -- content/payments/umap/payments/flash/create-sqr.mdx | 3 ++- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/content/payments/umap/payments/flash/create-dqr.mdx b/content/payments/umap/payments/flash/create-dqr.mdx index 4f0233e3..74f50ce1 100644 --- a/content/payments/umap/payments/flash/create-dqr.mdx +++ b/content/payments/umap/payments/flash/create-dqr.mdx @@ -76,7 +76,6 @@ visible_in_sidebar: true {`{ "amount": 10000, - "minAmount": 100, "merchantVpa": "fastestupi@pineaxis", "expiryDate": "2023-09-04T12:08:20+0530", "referenceId": "1240689979139556557", @@ -129,7 +128,6 @@ visible_in_sidebar: true {`{ "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", "amount": 10000, - "minAmount": 100, "createdAt": "2023-09-04T12:08:20+0530", "expiryDate": "2023-09-04T12:08:20+0530", "intentLink": "upi://pay?pa=test-auto-pgruosncak@okokax...", diff --git a/content/payments/umap/payments/flash/create-sqr.mdx b/content/payments/umap/payments/flash/create-sqr.mdx index 92e85b32..802bf77a 100644 --- a/content/payments/umap/payments/flash/create-sqr.mdx +++ b/content/payments/umap/payments/flash/create-sqr.mdx @@ -75,8 +75,8 @@ visible_in_sidebar: true <> {`{ + "amount": 10000, "merchantVpa": "fastestupi@pineaxis", - "expiryDate": "2023-09-04T12:08:20+0530", "referenceId": "1240689979139556557", "metadata": { "InvoiceNumber": "INV-21-12-009" @@ -95,6 +95,7 @@ visible_in_sidebar: true {`{ "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV", + "amount" : 10000 "createdAt": "2023-09-04T12:08:20+0530", "expiryDate": "2023-09-04T12:08:20+0530", "intentLink": "upi://pay?pa=test-auto-pgruosncak@okokax...",