From 4084a5bc46a1e7f5611e6bdfd6a727a3ac04070a Mon Sep 17 00:00:00 2001 From: Sreejit7 Date: Tue, 16 Sep 2025 08:15:47 +0530 Subject: [PATCH] API reference update for staging --- .../payments/billpay/api-integration.json | 3228 +---------------- 1 file changed, 2 insertions(+), 3226 deletions(-) diff --git a/api-references/payments/billpay/api-integration.json b/api-references/payments/billpay/api-integration.json index c730f836..f23e2b70 100644 --- a/api-references/payments/billpay/api-integration.json +++ b/api-references/payments/billpay/api-integration.json @@ -5175,8 +5175,8 @@ } } }, - "x-go-name": "CouAgentBillPaymentResponse", - "x-omitempty": true + "x-omitempty": true, + "x-go-name": "CouAgentBillPaymentResponse" } } } @@ -9537,12 +9537,6 @@ } } }, - "planRequirement": { - "type": "string", - "description": "Indicates if plan selection is required for bill payments", - "example": "MANDATORY", - "enum": ["MANDATORY", "OPTIONAL", "CONDITIONAL"] - }, "paymentChannels": { "type": "array", "items": { @@ -9594,20 +9588,7 @@ "OPTIONAL", "CONDITIONAL" ], -<<<<<<< HEAD "x-omitempty": true -======= - "x-nullable": true, - "x-omitempty": false - }, - "state": { - "type": "string", - "example": "TEL" - }, - "subCategoryName": { - "type": "string", - "example": "DAIRY" ->>>>>>> 5f25c1980d76beccd1b61ec7b91d86fb0a04af2f }, "supportsPendingStatus": { "type": "boolean", @@ -9622,7 +9603,6 @@ }, "valAddCustParams": { "type": "array", -<<<<<<< HEAD "description": "Customer parameters for value added services.", "items": { "type": "object", @@ -9686,50 +9666,11 @@ } } } -======= - "description": "The list of parameters that a biller requires to be passed in the `mandate.billerParams` while registering a new customer", - "items": { - "required": [ - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Low Balance Threshold" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true ->>>>>>> 5f25c1980d76beccd1b61ec7b91d86fb0a04af2f } } }, "x-omitempty": true }, -<<<<<<< HEAD "bbpsUpdateTimestamp": { "type": "string", "description": "Last updated date-time of the Biller accurate to the nearest day.", @@ -9827,27 +9768,10 @@ "type": "boolean", "description": "Flag indicating if the Biller accepts adhoc payment", "example": true -======= - "upmsEnabled": { - "type": "boolean", - "description": "This field denotes whether a biller supports registering customers for automated bill presentments via UPMS", - "nullable": true, - "example": true, - "x-omitempty": true ->>>>>>> 5f25c1980d76beccd1b61ec7b91d86fb0a04af2f } }, "x-go-name": "CouBillerDetails" } -<<<<<<< HEAD -======= - }, - "nextPage": { - "type": "string", - "example": "/api/bbps/billers?search=Aditya&CategoryCode=Loan+Repayment&CategoryCode=Insurance&after=ABCC00000PTNNS" - }, - "total": { - "type": "integer" } } }, @@ -9985,3154 +9909,6 @@ ] } }, - "/api/v2/bbps/billers/plans": { - "get": { - "tags": ["List"], - "description": "Returns the list of plans for a given set of billers", - "operationId": "getBillerPlans", - "parameters": [ - { - "name": "X-PARTNER-ID", - "in": "header", - "description": "The Partner ID provided by Setu.", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "billerIds", - "in": "query", - "description": "Biller IDs", - "required": true, - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "limit", - "in": "query", - "description": "Number of plans to return per page", - "schema": { - "maximum": 1000.0, - "minimum": 1.0, - "type": "integer" - } - }, - { - "name": "after", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "updatedSince", - "in": "query", - "description": "Used to fetch plans updated since the given date-time in IST", - "schema": { - "type": "string", - "format": "date-time" - } - } - ], - "responses": { - "200": { - "description": "List of plans for the biller", - "headers": { - "X-Frame-Options": { - "description": "X Frame options", - "schema": { - "type": "string" - } - }, - "Strict-Transport-Security": { - "description": "Strict transport security", - "schema": { - "type": "string" - } - }, - "Cache-Control": { - "description": "Cache control", - "schema": { - "type": "string" - } - }, - "X-Content-Type-Options": { - "description": "X Content type options", - "schema": { - "type": "string" - } - }, - "Content-Security-Policy": { - "description": "Content security policy", - "schema": { - "type": "string" - } - }, - "Pragma": { - "description": "Pragma", - "schema": { - "type": "string" - } - }, - "X-XSS-Protection": { - "description": "X Xss Protection", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "required": ["success", "traceId"], - "type": "object", - "properties": { - "data": { - "required": ["plans"], - "type": "object", - "properties": { - "nextPage": { - "type": "string", - "example": "/api/bbps/billers/plans?biller_ids=BILLER_01&after=ABCC00000PTNNS" - }, - "plans": { - "type": "array", - "items": { - "required": [ - "Id", - "amountInRupees", - "categoryType", - "description", - "status" - ], - "type": "object", - "properties": { - "Id": { - "type": "string", - "description": "Plan ID", - "example": "1.0", - "x-order": 1.0 - }, - "additionalInfo": { - "minItems": 1, - "type": "array", - "description": "Plan Additional information details provided by the Biller.", - "example": [ - { - "paramName": "Mobile Number", - "paramValue": "Text" - } - ], - "items": { - "type": "object", - "properties": { - "paramName": { - "type": "string", - "example": "Plan Additional information parameter name." - }, - "paramValue": { - "type": "string", - "example": "Plan Additional information parameter value." - } - }, - "example": { - "paramName": "Mobile Number", - "paramValue": "Text" - }, - "x-go-name": "PlanAdditionalInfoItem" - }, - "x-omitempty": true - }, - "amountInRupees": { - "type": "string", - "example": "22.0", - "x-order": 2.0 - }, - "billerId": { - "type": "string", - "description": "Biller ID to which the plan belongs to", - "example": "1.0", - "x-order": 0.0 - }, - "categorySubType": { - "type": "object", - "properties": {}, - "description": "Plan sub category as defined by the Biller.", - "example": { - "subType": "1 Month" - }, - "x-omitempty": true, - "x-order": 4.0 - }, - "categoryType": { - "type": "string", - "description": "Plan category as defined by the Biller.", - "example": "VIP", - "x-order": 3.0 - }, - "description": { - "type": "string", - "description": "Plan description as defined by the Biller.", - "example": "Unlimited Live Sports" - }, - "effectiveFrom": { - "type": "string", - "description": "Effective from date of corresponding Plan.", - "format": "date", - "nullable": true, - "example": "2017-07-21", - "x-omitempty": false - }, - "effectiveTo": { - "type": "string", - "description": "Effective to date of corresponding Plan.", - "format": "date", - "nullable": true, - "example": "2020-08-21", - "x-omitempty": false - }, - "status": { - "type": "string", - "description": "Effective to date of corresponding Plan.", - "example": "ACTIVE", - "enum": ["ACTIVE", "DEACTIVATED"] - } - } - } - }, - "total": { - "type": "integer" - } - } - }, - "error": { - "required": ["code", "message"], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": true - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": ["error", "success", "traceId"], - "type": "object", - "properties": { - "error": { - "required": ["code", "message"], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - }, - "500": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": ["error", "success", "traceId"], - "type": "object", - "properties": { - "error": { - "required": ["code", "message"], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - } - }, - "security": [ - { - "Production": ["bbps:partner"] - }, - { - "Sandbox": ["bbps:partner"] - }, - { - "QA": ["bbps:partner"] - } - ] - } - }, - "/api/v2/bbps/categories": { - "get": { - "tags": [ - "List" - ], - "description": "Returns the list of categories.", - "parameters": [ - { - "name": "X-PARTNER-ID", - "in": "header", - "description": "The Partner ID provided by Setu.", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "List of categories", - "headers": { - "X-Frame-Options": { - "description": "X Frame options", - "schema": { - "type": "string" - } - }, - "Strict-Transport-Security": { - "description": "Strict transport security", - "schema": { - "type": "string" - } - }, - "Cache-Control": { - "description": "Cache control", - "schema": { - "type": "string" - } - }, - "X-Content-Type-Options": { - "description": "X Content type options", - "schema": { - "type": "string" - } - }, - "Content-Security-Policy": { - "description": "Content security policy", - "schema": { - "type": "string" - } - }, - "Pragma": { - "description": "Pragma", - "schema": { - "type": "string" - } - }, - "X-XSS-Protection": { - "description": "X Xss Protection", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "required": [ - "success", - "traceId" - ], - "type": "object", - "properties": { - "data": { - "required": [ - "categories" - ], - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "type": "object", - "properties": { - "billerCount": { - "type": "integer" - }, - "name": { - "type": "string", - "example": "Loan Repayment" - } - } - } ->>>>>>> 5f25c1980d76beccd1b61ec7b91d86fb0a04af2f - } - } - }, - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": true - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": [ - "error", - "success", - "traceId" - ], - "type": "object", - "properties": { - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - }, - "500": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": [ - "error", - "success", - "traceId" - ], - "type": "object", - "properties": { - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - } - }, - "security": [ - { - "Production": [ - "bbps:partner" - ] - }, - { - "Sandbox": [ - "bbps:partner" - ] - }, - { - "QA": [ - "bbps:partner" - ] - } - ] - } - }, -<<<<<<< HEAD -======= - "/api/v2/bbps/disputes": { - "get": { - "tags": [ - "List" - ], - "description": "Returns the list of disputes.", - "parameters": [ - { - "name": "X-PARTNER-ID", - "in": "header", - "description": "The Partner ID provided by Setu.", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "status", - "in": "query", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "ASSIGNED", - "REJECTED", - "RESOLVED", - "DEFAULT_RESOLVED", - "REFUNDED", - "PENDING_REFUND" - ] - } - } - }, - { - "name": "limit", - "in": "query", - "description": "Limit", - "schema": { - "maximum": 1000.0, - "minimum": 1.0, - "type": "integer" - } - }, - { - "name": "categories", - "in": "query", - "description": "Biller Category", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "months", - "in": "query", - "description": "Month ranges. A full-date notation as defined by 'RFC 3339, section 5.6' has to be provided but only month and year will be considered.", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - } - }, - { - "name": "after", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "mobile", - "in": "query", - "description": "Mobile number with 6 to 22 digits are valid.", - "schema": { - "maxLength": 22, - "minLength": 6, - "pattern": "^\\d{6,22}$", - "type": "string" - } - }, - { - "name": "customerId", - "in": "query", - "description": "Customer Identifier", - "schema": { - "type": "string" - } - }, - { - "name": "transactionIds", - "in": "query", - "description": "Transaction IDs", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "paymentRefIds", - "in": "query", - "description": "Partner provided transaction Ids", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "maxLength": 35, - "minLength": 6, - "type": "string" - } - } - }, - { - "name": "billerIds", - "in": "query", - "description": "The biller ID on BBPS", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "expand", - "in": "query", - "style": "form", - "explode": false, - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "BILLER", - "TRANSACTION" - ] - } - } - } - ], - "responses": { - "200": { - "description": "List of disputes", - "headers": { - "X-Frame-Options": { - "description": "X Frame options", - "schema": { - "type": "string" - } - }, - "Strict-Transport-Security": { - "description": "Strict transport security", - "schema": { - "type": "string" - } - }, - "Cache-Control": { - "description": "Cache control", - "schema": { - "type": "string" - } - }, - "X-Content-Type-Options": { - "description": "X Content type options", - "schema": { - "type": "string" - } - }, - "Content-Security-Policy": { - "description": "Content security policy", - "schema": { - "type": "string" - } - }, - "Pragma": { - "description": "Pragma", - "schema": { - "type": "string" - } - }, - "X-XSS-Protection": { - "description": "X Xss Protection", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "required": [ - "success", - "traceId" - ], - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - }, - { - "type": "object", - "properties": { - "data": { - "required": [ - "disputes" - ], - "type": "object", - "properties": { - "disputes": { - "type": "array", - "items": { - "allOf": [ - { - "type": "object", - "properties": { - "assigned": { - "type": "string", - "example": "ADIT00000NATRA" - }, - "biller": { - "required": [ - "categoryName", - "customerParams", - "exactness", - "fetchApiType", - "id", - "name", - "payWithoutFetchAllowed", - "paymentChannels", - "paymentModes", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "bbpsUpdateTimestamp": { - "type": "string", - "description": "Last updated date-time of the Biller accurate to the nearest day.", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": true - }, - "billerAdditionalInfo": { - "type": "array", - "items": { - "required": [ - "dataType", - "optional", - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Package Duration" - } - } - } - }, - "billerAdditionalInfoPayment": { - "type": "array", - "items": { - "required": [ - "dataType", - "optional", - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Package Duration" - } - } - } - }, - "categoryName": { - "type": "string", - "description": "Biller Category", - "example": "loan-repayment" - }, - "city": { - "type": "string", - "example": "Hyderabad" - }, - "country": { - "type": "string", - "example": "IND" - }, - "coverage": { - "type": "string", - "example": "IND-TEL-Hyderabad" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": false - }, - "customerParams": { - "type": "array", - "items": { - "required": [ - "dataType", - "maxLength", - "minLength", - "optional", - "paramName", - "regex", - "values", - "visibility" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Loan Account Number" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true - } - } - } - }, - "customerParamsGroups": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string", - "example": "Param 1" - } - } - }, - "enforcesSameDayFetchPay": { - "type": "boolean", - "example": true, - "x-omitempty": false - }, - "exactness": { - "type": "string", - "example": "Exact", - "enum": [ - "Exact", - "Exact and above", - "Exact and below", - "Any", - "RANGE" - ] - }, - "fetchApiType": { - "type": "string", - "enum": [ - "BILL_FETCH", - "BILL_VALIDATE", - "BILL_DIRECT" - ] - }, - "id": { - "type": "string", - "description": "Identifier of the biller in BBPS.", - "example": "ADIT00000NAT0T" - }, - "interchangeFee": { - "type": "array", - "items": { - "type": "object", - "properties": { - "feeCode": { - "type": "string", - "example": "CCF1" - }, - "feeDesc": { - "type": "string", - "example": "Customer Convenience Fee" - }, - "feeDirection": { - "type": "string", - "example": "C2B" - }, - "interchangeFeeDetails": { - "required": [ - "effctvFrom", - "effctvTo", - "flatFee", - "percentFee", - "tranAmtRangeMax", - "tranAmtRangeMin" - ], - "type": "object", - "properties": { - "effctvFrom": { - "type": "string", - "example": "2024-01-01" - }, - "effctvTo": { - "type": "string", - "example": "2024-12-31" - }, - "flatFee": { - "type": "number", - "format": "decimal", - "example": 0.0 - }, - "percentFee": { - "type": "number", - "format": "decimal", - "example": 1.0 - }, - "tranAmtRangeMax": { - "type": "integer", - "format": "int64" - }, - "tranAmtRangeMin": { - "type": "integer", - "format": "int64" - } - } - } - } - } - }, - "logo": { - "type": "string", - "example": "logo" - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": false - }, - "name": { - "type": "string", - "description": "Name of the biller.", - "example": "Umbrella Corporation" - }, - "payWithoutFetchAllowed": { - "type": "boolean", - "description": "Flag indicating if the Biller accepts adhoc payment", - "example": true - }, - "paymentChannels": { - "type": "array", - "items": { - "required": [ - "maxLimit", - "minLimit", - "paymentChannel", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "maxLimit": { - "type": "integer" - }, - "minLimit": { - "type": "integer" - }, - "paymentChannel": { - "type": "string", - "description": "This is the initiating channel.\n1. `AGT`: Offline agent.\n2. `BNKBRNCH`: Bank branch.\n3. `BSC`: Business correspondent\n4. `MOB`: Mobile application\n5. `INT`: Internet portal\n6. `INTB`: Internet banking\n7. `MOBB`: Mobile banking\n8. `ATM`: ATM\n9. `KIOSK`: KIOSK\n", - "example": "INT", - "enum": [ - "INT", - "INTB", - "MOB", - "BNKBRNCH", - "BSC", - "AGT", - "KIOSK", - "ATM", - "MOBB", - "POS", - "MPOS" - ] - }, - "supportsPendingStatus": { - "type": "boolean", - "example": false - } - } - } - }, - "paymentModes": { - "type": "array", - "items": { - "required": [ - "maxLimit", - "minLimit", - "paymentMode", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "maxLimit": { - "type": "integer" - }, - "minLimit": { - "type": "integer" - }, - "paymentMode": { - "type": "string", - "example": "Internet Banking", - "enum": [ - "Internet Banking", - "Debit Card", - "Credit Card", - "Prepaid Card", - "IMPS", - "Cash", - "UPI", - "Wallet", - "NEFT", - "AEPS", - "Account Transfer", - "Bharat QR", - "USSD" - ] - }, - "supportsPendingStatus": { - "type": "boolean", - "example": false - } - } - } - }, - "pincode": { - "type": "string", - "example": "pincode" - }, - "planRequirement": { - "type": "string", - "description": "Indicates if plan selection is required for bill payments", - "example": "MANDATORY", - "enum": [ - "MANDATORY", - "OPTIONAL", - "CONDITIONAL" - ], - "x-omitempty": true - }, - "responseType": { - "type": "string", - "nullable": true, - "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], - "x-nullable": true, - "x-omitempty": false - }, - "selectionType": { - "type": "string", - "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" - ], - "x-nullable": true, - "x-omitempty": false - }, - "state": { - "type": "string", - "example": "TEL" - }, - "subCategoryName": { - "type": "string", - "example": "DAIRY" - }, - "supportsPendingStatus": { - "type": "boolean", - "description": "Flag indicating whether pending status is applicable for the biller or not", - "example": false - }, - "tags": { - "type": "string", - "example": "tags" - }, - "upmsBillerParams": { - "type": "array", - "description": "The list of parameters that a biller requires to be passed in the `mandate.billerParams` while registering a new customer", - "items": { - "required": [ - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Low Balance Threshold" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true - } - } - }, - "x-omitempty": true - }, - "upmsEnabled": { - "type": "boolean", - "description": "This field denotes whether a biller supports registering customers for automated bill presentments via UPMS", - "nullable": true, - "example": true, - "x-omitempty": true - } - }, - "x-go-name": "CouBillerDetails" - }, - "billerId": { - "type": "string", - "description": "The biller ID on BBPS", - "example": "MAHI00000NATIC" - }, - "complaintId": { - "type": "string", - "example": "Loan Repayment" - }, - "complaintStatus": { - "type": "string", - "description": "BBPS Complaint status", - "example": "ASSIGNED", - "enum": [ - "ASSIGNED", - "REJECTED", - "RESOLVED", - "DEFAULT_RESOLVED", - "REFUNDED", - "PENDING_REFUND" - ] - }, - "createdAt": { - "type": "string", - "description": "Dispute's creation timestamp", - "format": "date-time", - "example": "2020-12-12T13:12:00+05:30" - }, - "customerId": { - "type": "string", - "description": "Customer Identifier" - }, - "disposition": { - "type": "string", - "enum": [ - "D11", - "D12", - "D13", - "D21", - "D22", - "D23", - "D31", - "D32" - ] - }, - "lastModifiedAt": { - "type": "string", - "description": "Dispute's last modified timestamp", - "format": "date-time", - "example": "2020-12-12T13:12:00+05:30" - }, - "refId": { - "type": "string", - "description": "The generated Reference ID for the request." - }, - "remarks": { - "type": "string", - "example": "ADIT00000NATRA" - }, - "responseCode": { - "type": "string", - "example": "ADIT00000NATRA" - }, - "responseReason": { - "type": "string", - "example": "ADIT00000NATRA" - }, - "ticketTAT": { - "type": "string", - "format": "date", - "nullable": true - }, - "ticketType": { - "type": "string", - "enum": [ - "DISPUTE", - "COMPLAINT" - ] - }, - "transactionId": { - "type": "string", - "description": "Setu BillPay Transaction ID.", - "example": "AS01910192192192192" - } - } - }, - { - "type": "object", - "properties": { - "mobile": { - "maxLength": 22, - "minLength": 6, - "pattern": "^\\d{6,22}$", - "type": "string", - "description": "Mobile number with 6 to 22 digits are valid." - }, - "paymentRefID": { - "maxLength": 35, - "minLength": 6, - "type": "string", - "description": "Unique identifier provided by Partner for the payment request.", - "example": "BD019181220291" - }, - "transaction": { - "allOf": [ - { - "type": "object", - "properties": { - "amount": { - "type": "integer" - }, - "biller": { - "required": [ - "categoryName", - "customerParams", - "exactness", - "fetchApiType", - "id", - "name", - "payWithoutFetchAllowed", - "paymentChannels", - "paymentModes", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "bbpsUpdateTimestamp": { - "type": "string", - "description": "Last updated date-time of the Biller accurate to the nearest day.", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": true - }, - "billerAdditionalInfo": { - "type": "array", - "items": { - "required": [ - "dataType", - "optional", - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Package Duration" - } - } - } - }, - "billerAdditionalInfoPayment": { - "type": "array", - "items": { - "required": [ - "dataType", - "optional", - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Package Duration" - } - } - } - }, - "categoryName": { - "type": "string", - "description": "Biller Category", - "example": "loan-repayment" - }, - "city": { - "type": "string", - "example": "Hyderabad" - }, - "country": { - "type": "string", - "example": "IND" - }, - "coverage": { - "type": "string", - "example": "IND-TEL-Hyderabad" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": false - }, - "customerParams": { - "type": "array", - "items": { - "required": [ - "dataType", - "maxLength", - "minLength", - "optional", - "paramName", - "regex", - "values", - "visibility" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Loan Account Number" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true - } - } - } - }, - "customerParamsGroups": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string", - "example": "Param 1" - } - } - }, - "enforcesSameDayFetchPay": { - "type": "boolean", - "example": true, - "x-omitempty": false - }, - "exactness": { - "type": "string", - "example": "Exact", - "enum": [ - "Exact", - "Exact and above", - "Exact and below", - "Any", - "RANGE" - ] - }, - "fetchApiType": { - "type": "string", - "enum": [ - "BILL_FETCH", - "BILL_VALIDATE", - "BILL_DIRECT" - ] - }, - "id": { - "type": "string", - "description": "Identifier of the biller in BBPS.", - "example": "ADIT00000NAT0T" - }, - "interchangeFee": { - "type": "array", - "items": { - "type": "object", - "properties": { - "feeCode": { - "type": "string", - "example": "CCF1" - }, - "feeDesc": { - "type": "string", - "example": "Customer Convenience Fee" - }, - "feeDirection": { - "type": "string", - "example": "C2B" - }, - "interchangeFeeDetails": { - "required": [ - "effctvFrom", - "effctvTo", - "flatFee", - "percentFee", - "tranAmtRangeMax", - "tranAmtRangeMin" - ], - "type": "object", - "properties": { - "effctvFrom": { - "type": "string", - "example": "2024-01-01" - }, - "effctvTo": { - "type": "string", - "example": "2024-12-31" - }, - "flatFee": { - "type": "number", - "format": "decimal", - "example": 0.0 - }, - "percentFee": { - "type": "number", - "format": "decimal", - "example": 1.0 - }, - "tranAmtRangeMax": { - "type": "integer", - "format": "int64" - }, - "tranAmtRangeMin": { - "type": "integer", - "format": "int64" - } - } - } - } - } - }, - "logo": { - "type": "string", - "example": "logo" - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": false - }, - "name": { - "type": "string", - "description": "Name of the biller.", - "example": "Umbrella Corporation" - }, - "payWithoutFetchAllowed": { - "type": "boolean", - "description": "Flag indicating if the Biller accepts adhoc payment", - "example": true - }, - "paymentChannels": { - "type": "array", - "items": { - "required": [ - "maxLimit", - "minLimit", - "paymentChannel", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "maxLimit": { - "type": "integer" - }, - "minLimit": { - "type": "integer" - }, - "paymentChannel": { - "type": "string", - "description": "This is the initiating channel.\n1. `AGT`: Offline agent.\n2. `BNKBRNCH`: Bank branch.\n3. `BSC`: Business correspondent\n4. `MOB`: Mobile application\n5. `INT`: Internet portal\n6. `INTB`: Internet banking\n7. `MOBB`: Mobile banking\n8. `ATM`: ATM\n9. `KIOSK`: KIOSK\n", - "example": "INT", - "enum": [ - "INT", - "INTB", - "MOB", - "BNKBRNCH", - "BSC", - "AGT", - "KIOSK", - "ATM", - "MOBB", - "POS", - "MPOS" - ] - }, - "supportsPendingStatus": { - "type": "boolean", - "example": false - } - } - } - }, - "paymentModes": { - "type": "array", - "items": { - "required": [ - "maxLimit", - "minLimit", - "paymentMode", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "maxLimit": { - "type": "integer" - }, - "minLimit": { - "type": "integer" - }, - "paymentMode": { - "type": "string", - "example": "Internet Banking", - "enum": [ - "Internet Banking", - "Debit Card", - "Credit Card", - "Prepaid Card", - "IMPS", - "Cash", - "UPI", - "Wallet", - "NEFT", - "AEPS", - "Account Transfer", - "Bharat QR", - "USSD" - ] - }, - "supportsPendingStatus": { - "type": "boolean", - "example": false - } - } - } - }, - "pincode": { - "type": "string", - "example": "pincode" - }, - "planRequirement": { - "type": "string", - "description": "Indicates if plan selection is required for bill payments", - "example": "MANDATORY", - "enum": [ - "MANDATORY", - "OPTIONAL", - "CONDITIONAL" - ], - "x-omitempty": true - }, - "responseType": { - "type": "string", - "nullable": true, - "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], - "x-nullable": true, - "x-omitempty": false - }, - "selectionType": { - "type": "string", - "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" - ], - "x-nullable": true, - "x-omitempty": false - }, - "state": { - "type": "string", - "example": "TEL" - }, - "subCategoryName": { - "type": "string", - "example": "DAIRY" - }, - "supportsPendingStatus": { - "type": "boolean", - "description": "Flag indicating whether pending status is applicable for the biller or not", - "example": false - }, - "tags": { - "type": "string", - "example": "tags" - }, - "upmsBillerParams": { - "type": "array", - "description": "The list of parameters that a biller requires to be passed in the `mandate.billerParams` while registering a new customer", - "items": { - "required": [ - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Low Balance Threshold" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true - } - } - }, - "x-omitempty": true - }, - "upmsEnabled": { - "type": "boolean", - "description": "This field denotes whether a biller supports registering customers for automated bill presentments via UPMS", - "nullable": true, - "example": true, - "x-omitempty": true - } - }, - "x-go-name": "CouBillerDetails" - }, - "billerId": { - "type": "string", - "description": "The biller ID on BBPS", - "example": "MAHI00000NATIC" - }, - "custConvFee": { - "type": "integer", - "description": "Customer convenience fee in paise" - }, - "customerId": { - "type": "string", - "description": "Customer Identifier" - }, - "customerParams": { - "type": "array", - "description": "The bill params for fetching the bill", - "items": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The display name of the parameter. This has to match what is sent in fields.", - "example": "Loan Number" - }, - "value": { - "type": "string", - "description": "The value of the customer parameter", - "example": "1895159" - } - } - } - }, - "etherealTransaction": { - "required": [ - "amount", - "billRefId", - "refId", - "status", - "transactionId" - ], - "type": "object", - "properties": { - "amount": { - "type": "string", - "example": "100.00" - }, - "billRefId": { - "type": "string", - "description": "The BBPS Ref ID", - "example": "C3SFG0O6N88R6UI7EQ" - }, - "refId": { - "type": "string", - "example": "COUWL910192192192192" - }, - "status": { - "type": "string", - "enum": [ - "INIT", - "SUCCESS", - "FAILURE", - "PENDING", - "UNKNOWN" - ] - }, - "transactionId": { - "type": "string", - "example": "Q910192192192192" - } - } - }, - "refId": { - "type": "string", - "description": "The generated Reference ID for the request." - }, - "refundStatus": { - "type": "string", - "enum": [ - "Required", - "Requested", - "Processed" - ] - }, - "status": { - "type": "string", - "example": "Success", - "enum": [ - "Processing", - "Success", - "Error", - "Credit_Adjustment" - ] - }, - "timestamp": { - "type": "string", - "description": "Timestamp provided by partner while making payment request.", - "format": "date-time", - "example": "2020-12-12T13:12:00+05:30" - }, - "transactionId": { - "type": "string", - "description": "Setu BillPay Transaction ID.", - "example": "AS01910192192192192" - } - } - }, - { - "type": "object", - "properties": { - "mobile": { - "maxLength": 22, - "minLength": 6, - "pattern": "^\\d{6,22}$", - "type": "string", - "description": "Mobile number with 6 to 22 digits are valid." - }, - "paymentRefId": { - "maxLength": 35, - "minLength": 6, - "type": "string", - "description": "Unique identifier provided by Partner for the payment request.", - "example": "BD019181220291" - } - } - } - ] - } - } - } - ] - } - }, - "nextPage": { - "type": "string", - "example": "/api/bbps/disputes?search=Aditya&CategoryCode=Loan+Repayment&CategoryCode=Insurance&after=ABCC00000PTNNS" - } - } - } - } - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": [ - "error", - "success", - "traceId" - ], - "type": "object", - "properties": { - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - }, - "500": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": [ - "error", - "success", - "traceId" - ], - "type": "object", - "properties": { - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - } - }, - "security": [ - { - "Production": [ - "bbps:partner" - ] - }, - { - "Sandbox": [ - "bbps:partner" - ] - }, - { - "QA": [ - "bbps:partner" - ] - } - ] - } - }, - "/api/v2/bbps/transactions": { - "get": { - "tags": [ - "List" - ], - "description": "Returns the list of transactions.", - "parameters": [ - { - "name": "X-PARTNER-ID", - "in": "header", - "description": "The Partner ID provided by Setu.", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "after", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "startDate", - "in": "query", - "description": "start date of the timestamp provided by the partner while making the request.", - "required": true, - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "endDate", - "in": "query", - "description": "end date of the timestamp provided by the partner while making the request.", - "required": true, - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "billerId", - "in": "query", - "description": "Transaction BillerId", - "schema": { - "type": "string" - } - }, - { - "name": "ids", - "in": "query", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "categories", - "in": "query", - "description": "Biller Category", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "billerFetchApiType", - "in": "query", - "description": "Biller Fetch Api Type", - "schema": { - "type": "string", - "enum": [ - "BILL_FETCH", - "BILL_VALIDATE", - "BILL_DIRECT" - ] - } - }, - { - "name": "months", - "in": "query", - "description": "Month ranges. A full-date notation as defined by 'RFC 3339, section 5.6' has to be provided but only month and year will be considered.", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "date" - } - } - }, - { - "name": "status", - "in": "query", - "description": "Transaction Status", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Processing", - "Success", - "Error" - ] - } - } - }, - { - "name": "mobile", - "in": "query", - "description": "Mobile number with 6 to 22 digits are valid.", - "schema": { - "maxLength": 22, - "minLength": 6, - "pattern": "^\\d{6,22}$", - "type": "string" - } - }, - { - "name": "customerId", - "in": "query", - "description": "Customer Identifier", - "schema": { - "type": "string" - } - }, - { - "name": "expand", - "in": "query", - "style": "form", - "explode": false, - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "BILLER", - "ETHEREAL_TRANSACTION" - ] - } - } - }, - { - "name": "refundStatus", - "in": "query", - "schema": { - "type": "string", - "enum": [ - "Required", - "Requested", - "Processed" - ] - } - } - ], - "responses": { - "200": { - "description": "List of Txns", - "headers": { - "X-Frame-Options": { - "description": "X Frame options", - "schema": { - "type": "string" - } - }, - "Strict-Transport-Security": { - "description": "Strict transport security", - "schema": { - "type": "string" - } - }, - "Cache-Control": { - "description": "Cache control", - "schema": { - "type": "string" - } - }, - "X-Content-Type-Options": { - "description": "X Content type options", - "schema": { - "type": "string" - } - }, - "Content-Security-Policy": { - "description": "Content security policy", - "schema": { - "type": "string" - } - }, - "Pragma": { - "description": "Pragma", - "schema": { - "type": "string" - } - }, - "X-XSS-Protection": { - "description": "X Xss Protection", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "required": [ - "success", - "traceId" - ], - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - }, - { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "type": "object", - "properties": { - "nextPage": { - "type": "string", - "example": "/api/bbps/transactions?search=Aditya&CategoryCode=Loan+Repayment&CategoryCode=Insurance&after=ABCC00000PTNNS" - } - } - }, - { - "type": "object", - "properties": { - "transactions": { - "type": "array", - "items": { - "allOf": [ - { - "type": "object", - "properties": { - "amount": { - "type": "integer" - }, - "biller": { - "required": [ - "categoryName", - "customerParams", - "exactness", - "fetchApiType", - "id", - "name", - "payWithoutFetchAllowed", - "paymentChannels", - "paymentModes", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "bbpsUpdateTimestamp": { - "type": "string", - "description": "Last updated date-time of the Biller accurate to the nearest day.", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": true - }, - "billerAdditionalInfo": { - "type": "array", - "items": { - "required": [ - "dataType", - "optional", - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Package Duration" - } - } - } - }, - "billerAdditionalInfoPayment": { - "type": "array", - "items": { - "required": [ - "dataType", - "optional", - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC", - "enum": [ - "ALPHANUMERIC", - "NUMERIC" - ] - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Package Duration" - } - } - } - }, - "categoryName": { - "type": "string", - "description": "Biller Category", - "example": "loan-repayment" - }, - "city": { - "type": "string", - "example": "Hyderabad" - }, - "country": { - "type": "string", - "example": "IND" - }, - "coverage": { - "type": "string", - "example": "IND-TEL-Hyderabad" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": false - }, - "customerParams": { - "type": "array", - "items": { - "required": [ - "dataType", - "maxLength", - "minLength", - "optional", - "paramName", - "regex", - "values", - "visibility" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Loan Account Number" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true - } - } - } - }, - "customerParamsGroups": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string", - "example": "Param 1" - } - } - }, - "enforcesSameDayFetchPay": { - "type": "boolean", - "example": true, - "x-omitempty": false - }, - "exactness": { - "type": "string", - "example": "Exact", - "enum": [ - "Exact", - "Exact and above", - "Exact and below", - "Any", - "RANGE" - ] - }, - "fetchApiType": { - "type": "string", - "enum": [ - "BILL_FETCH", - "BILL_VALIDATE", - "BILL_DIRECT" - ] - }, - "id": { - "type": "string", - "description": "Identifier of the biller in BBPS.", - "example": "ADIT00000NAT0T" - }, - "interchangeFee": { - "type": "array", - "items": { - "type": "object", - "properties": { - "feeCode": { - "type": "string", - "example": "CCF1" - }, - "feeDesc": { - "type": "string", - "example": "Customer Convenience Fee" - }, - "feeDirection": { - "type": "string", - "example": "C2B" - }, - "interchangeFeeDetails": { - "required": [ - "effctvFrom", - "effctvTo", - "flatFee", - "percentFee", - "tranAmtRangeMax", - "tranAmtRangeMin" - ], - "type": "object", - "properties": { - "effctvFrom": { - "type": "string", - "example": "2024-01-01" - }, - "effctvTo": { - "type": "string", - "example": "2024-12-31" - }, - "flatFee": { - "type": "number", - "format": "decimal", - "example": 0.0 - }, - "percentFee": { - "type": "number", - "format": "decimal", - "example": 1.0 - }, - "tranAmtRangeMax": { - "type": "integer", - "format": "int64" - }, - "tranAmtRangeMin": { - "type": "integer", - "format": "int64" - } - } - } - } - } - }, - "logo": { - "type": "string", - "example": "logo" - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2021-11-12T13:37:04.572+05:30", - "x-omitempty": false - }, - "name": { - "type": "string", - "description": "Name of the biller.", - "example": "Umbrella Corporation" - }, - "payWithoutFetchAllowed": { - "type": "boolean", - "description": "Flag indicating if the Biller accepts adhoc payment", - "example": true - }, - "paymentChannels": { - "type": "array", - "items": { - "required": [ - "maxLimit", - "minLimit", - "paymentChannel", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "maxLimit": { - "type": "integer" - }, - "minLimit": { - "type": "integer" - }, - "paymentChannel": { - "type": "string", - "description": "This is the initiating channel.\n1. `AGT`: Offline agent.\n2. `BNKBRNCH`: Bank branch.\n3. `BSC`: Business correspondent\n4. `MOB`: Mobile application\n5. `INT`: Internet portal\n6. `INTB`: Internet banking\n7. `MOBB`: Mobile banking\n8. `ATM`: ATM\n9. `KIOSK`: KIOSK\n", - "example": "INT", - "enum": [ - "INT", - "INTB", - "MOB", - "BNKBRNCH", - "BSC", - "AGT", - "KIOSK", - "ATM", - "MOBB", - "POS", - "MPOS" - ] - }, - "supportsPendingStatus": { - "type": "boolean", - "example": false - } - } - } - }, - "paymentModes": { - "type": "array", - "items": { - "required": [ - "maxLimit", - "minLimit", - "paymentMode", - "supportsPendingStatus" - ], - "type": "object", - "properties": { - "maxLimit": { - "type": "integer" - }, - "minLimit": { - "type": "integer" - }, - "paymentMode": { - "type": "string", - "example": "Internet Banking", - "enum": [ - "Internet Banking", - "Debit Card", - "Credit Card", - "Prepaid Card", - "IMPS", - "Cash", - "UPI", - "Wallet", - "NEFT", - "AEPS", - "Account Transfer", - "Bharat QR", - "USSD" - ] - }, - "supportsPendingStatus": { - "type": "boolean", - "example": false - } - } - } - }, - "pincode": { - "type": "string", - "example": "pincode" - }, - "planRequirement": { - "type": "string", - "description": "Indicates if plan selection is required for bill payments", - "example": "MANDATORY", - "enum": [ - "MANDATORY", - "OPTIONAL", - "CONDITIONAL" - ], - "x-omitempty": true - }, - "responseType": { - "type": "string", - "nullable": true, - "example": "SINGLE", - "enum": [ - "SINGLE", - "LIST", - "SELECTIVE" - ], - "x-nullable": true, - "x-omitempty": false - }, - "selectionType": { - "type": "string", - "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" - ], - "x-nullable": true, - "x-omitempty": false - }, - "state": { - "type": "string", - "example": "TEL" - }, - "subCategoryName": { - "type": "string", - "example": "DAIRY" - }, - "supportsPendingStatus": { - "type": "boolean", - "description": "Flag indicating whether pending status is applicable for the biller or not", - "example": false - }, - "tags": { - "type": "string", - "example": "tags" - }, - "upmsBillerParams": { - "type": "array", - "description": "The list of parameters that a biller requires to be passed in the `mandate.billerParams` while registering a new customer", - "items": { - "required": [ - "paramName" - ], - "type": "object", - "properties": { - "dataType": { - "type": "string", - "example": "ALPHANUMERIC" - }, - "maxLength": { - "type": "integer" - }, - "minLength": { - "type": "integer" - }, - "optional": { - "type": "boolean", - "example": false - }, - "paramName": { - "type": "string", - "example": "Low Balance Threshold" - }, - "regex": { - "type": "string", - "example": "^[a-zA-Z0-9]{7,15}" - }, - "values": { - "type": "string", - "example": "CHOICE1,CHOICE2,CHOICE3" - }, - "visibility": { - "type": "boolean", - "example": true - } - } - }, - "x-omitempty": true - }, - "upmsEnabled": { - "type": "boolean", - "description": "This field denotes whether a biller supports registering customers for automated bill presentments via UPMS", - "nullable": true, - "example": true, - "x-omitempty": true - } - }, - "x-go-name": "CouBillerDetails" - }, - "billerId": { - "type": "string", - "description": "The biller ID on BBPS", - "example": "MAHI00000NATIC" - }, - "custConvFee": { - "type": "integer", - "description": "Customer convenience fee in paise" - }, - "customerId": { - "type": "string", - "description": "Customer Identifier" - }, - "customerParams": { - "type": "array", - "description": "The bill params for fetching the bill", - "items": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The display name of the parameter. This has to match what is sent in fields.", - "example": "Loan Number" - }, - "value": { - "type": "string", - "description": "The value of the customer parameter", - "example": "1895159" - } - } - } - }, - "etherealTransaction": { - "required": [ - "amount", - "billRefId", - "refId", - "status", - "transactionId" - ], - "type": "object", - "properties": { - "amount": { - "type": "string", - "example": "100.00" - }, - "billRefId": { - "type": "string", - "description": "The BBPS Ref ID", - "example": "C3SFG0O6N88R6UI7EQ" - }, - "refId": { - "type": "string", - "example": "COUWL910192192192192" - }, - "status": { - "type": "string", - "enum": [ - "INIT", - "SUCCESS", - "FAILURE", - "PENDING", - "UNKNOWN" - ] - }, - "transactionId": { - "type": "string", - "example": "Q910192192192192" - } - } - }, - "refId": { - "type": "string", - "description": "The generated Reference ID for the request." - }, - "refundStatus": { - "type": "string", - "enum": [ - "Required", - "Requested", - "Processed" - ] - }, - "status": { - "type": "string", - "example": "Success", - "enum": [ - "Processing", - "Success", - "Error", - "Credit_Adjustment" - ] - }, - "timestamp": { - "type": "string", - "description": "Timestamp provided by partner while making payment request.", - "format": "date-time", - "example": "2020-12-12T13:12:00+05:30" - }, - "transactionId": { - "type": "string", - "description": "Setu BillPay Transaction ID.", - "example": "AS01910192192192192" - } - } - }, - { - "type": "object", - "properties": { - "mobile": { - "maxLength": 22, - "minLength": 6, - "pattern": "^\\d{6,22}$", - "type": "string", - "description": "Mobile number with 6 to 22 digits are valid." - }, - "paymentRefId": { - "maxLength": 35, - "minLength": 6, - "type": "string", - "description": "Unique identifier provided by Partner for the payment request.", - "example": "BD019181220291" - } - } - } - ] - } - } - } - } - ] - } - } - } - ], - "x-go-name": "TransactionsResponse" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": [ - "error", - "success", - "traceId" - ], - "type": "object", - "properties": { - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - }, - "500": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "required": [ - "error", - "success", - "traceId" - ], - "type": "object", - "properties": { - "error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "validation-error" - }, - "message": { - "type": "string", - "example": "Input is invalid" - } - } - }, - "success": { - "type": "boolean", - "example": false - }, - "traceId": { - "type": "string", - "example": "C3SFG0O6N88R6UI7EQ" - } - } - } - } - } - } - }, - "security": [ - { - "Production": [ - "bbps:partner" - ] - }, - { - "Sandbox": [ - "bbps:partner" - ] - }, - { - "QA": [ - "bbps:partner" - ] - } - ] - } - }, - "/api/v2/health": { - "get": { - "tags": [ - "Health" - ], - "description": "Health check", - "operationId": "getHealth", - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "required": [ - "environment", - "server", - "version" - ], - "type": "object", - "properties": { - "environment": { - "type": "string", - "example": "PROD" - }, - "server": { - "type": "string", - "example": "mistborn" - }, - "version": { - "type": "string", - "example": "db42717a829da9d3061e4f409f3c0ee9935b72a5" - } - }, - "x-go-name": "HealthResponseParam", - "x-omitempty": true - } - } - } - } - } - } - }, ->>>>>>> 5f25c1980d76beccd1b61ec7b91d86fb0a04af2f "/api/v2/upms/registrations/{upmsRegistrationRefID}": { "get": { "tags": [