Headers
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 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
Encrypted Sample Request Body
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:
FAILED:
Invalid Mobile Number:
Mobile Number Missing:
Invalid Email ID:
Email ID Missing:
Invalid / Duplicate Tag or Mandatory Tag is not provided:
Encrypted Sample Response Body
Status Codes
| Status | Status Code | Description |
| SUCCESS | 0 | successful |
| FAILED | 1 | Internal Server Error |
| FAILED | 2 | Validation Error |