From d7f697cd252823b53343da3531b9f5486af6db50 Mon Sep 17 00:00:00 2001 From: Aditya Gannavarapu Date: Thu, 28 Nov 2024 09:19:52 +0530 Subject: [PATCH] Fix formatting --- .../payments/billpay/api-integration.json | 759 ++++------------- .../payments/billpay/pre-built-screens.json | 115 +-- .../payments/billpay_v1/api-integration.json | 769 ++++-------------- .../billpay_v1/pre-built-screens.json | 115 +-- 4 files changed, 362 insertions(+), 1396 deletions(-) diff --git a/api-references/payments/billpay/api-integration.json b/api-references/payments/billpay/api-integration.json index 916ddfd..acb0c41 100644 --- a/api-references/payments/billpay/api-integration.json +++ b/api-references/payments/billpay/api-integration.json @@ -22,9 +22,7 @@ "paths": { "/api/v2/auth/token": { "post": { - "tags": [ - "Token API" - ], + "tags": ["Token API"], "description": "Fetch token to be used to authorize all Setu APIs", "operationId": "fetchToken", "requestBody": { @@ -101,10 +99,7 @@ "schema": { "allOf": [ { - "required": [ - "expiresIn", - "token" - ], + "required": ["expiresIn", "token"], "type": "object", "properties": { "expiresIn": { @@ -118,10 +113,7 @@ } }, { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -144,18 +136,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -187,9 +172,7 @@ }, "/api/v2/bbps/bills/fetch/request": { "post": { - "tags": [ - "Fetch" - ], + "tags": ["Fetch"], "description": "Bill fetch request API", "operationId": "FetchRequestV2", "parameters": [ @@ -209,27 +192,18 @@ "schema": { "allOf": [ { - "required": [ - "agent", - "biller" - ], + "required": ["agent", "biller"], "type": "object", "properties": { "agent": { - "required": [ - "channel", - "id" - ], + "required": ["channel", "id"], "type": "object", "properties": { "os": { "type": "string", "description": "Mandatory if channel is `MOB`, `MOBB`. Not required for others.", "example": "iOS", - "enum": [ - "iOS", - "Android" - ] + "enum": ["iOS", "Android"] }, "postalCode": { "pattern": "^[1-9][0-9]{5}$", @@ -308,9 +282,7 @@ } }, "biller": { - "required": [ - "id" - ], + "required": ["id"], "type": "object", "properties": { "id": { @@ -326,17 +298,13 @@ "x-omitempty": true }, { - "required": [ - "customer" - ], + "required": ["customer"], "type": "object", "properties": { "customer": { "allOf": [ { - "required": [ - "mobile" - ], + "required": ["mobile"], "type": "object", "properties": { "remitter": { @@ -375,19 +343,14 @@ } }, { - "required": [ - "customerParams" - ], + "required": ["customerParams"], "type": "object", "properties": { "customerParams": { "type": "array", "description": "The bill params for fetching the bill", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -466,24 +429,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -518,18 +472,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -560,18 +507,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -600,19 +540,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentBillFetchRequest" @@ -620,9 +554,7 @@ }, "/api/v2/bbps/bills/fetch/response": { "post": { - "tags": [ - "Fetch" - ], + "tags": ["Fetch"], "description": "Bill fetch response API", "operationId": "FetchResponseV2", "parameters": [ @@ -640,9 +572,7 @@ "content": { "application/json": { "schema": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "refId": { @@ -709,10 +639,7 @@ "schema": { "allOf": [ { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -726,16 +653,11 @@ } }, { - "required": [ - "data" - ], + "required": ["data"], "type": "object", "properties": { "data": { - "required": [ - "refId", - "status" - ], + "required": ["refId", "status"], "type": "object", "properties": { "refId": { @@ -745,10 +667,7 @@ "additionalInfo": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -767,11 +686,7 @@ "type": "string", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], + "enum": ["SINGLE", "LIST", "SELECTIVE"], "x-nullable": true, "x-omitempty": false }, @@ -780,11 +695,7 @@ "description": "Defined only for billers with response type as LIST. SINGLE: User can pay only one of the bills in bill fetch response. MULTIPLE: User can pay any combination of bills in bill fetch response. ALL: User has to pay all the bills in bill fetch response.", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "MULTIPLE", - "ALL" - ], + "enum": ["SINGLE", "MULTIPLE", "ALL"], "x-nullable": true, "x-omitempty": false }, @@ -856,9 +767,7 @@ "type": "array", "nullable": true, "items": { - "required": [ - "name" - ], + "required": ["name"], "type": "object", "properties": { "minAmount": { @@ -904,10 +813,7 @@ "example": "7f16a032e514" }, "failureReason": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -920,22 +826,14 @@ }, "type": { "type": "string", - "enum": [ - "FUND_TRANSFER", - "BBPS", - "APP" - ] + "enum": ["FUND_TRANSFER", "BBPS", "APP"] } } }, "status": { "type": "string", "example": "Success", - "enum": [ - "Processing", - "Success", - "Failure" - ] + "enum": ["Processing", "Success", "Failure"] } } } @@ -952,18 +850,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -994,18 +885,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1034,19 +918,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentAsyncRequest" @@ -1054,9 +932,7 @@ }, "/api/v2/bbps/bills/payment/request": { "post": { - "tags": [ - "Pay" - ], + "tags": ["Pay"], "description": "Bill payment request API", "operationId": "PaymentRequestV2", "parameters": [ @@ -1076,9 +952,7 @@ "schema": { "allOf": [ { - "required": [ - "paymentDetails" - ], + "required": ["paymentDetails"], "type": "object", "properties": { "refId": { @@ -1091,10 +965,7 @@ "nullable": true, "example": "Selection on bills in case of list billers", "items": { - "required": [ - "amount", - "billNumber" - ], + "required": ["amount", "billNumber"], "type": "object", "properties": { "amount": { @@ -1144,10 +1015,7 @@ "description": "List of selected payment options", "nullable": true, "items": { - "required": [ - "amount", - "name" - ], + "required": ["amount", "name"], "type": "object", "properties": { "name": { @@ -1201,20 +1069,14 @@ } }, "agent": { - "required": [ - "channel", - "id" - ], + "required": ["channel", "id"], "type": "object", "properties": { "os": { "type": "string", "description": "Mandatory if channel is `MOB`, `MOBB`. Not required for others.", "example": "iOS", - "enum": [ - "iOS", - "Android" - ] + "enum": ["iOS", "Android"] }, "postalCode": { "pattern": "^[1-9][0-9]{5}$", @@ -1293,9 +1155,7 @@ } }, "biller": { - "required": [ - "id" - ], + "required": ["id"], "type": "object", "properties": { "id": { @@ -1316,9 +1176,7 @@ "customer": { "allOf": [ { - "required": [ - "mobile" - ], + "required": ["mobile"], "type": "object", "properties": { "remitter": { @@ -1357,19 +1215,14 @@ } }, { - "required": [ - "customerParams" - ], + "required": ["customerParams"], "type": "object", "properties": { "customerParams": { "type": "array", "description": "The bill params for fetching the bill", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -1448,24 +1301,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1500,18 +1344,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1586,24 +1423,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1638,18 +1466,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1678,19 +1499,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentBillPaymentRequestV2" @@ -1698,9 +1513,7 @@ }, "/api/v2/bbps/bills/payment/response": { "post": { - "tags": [ - "Pay" - ], + "tags": ["Pay"], "description": "Bill payment response API", "parameters": [ { @@ -1717,9 +1530,7 @@ "content": { "application/json": { "schema": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "refId": { @@ -1740,18 +1551,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1782,18 +1586,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1868,18 +1665,11 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId", - "status" - ], + "required": ["refId", "status"], "type": "object", "properties": { "lastPaidDate": { @@ -1921,10 +1711,7 @@ "description": "List of selected payment options", "nullable": true, "items": { - "required": [ - "amount", - "name" - ], + "required": ["amount", "name"], "type": "object", "properties": { "name": { @@ -1984,11 +1771,7 @@ "status": { "type": "string", "example": "Success", - "enum": [ - "Processing", - "Success", - "Failure" - ] + "enum": ["Processing", "Success", "Failure"] }, "transactionId": { "type": "string", @@ -1997,10 +1780,7 @@ "additionalInfo": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -2021,10 +1801,7 @@ "example": "MAHI00000NATIC" }, "failureReason": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2037,11 +1814,7 @@ }, "type": { "type": "string", - "enum": [ - "FUND_TRANSFER", - "BBPS", - "APP" - ] + "enum": ["FUND_TRANSFER", "BBPS", "APP"] } } }, @@ -2055,10 +1828,7 @@ "nullable": true, "example": "The bills paid in case of list billers", "items": { - "required": [ - "amount", - "billNumber" - ], + "required": ["amount", "billNumber"], "type": "object", "properties": { "amount": { @@ -2095,19 +1865,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentAsyncRequest" @@ -2115,9 +1879,7 @@ }, "/api/v2/bbps/bills/complaint/request": { "post": { - "tags": [ - "Dispute" - ], + "tags": ["Dispute"], "description": "Raise dispute request API", "operationId": "DisputeRequestV2", "parameters": [ @@ -2137,10 +1899,7 @@ "schema": { "allOf": [ { - "required": [ - "description", - "disputeType" - ], + "required": ["description", "disputeType"], "type": "object", "properties": { "description": { @@ -2164,9 +1923,7 @@ } }, { - "required": [ - "transactionId" - ], + "required": ["transactionId"], "type": "object", "properties": { "transactionId": { @@ -2232,24 +1989,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2284,18 +2032,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2326,18 +2067,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2366,19 +2100,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentDisputeRequest" @@ -2386,9 +2114,7 @@ }, "/api/v2/bbps/bills/complaint/response": { "post": { - "tags": [ - "Dispute" - ], + "tags": ["Dispute"], "description": "Raise dispute response API", "parameters": [ { @@ -2405,9 +2131,7 @@ "content": { "application/json": { "schema": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "refId": { @@ -2472,10 +2196,7 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "data": { @@ -2543,18 +2264,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2585,18 +2299,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2625,19 +2332,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentAsyncRequest" @@ -2645,9 +2346,7 @@ }, "/api/v2/bbps/disputes": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of disputes.", "operationId": "getDisputesV2", "parameters": [ @@ -2795,10 +2494,7 @@ "items": { "type": "string", "example": "BILLER", - "enum": [ - "BILLER", - "TRANSACTION" - ] + "enum": ["BILLER", "TRANSACTION"] } } } @@ -2855,10 +2551,7 @@ "schema": { "allOf": [ { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -3701,10 +3394,7 @@ "type": "array", "description": "The bill params for fetching the bill", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -3778,18 +3468,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -3820,18 +3503,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -3860,28 +3536,20 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } }, "/api/v2/bbps/transactions": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of transactions.", "operationId": "getTxnsV2", "parameters": [ @@ -3966,11 +3634,7 @@ "description": "Biller Fetch Api Type", "schema": { "type": "string", - "enum": [ - "BILL_FETCH", - "BILL_VALIDATE", - "BILL_DIRECT" - ] + "enum": ["BILL_FETCH", "BILL_VALIDATE", "BILL_DIRECT"] } }, { @@ -3999,11 +3663,7 @@ "items": { "type": "string", "example": "Success", - "enum": [ - "Processing", - "Success", - "Error" - ] + "enum": ["Processing", "Success", "Error"] } } }, @@ -4029,9 +3689,7 @@ "items": { "type": "string", "example": "BILLER", - "enum": [ - "BILLER" - ] + "enum": ["BILLER"] } } } @@ -4042,18 +3700,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -4130,10 +3781,7 @@ "schema": { "allOf": [ { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -4169,10 +3817,7 @@ "bills": { "type": "array", "items": { - "required": [ - "amount", - "billNumber" - ], + "required": ["amount", "billNumber"], "type": "object", "properties": { "amount": { @@ -4553,10 +4198,7 @@ "type": "array", "description": "The bill params for fetching the bill", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -4619,18 +4261,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -4659,28 +4294,20 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } }, "/api/v2/bbps/billers": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of billers.", "operationId": "getBillersV2", "parameters": [ @@ -4890,16 +4517,11 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "billers" - ], + "required": ["billers"], "type": "object", "properties": { "total": { @@ -4976,11 +4598,7 @@ "type": "string", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], + "enum": ["SINGLE", "LIST", "SELECTIVE"], "x-nullable": true, "x-omitempty": false }, @@ -4989,11 +4607,7 @@ "description": "Defined only for billers with response type as LIST. SINGLE: User can pay only one of the bills in bill fetch response. MULTIPLE: User can pay any combination of bills in bill fetch response. ALL: User has to pay all the bills in bill fetch response.", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "MULTIPLE", - "ALL" - ], + "enum": ["SINGLE", "MULTIPLE", "ALL"], "x-nullable": true, "x-omitempty": false }, @@ -5010,10 +4624,7 @@ "dataType": { "type": "string", "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] + "enum": ["ALPHANUMERIC", "NUMERIC"] }, "optional": { "type": "boolean", @@ -5039,10 +4650,7 @@ "dataType": { "type": "string", "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] + "enum": ["ALPHANUMERIC", "NUMERIC"] }, "optional": { "type": "boolean", @@ -5258,10 +4866,7 @@ } }, "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5292,18 +4897,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5334,18 +4932,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5374,28 +4965,20 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } }, "/api/v2/bbps/categories": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of categories.", "parameters": [ { @@ -5414,18 +4997,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5456,18 +5032,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5542,17 +5111,11 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5574,9 +5137,7 @@ "example": "C3SFG0O6N88R6UI7EQ" }, "data": { - "required": [ - "categories" - ], + "required": ["categories"], "type": "object", "properties": { "categories": { @@ -5604,19 +5165,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } diff --git a/api-references/payments/billpay/pre-built-screens.json b/api-references/payments/billpay/pre-built-screens.json index 1e7f24a..4b71863 100644 --- a/api-references/payments/billpay/pre-built-screens.json +++ b/api-references/payments/billpay/pre-built-screens.json @@ -22,9 +22,7 @@ "paths": { "/api/v2/webhooks/payment-event": { "post": { - "tags": [ - "Custom Payment Webhook" - ], + "tags": ["Custom Payment Webhook"], "description": "Custom payment webhook API", "operationId": "CouCustomPaymentWebhook", "parameters": [ @@ -134,9 +132,7 @@ "content": { "application/json": { "schema": { - "required": [ - "status" - ], + "required": ["status"], "type": "object", "properties": { "status": { @@ -155,18 +151,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -197,18 +186,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -240,9 +222,7 @@ }, "/api/v2/ethereal/link": { "post": { - "tags": [ - "Link Generation" - ], + "tags": ["Link Generation"], "description": "Ethereal link create request API", "operationId": "EtherealLinkRequest", "parameters": [ @@ -260,9 +240,7 @@ "content": { "application/json": { "schema": { - "required": [ - "orgId" - ], + "required": ["orgId"], "type": "object", "properties": { "categoryName": { @@ -288,10 +266,7 @@ "redirectTo": { "type": "string", "example": "transactions", - "enum": [ - "transactions", - "disputes" - ] + "enum": ["transactions", "disputes"] }, "additionalInfo": { "type": "object", @@ -301,10 +276,7 @@ "billParams": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -382,10 +354,7 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "link": { @@ -416,18 +385,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -458,18 +420,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -502,9 +457,7 @@ }, "/api/v2/auth/token": { "post": { - "tags": [ - "Token API" - ], + "tags": ["Token API"], "description": "Fetch token to be used to authorize all Setu APIs", "operationId": "fetchToken", "requestBody": { @@ -581,10 +534,7 @@ "schema": { "allOf": [ { - "required": [ - "expiresIn", - "token" - ], + "required": ["expiresIn", "token"], "type": "object", "properties": { "expiresIn": { @@ -598,10 +548,7 @@ } }, { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -624,18 +571,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -685,10 +625,7 @@ "fetchTokenResponse": { "allOf": [ { - "required": [ - "expiresIn", - "token" - ], + "required": ["expiresIn", "token"], "type": "object", "properties": { "expiresIn": { @@ -702,10 +639,7 @@ } }, { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -721,10 +655,7 @@ ] }, "successAndTracerDetails": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { diff --git a/api-references/payments/billpay_v1/api-integration.json b/api-references/payments/billpay_v1/api-integration.json index 030700d..00ed5f7 100644 --- a/api-references/payments/billpay_v1/api-integration.json +++ b/api-references/payments/billpay_v1/api-integration.json @@ -22,9 +22,7 @@ "paths": { "/api/v1/auth/token": { "post": { - "tags": [ - "Token API" - ], + "tags": ["Token API"], "description": "Fetch token to be used to authorize all Setu APIs", "operationId": "fetchToken", "requestBody": { @@ -101,10 +99,7 @@ "schema": { "allOf": [ { - "required": [ - "expiresIn", - "token" - ], + "required": ["expiresIn", "token"], "type": "object", "properties": { "expiresIn": { @@ -118,10 +113,7 @@ } }, { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -144,18 +136,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -187,9 +172,7 @@ }, "/api/v1/bbps/bills/fetch/request": { "post": { - "tags": [ - "Fetch" - ], + "tags": ["Fetch"], "description": "Bill fetch request API", "operationId": "FetchRequest", "parameters": [ @@ -209,27 +192,18 @@ "schema": { "allOf": [ { - "required": [ - "agent", - "biller" - ], + "required": ["agent", "biller"], "type": "object", "properties": { "agent": { - "required": [ - "channel", - "id" - ], + "required": ["channel", "id"], "type": "object", "properties": { "os": { "type": "string", "description": "Mandatory if channel is `MOB`, `MOBB`. Not required for others.", "example": "iOS", - "enum": [ - "iOS", - "Android" - ] + "enum": ["iOS", "Android"] }, "postalCode": { "pattern": "^[1-9][0-9]{5}$", @@ -308,9 +282,7 @@ } }, "biller": { - "required": [ - "id" - ], + "required": ["id"], "type": "object", "properties": { "id": { @@ -326,17 +298,13 @@ "x-omitempty": true }, { - "required": [ - "customer" - ], + "required": ["customer"], "type": "object", "properties": { "customer": { "allOf": [ { - "required": [ - "mobile" - ], + "required": ["mobile"], "type": "object", "properties": { "remitter": { @@ -375,18 +343,13 @@ } }, { - "required": [ - "billParameters" - ], + "required": ["billParameters"], "type": "object", "properties": { "billParameters": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -465,24 +428,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -517,18 +471,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -559,18 +506,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -599,19 +539,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentBillFetchRequest" @@ -619,9 +553,7 @@ }, "/api/v1/bbps/bills/fetch/response": { "post": { - "tags": [ - "Fetch" - ], + "tags": ["Fetch"], "description": "Bill fetch response API", "operationId": "FetchResponse", "parameters": [ @@ -639,9 +571,7 @@ "content": { "application/json": { "schema": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "refId": { @@ -708,10 +638,7 @@ "schema": { "allOf": [ { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -725,18 +652,13 @@ } }, { - "required": [ - "data" - ], + "required": ["data"], "type": "object", "properties": { "data": { "allOf": [ { - "required": [ - "refId", - "status" - ], + "required": ["refId", "status"], "type": "object", "properties": { "lastPaidDate": { @@ -752,10 +674,7 @@ "additionalInfo": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -774,11 +693,7 @@ "type": "string", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], + "enum": ["SINGLE", "LIST", "SELECTIVE"], "x-nullable": true, "x-omitempty": false }, @@ -787,11 +702,7 @@ "description": "Defined only for billers with response type as LIST. SINGLE: User can pay only one of the bills in bill fetch response. MULTIPLE: User can pay any combination of bills in bill fetch response. ALL: User has to pay all the bills in bill fetch response.", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "MULTIPLE", - "ALL" - ], + "enum": ["SINGLE", "MULTIPLE", "ALL"], "x-nullable": true, "x-omitempty": false }, @@ -863,9 +774,7 @@ "type": "array", "nullable": true, "items": { - "required": [ - "name" - ], + "required": ["name"], "type": "object", "properties": { "minAmount": { @@ -911,10 +820,7 @@ "example": "7f16a032e514" }, "failureReason": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -927,11 +833,7 @@ }, "type": { "type": "string", - "enum": [ - "FUND_TRANSFER", - "BBPS", - "APP" - ] + "enum": ["FUND_TRANSFER", "BBPS", "APP"] } } }, @@ -943,11 +845,7 @@ "status": { "type": "string", "example": "Success", - "enum": [ - "Processing", - "Success", - "Failure" - ] + "enum": ["Processing", "Success", "Failure"] } } }, @@ -1019,9 +917,7 @@ "type": "array", "nullable": true, "items": { - "required": [ - "name" - ], + "required": ["name"], "type": "object", "properties": { "minAmount": { @@ -1133,18 +1029,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1175,18 +1064,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1215,19 +1097,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentAsyncRequest" @@ -1235,9 +1111,7 @@ }, "/api/v1/bbps/bills/payment/request": { "post": { - "tags": [ - "Pay" - ], + "tags": ["Pay"], "description": "Bill payment request API", "operationId": "PaymentRequest", "parameters": [ @@ -1257,9 +1131,7 @@ "schema": { "allOf": [ { - "required": [ - "paymentDetails" - ], + "required": ["paymentDetails"], "type": "object", "properties": { "refId": { @@ -1272,10 +1144,7 @@ "nullable": true, "example": "Selection on bills in case of list billers", "items": { - "required": [ - "amount", - "billNumber" - ], + "required": ["amount", "billNumber"], "type": "object", "properties": { "amount": { @@ -1325,10 +1194,7 @@ "description": "List of selected payment options", "nullable": true, "items": { - "required": [ - "amount", - "name" - ], + "required": ["amount", "name"], "type": "object", "properties": { "name": { @@ -1382,20 +1248,14 @@ } }, "agent": { - "required": [ - "channel", - "id" - ], + "required": ["channel", "id"], "type": "object", "properties": { "os": { "type": "string", "description": "Mandatory if channel is `MOB`, `MOBB`. Not required for others.", "example": "iOS", - "enum": [ - "iOS", - "Android" - ] + "enum": ["iOS", "Android"] }, "postalCode": { "pattern": "^[1-9][0-9]{5}$", @@ -1474,9 +1334,7 @@ } }, "biller": { - "required": [ - "id" - ], + "required": ["id"], "type": "object", "properties": { "id": { @@ -1497,9 +1355,7 @@ "customer": { "allOf": [ { - "required": [ - "mobile" - ], + "required": ["mobile"], "type": "object", "properties": { "remitter": { @@ -1538,18 +1394,13 @@ } }, { - "required": [ - "billParameters" - ], + "required": ["billParameters"], "type": "object", "properties": { "billParameters": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -1628,24 +1479,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1680,18 +1522,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1766,24 +1601,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1818,18 +1644,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -1858,19 +1677,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentBillPaymentRequestV1" @@ -1878,9 +1691,7 @@ }, "/api/v1/bbps/bills/payment/response": { "post": { - "tags": [ - "Pay" - ], + "tags": ["Pay"], "description": "Bill payment response API", "parameters": [ { @@ -1897,9 +1708,7 @@ "content": { "application/json": { "schema": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "refId": { @@ -1920,18 +1729,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2006,18 +1808,11 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId", - "status" - ], + "required": ["refId", "status"], "type": "object", "properties": { "lastPaidDate": { @@ -2059,10 +1854,7 @@ "description": "List of selected payment options", "nullable": true, "items": { - "required": [ - "amount", - "name" - ], + "required": ["amount", "name"], "type": "object", "properties": { "name": { @@ -2122,11 +1914,7 @@ "status": { "type": "string", "example": "Success", - "enum": [ - "Processing", - "Success", - "Failure" - ] + "enum": ["Processing", "Success", "Failure"] }, "transactionId": { "type": "string", @@ -2135,10 +1923,7 @@ "additionalInfo": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -2159,10 +1944,7 @@ "example": "MAHI00000NATIC" }, "failureReason": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2175,11 +1957,7 @@ }, "type": { "type": "string", - "enum": [ - "FUND_TRANSFER", - "BBPS", - "APP" - ] + "enum": ["FUND_TRANSFER", "BBPS", "APP"] } } }, @@ -2193,10 +1971,7 @@ "nullable": true, "example": "The bills paid in case of list billers", "items": { - "required": [ - "amount", - "billNumber" - ], + "required": ["amount", "billNumber"], "type": "object", "properties": { "amount": { @@ -2235,18 +2010,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2275,19 +2043,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentAsyncRequest" @@ -2295,9 +2057,7 @@ }, "/api/v1/bbps/bills/complaint/request": { "post": { - "tags": [ - "Dispute" - ], + "tags": ["Dispute"], "description": "Raise dispute request API", "operationId": "DisputeRequest", "parameters": [ @@ -2317,10 +2077,7 @@ "schema": { "allOf": [ { - "required": [ - "description", - "disputeType" - ], + "required": ["description", "disputeType"], "type": "object", "properties": { "description": { @@ -2344,9 +2101,7 @@ } }, { - "required": [ - "txnReferenceId" - ], + "required": ["txnReferenceId"], "type": "object", "properties": { "txnReferenceId": { @@ -2368,18 +2123,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2454,24 +2202,15 @@ "content": { "application/json": { "schema": { - "required": [ - "data", - "success", - "traceId" - ], + "required": ["data", "success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "duplicate": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2506,18 +2245,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2546,19 +2278,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentDisputeRequest" @@ -2566,9 +2292,7 @@ }, "/api/v1/bbps/bills/complaint/response": { "post": { - "tags": [ - "Dispute" - ], + "tags": ["Dispute"], "description": "Raise dispute response API", "parameters": [ { @@ -2585,9 +2309,7 @@ "content": { "application/json": { "schema": { - "required": [ - "refId" - ], + "required": ["refId"], "type": "object", "properties": { "refId": { @@ -2652,10 +2374,7 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "data": { @@ -2723,18 +2442,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2765,18 +2477,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -2805,19 +2510,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ], "x-codegen-request-body-name": "CouAgentAsyncRequest" @@ -2825,9 +2524,7 @@ }, "/api/v1/bbps/transactions": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of transactions.", "operationId": "getTxns", "parameters": [ @@ -2912,11 +2609,7 @@ "description": "Biller Fetch Api Type", "schema": { "type": "string", - "enum": [ - "BILL_FETCH", - "BILL_VALIDATE", - "BILL_DIRECT" - ] + "enum": ["BILL_FETCH", "BILL_VALIDATE", "BILL_DIRECT"] } }, { @@ -2945,11 +2638,7 @@ "items": { "type": "string", "example": "Success", - "enum": [ - "Processing", - "Success", - "Error" - ] + "enum": ["Processing", "Success", "Error"] } } }, @@ -2975,9 +2664,7 @@ "items": { "type": "string", "example": "BILLER", - "enum": [ - "BILLER" - ] + "enum": ["BILLER"] } } }, @@ -2986,11 +2673,7 @@ "in": "query", "schema": { "type": "string", - "enum": [ - "Required", - "Requested", - "Processed" - ] + "enum": ["Required", "Requested", "Processed"] } } ], @@ -3000,18 +2683,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -3042,18 +2718,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -3130,10 +2799,7 @@ "schema": { "allOf": [ { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -3169,10 +2835,7 @@ "bills": { "type": "array", "items": { - "required": [ - "amount", - "billNumber" - ], + "required": ["amount", "billNumber"], "type": "object", "properties": { "amount": { @@ -3651,10 +3314,7 @@ "type": "array", "description": "The bill params for fetching the bill", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -3724,28 +3384,20 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } }, "/api/v1/bbps/billers": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of billers.", "operationId": "getBillers", "parameters": [ @@ -3960,16 +3612,11 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "data": { - "required": [ - "billers" - ], + "required": ["billers"], "type": "object", "properties": { "total": { @@ -4046,11 +3693,7 @@ "type": "string", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], + "enum": ["SINGLE", "LIST", "SELECTIVE"], "x-nullable": true, "x-omitempty": false }, @@ -4059,11 +3702,7 @@ "description": "Defined only for billers with response type as LIST. SINGLE: User can pay only one of the bills in bill fetch response. MULTIPLE: User can pay any combination of bills in bill fetch response. ALL: User has to pay all the bills in bill fetch response.", "nullable": true, "example": "SINGLE", - "enum": [ - "SINGLE", - "MULTIPLE", - "ALL" - ], + "enum": ["SINGLE", "MULTIPLE", "ALL"], "x-nullable": true, "x-omitempty": false }, @@ -4080,10 +3719,7 @@ "dataType": { "type": "string", "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] + "enum": ["ALPHANUMERIC", "NUMERIC"] }, "optional": { "type": "boolean", @@ -4109,10 +3745,7 @@ "dataType": { "type": "string", "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] + "enum": ["ALPHANUMERIC", "NUMERIC"] }, "optional": { "type": "boolean", @@ -4328,10 +3961,7 @@ } }, "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -4362,18 +3992,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -4404,18 +4027,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -4444,28 +4060,20 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } }, "/api/v1/bbps/disputes": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of disputes.", "operationId": "getDisputes", "parameters": [ @@ -4611,10 +4219,7 @@ "items": { "type": "string", "example": "BILLER", - "enum": [ - "BILLER", - "TRANSACTION" - ] + "enum": ["BILLER", "TRANSACTION"] } } } @@ -4671,10 +4276,7 @@ "schema": { "allOf": [ { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -5524,10 +5126,7 @@ "type": "array", "description": "The bill params for fetching the bill", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -5603,18 +5202,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5645,18 +5237,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5685,28 +5270,20 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } }, "/api/v1/bbps/categories": { "get": { - "tags": [ - "List" - ], + "tags": ["List"], "description": "Returns the list of categories.", "parameters": [ { @@ -5725,18 +5302,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5767,18 +5337,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5853,17 +5416,11 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -5885,9 +5442,7 @@ "example": "C3SFG0O6N88R6UI7EQ" }, "data": { - "required": [ - "categories" - ], + "required": ["categories"], "type": "object", "properties": { "categories": { @@ -5915,19 +5470,13 @@ }, "security": [ { - "Production": [ - "bbps:partner" - ] + "Production": ["bbps:partner"] }, { - "Sandbox": [ - "bbps:partner" - ] + "Sandbox": ["bbps:partner"] }, { - "QA": [ - "bbps:partner" - ] + "QA": ["bbps:partner"] } ] } diff --git a/api-references/payments/billpay_v1/pre-built-screens.json b/api-references/payments/billpay_v1/pre-built-screens.json index 610b6f9..3ceabe8 100644 --- a/api-references/payments/billpay_v1/pre-built-screens.json +++ b/api-references/payments/billpay_v1/pre-built-screens.json @@ -22,9 +22,7 @@ "paths": { "/api/v1/webhooks/payment-event": { "post": { - "tags": [ - "Custom Payment Webhook" - ], + "tags": ["Custom Payment Webhook"], "description": "Custom payment webhook API", "operationId": "CouCustomPaymentWebhook", "parameters": [ @@ -134,9 +132,7 @@ "content": { "application/json": { "schema": { - "required": [ - "status" - ], + "required": ["status"], "type": "object", "properties": { "status": { @@ -155,18 +151,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -197,18 +186,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -240,9 +222,7 @@ }, "/api/v1/ethereal/link": { "post": { - "tags": [ - "Link Generation" - ], + "tags": ["Link Generation"], "description": "Ethereal link create request API", "operationId": "EtherealLinkRequest", "parameters": [ @@ -260,9 +240,7 @@ "content": { "application/json": { "schema": { - "required": [ - "orgId" - ], + "required": ["orgId"], "type": "object", "properties": { "categoryName": { @@ -288,10 +266,7 @@ "redirectTo": { "type": "string", "example": "transactions", - "enum": [ - "transactions", - "disputes" - ] + "enum": ["transactions", "disputes"] }, "additionalInfo": { "type": "object", @@ -301,10 +276,7 @@ "billParams": { "type": "array", "items": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", "properties": { "name": { @@ -382,10 +354,7 @@ "content": { "application/json": { "schema": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "link": { @@ -416,18 +385,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -458,18 +420,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -502,9 +457,7 @@ }, "/api/v1/auth/token": { "post": { - "tags": [ - "Token API" - ], + "tags": ["Token API"], "description": "Fetch token to be used to authorize all Setu APIs", "operationId": "fetchToken", "requestBody": { @@ -581,10 +534,7 @@ "schema": { "allOf": [ { - "required": [ - "expiresIn", - "token" - ], + "required": ["expiresIn", "token"], "type": "object", "properties": { "expiresIn": { @@ -598,10 +548,7 @@ } }, { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -624,18 +571,11 @@ "content": { "application/json": { "schema": { - "required": [ - "error", - "success", - "traceId" - ], + "required": ["error", "success", "traceId"], "type": "object", "properties": { "error": { - "required": [ - "code", - "message" - ], + "required": ["code", "message"], "type": "object", "properties": { "code": { @@ -685,10 +625,7 @@ "fetchTokenResponse": { "allOf": [ { - "required": [ - "expiresIn", - "token" - ], + "required": ["expiresIn", "token"], "type": "object", "properties": { "expiresIn": { @@ -702,10 +639,7 @@ } }, { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": { @@ -721,10 +655,7 @@ ] }, "successAndTracerDetails": { - "required": [ - "success", - "traceId" - ], + "required": ["success", "traceId"], "type": "object", "properties": { "success": {