Bill Validate API

API for validating a Customer Bill, based on Biller Category, Customer Parameters etc.

Endpoint
Request: POST /couapp/bills/validate

Request Parameters

The various parameters are explained below:

Parent Property/Element	Property/Element Name	Mandatory	Data Type	Description
[ROOT] (No parent property / element)	tenantId	M	Alphanumeric	Fixed Length – 14
	billerId	M	Alphanumeric	Unique ID assigned to the Biller by NPCI Eg: BSNL00000NATHL
	billerName	M	String	Name of the biller
	billerCategory	M	String	Category of biler
	macAdress	C	Alphanumeric	MAC Address of the Agent Server
	customerMobNo	M	String	Mobile of the Customer, on whose behalf the Agent is paying the Bill
	clientReqId	C	String	A unique id which the client has to provide
	customerParamsReques t	M	Object	Unique parameters used for identifying a Customer Bill
customerParamsReq uest	tags	M	List	List of customer params
tags	name	M	String	Name of customer param
tags	value	M	String	Value of customer param

Response Parameters

The various parameters are explained below:

Parent Property/Element	Property/Element Name	Mandatory	Data Type	Description
[ROOT] (No parent property / element)	billId	C	UUID	Machine-generated Unique ID for a Bill, used internally
	refId	C	String	Will be null
	billerId	C	String	Will be null
	status	C	String	Will be null
	actionType	C	String	Will be null
	billerResponse	C	String	Will be null
	additionalInfo	C	String	Will be null
	customerParams	C	String	Will be null
	planInfoDaos	C	String	Will be null
	creationDate	C	String	Will be null
	modifiedDate	C	String	Will be null
	createdEpochDate	C	String	Will be null
	modifiedEpochDate	C	String	Will be null
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	C	String

Json Formatted Request Example

{
"tenantId": "FE41",
"billerId": "HUNG00000NATJL",
"customerParamsRequest": 
{ "tags": [
{
"name": "Mobile Number", 
"value": "8281970522"
},
{
"name": "Email ID",
"value": "[e-mail]"
},
{
"name": "Id",
"value": "2862"
}
]
},
"billerName": "Hungama Music", 
"billerCategory": "Subscription", 
"macAdress": null, 
"customerMobNo": "8281970523"
}

Json Formatted Response Example

{
"genericResponse": { 
"statusCode": "200",
"status": "success",
"message": "Bill Validate Initiated", 
"remarks": ""
},
"billId": "c9670952-ebd7-487a-b6ea-49f2b4d4a718", 
"refId": null,
"billerId": null, 
"status": null, "actionType": null, 
"userId": null, "billerResponse": null, 
"additionalInfo": null,
"customerParams": null, 
"planInfoDaos": null, 
"creationDate": null, 
"modifiedDate": null, 
"createdEpochDate": 0,
"modifiedEpochDate": 0
}