From 055fd0d0db6127dc0542f08472017cdc77ab103d Mon Sep 17 00:00:00 2001 From: tanmay Date: Wed, 7 May 2025 17:38:17 +0530 Subject: [PATCH 1/6] update descriptions --- api-references/payments/billpay/api-integration.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api-references/payments/billpay/api-integration.json b/api-references/payments/billpay/api-integration.json index eadbd03c..34aded26 100644 --- a/api-references/payments/billpay/api-integration.json +++ b/api-references/payments/billpay/api-integration.json @@ -6958,7 +6958,7 @@ "tags": [ "UPMS" ], - "description": "This synchronous endpoint allows you to retrieve the current status and details of a specific, existing UPMS registration immediately.", + "description": "View registration", "operationId": "ViewUPMSRegistration", "parameters": [ { @@ -7387,7 +7387,7 @@ "tags": [ "UPMS" ], - "description": "This asynchronous endpoint permanently triggers cancellation of an active UPMS registration.", + "description": "Cancel registration", "operationId": "CancelUPMSRegistration", "parameters": [ { @@ -7666,7 +7666,7 @@ "tags": [ "UPMS" ], - "description": "Update details for a UPMS registration. This is an asynchronous API which only acknowledges receipt of a valid request. The actual result of the update operation will be communicated via a callback.\n", + "description": "Update registration", "operationId": "UpdateUPMSRegistration", "parameters": [ { @@ -8028,7 +8028,7 @@ "tags": [ "UPMS" ], - "description": "Simulates a skip payment notification for the specified bill. Validates the request, acknowledges receipt, and triggers an asynchronous callback delivery that indicates a payment was made through an alternative channel. For lower environments only.", + "description": "Simulate skip payment", "operationId": "SimulateSkipPaymentNotification", "parameters": [ { @@ -8317,7 +8317,7 @@ "tags": [ "UPMS" ], - "description": "Simulates a bill notification for the specified UPMS registration. Validates the request, acknowledges receipt, and triggers an asynchronous callback delivery. For lower environments only.", + "description": "Simulate bill notification", "operationId": "SimulateBillNotification", "parameters": [ { @@ -8641,4 +8641,4 @@ } }, "x-original-swagger-version": "2.0" -} +} \ No newline at end of file From 03d7583b077a6a4f286bb1690a5e502f579024db Mon Sep 17 00:00:00 2001 From: tanmay Date: Wed, 7 May 2025 17:45:09 +0530 Subject: [PATCH 2/6] remove debug fields --- .../payments/billpay/api-integration.json | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/api-references/payments/billpay/api-integration.json b/api-references/payments/billpay/api-integration.json index 34aded26..996478b6 100644 --- a/api-references/payments/billpay/api-integration.json +++ b/api-references/payments/billpay/api-integration.json @@ -1421,21 +1421,6 @@ }, "x-omitempty": true }, - "dummyBillerResponseAmount": { - "type": "integer", - "description": "On debug, this is the amount passed in biller response COMFORT NEGATIVE 23", - "nullable": true - }, - "dummyCustomerMobile": { - "type": "string", - "description": "On debug, this hijacks the customer mobiler number COMFORT NEGATIVE 30, 31", - "nullable": true - }, - "dummyOrigRefId": { - "type": "string", - "description": "On debug, hijacks orig ref id of payment request - COMFORT PAYMENT - 83", - "nullable": true - }, "paymentDetails": { "required": [ "amount", From e74ecbf576c16f1ff9281510ff6c85ccb697546e Mon Sep 17 00:00:00 2001 From: tanmay Date: Wed, 7 May 2025 17:54:21 +0530 Subject: [PATCH 3/6] remove upms debug param --- api-references/payments/billpay/api-integration.json | 8 -------- 1 file changed, 8 deletions(-) diff --git a/api-references/payments/billpay/api-integration.json b/api-references/payments/billpay/api-integration.json index 996478b6..c929b812 100644 --- a/api-references/payments/billpay/api-integration.json +++ b/api-references/payments/billpay/api-integration.json @@ -6965,14 +6965,6 @@ "minLength": 35, "type": "string" } - }, - { - "name": "debug", - "in": "query", - "description": "DEBUG-FIELD: In debug, if the UPMS View Registration is sent to NPCI", - "schema": { - "type": "boolean" - } } ], "responses": { From 74a5daa4229caa6df89a92d48a477f1f638de4a6 Mon Sep 17 00:00:00 2001 From: tanmay Date: Wed, 7 May 2025 19:01:54 +0530 Subject: [PATCH 4/6] update apis --- .../payments/billpay/api-integration/apis.mdx | 418 ++++++++++++------ 1 file changed, 295 insertions(+), 123 deletions(-) diff --git a/content/payments/billpay/api-integration/apis.mdx b/content/payments/billpay/api-integration/apis.mdx index 8ebcfa9f..b2058626 100644 --- a/content/payments/billpay/api-integration/apis.mdx +++ b/content/payments/billpay/api-integration/apis.mdx @@ -23,87 +23,117 @@ For e.g., if your customer wants to pay their phone bill for Vodafone Postpaid,
  • -

    the customer’s identifier (mobile number in this case)

    +

    the customer's identifier (mobile number in this case)

  • -

    the business’s identifier (BBPS ID for Vodafone, in this case)

    +

    the business's identifier (BBPS ID for Vodafone, in this case)

-Optionally, you can also registration the customer with this biller simultaneously to receive future bills as and when they are generated (See [UPMS Integration Guide](upms.mdx)). +Optionally, you can also register the customer with this biller simultaneously to receive future bills as and when they are generated (See [UPMS Integration Guide](upms.mdx)). +If you include the `mandate` object in the request, a registration will be initiated for the customer with the biller.
- Detailed sample request body + Sample Request {` - { - "customer": { - "mobile": "9505987798", - "billParameters": [ - { - "name": "Parameter 1", - "value": "Value 1" - }, - { - "name": "Parameter 2", - "value": "Value 2" - }, - { - "name": "Parameter 3", - "value": "Value 3" - } - ] - }, - "agent": { - "app": "SmartPay", - "channel": "INT", - "geocode": "19.0139,72.8254", - "id": "AX01AI06512391457204", - "ifsc": "ICIC0000152", - "imei": "123456789012345", - "ip": "124.170.23.24", - "mac": "48-4D-7E-CB-DB-6F", - "mobile": "9481773011", - "os": "iOS", - "postalCode": "600001", - "terminalId": "6000011234" - }, - "biller": { - "id": "VODA00000MUM03" - } - } +{ + "customer": { + "mobile": "9505987798", + "customerParams": [ + { + "name": "Parameter 1", + "value": "Value 1" + }, + { + "name": "Parameter 2", + "value": "Value 2" + }, + { + "name": "Parameter 3", + "value": "Value 3" + } + ] + }, + "agent": { + "app": "SmartPay", + "channel": "INT", + "geocode": "19.0139,72.8254", + "id": "AX01AI06512391457204", + "ifsc": "ICIC0000152", + "imei": "123456789012345", + "ip": "124.170.23.24", + "mac": "48-4D-7E-CB-DB-6F", + "mobile": "9481773011", + "os": "iOS", + "postalCode": "600001", + "terminalId": "6000011234" + }, + "biller": { + "id": "VODA00000MUM03" + }, + "mandate": { + "registrationType": "VIEW_N_PAY", + "billPeriod": "ASPRESENTED" + } +} `}

-You get a `refId` in the response, a unique identifier that can be further used to check the status of the bill fetch. +You get a `refId` in the response, a unique identifier that can be further used to check the status of the bill fetch. If a UPMS registration was requested, the response will also include `upmsRegistration.refId` and `upmsRegistration.status`. + -{` + +
+ + + Sample Response + + + {` { "data": { "refId": "LNMSQQR4RKT7X1UGPY7JGUV454PL9T2C689", + "upmsRegistration": { + "status": "PENDING", + "refId": "HENSVVR4QOS7X1UGPY7JGUV444P10102202" + } }, "success": true, - "error": null + "traceId": "C3SFG0O6N88R6UI7EQ" } -`} + `} +
+
+
You may also use the `/bbps/bills/fetch/response` endpoint with above `refId` to check status of the bill fetch— -{` + +
+ + + Sample Request + + + {` { "refId": "LNMSQQR4RKT7X1UGPY7JGUV454PL9T2C689" } -`} + `} +
+
-In the response you either get the bill details, or “Processing” status if the bill fetch is still in progress. + +In the response you either get the bill details, or "Processing" status if the bill fetch is still in progress.
@@ -133,32 +163,33 @@ In the response you either get the bill details, or “Processing” status if t "value": "Samuraipsychadelic" } ], - "bill": { // optional - selective present for SINGLE billers - "amount": 300000, - "billDate": "2021-09-13", - "billNumber": "8394852342371080869", - "billPeriod": "Monthly", - "customerName": "William Miller", - "dueDate": "2021-09-26", - "paymentOptions": [ - { - "name": "3 month EMI", - "amount": 900000, - "minAmount": 300000, - "maxAmount": 1500000, - "amountMultiple": 10000 - }, - { - "name": "6 month EMI", - "amount": 1800000, - "minAmount": 600000, - "maxAmount": 3000000, - "amountMultiple": 10000 - } - ] - }, - "billerResponseType": "SINGLE", - "billerSelectionType": null, + "bills": [ + { + "amount": 300000, + "billDate": "2021-09-13", + "billNumber": "8394852342371080869", + "billPeriod": "Monthly", + "customerName": "William Miller", + "dueDate": "2021-09-26", + "paymentOptions": [ + { + "name": "3 month EMI", + "amount": 900000, + "minAmount": 300000, + "maxAmount": 1500000, + "amountMultiple": 10000 + }, + { + "name": "6 month EMI", + "amount": 1800000, + "minAmount": 600000, + "maxAmount": 3000000, + "amountMultiple": 10000 + } + ] + } + ], + "billerResponseType": "SINGLE", "billerRefId": "4047076513", "exactness": "Exact", "paymentLimits": [ @@ -260,56 +291,197 @@ The - List categories - - —lists all categories on BBPS. -- - List billers - - —lists all billers on BBPS. -- - List disputes - - —lists all the raised disputes using the - Dispute API - . -- - List fetched Bills - - —lists all the fetched bills that were fetched using - Fetch API - . -- - List paid bills - - —lists all the bill pay transactions paid using - Pay API - . + + +
+ +### Managing Customer Registrations + +These APIs allow you to manage the lifecycle of UPMS (Unified Presentment Management Service) registrations for your customers. Refer to the [UPMS Integration Guide](upms.mdx) for detailed flows and callback handling. + +#### Viewing Registration Details + +To retrieve the current status and details of a specific, existing UPMS registration. + +**API Reference:** GET /api/v2/upms/registrations/{upmsRegistrationRefID} + + +
+ + + Sample Success Response + + + {` +{ + "data": { + "biller": { + "id": "ABLP01000ANP03" + }, + "createdAt": "2025-04-24T14:38:46.377Z", + "customer": { + "customerParams": [ + { + "name": "Roll No", + "value": "27257063" + } + ], + "mobile": "9039403265", + "name": "Priya Shukla" + }, + "mandate": { + "billPeriod": "ASPRESENTED", + "billerParams": [ + { + "name": "Low Balance Threshold", + "value": "500" + } + ], + "debitInfo": { + "amount": 999999999, + "currency": 356, + "debitDate": "10-Feb", + "paymentMode": "Internet Banking", + "type": "FIXED_AMOUNT" + }, + "registrationType": "AUTO_PAY", + "toDate": "2025-12-22" + }, + "refId": "D054PTM52FL7R8CJPQ90GZ2ORTG51142008", + "status": "SUCCESS", + "updatedAt": "2025-04-24T14:38:47.389Z" + }, + "success": true, + "traceId": "D055CNT3GMB863CND9LG" +} + `} +
+
+
+ +
+ +#### Updating a Registration + +To modify specific details of an existing, active UPMS registration. This is an asynchronous operation; the final result is delivered via the [Update UPMS Registration webhook](/content/payments/billpay/api-integration/webhooks.mdx#update-upms-registration-webhook). + +**API Reference:** PATCH /api/v2/upms/registrations/{upmsRegistrationRefID} + + +
+ + + Sample Request Body + + + {` +{ + "mandate": { + "toDate": "2025-12-31", + "debitInfo": { + "amount": 750000 + } + } +} + `} +
+
+
+ +
+ + + Sample Success Response + + + {` +{ + "success": true, + "traceId": "CV4PE82LTNJE9O014OE0" +} + `} +
+
+ +
+ +#### Cancelling a Registration + +To permanently cancel an existing UPMS registration. This is an asynchronous operation; confirmation comes via the [Cancel UPMS Registration webhook](/content/payments/billpay/api-integration/webhooks.mdx#cancel-upms-registration-webhook). + +**API Reference:** DELETE /api/v2/upms/registrations/{upmsRegistrationRefID} + + +
+ + + Sample Success Response + + + {` +{ + "success": true, + "traceId": "CV4PE82LTNJE9O014OE0" +} + `} +
+

From 9d9d7eadc4172be84a6c4696ac3d82195067a57e Mon Sep 17 00:00:00 2001 From: tanmay Date: Wed, 7 May 2025 19:02:05 +0530 Subject: [PATCH 5/6] update menu items --- content/menuItems.json | 2333 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 2332 insertions(+), 1 deletion(-) diff --git a/content/menuItems.json b/content/menuItems.json index fd53757b..add8e411 100644 --- a/content/menuItems.json +++ b/content/menuItems.json @@ -1 +1,2332 @@ -{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":6},{"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":"Migration Guide to v2","visible_in_sidebar":true,"page_title":"BBPS COU - Migration Guide to v2","path":"v2-migration","order":5},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Prepaid Recharge","visible_in_sidebar":true,"page_title":"BBPS Billpay Prepaid Recharge APIs","path":"mobile-prepaid-recharge","order":3,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge quickstart","path":"quickstart","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":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}]},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Secure Data Add-On","visible_in_sidebar":true,"page_title":"Setu Encrypted APIs","path":"encryption","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar eSign","path":"esign","order":2,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":9},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":8},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":7},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"PDF templates","visible_in_sidebar":true,"page_title":"Integration guide with pdf templating API's","path":"pdf-templating","order":5},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Multi AA gateway","visible_in_sidebar":true,"page_title":"Account Aggregator multi-AA gateway","path":"multi-aa-gateway","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"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}]},{"name":"PennyLess Drop","visible_in_sidebar":true,"page_title":"BAV using PennyLess Drop API","path":"pennyless-drop","order":4,"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,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]},{"path":"v1","children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]}]},{"name":"ULI","path":"uli","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]},{"name":"eKYC","path":"ekyc","order":8,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"eKYC API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":1}]}]},{"name":"Dev tools","path":"dev-tools","order":2,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"Analytics and reports","visible_in_sidebar":true,"page_title":"Bridge analytics and reports","path":"analytics-and-reports","order":3},{"name":"Explore and configure products","visible_in_sidebar":true,"page_title":"Bridge explore and configure products","path":"explore-and-configure-products","order":2},{"name":"Glossary","visible_in_sidebar":true,"page_title":"Bridge glossary","path":"glossary","order":0},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":1},{"name":"Settings","visible_in_sidebar":true,"page_title":"Bridge settings","path":"settings","order":4},{"name":"User profile","visible_in_sidebar":true,"page_title":"Bridge user profile","path":"user-profile","order":5},{"path":"v1","children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]}]},{"name":"Sample Category","path":"sample-category","order":3,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]} \ No newline at end of file +{ + "home": [ + { + "name": "Payments", + "path": "payments", + "order": 0, + "visible_in_sidebar": true, + "api_reference": true, + "children": [ + { + "name": "BBPS BillCollect", + "path": "bbps", + "order": 0, + "visible_in_sidebar": true, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "BBPS API reference", + "path": "api-reference", + "order": 9 + }, + { + "name": "Axis BBPS", + "visible_in_sidebar": false, + "page_title": "Axis BBPS API Approach Document", + "path": "axis", + "order": 10 + }, + { + "name": "Bill Structure", + "visible_in_sidebar": true, + "page_title": "BBPS - Bill Structure", + "path": "bill-structure", + "order": 5, + "children": [ + { + "name": "Special cases", + "visible_in_sidebar": true, + "page_title": "BBPS - Bill Structure special cases", + "path": "special-cases", + "order": 1 + } + ] + }, + { + "name": "Go live", + "visible_in_sidebar": true, + "page_title": "BBPS - Go live", + "path": "go-live", + "order": 3 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "BBPS - Notifications", + "path": "notifications", + "order": 4 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "BBPS - Overview", + "path": "overview", + "order": 1 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "BBPS - Quickstart", + "path": "quickstart", + "order": 2, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "BBPS - API integration", + "path": "api-integration", + "order": 2 + }, + { + "name": "No-code CSV", + "visible_in_sidebar": true, + "page_title": "BBPS - No-code CSV", + "path": "no-code-integration", + "order": 1 + }, + { + "name": "Share bills", + "visible_in_sidebar": false, + "page_title": "BBPS - Share bills", + "path": "share-biils", + "order": 1 + } + ] + }, + { + "name": "Reports API", + "visible_in_sidebar": true, + "page_title": "BBPS - Reports API", + "path": "reports", + "order": 6 + }, + { + "name": "Additional resources", + "visible_in_sidebar": true, + "page_title": "BBPS - Additional Resources", + "path": "resources", + "order": 8, + "children": [ + { + "name": "Errors", + "visible_in_sidebar": true, + "page_title": "BBPS error codes", + "path": "errors", + "order": 4 + }, + { + "name": "JWT authentication", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks JWT authentication", + "path": "jwt", + "order": 2 + }, + { + "name": "OAuth 2.0", + "visible_in_sidebar": true, + "page_title": "BBPS OAuth 2.0", + "path": "oauth", + "order": 1 + }, + { + "name": "Settlement object", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks settlement object", + "path": "settlement-object", + "order": 3 + } + ] + } + ] + }, + { + "name": "BBPS BillPay", + "path": "billpay", + "order": 1, + "versions": [ + "v1", + "v2" + ], + "default_version": "v2", + "visible_in_sidebar": true, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay API integration", + "path": "api-integration", + "order": 1, + "children": [ + { + "name": "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": "Quickstart", + "visible_in_sidebar": true, + "page_title": "BBPS COU - API integration", + "path": "quickstart", + "order": 1 + }, + { + "name": "List of APIs", + "visible_in_sidebar": true, + "page_title": "BBPS COU - List of APIs", + "path": "apis", + "order": 2 + }, + { + "name": "Objects", + "visible_in_sidebar": true, + "page_title": "BBPS COU - Objects", + "path": "objects", + "order": 3 + }, + { + "name": "Webhooks", + "visible_in_sidebar": true, + "page_title": "BBPS COU - Webhooks", + "path": "webhooks", + "order": 4 + }, + { + "name": "Migration Guide to v2", + "visible_in_sidebar": true, + "page_title": "BBPS COU - Migration Guide to v2", + "path": "v2-migration", + "order": 5 + }, + { + "name": "UPMS", + "visible_in_sidebar": true, + "page_title": "BBPS COU - UPMS", + "path": "upms", + "order": 6 + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "COU Direct Connectivity API reference", + "path": "api-reference", + "order": 7 + } + ] + }, + { + "name": "API reference", + "visible_in_sidebar": false, + "page_title": "BillPay API reference", + "path": "api-reference", + "order": 5 + }, + { + "name": "Prepaid Recharge", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay Prepaid Recharge APIs", + "path": "mobile-prepaid-recharge", + "order": 3, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Mobile Prepaid Recharge API reference", + "path": "api-reference", + "order": 2 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "Mobile Prepaid Recharge quickstart", + "path": "quickstart", + "order": 1 + } + ] + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay Overview", + "path": "overview", + "order": 0 + }, + { + "name": "Pre-built screens", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay pre-built screens", + "path": "pre-built-screens", + "order": 2, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": false, + "page_title": "BBPS Billpay API reference", + "path": "api-reference-wl", + "order": 4 + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay API reference", + "path": "api-reference", + "order": 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 + } + ] + }, + { + "path": "v1", + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay API integration", + "path": "api-integration", + "order": 1, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "COU Direct Connectivity API reference", + "path": "api-reference", + "order": 5 + }, + { + "name": "List of APIs", + "visible_in_sidebar": true, + "page_title": "BBPS COU - List of APIs", + "path": "apis", + "order": 2 + }, + { + "name": "Deprecated APIs", + "visible_in_sidebar": false, + "page_title": "BBPS COU - API integration (deprecated)", + "path": "deprecated", + "order": 4, + "children": [ + { + "name": "Mock environment", + "visible_in_sidebar": false, + "page_title": "BBPS Billpay Mock environment", + "path": "mock-environment", + "order": 2 + }, + { + "name": "Polling", + "visible_in_sidebar": false, + "page_title": "BBPS Billpay polling", + "path": "polling", + "order": 2 + } + ] + }, + { + "name": "Objects", + "visible_in_sidebar": true, + "page_title": "BBPS COU - Objects", + "path": "objects", + "order": 3 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "BBPS COU - API integration", + "path": "quickstart", + "order": 1 + }, + { + "name": "Webhooks", + "visible_in_sidebar": true, + "page_title": "BBPS COU - Webhooks", + "path": "webhooks", + "order": 4 + } + ] + }, + { + "name": "API reference", + "visible_in_sidebar": false, + "page_title": "BillPay API reference", + "path": "api-reference", + "order": 5 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay Overview", + "path": "overview", + "order": 0 + }, + { + "name": "Pre-built screens", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay pre-built screens", + "path": "pre-built-screens", + "order": 2, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": false, + "page_title": "BBPS Billpay API reference", + "path": "api-reference-wl", + "order": 4 + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay API reference", + "path": "api-reference", + "order": 4 + }, + { + "name": "Custom payment", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay custom payment", + "path": "custom-payment", + "order": 2, + "children": [ + { + "name": "Android", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay android integration for custom payment", + "path": "android", + "order": 3 + }, + { + "name": "Required APIs", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay APIs for custom payment", + "path": "apis", + "order": 1 + }, + { + "name": "Cross platform", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay cross-platform integration for custom payment", + "path": "cross-platform", + "order": 3 + }, + { + "name": "iOS", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay iOS integration for custom payment", + "path": "iOS", + "order": 4 + }, + { + "name": "Website", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay website integration for custom payment", + "path": "website", + "order": 2 + } + ] + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay Quickstart", + "path": "quickstart", + "order": 1, + "children": [ + { + "name": "Android", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay Android integration", + "path": "android", + "order": 2 + }, + { + "name": "API", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay API", + "path": "api", + "order": 2 + }, + { + "name": "Cross platform", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay cross platform integration", + "path": "cross-platform", + "order": 4 + }, + { + "name": "iOS", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay iOS integration", + "path": "iOS", + "order": 3 + }, + { + "name": "Website", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay website", + "path": "website", + "order": 1 + } + ] + }, + { + "name": "Webhooks", + "visible_in_sidebar": true, + "page_title": "BBPS Billpay webhooks", + "path": "webhooks", + "order": 2 + } + ] + } + ] + } + ] + }, + { + "name": "WhatsApp Collect", + "path": "whatsapp-collect", + "order": 3, + "visible_in_sidebar": true, + "children": [ + { + "name": "API Integration", + "visible_in_sidebar": true, + "page_title": "WhatsApp Collect API Integration", + "path": "api-integration", + "order": 3 + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "WhatsApp Collect API reference", + "path": "api-reference", + "order": 5 + }, + { + "name": "Error codes", + "visible_in_sidebar": true, + "page_title": "WhatsApp Collect error codes", + "path": "errors", + "order": 4 + }, + { + "name": "Collection journey", + "visible_in_sidebar": true, + "page_title": "WhatsApp Collect Journey", + "path": "journey", + "order": 1 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "WhatsApp Collect Overview", + "path": "overview", + "order": 0 + }, + { + "name": "Collection reminders", + "visible_in_sidebar": true, + "page_title": "WhatsApp Collect reminders", + "path": "reminders", + "order": 2 + } + ] + }, + { + "name": "UPI DeepLinks", + "path": "upi-deeplinks", + "order": 4, + "visible_in_sidebar": true, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks API reference", + "path": "api-reference", + "order": 8 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks Notifications", + "path": "notifications", + "order": 6 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks Overview", + "path": "overview", + "order": 0 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks quickstart", + "path": "quickstart", + "order": 1, + "children": [ + { + "name": "Go Live", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks go live", + "path": "go-live", + "order": 1 + } + ] + }, + { + "name": "Refunds", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks Refunds", + "path": "refunds", + "order": 4 + }, + { + "name": "Reports API", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks Reports API", + "path": "reports", + "order": 5 + }, + { + "name": "Additional resources", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks additonal resources", + "path": "resources", + "order": 6, + "children": [ + { + "name": "JWT authentication", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks JWT authentication", + "path": "jwt", + "order": 2 + }, + { + "name": "OAuth 2.0", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks OAuth 2.0", + "path": "oauth", + "order": 1 + }, + { + "name": "Settlement object", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks settlement object", + "path": "settlement-object", + "order": 3 + } + ] + }, + { + "name": "SDKs", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks SDKs", + "path": "sdks", + "order": 3 + }, + { + "name": "Third party verification", + "visible_in_sidebar": true, + "page_title": "UPI Deeplinks third party verification", + "path": "third-party-verification", + "order": 3 + } + ] + }, + { + "name": "UPI Setu", + "path": "umap", + "order": 7, + "visible_in_sidebar": true, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "UPI Setu - API integration", + "path": "api-integration", + "order": 2, + "children": [ + { + "name": "Aggregators", + "visible_in_sidebar": true, + "page_title": "UPI Setu - API integration for aggregators", + "path": "aggregators", + "order": 1 + }, + { + "name": "Merchants", + "visible_in_sidebar": true, + "page_title": "UPI Setu - API integration for merchants", + "path": "merchants", + "order": 2 + } + ] + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "UPI Setu - API reference", + "path": "api-reference", + "order": 8 + }, + { + "name": "UPI mandates", + "visible_in_sidebar": true, + "page_title": "UPI mandates", + "path": "mandates", + "order": 4, + "children": [ + { + "name": "Mandate operations", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Mandate operations", + "path": "generic", + "order": 5, + "children": [ + { + "name": "Pause", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Pause", + "path": "pause", + "order": 3 + }, + { + "name": "Revoke", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Revoke", + "path": "revoke", + "order": 2 + }, + { + "name": "Unpause", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Unpause", + "path": "unpause", + "order": 4 + }, + { + "name": "Update", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Update", + "path": "update", + "order": 1 + } + ] + }, + { + "name": "OneShot", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - OneShot", + "path": "one-shot", + "order": 1, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Check payment status", + "path": "check-status", + "order": 4 + }, + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Create One Time Mandate", + "path": "create", + "order": 1 + }, + { + "name": "Execute", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Execute One Time Mandate", + "path": "execute", + "order": 3 + }, + { + "name": "Pre Debit Notify", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification", + "path": "pre-debit-notify", + "order": 2 + } + ] + }, + { + "name": "Recur", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Recur", + "path": "recur", + "order": 3, + "children": [ + { + "name": "Check payment status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Check payment status", + "path": "check-status", + "order": 4 + }, + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Create recurring mandate", + "path": "create", + "order": 1 + }, + { + "name": "Execute", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Execute mandate", + "path": "execute", + "order": 3 + }, + { + "name": "Pre Debit Notify", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification", + "path": "pre-debit-notify", + "order": 2 + } + ] + }, + { + "name": "Reserve", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Reserve", + "path": "reserve", + "order": 2, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Check payment status", + "path": "check-status", + "order": 4 + }, + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Create Reserve Mandate", + "path": "create", + "order": 1 + }, + { + "name": "Execute", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Execute Reserve Mandate", + "path": "execute", + "order": 3 + } + ] + }, + { + "name": "ReservePlus", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - ReservePlus", + "path": "reserve-plus", + "order": 4, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Check payment status", + "path": "check-status", + "order": 3 + }, + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Create single block multi-debit", + "path": "create", + "order": 1 + }, + { + "name": "Execute", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Mandates - Execute single block multi-debit", + "path": "execute", + "order": 2 + } + ] + } + ] + }, + { + "name": "Merchant on-boarding", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Merchant onboarding", + "path": "merchant-onboarding", + "order": 2, + "children": [ + { + "name": "Check VPA availability", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Merchant on-boarding - Check VPA availability", + "path": "check-vpa-availability-api", + "order": 2 + }, + { + "name": "Setup a merchant", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Merchant on-boarding - Setup merchant", + "path": "create-merchant-api", + "order": 1 + }, + { + "name": "Registering VPA", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Merchant on-boarding - Registering a VPA", + "path": "create-vpa-api", + "order": 3 + } + ] + }, + { + "name": "Notifications and alerts", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts", + "path": "notifications", + "order": 7, + "children": [ + { + "name": "VPA verification", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Customer VPA verification", + "path": "customer-vpa-verification", + "order": 6 + }, + { + "name": "Disputes", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Disputes", + "path": "disputes", + "order": 5 + }, + { + "name": "Mandates", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Mandates", + "path": "mandates", + "order": 3, + "children": [ + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Creation of mandate", + "path": "create", + "order": 1 + }, + { + "name": "Execute", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Mandate execution", + "path": "execute", + "order": 7 + }, + { + "name": "Notify", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Mandate pre-debit notifications", + "path": "notify", + "order": 6 + }, + { + "name": "Pause", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Pausing mandate", + "path": "pause", + "order": 4 + }, + { + "name": "Revoke", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Revoking mandate", + "path": "revoke", + "order": 3 + }, + { + "name": "Unpause", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Unpausing mandate", + "path": "unpause", + "order": 5 + }, + { + "name": "Update", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Updating mandate", + "path": "update", + "order": 2 + } + ] + }, + { + "name": "Payments", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Payments", + "path": "payments", + "order": 2 + }, + { + "name": "Refunds", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Notifications and alerts - Refunds", + "path": "refunds", + "order": 4 + }, + { + "name": "Verify signature", + "visible_in_sidebar": true, + "page_title": "UMAP - Events and notifications", + "path": "verify-signature", + "order": 1 + } + ] + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Overview", + "path": "overview", + "order": 0 + }, + { + "name": "UPI payments", + "visible_in_sidebar": true, + "page_title": "UPI payments", + "path": "payments", + "order": 3, + "children": [ + { + "name": "Collect", + "visible_in_sidebar": true, + "page_title": "UPI payments - Collect", + "path": "collect", + "order": 2, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu payments - Collect request - Check payment status", + "path": "check-status", + "order": 3 + }, + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu payments - Create collect request", + "path": "create-collect-request", + "order": 2 + }, + { + "name": "Verify customer VPA", + "visible_in_sidebar": true, + "page_title": "UPI Setu payments - Verify customer VPA", + "path": "verify-customer-vpa-api", + "order": 1 + } + ] + }, + { + "name": "Flash", + "visible_in_sidebar": true, + "page_title": "UPI payments - Flash", + "path": "flash", + "order": 1, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu payments - Intent/QR - Check payment status", + "path": "check-status", + "order": 2 + }, + { + "name": "Dynamic QR", + "visible_in_sidebar": true, + "page_title": "UPI Setu payments - Create Dynamic QR", + "path": "create-dqr", + "order": 1 + }, + { + "name": "Static QR", + "visible_in_sidebar": true, + "page_title": "UPI Setu payments - Create Static QR", + "path": "create-sqr", + "order": 1 + } + ] + }, + { + "name": "TPV", + "visible_in_sidebar": true, + "page_title": "UPI payments - TPV", + "path": "tpv", + "order": 3, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Payments - TPV - Check payment status", + "path": "check-status", + "order": 2 + }, + { + "name": "Create", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Payments - Create TPV API", + "path": "create-tpv", + "order": 1 + }, + { + "name": "Payments", + "visible_in_sidebar": true, + "page_title": "UMAP - Notifications and alerts - Payments", + "path": "life-cycle", + "order": 1 + } + ] + } + ] + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Quickstart", + "path": "quickstart", + "order": 1, + "children": [ + { + "name": "Aggregators", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Quickstart for aggregators", + "path": "aggregators", + "order": 1 + }, + { + "name": "Merchants", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Quickstart for merchants", + "path": "merchants", + "order": 2 + } + ] + }, + { + "name": "Refunds and disputes", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Refunds and disputes", + "path": "refunds-disputes", + "order": 6, + "children": [ + { + "name": "Check refund status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Refunds and disputes - Check refund status API", + "path": "check-refund-status-api", + "order": 2 + }, + { + "name": "Create refund", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Refunds and disputes - Create refund API", + "path": "create-refund-api", + "order": 1 + }, + { + "name": "Fetch dispute", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Refunds and disputes - Fetch dispute API", + "path": "fetch-dispute-api", + "order": 3 + } + ] + }, + { + "name": "Transaction Monitoring", + "visible_in_sidebar": false, + "page_title": "UPI Setu - Transaction Monitoring", + "path": "transaction-monitoring", + "order": 5, + "children": [ + { + "name": "Check status", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Transaction monitoring - Check status API", + "path": "check-status-api", + "order": 1 + }, + { + "name": "Check status history", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Transaction monitoring - Check status sistory API", + "path": "check-status-history-api", + "order": 2 + }, + { + "name": "Fetch payment", + "visible_in_sidebar": true, + "page_title": "UPI Setu - Transaction monitoring - Fetch payment API", + "path": "fetch-payment-api", + "order": 3 + } + ] + } + ] + } + ] + }, + { + "name": "Data", + "path": "data", + "order": 1, + "visible_in_sidebar": true, + "children": [ + { + "name": "KYC", + "path": "kyc", + "order": 0, + "visible_in_sidebar": true, + "children": [ + { + "name": "Secure Data Add-On", + "visible_in_sidebar": true, + "page_title": "Setu Encrypted APIs", + "path": "encryption", + "order": 2 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Setu KYC Overview", + "path": "overview", + "order": 1 + } + ] + }, + { + "name": "PAN verification", + "path": "pan", + "order": 0, + "visible_in_sidebar": false, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "PAN verification API reference", + "path": "api-reference", + "order": 1 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "PAN verification quickstart", + "path": "quickstart", + "order": 0 + } + ] + }, + { + "name": "Aadhaar eSign", + "path": "esign", + "order": 2, + "visible_in_sidebar": true, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Aadhaar eSign API reference", + "path": "api-reference", + "order": 9 + }, + { + "name": "Error codes", + "visible_in_sidebar": true, + "page_title": "Aadhaar eSign error codes", + "path": "error-codes", + "order": 8 + }, + { + "name": "eStamp overview", + "visible_in_sidebar": true, + "page_title": "eStamp overview", + "path": "estamp", + "order": 2 + }, + { + "name": "Flexible eSign guide", + "visible_in_sidebar": true, + "page_title": "Integration guide with flexible signature coordinates", + "path": "flexi-esign", + "order": 4 + }, + { + "name": "eSign Name Match", + "visible_in_sidebar": true, + "page_title": "Aadhaar eSign Name Match", + "path": "name-match", + "order": 6 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "Aadhaar eSign Notifications", + "path": "notifications", + "order": 7 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Aadhaar eSign overview", + "path": "overview", + "order": 1 + }, + { + "name": "PDF templates", + "visible_in_sidebar": true, + "page_title": "Integration guide with pdf templating API's", + "path": "pdf-templating", + "order": 5 + }, + { + "name": "Integration guide", + "visible_in_sidebar": true, + "page_title": "Aadhaar eSign integration guide", + "path": "quickstart", + "order": 3 + } + ] + }, + { + "name": "DigiLocker", + "path": "digilocker", + "order": 3, + "visible_in_sidebar": false, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Digilocker API reference", + "path": "api-reference", + "order": 3 + }, + { + "name": "Error codes", + "visible_in_sidebar": true, + "page_title": "DigiLocker error codes", + "path": "error-codes", + "order": 4 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Digilocker overview", + "path": "overview", + "order": 0 + }, + { + "name": "Integration guide", + "visible_in_sidebar": true, + "page_title": "Digilocker quickstart", + "path": "quickstart", + "order": 1 + } + ] + }, + { + "name": "AA Gateway", + "path": "account-aggregator", + "order": 4, + "versions": [ + "v1", + "v2" + ], + "default_version": "v2", + "visible_in_sidebar": true, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "Account Aggregator API integration", + "path": "api-integration", + "order": 3, + "children": [ + { + "name": "Account Availability", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Account Availability", + "path": "account-availability-apis", + "order": 5 + }, + { + "name": "Consent flow", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Consent flow", + "path": "consent-flow", + "order": 1 + }, + { + "name": "Data flow", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Data flow", + "path": "data-apis", + "order": 2 + }, + { + "name": "Active FIPs", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Active FIPs", + "path": "fip-apis", + "order": 4 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Notifications", + "path": "notifications", + "order": 3 + } + ] + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Account Aggregator API reference", + "path": "api-reference", + "order": 10 + }, + { + "name": "Consent object", + "visible_in_sidebar": true, + "page_title": "Account Aggregator consent object", + "path": "consent-object", + "order": 4 + }, + { + "name": "Embed Setu screens", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Embed Setu screens", + "path": "embed-setu-aa", + "order": 7 + }, + { + "name": "FI data types", + "visible_in_sidebar": true, + "page_title": "Account Aggregator FI data types", + "path": "fi-data-types", + "order": 5 + }, + { + "name": "Licenses and go live", + "visible_in_sidebar": true, + "page_title": "Account Aggregator license and go live process", + "path": "licenses-and-go-live", + "order": 8, + "children": [ + { + "name": "Go live", + "visible_in_sidebar": true, + "page_title": "FIU go live process", + "path": "go-live", + "order": 2 + }, + { + "name": "Licenses", + "visible_in_sidebar": true, + "page_title": "Licenses required to participate in AA", + "path": "licenses", + "order": 1 + }, + { + "name": "Participants in AA", + "visible_in_sidebar": true, + "page_title": "Participants in AA", + "path": "participants-in-aa", + "order": 0 + } + ] + }, + { + "name": "Multi AA gateway", + "visible_in_sidebar": true, + "page_title": "Account Aggregator multi-AA gateway", + "path": "multi-aa-gateway", + "order": 2 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Account Aggregator overview", + "path": "overview", + "order": 0 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "Account Aggregator quickstart", + "path": "quickstart", + "order": 1 + }, + { + "path": "v1", + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "Account Aggregator API integration", + "path": "api-integration", + "order": 3, + "children": [ + { + "name": "Consent flow", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Consent flow", + "path": "consent-flow", + "order": 1 + }, + { + "name": "Data flow", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Data flow", + "path": "data-apis", + "order": 2 + }, + { + "name": "Active FIPs", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Active FIPs", + "path": "fip-apis", + "order": 4 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Notifications", + "path": "notifications", + "order": 3 + } + ] + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Account Aggregator API reference", + "path": "api-reference", + "order": 10 + }, + { + "name": "Consent object", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Consent object", + "path": "consent-object", + "order": 4 + }, + { + "name": "Embed Setu screens", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Embed Setu screens", + "path": "embed-setu-aa", + "order": 7 + }, + { + "name": "End-to-end encryption", + "visible_in_sidebar": false, + "page_title": "Account Aggregator End-to-end encryption", + "path": "encryption", + "order": 1 + }, + { + "name": "FI data types", + "visible_in_sidebar": true, + "page_title": "Account Aggregator FI data types", + "path": "fi-data-types", + "order": 5 + }, + { + "name": "Get started", + "visible_in_sidebar": false, + "page_title": "Account Aggregator getting started", + "path": "get-started", + "order": 0 + }, + { + "name": "Licenses and go live", + "visible_in_sidebar": true, + "page_title": "Account Aggregator license and go live process", + "path": "licenses-and-go-live", + "order": 8, + "children": [ + { + "name": "Go live", + "visible_in_sidebar": true, + "page_title": "FIU go live process", + "path": "go-live", + "order": 2 + }, + { + "name": "Licenses", + "visible_in_sidebar": true, + "page_title": "Licenses required to participate in AA", + "path": "licenses", + "order": 1 + }, + { + "name": "Participants in AA", + "visible_in_sidebar": true, + "page_title": "Participants in AA", + "path": "participants-in-aa", + "order": 0 + } + ] + }, + { + "name": "Migration guide", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Migration Guide", + "path": "migration-guide", + "order": 6, + "children": [ + { + "name": "Consent flow", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Consent flow", + "path": "consent-flow", + "order": 1 + }, + { + "name": "Data flow", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Data flow", + "path": "data-flow", + "order": 2 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Notifications", + "path": "notifications", + "order": 3 + } + ] + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Account Aggregator overview", + "path": "overview", + "order": 0 + }, + { + "name": "Postman integration", + "visible_in_sidebar": true, + "page_title": "Account Aggregator Postman integration", + "path": "postman", + "order": 2 + }, + { + "name": "Quickstart", + "visible_in_sidebar": false, + "page_title": "Account Aggregator quickstart", + "path": "quickstart-v1", + "order": 1 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "Account Aggregator quickstart", + "path": "quickstart", + "order": 1 + }, + { + "name": "Request signing", + "visible_in_sidebar": false, + "page_title": "Account Aggregator Request signing", + "path": "request-signing", + "order": 1 + } + ] + } + ] + }, + { + "name": "Bank account verification", + "path": "bav", + "order": 5, + "visible_in_sidebar": false, + "children": [ + { + "name": "Penny drop", + "visible_in_sidebar": true, + "page_title": "BAV using penny drop", + "path": "penny-drop", + "order": 1, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "BAV API integration", + "path": "api-integration", + "order": 1, + "children": [ + { + "name": "Async API", + "visible_in_sidebar": true, + "page_title": "BAV Async API integration", + "path": "async", + "order": 2 + }, + { + "path": "bav-codes" + }, + { + "name": "Sync API", + "visible_in_sidebar": true, + "page_title": "BAV Sync API integration", + "path": "sync", + "order": 1 + } + ] + }, + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "BAV API reference", + "path": "api-reference", + "order": 3 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "BAV Async Penny drop Notifications", + "path": "notifications", + "order": 2 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "BAV quickstart", + "path": "quickstart", + "order": 0 + } + ] + }, + { + "name": "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 + } + ] + }, + { + "name": "PennyLess Drop", + "visible_in_sidebar": true, + "page_title": "BAV using PennyLess Drop API", + "path": "pennyless-drop", + "order": 4, + "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, + "versions": [ + "v1", + "v2" + ], + "default_version": "v2", + "visible_in_sidebar": true, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Setu Insights API reference", + "path": "api-reference", + "order": 4 + }, + { + "name": "List of insights", + "visible_in_sidebar": true, + "page_title": "All Setu insights", + "path": "insights", + "order": 2 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "Setu Insights notifications", + "path": "notifications", + "order": 3 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Setu Insights overview", + "path": "overview", + "order": 0 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "Setu Insights quickstart", + "path": "quickstart", + "order": 1, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "Setu Insights Postman integration", + "path": "api-integration", + "order": 1 + }, + { + "name": "Postman integration", + "visible_in_sidebar": true, + "page_title": "Setu Insights Postman integration", + "path": "postman", + "order": 0 + } + ] + }, + { + "path": "v1", + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Setu Insights API reference", + "path": "api-reference", + "order": 4 + }, + { + "name": "List of insights", + "visible_in_sidebar": true, + "page_title": "All Setu insights", + "path": "insights", + "order": 2 + }, + { + "name": "Notifications", + "visible_in_sidebar": true, + "page_title": "Setu Insights notifications", + "path": "notifications", + "order": 3 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Setu Insights overview", + "path": "overview", + "order": 0 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "Setu Insights quickstart", + "path": "quickstart", + "order": 1, + "children": [ + { + "name": "API integration", + "visible_in_sidebar": true, + "page_title": "Setu Insights Postman integration", + "path": "api-integration", + "order": 1 + }, + { + "name": "Postman integration", + "visible_in_sidebar": true, + "page_title": "Setu Insights Postman integration", + "path": "postman", + "order": 0 + } + ] + } + ] + } + ] + }, + { + "name": "ULI", + "path": "uli", + "order": 6, + "visible_in_sidebar": false, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "GSTIN verification API reference", + "path": "api-reference", + "order": 2 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "GST Verification quickstart", + "path": "quickstart", + "order": 1 + } + ] + }, + { + "name": "GST verification", + "path": "gst", + "order": 6, + "visible_in_sidebar": false, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "GSTIN verification API reference", + "path": "api-reference", + "order": 2 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "GST Verification quickstart", + "path": "quickstart", + "order": 1 + } + ] + }, + { + "name": "Match APIs", + "path": "match-apis", + "order": 7, + "visible_in_sidebar": false, + "children": [ + { + "name": "Name match", + "visible_in_sidebar": true, + "page_title": "Name match APIs", + "path": "name-match", + "order": 1, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "Name Match API reference", + "path": "api-reference", + "order": 4 + }, + { + "name": "Examples", + "visible_in_sidebar": true, + "page_title": "Name Match API response examples", + "path": "examples", + "order": 3 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Name Match API overview", + "path": "overview", + "order": 1 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "Name Match API quickstart", + "path": "quickstart", + "order": 2 + } + ] + } + ] + }, + { + "name": "eKYC", + "path": "ekyc", + "order": 8, + "visible_in_sidebar": false, + "children": [ + { + "name": "API reference", + "visible_in_sidebar": true, + "page_title": "eKYC API reference", + "path": "api-reference", + "order": 2 + }, + { + "name": "Quickstart", + "visible_in_sidebar": true, + "page_title": "PAN verification quickstart", + "path": "quickstart", + "order": 1 + } + ] + } + ] + }, + { + "name": "Dev tools", + "path": "dev-tools", + "order": 2, + "visible_in_sidebar": true, + "children": [ + { + "name": "The Bridge", + "path": "bridge", + "order": 0, + "versions": [ + "v1", + "v2" + ], + "default_version": "v2", + "visible_in_sidebar": true, + "children": [ + { + "name": "Analytics and reports", + "visible_in_sidebar": true, + "page_title": "Bridge analytics and reports", + "path": "analytics-and-reports", + "order": 3 + }, + { + "name": "Explore and configure products", + "visible_in_sidebar": true, + "page_title": "Bridge explore and configure products", + "path": "explore-and-configure-products", + "order": 2 + }, + { + "name": "Glossary", + "visible_in_sidebar": true, + "page_title": "Bridge glossary", + "path": "glossary", + "order": 0 + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Bridge overview", + "path": "overview", + "order": 1 + }, + { + "name": "Settings", + "visible_in_sidebar": true, + "page_title": "Bridge settings", + "path": "settings", + "order": 4 + }, + { + "name": "User profile", + "visible_in_sidebar": true, + "page_title": "Bridge user profile", + "path": "user-profile", + "order": 5 + }, + { + "path": "v1", + "children": [ + { + "name": "Bridge configuration", + "visible_in_sidebar": false, + "page_title": "Bridge configuration", + "path": "configure", + "order": 6 + }, + { + "name": "Generate Token", + "visible_in_sidebar": false, + "page_title": "Bridge generate token", + "path": "generate-token", + "order": 4 + }, + { + "name": "Org settings", + "visible_in_sidebar": true, + "page_title": "Bridge org settings", + "path": "org-settings", + "order": 3, + "children": [ + { + "name": "API keys", + "visible_in_sidebar": true, + "page_title": "API keys", + "path": "api-keys", + "order": 2, + "children": [ + { + "name": "JWT Auth", + "visible_in_sidebar": false, + "page_title": "JWT Auth", + "path": "jwt-auth", + "order": 3 + }, + { + "name": "JWT", + "visible_in_sidebar": true, + "page_title": "JWT", + "path": "jwt", + "order": 1 + }, + { + "name": "OAuth", + "visible_in_sidebar": true, + "page_title": "OAuth", + "path": "oauth", + "order": 2 + } + ] + }, + { + "name": "People", + "visible_in_sidebar": true, + "page_title": "People", + "path": "people", + "order": 1 + } + ] + }, + { + "name": "Overview", + "visible_in_sidebar": true, + "page_title": "Bridge overview", + "path": "overview", + "order": 0 + }, + { + "name": "Reports", + "visible_in_sidebar": true, + "page_title": "Bridge reports", + "path": "reports", + "order": 1, + "children": [ + { + "name": "Types", + "visible_in_sidebar": false, + "page_title": "Report types", + "path": "types", + "order": 1 + } + ] + }, + { + "name": "Reports API", + "visible_in_sidebar": false, + "page_title": "Reports API", + "path": "reports-api", + "order": 5 + } + ] + } + ] + } + ] + }, + { + "name": "Sample Category", + "path": "sample-category", + "order": 3, + "visible_in_sidebar": false, + "children": [ + { + "name": "Sample Product", + "path": "sample-product", + "order": 0, + "visible_in_sidebar": false, + "children": [ + { + "name": "Sample Page", + "visible_in_sidebar": false, + "page_title": "Docs sample page", + "path": "sample-page", + "order": 0 + } + ] + } + ] + } + ] +} \ No newline at end of file From cb4d0bc34faff44d8824e8bc1150d5a3855700b2 Mon Sep 17 00:00:00 2001 From: tanmay Date: Wed, 7 May 2025 19:27:17 +0530 Subject: [PATCH 6/6] add api playground examples --- .../CancelUPMSRegistration.json | 14 +++++++++++ .../SimulateBillNotification.json | 14 +++++++++++ .../SimulateSkipPaymentNotification.json | 14 +++++++++++ .../UpdateUPMSRegistration.json | 24 +++++++++++++++++++ .../api-integration/ViewUPMSRegistration.json | 14 +++++++++++ 5 files changed, 80 insertions(+) create mode 100644 api-playground/json/payments/billpay/api-integration/CancelUPMSRegistration.json create mode 100644 api-playground/json/payments/billpay/api-integration/SimulateBillNotification.json create mode 100644 api-playground/json/payments/billpay/api-integration/SimulateSkipPaymentNotification.json create mode 100644 api-playground/json/payments/billpay/api-integration/UpdateUPMSRegistration.json create mode 100644 api-playground/json/payments/billpay/api-integration/ViewUPMSRegistration.json diff --git a/api-playground/json/payments/billpay/api-integration/CancelUPMSRegistration.json b/api-playground/json/payments/billpay/api-integration/CancelUPMSRegistration.json new file mode 100644 index 00000000..685a1955 --- /dev/null +++ b/api-playground/json/payments/billpay/api-integration/CancelUPMSRegistration.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "header": [ + { + "X-PARTNER-ID": "1010225520484287807" + } + ], + "path": [ + { + "upmsRegistrationRefID": "SETUUPMSREFIDEXAMPLE123456789012345" + } + ] + } +} \ No newline at end of file diff --git a/api-playground/json/payments/billpay/api-integration/SimulateBillNotification.json b/api-playground/json/payments/billpay/api-integration/SimulateBillNotification.json new file mode 100644 index 00000000..685a1955 --- /dev/null +++ b/api-playground/json/payments/billpay/api-integration/SimulateBillNotification.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "header": [ + { + "X-PARTNER-ID": "1010225520484287807" + } + ], + "path": [ + { + "upmsRegistrationRefID": "SETUUPMSREFIDEXAMPLE123456789012345" + } + ] + } +} \ No newline at end of file diff --git a/api-playground/json/payments/billpay/api-integration/SimulateSkipPaymentNotification.json b/api-playground/json/payments/billpay/api-integration/SimulateSkipPaymentNotification.json new file mode 100644 index 00000000..1aaa4467 --- /dev/null +++ b/api-playground/json/payments/billpay/api-integration/SimulateSkipPaymentNotification.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "header": [ + { + "X-PARTNER-ID": "1010225520484287807" + } + ], + "path": [ + { + "billRefId": "SETUBILLREFIDEXAMPLE123456789012345" + } + ] + } +} \ No newline at end of file diff --git a/api-playground/json/payments/billpay/api-integration/UpdateUPMSRegistration.json b/api-playground/json/payments/billpay/api-integration/UpdateUPMSRegistration.json new file mode 100644 index 00000000..01c1c759 --- /dev/null +++ b/api-playground/json/payments/billpay/api-integration/UpdateUPMSRegistration.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "header": [ + { + "X-PARTNER-ID": "1010225520484287807" + } + ], + "path": [ + { + "upmsRegistrationRefID": "SETUUPMSREFIDEXAMPLE123456789012345" + } + ] + }, + "body": { + "mandate": { + "registrationType": "AUTO_PAY", + "toDate": "2027-01-01", + "debitInfo": { + "amount": 10000, + "type": "MAX_AMOUNT" + } + } + } +} \ No newline at end of file diff --git a/api-playground/json/payments/billpay/api-integration/ViewUPMSRegistration.json b/api-playground/json/payments/billpay/api-integration/ViewUPMSRegistration.json new file mode 100644 index 00000000..685a1955 --- /dev/null +++ b/api-playground/json/payments/billpay/api-integration/ViewUPMSRegistration.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "header": [ + { + "X-PARTNER-ID": "1010225520484287807" + } + ], + "path": [ + { + "upmsRegistrationRefID": "SETUUPMSREFIDEXAMPLE123456789012345" + } + ] + } +} \ No newline at end of file