BBPS
Search
K

Customer Parameters API

API for listing Customer Parameter details of a specific Biller, by using the Biller ID.
Endpoint
Request: GET /agent/cou-master/masters/customerParam?billerId=BSNL00000NATHL
Request Parameters
The various parameters are explained below:
Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description
[ROOT] (No parent property / element)
billerId
C
Alphanumeric
Fixed Length – 14
Response Parameters
The various parameters are explained below:
Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description
[ROOT] (No parent property / element)
customParamResp
M
List
List of customer params
customParamResp
customParamName
M
UUID
Unique ID associated with a specific Amount Breakup Set
dataType
M
String
Lists all combinations of Amount Breakup Options configured by the Biller
optional
M
Boolean
minLength
M
Numeric
maxLength
M
Numeric
regex
M
Alphanumeric
generalResp
visibility
M
Boolean
statusCode
M
Numeric
200- SUCCESS Other than 200-Failure
status
M
String
It is either “Success” or failure
message
M
String
Contains the reason message for failure / success
Json Formatted Response Example
{
"generalResp": { "statusCode": "200",
"status": "success",
"message": "Customer param retrieved successfully",
"remarks": ""
},
"customParamResp": [
{
"customParamName": "Mobile Number",
"dataType": "NUMERIC",
"optional": false,
"minLength": 10,
"maxLength": 10,
"regex": "^[6-9]{1}[0-9]{9}$",
"visibility": true
},
{
"customParamName": "Circle",
"dataType": "ALPHANUMERIC",
"optional": false,
"minLength": 1,
"maxLength": 50,
"regex": null,
"visibility": true
},
{
"customParamName": "Id",
"dataType": "ALPHANUMERIC",
"optional": false,
"minLength": 1,
"maxLength": 50,
"regex": null,
"visibility": false
}
]
}