Billers By ID API

API for listing all the Billers onboarded in BBPS

Endpoint
Request: GET /masters/billersById?billerId=KIFS00000NATST

Request Parameters

The various parameters are explained below:

Parent Property/Element	Property/Element Name	Mandatory	Data Type	Description
[ROOT] (No parent property / element)	billerId	M	String	Biller ID of the biller

Response Parameters

The various parameters are explained below:

Parent Property/Element	Property/Element Name	Mandatory	Data Type	Description
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

    
    {
    "billerDAO": {
    "billerId": "KIFS00000NATST",
    "billerName": "KIFS Housing Finance Ltd", 
    "billerAliasName": "KIFS", 
    "billerCategoryName": "Loan Repayment", 
    "billerMode": "OFFLINEA", 
    "billerAcceptsAdhoc": true,
    "parentBiller": false, 
    "parentBillerId": "", 
    "billerOwnerShp": "Private", 
    "billerCoverage": "IND",
    "fetchRequirement": "MANDATORY", 
    "paymentAmountExactness": "Exact", 
    "supportBillValidation": "NOT_SUPPORTED", 
    "billerEffctvFrom": "2022-01-14",
    "billerEffctvTo": "2027-01-14", 
    "billerTempDeactivationStart": "", 
    "billerTempDeactivationEnd": "", 
    "billerPaymentModes": [
    {
    "paymentModelLimitId": "6c0d0056-a9dc-4d39-82f0-68de6bb67d37", 
    "paymentMode": "Internet Banking",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentModelLimitId": "e5293ec8-be67-4972-9bf7-c2c6c4c2a961", 
    "paymentMode": "Debit Card",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    "paymentMode": "Bharat QR", 
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentModelLimitId": "67d00ef8-817c-4987-9136-5055cb4be599", 
    "paymentMode": "USSD",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    }
    ],
    "billerPaymentChannels": [
    {
    "paymentChannelLimitId": "36934eb4-2341-4cde-8833-78195cc92c7b", 
    "paymentChannel": "BSC",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "a692239d-847c-44d2-9f6a-22f1490a8607", 
    "paymentChannel": "INT",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "f90d3052-444e-4514-aa07-57cde994af0d", 
    "paymentChannel": "INTB",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "2ad7cd2e-d0e0-4c0a-b0a7-b10f6237532e", 
    "paymentChannel": "MOB",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "c2bf4ee9-4128-4121-8a29-d4d423d40cba", 
    "paymentChannel": "MOBB",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "77542075-b4e6-4f6a-91fa-d4e261a8b271",
    "paymentChannel": "POS", 
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "7cfd4bb8-8d78-4e0b-9388-1302356e6db1", 
    "paymentChannel": "MPOS",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "3ddcaad0-35bc-4c2f-bb40-12c421d2549a", 
    "paymentChannel": "ATM",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "08535682-6366-4148-9d0b-860d8d1017f2", 
    "paymentChannel": "BNKBRNCH",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "8ae1b88a-1aff-453e-ac20-4ca0b5e7d006", 
    "paymentChannel": "KIOSK",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    },
    {
    "paymentChannelLimitId": "8e93c7de-4f08-4551-b61b-cd5bc85216d7", 
    "paymentChannel": "AGT",
    "maxLimit": 100000000,
    "minLimit": 1, 
    "supportPendingStatus": "Yes"
    }
    ],
    "billerCustomerParams": [
    {
    "paramConfigId": "",
    "paramName": "APPLICATION NUMBER", 
    "dataTypeDAO": "NUMERIC",
    "dataTypeModel": "NUMERIC", 
    "optional": false,
    "minLength": 5,
    "maxLength": 10, 
    "visibility": true
    }
    ],
    "customerParamGroups": { "groups": []
    },
    "billerResponseParams": {
    "billerResponseId": "338499e5-4c19-404b-bc80-d720bc0147be", 
    "params": [],
    "amountOptions": [
    {
    "amountOptionId": "c5a8266a-7b4c-4464-bac1-1a797cf8af41", 
    "amountBreakupSets": [
    "BASE_BILL_AMOUNT"
    ]
    }
    ]
    },
    "billerAdditionalInfos": [
    {
    "paramConfigId": "6f7bc0a5-8bf8-4092-8c90-a993f64035e1", 
    "paramName": "Loan Account Number",
    "dataTypeDAO": "ALPHANUMERIC",
    "dataTypeModel": "ALPHANUMERIC", 
    "optional": true,
    "visibility": false
    }
    ],
    "billerAdditionalInfoPayments": [], 
    "interchangeFeeConves": [
    {
    "interChangeFeeConfId": "133b0675-b527-4c69-b0aa-50aaed39213a", 
    "mti": "PAYMENT",
    "paymentMode": "", 
    "paymentChannel": "AGT", 
    "responseCode": "000", 
    "fees": [
    "CCF1", "PBF"
    ],
    "defaultFee": false, 
    "effctvFrom": "20210226", 
    "effctvTo": ""
    },
    {
    "interChangeFeeConfId": "630188cd-382d-49cf-b6af-6571816dd90e", 
    "mti": "PAYMENT",
    "paymentMode": "", 
    "paymentChannel": "BNKBRNCH", 
    "responseCode": "000",
    "fees": [
    "CCF1",
    "PBF"
    ],
    "defaultFee": false, 
    "effctvFrom": "20210226", 
    "effctvTo": ""
    },
    {
    "interChangeFeeConfId": "b63e2838-7a66-46e8-9521-4f2550f03368", 
    "mti": "PAYMENT",
    "paymentMode": "", 
    "paymentChannel": "BSC", "responseCode": "000", "fees": [
    "CCF1", "PBF"
    ],
    "defaultFee": false, "effctvFrom": "20210226", "effctvTo": ""
    },
    {
    "interChangeFeeConfId": "704eaf4a-addd-488e-bb28-19427d5ad57b", "mti": "PAYMENT",
    "paymentMode": "", "paymentChannel": "", "responseCode": "000", "fees": [
    "CCF1", "EBF"
    ],
    "defaultFee": true, "effctvFrom": "20210226", "effctvTo": ""
    }
    ],
    "interchangeFees": [
    {
    "interchangeFeeId": "597b52ba-024f-4075-b772-bde05c37dae9", "feeCode": "CCF1",
    "feeDesc": "Customer_Convenience_Fee", "feeDirection": "C_2_B", "interchangeFeeDetails": [
    {
    "interchangeFeeDetId": "dae2a937-18e5-439e-8af1-30128bc40c31", "tranAmtRangeMax": 9999999999,
    "tranAmtRangeMin": 1,
    "percentFee": 0,
    "flatFee": 0,
    "effctvFrom": "2019-11-28"
    }
    ]
    },
    {
    "interchangeFeeId": "00a941f6-145f-4bb8-adc2-d3727c3599dd", 
    "feeCode": "PBF",
    "feeDesc": "Physical_Biller_Fee", 
    "feeDirection": "B_2_C", 
    "interchangeFeeDetails": [
    {
    "interchangeFeeDetId": "df4cc8c7-f0e5-4b3f-8c99-5e3056b60547", 
    "tranAmtRangeMax": 166700,
    "tranAmtRangeMin": 1,
    "percentFee": 0,
    "flatFee": 500,
    "effctvFrom": "2020-07-01"
    },
    {
    "interchangeFeeDetId": "89924926-3de1-4940-a5c2-676270d48585", 
    "tranAmtRangeMax": 9999999999,
    "tranAmtRangeMin": 166701,
    "percentFee": 0.3,
    "flatFee": 0,
    "effctvFrom": "2020-07-01"
    }
    ]
    },
    {
    "interchangeFeeId": "79ca83bf-b521-4f31-b201-8c856a01a5f0", 
    "feeCode": "EBF",
    "feeDesc": "Electronic_Biller_Fee", 
    "feeDirection": "B_2_C", 
    "interchangeFeeDetails": [
    {
    "interchangeFeeDetId": "b91f831e-007f-417e-a074-71ff1a3caddd", 
    "tranAmtRangeMax": 9999999999,
    "tranAmtRangeMin": 1,
    "percentFee": 0,
    "flatFee": 500,
    "effctvFrom": "2019-11-28"
    }
    ]
    }
    ],
    "status": "ACTIVE", 
    "billerDescription": "", 
    "supportDeemed": "Yes", 
    "supportPendingStatus": "Yes", 
    "billerTimeOut": "30", 
    "routeUrl": "", 
    "billerResponseType": "SINGLE", 
    "billerPlanResponseParams": {
    "billerPlanResponseId": "830fb128-c798-46df-8ab8-8be14730d81b",
    "params": [], 
    "amountOptions": []
    },
    "planMDMRequirement": "NOT_SUPPORTED", 
    "planAdditionalInfos": []
    },
    "generalResp": { "statusCode": "200",
    "status": "success",
    "message": "Biller details retrieved successfully", 
    "remarks": ""
    }
    }