Get Utility Bill Status

📌

Use this API to retrieve the current status of a specific utility bill, such as whether it is pending, paid, or failed.
By providing the appropriate reference ID or transaction identifier, you can easily track the payment lifecycle and keep your records up to date.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "companyName": "string",
        "utilityEnkashId": "string",
        "amount": 0,
        "consumerNumber": "string",
        "consumerName": "string",
        "billDate": "2025-06-02",
        "billDueDate": "2025-06-02",
        "createdDate": "2025-06-02T14:24:14.670Z",
        "billNumber": "string",
        "billerBillNumber": "string",
        "numberOfUnits": 0,
        "approvalStatus": "MAKER_APPROVAL_PENDING",
        "approvalRemarks": "string",
        "paymentStatus": "INIT",
        "billpayStatus": "SUCCESS",
        "failureReason": "string",
        "failureCode": "UTEX001",
        "paymentDate": "2025-06-02T14:24:14.670Z",
        "billpayDate": "2025-06-02T14:24:14.670Z",
        "paymentMode": "CREDIT_CARD",
        "approvedDate": "2025-06-02T14:24:14.670Z",
        "billReferenceId": "string",
        "billStartDate": "2025-06-02",
        "billEndDate": "2025-06-02",
        "remarks": "string",
        "companyBiller": {
            "companyBillerId": "string",
            "companyName": "string",
            "companyId": "string",
            "biller": {
                "billerId": 0,
                "name": "string",
                "billerType": "string",
                "inputParams": [
                    {
                        "paramKey": "string",
                        "paramName": "string",
                        "paramType": "NUMBER",
                        "paramRegex": "string",
                        "invalidParamError": "string",
                        "mandatory": true,
                        "paramValues": [
                            {
                                "key": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "circleParams": [
                    {
                        "key": "string",
                        "value": "AP"
                    }
                ],
                "paymentAmountExactness": "string",
                "state": "ANDAMAN_AND_NICOBAR_ISLANDS",
                "circleStateMapping": {
                    "additionalProp1": "ANDAMAN_AND_NICOBAR_ISLANDS",
                    "additionalProp2": "ANDAMAN_AND_NICOBAR_ISLANDS",
                    "additionalProp3": "ANDAMAN_AND_NICOBAR_ISLANDS"
                },
                "viewBillSupported": true
            },
            "circleEnum": "AP",
            "billInputParams": "string",
            "billerParams": [
                {
                    "key": "string",
                    "name": "string",
                    "value": "string",
                    "paramType": "NUMBER"
                }
            ],
            "consumerNumber": "string",
            "consumerName": "string",
            "createdDate": "2025-06-02T14:24:14.671Z",
            "lastDueDate": "2025-06-02",
            "billFetchFailureMessage": "string"
        },
        "billAmount": 0,
        "earlyPaymentDate": "2025-06-02",
        "earlyPaymentAmount": 0,
        "latePaymentAmount": 0,
        "actualDueDate": "2025-06-02",
        "companyId": "string",
        "bankTransactionId": "string",
        "referenceId": "string",
        "refund": {
            "refundDate": "2025-06-02T14:24:14.671Z",
            "refundAmount": 0,
            "refundMode": "CREDIT_CARD",
            "instrument": "string",
            "refundTransactionId": "string",
            "refundStatus": "string",
            "refundReason": "string"
        }
    }
}

Request

Request Code Samples

Responses