Request Method :: POST

Description: This API enables seamless fetching of bill data using unique identifiers.

Headers

---

Content-Type: application/JSON

client_id:  To be shared during integration by ISU Team

client_secret:  To be shared during integration by ISU Team

Request Body Parameters

Parameters	Parameter description with validations and examples	Data type	Mandatory/Optional
mobile_no	Mobile Number.Must have a length of 10. E.g. - "7000122114"	String	Mandatory
email	Email ID of the User. E.g. - "[email protected]"	String	Mandatory
biller_params	Biller Parameters.	String
name	Name of the parameter passed. E.g. - "Consumer Id"	String	Mandatory
value	Value passed against the above parameter. E.g. - "3002897130"	String	Mandatory

Sample Request Body

---

{ "mobile_no": "7000122114", "email": "sonali.p@iserveu.in", "biller_params": [ { "name": "Consumer Id", "value": "3002897130" } ] }

Response Body Parameters (Success)

Parameters	Parameter description with examples	Data type
txnId	Transaction ID	String
status	Status of the Operation	integer
status_desc	Status Description.	string
data_obj	Fetched Data.	String
id	Id	String
response_code	Response Code	String
response_msg	Response Message	String
customer_name	Name of the Customer	String
bill_number	Bill Number	String
bill_period	Bill Period (Month)	String
bill_date	Bill Date	string
due_date	Due Date of the Bill.	string
bill_amount	Bill Amount	String
ccf	CCF - unit used by electric utilities	string
ccf_desc	CCF Description	String
ref_id	Reference ID	String
msgId	Message ID	String
additionalInfo	Additional Information	String
tag	Tag	String
name	Tag Name	String
value	Tag Value	String
billerResponseTags	Biller Response Tags	String
name	Biller Response Tag Name	String
value	Biller Response Tag Values	String
approvalRefNum	Approval Reference Number	String
paramA	To be used as per Client Discretion.	String
paramB	To be used as per Client Discretion.	String
dateAndTime	Date and Time	timestamp
errors	Error Details (For Failed Responses only)
type	Type of Error	String
value	Value provided (Error)	String
msg	Error Message	String
path	Path which contains the Error	String
location	Location of the Error	string

Sample Response Body

---

SUCCESS:

{ "txnId": "104274901697712449", "status": 0, "status_desc": "SUCCESS", "data_obj": { "id": "104274901697712449", "response_code": "000", "response_msg": "Successful", "customer_name": "Manoj Chekuri", "bill_number": "123450001", "bill_period": "June", "bill_date": "2017-06-01", "due_date": "2017-06-30", "bill_amount": "2.00", "ccf": "0", "ccf_desc": null, "ref_id": "a6bb7eaa6b2f4844b0f2b4baebd42741004", "msgId": "a2df897299aa4bb2985cb903ed042741004", "additionalInfo": { "tag": [ { "name": "Service Provider Name", "value": "ABC" }, { "name": "Location/Circle", "value": "Mumbai" } ] }, "tag": [], "billerResponseTags": [ { "name": "Early Payment Amount", "value": "100" }, { "name": "Late Payment Amount", "value": "300" } ], "approvalRefNum": "F5432001", "paramA": "", "paramB": "" }, "dateAndTime": 1727670859260 }

 

FAILED:

Invalid Mobile Number:

{ "status": 2, "errors": [ { "type": "field", "value": "700012211", "msg": "mobile number should be a 10 digit value", "path": "mobile_no", "location": "body" } ] }

Mobile Number Missing:

{ "status": 2, "errors": [ { "type": "field", "value": "", "msg": "mobile number cannot be empty", "path": "mobile_no", "location": "body" }, { "type": "field", "value": "", "msg": "mobile number must be numeric", "path": "mobile_no", "location": "body" }, { "type": "field", "value": "", "msg": "mobile number should be a 10 digit value", "path": "mobile_no", "location": "body" } ] }

Invalid Email ID:

{ "status": 2, "errors": [ { "type": "field", "value": "sonali.piserveu.in", "msg": "email id is not valid", "path": "email", "location": "body" } ] }

Email ID Missing:

{ "status": 2, "errors": [ { "type": "field", "value": "", "msg": "email id is not valid", "path": "email", "location": "body" } ] }

Invalid / Duplicate Tag or Mandatory Tag is not provided:

{ "status": 1, "status_desc": "Tag is Invalid or Duplicate(CPR013) | Mandatory Tag(s) Not Present(CPR014)", "data_obj": { "response_code": "02", "response_msg": "Tag is Invalid or Duplicate(CPR013) | Mandatory Tag(s) Not Present(CPR014)", "customer_name": "", "bill_number": "", "bill_period": "", "bill_date": "", "due_date": "", "bill_amount": "", "ccf": "", "ccf_desc": "", "ref_id": "", "agent_ref_id": "", "additionalInfo": "", "tag": [], "paramA": "", "paramB": "" } }

Status Codes

Status	Status Code	Description
SUCCESS	0	successful
FAILED	1	Internal Server Error
FAILED	2	Validation Error