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.
Note : This MDM Biller List will work only when your api account is login
Request Example
Responses (JSON)
    • 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.
    • 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."
    • Description: Predefined message.
    • status_code (integer): 3
    • status (string): The status of the response.
    • message (string): "No bill due"
    • 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.
© Redpay.
Design & Develop by Redpay Payments Private Limited