Bill Fetch Response Endpoint

Biller server to Biller Protocol

Endpoint
Request: POST /BillFetchResponse

Response Parameters

The various parameters are explained below:

Parent Property/Element`	Property/Element Name	Mandatory	Data Type	Description
[ROOT] (No parent property / element)	refId	M	String	Unique identification assigned by the initiating BBPOU to unambiguously identify the transaction which is passed on, unchanged, throughout the entire end-to-end chain, binding the Fetch and Payment messages
	errorCode	M	String Fixed Length – 6	Carries the compliance code indicating the reason for a failed transaction – not required for a successful transaction
	errorDescription	M	String Min Length – 1, Max Length – 100	Description of the compliance code – not required for a successful transaction
	status	M	String Format: Successful / Failure	Status of the bill fetch response Successful/Failure
	billNumber	M	String Min Length – 1, Max Length – 100	Unique Id of the Bill
	customerName	M	String Min Length – 1, Max Length – 100	Name of the Customer
	amount	M	String Min Length – 1, Max Length – 18	Total amount of the bill
	billPeriod	M	String Min Length – 1, Max Length – 50	Bill Period set by the biller
	billDate	M	String Fixed Length – 10	Bill Date set by the biller
	dueDate	M	String Fixed Length – 10	DueDate Set by the biller
	billerResponseTags	M	Array of name value pairs	Biller response related tag indicating the various amount options provided by the Biller
	name	M	String Min Length – 1, Max Length – 100	Name of the amount field assigned by the Biller
	value	M	String Min Length – 1, Max Length – 100	Value of the amount field
	additionalInfo	M	Array of name value pairs Min Length – 1, Max Length – 100	Additional information parameters sent by the Biller supporting fetch is copied in the payment request "as-is" – not applicable for payment only Billers
	Value	M	String Min Length – 1, Max Length – 100	Value of the field
	tenantId	M	String Fixed length - 4	OU ID of the BOU

Json Formatted Response Example

    {
    "refId": "String", "errorCode": "String", "errorDescription": "String", "status": "String", "billNumber": "String", "customerName": "String", "amount": "String", "billPeriod": "String", "billDate": "String", "dueDate": "String", "billerResponseTags": [
    {
    "name": "String",
    "value": "String"
    }
    ],
    "additionalInfo": [
    {
    "name": "String",
    "value": "String"
    }
    ],
    "tenantId" : "String"
    }

Json Formatted Acknowledgement Example

{
"reason":"String",
"code":"Integer", "status
}