Fetch Bill Details
Fetch Bill Details
Description :
This API endpoint is used to get the bill details.
Endpoint URL :Request Parameters
Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
---|---|---|---|---|---|---|
token | string | Yes | API access token for user authentication. [To known more about token Click Here] |
|||
customer_id | integer/string | Yes | Please pass Customer Id as mentioned on the bill being paid. | |||
operatorcode | string | Yes | Operator Code for operator identification | |||
refid | string | Yes | A unique reference id generated by your application, to track the requests later. | |||
customer_mobile | integer | Yes | Please pass Customer Mobile No. for every request. | |||
agent_id | string | Optional | Pass the agent id from where the transaction is requested.[Required for BBPS] | |||
p2 | string | Optional | Certain billers require p2 for bill details. Please Click below MDM Biller List to see service wise list of additional parameters. | |||
p3 | string | Optional | Certain billers require p3 for bill details. Please Click below MDM Biller List to see service wise list of additional parameters. | |||
p4 | string | Optional | Certain billers require p4 for bill details. Please Click below MDM Biller List to see service wise list of additional parameters. | |||
p5 | string | Optional | Certain billers require p5 for bill details. Please Click below MDM Biller List to see service wise list of additional parameters. | |||
p6 | string | Optional | Certain billers require p6 for bill details. Please Click below MDM Biller List to see service wise list of additional parameters. |
Request Example
token=02c4aa7315a0778abb7095c944a1f09b&customer_id=N23680090000&operatorcode=MPCZ00000MAP02&refid=15165&customer_mobile=1234567890&agent_id=&p2=&p3=&p4=&p5=&p6=
Responses (JSON)
{
"status_code": 1,
"status": "SUCCESS",
"message": "Bill successfully fetched",
"txn_id": "T20231218180849COEG",
"customer_id": "412950001701",
"BillDetails": {
"CustomerName": "RAKESH DYANAND DEULAKAR",
"Amount": 580,
"DueDate": "2023-12-11",
"BillDate": "2023-11-21",
"BillNumber": "6768134570",
"BillPeriod": "MONTHLY"
},
"AdditionalInformation": {
"info": [
{
"infoName": "Early Payment Date",
"infoValue": "2023-11-30"
},
{
"infoName": "PC",
"infoValue": "3"
},
{
"infoName": "Disconn Tag",
"infoValue": "0"
},
{
"infoName": "Bill Month",
"infoValue": "2023-11"
},
{
"infoName": "DTC Code",
"infoValue": "4359919"
}
]
}
}
- Description: Bill successfully fetched.
- status_code (integer): The status code of the response.
- status (string): The status of the response.
- message (string): A message indicating the result of the operation.
- txn_id (string): The transaction ID associated with the bill retrieval.
- customer_id (string): The ID of the customer.
- BillDetails (object):
- CustomerName (string): The name of the customer.
- Amount (number): The amount of the bill.
- DueDate (string): The due date of the bill.
- BillDate (string): The date when the bill was issued.
- BillNumber (string): The unique bill number.
- BillPeriod (string): The period for which the bill is generated (e.g., "MONTHLY").
- AdditionalInformation (object):
- info (array of objects):
- infoName (string): Name of the additional information.
- infoValue (string): Value associated with the additional information.
- info (array of objects):
{"status_code": 2, "status": "FAILED", "message": "token is required"}
- Description: Validation error in the input parameters.
- status_code (integer): 2
- status (string): The status of the response.
- message (string): "A specific validation error message."
{"status_code": 3, "status": "SUCCESS", "message": "No bill due"}
- Description: Predefined message.
- status_code (integer): 3
- status (string): The status of the response.
- message (string): "No bill due"
{"status_code": 0, "status": "FAILED", "message": "Something went wrong"}
- Description: A specific error message.
- status_code (integer): 0
- status (string): The status of the response.
- message (string): "Something went wrong"
Note
- The API endpoint should be accessed via a GET request.
- Status code 0 for Failed response.
- Status code 1 for Successfull response.
- Status code 2 for required parameter response.
- Status code 3 for No bill due response & it also consider as Successfull response.
- AdditionalInformation - This object you will get it in Certain billers only.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.