BILL FETCH API

Bill Fetch API is a request which will be sent from NPCI through BOU to the biller portal in order to retrieve bill related details from the biller.

REQUEST PARAMETERS

The various parameters are explained below:

Parent Property/ElementProperty NameMandatoryData TypeDescription

[ROOT] (No parent property / element)

refId

M

Alphanumeric Format: Fixed Length – 35

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

billerId

M

String Fixed Length – 14

Unique identification code allocated to the Biller (by NPCI)

customerParams

M

Array of name value pairs

Customer bill fetch related reference field tag

tenantId

M

String Fixed length - 4

OU ID of the BOU

name

M

String Min Length – 1, Max Length – 100

Customer bill fetch related reference field.

Name of the reference field as

configured for the Biller

value

M

String Min Length – 1, Max Length – 100

Value of the reference field which uniquely identifies the customer for the Biller

Expected Acknowledgement Parameters

The various parameters are explained below:

Parent Property/ElementProperty NameMandatoryData Type

[ROOT] (No parent property / element)

reason

M

String Min Length – 1, Max Length – 100

Reason of the Status

code

M

String Fixed Length 3

Response code for a request

status

M

String Min Length – 1, Max Length – 100

Status of given request

Json Formatted Request Example

{

"refId": "String", "billerId:": "String", "customerParams": [ { "name": "String", "value": "String" } ], "tenantId" : "String"

}

Json Formatted Response Example

{

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

}

Last updated