Request Parameters
The various parameters are explained below:
Response Parameters
The various parameters are explained below:
Json Formatted Response Example (success response)
Json Formatted Response Example (failure response)
Last updated
| Endpoint |
|---|
| Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
| Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
Request: GET /couapp/bills/fetch/byClientId?clientReqId=vgRdasd248
[ROOT] (No parent property / element)
clientReqId
M
Alphanumeric
Fixed Length – 10
[ROOT] (No parent property / element)
billId
M
UUID
Fixed LenMachine-generated Unique ID for a Bill, used internallygth – 10
refId
M
Alphanumeric
Code generated by the Biller Operating Unit that acquires the customer for every bill fetch transaction initiated and used across all messages
billerId
M
String
Unique ID assigned to the Biller by NPCI Fixed length - 14
status
M
String
Status of the Operation
actionType
C
String
Type of Bill Payment. Possible Values: BILL_FETCH QUICKPAY BILL_VALIDATE
userId
M
Alphanumeric
Agent id Fixed length - 20
creationDate
M
String
ISO 8601 Timestamp for the Bill Creation date
modifiedDate
M
String
ISO 8601 Timestamp for the Bill Modification date
createdEpochDate
M
Nuemric
UNIX Epoch Timestamp for the Bill Creation date
modifiedEpochDate
M
Numeric
UNIX Epoch Timestamp for the Bill Modification date
billerResponse
billId
M
String
Machine-generated Unique ID for a Bill, used internally
amount
M
String
Actual bill amount inclusive of all charges
billDate
M
String
This field denotes generation date of the bill
billNumber
M
String
This field denotes the bill number of the bill fetch / payment message requested
billPeriod
M
String
The bill period of the bill fetch / payment requested
custConvFee
M
String
Customer convenience fee (CCF1) paid by the Customer Operating Unit
couCustConvFee
M
String
Customer convenience fee (CCF2), paid by the Customer to Customer Operating Unit
dueDate
M
String
This field denotes due date of the bill
customerName
M
String
This field denotes due date of the bill
amountOption
M
Boolean
A flag indicating if the Biller supports Amount Options
tagList
M
String
Amount Breakup Options eg:{"name": "Additional Charges", "value": "500"}
additionalInfo
name
C
String
Name of the Additional Info Parameter
value
C
String
Value of the Additional Info Parameter
customerParams
name
C
String
Name of the Customer Parameter attribute
value
C
String
Value of the Customer Parameter attribute
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
