Billers By ID API
API for listing all the Billers onboarded in BBPS
Request: GET /masters/billersById?billerId=KIFS00000NATST
Request Parameters
The various parameters are explained below:
[ROOT] (No parent property / element)
billerId
M
String
Biller ID of the biller
Response Parameters
The various parameters are explained below:
billerDAO (will be an object)
billerId
M
String
Unique ID assigned to the Biller by NPCI Fixed length - 14
billerName
M
String
Name of the Biller
billerAliasName
M
String
Alias Name of the Biller
billerCategoryName
M
String
Category Name of the Biller
billerMode
M
String
Biller Mode of the Biller - Possible values are ONLINE,OFFLINEA,OFFLINEB
billerAcceptsAdhoc
M
Boolean
Whether the biller accepts any amount or not
parentBiller
M
Boolean
Parent Biller Flag
parentBillerId
M
String
Parent Biller ID
billerOwnerShp
M
String
Biller Ownership - Possible values are PSU and Private
billerCoverage
M
String
Coverage in IND-STATE-DISTRICT format
fetchRequirement
M
String
Fetch Requirement - Possible values are MANDATORY, OPTIONAL and NOT_SUPPORTED
paymentAmountExactn ess
M
String
Payment Amount Exactness - Possible values are Exact, Exact and above, Exact and below
supportBillValidation
M
String
Validation Requirement - Possible values are MANDATORY, OPTIONAL and NOT_SUPPORTED
billerEffctvFrom
M
String
Biller effective from date
billerEffctvTo
M
String
Biller effective to date
billerTempDeactivation Start
M
String
Biller Temporary Deactivation Start Date
billerTempDeactivation End
M
String
Biller Temporary Deactivation End Date
billerDescription
M
String
Biller description to display to user
billerResponseType
M
String
Possible values - SINGLE, SELECTIVE (For Plan MDM)
planMDMRequirement
M
String
Indicates whether the biller supports Plan MDM or not. Possible values are MANDATORY,OPTIONAL,NOT_SUPPORTE D
interchangeFeeConves
O
Array
Array of interchange fee convenience fees details
interchangeFees
O
Integer
Interchange fees null if not present
status
M
String
Biller status, can be “ACTIVE" or “INACTIVE”.
supportDeemed
M
String
Support deemed, can be “Yes” or “No”
supportPendingStatus
M
String
Support pending status, can be “Yes” or “No”
billerTimeOut
M
String
Biller time out value in numeric string. Eg: “10”
routeUrl
O
String
Route url
billerPlanResponseP arams
billerPlanResponseId
M
String
Unique Id
params (Array of object)
M
Array of object
Biller plan response param details
amountOptions (Array of object)
M
Array of object
Biller amount options
params (Array of object)
paramConfigId
M
String
Unique Id
paramName
M
String
Parameter name
dataTypeDAO
M
String
Parameter data type
optional
M
Boolean
Parameter optional
visibility
M
Boolean
Parameter visibility
amountOptions (Array of object
amountOptionId
M
Array
Unique Id
amountBreakupSets
M
Array
Array of amount option names
billerPaymentModes (Array of object)
paymentMode
M
String
Payment Mode supported by the Biller
maxLimit
O
Integer
Maximum Limit supported by the Payment Mode. If the tag is not there, maximum limit need not be checked.
minLimit
O
Integer
Minimum Limit supported by the Payment Mode. If the tag is not there, maximum limit need not be checked.
billerPaymentChann els (Array of object)
paymentChannel
M
String
Payment Channel supported by the Biller
maxLimit
O
Integer
Maximum Limit supported by the Payment Channel. If the tag is not there, maximum limit need not be checked.
minLimit
O
Integer
Minimum Limit supported by the Payment Channel. If the tag is not there, maximum limit need not be checked.
billerCustomerPara ms
paramName
M
String
Name of the
customer parameter
(Object)
dataTypeDAO
M
String
Datatype of the customer parameter - Possible values are NUMERIC and ALPHANUMERIC
optional
M
Boolean
Flag indicating whether the parameter is optional or not
minLength
O
Integer
Minimum length of the customer parameter value
maxLength
O
Integer
Maximum length of the customer parameter value
visibility
M
Boolean
Flag indicating whether the customer parameter should be visible to / entered manually by customers or not.
values
O
String
Possible default values for the customer parameter
customerParamGrou ps (Object)
groups
O
Array
Customer parameter groups information
groups (Array of object)
name
M
String
Name of the group
input
M
String
Input value of group
params
M
List
List of string containing the combination
groups
M
Object
Inner Group with same model as the outer Group
billerResponsePara ms
billerResponseId
M
String
Unique ID assigned
params
O
Array
Array of parameter name can also be empty
amountOptions
M
Array of Objects
Amount option details
amountOptions (Array of objects)
amountOptionId
M
String
Unique ID assigned
amountBreakupSets
M
Array of Objects
Consists of names of amount breakup set names
billerAdditionalInfos (Array of Object)
paramName
M
String
Name of the additional info
dataTypeDAO
M
String
Datatype of the additional info - Possible values are NUMERIC and ALPHANUMERIC
optional
M
Boolean
Flag indicating whether the parameter is optional or not
billerAdditionalInfoP ayments (Array of Object)
paramName
M
String
Name of the additional info
dataTypeDAO
M
String
Datatype of the additional info - Possible values are NUMERIC and ALPHANUMERIC
optional
M
Boolean
Flag indicating whether the parameter is optional or not
generalResp
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
remarks
O
String
Suggestion for improvement
Json Formatted Response Example
Last updated
Was this helpful?