Enkash Developer Portal
Home
Home
Login
  1. APIs
  • Back to home
  • Bill Payment
  • APIs
    • Generate Authentication Token
      POST
    • Fetch Current Bill
      POST
    • Fetch Biller List
      GET
    • Fetch Biller Categories
      GET
    • Fetch Bulk Bill Details
      POST
    • Get Utility Bill By Reference ID
      GET
    • Get Utility Bill Status
      GET
    • Confirm Debit for Bill Payment
      PUT
    • Initiate Bill Payment via EnKash PG
      POST
    • Create Bill Without Bill Fetch
      POST
    • Create Bill After Successful Bill Fetch
      POST
  • Webhook
    • Setup Webhook Endpoint
  1. APIs

Get Utility Bill By Reference ID

GET
/api/v2/utilityPayment/referenceId/{referenceId}
📌
Use this API to retrieve the details of a specific utility bill by providing its reference ID.
This allows you to quickly look up bill information that was previously generated or fetched, making it easy to track billing status or display details to customers.

Request

Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://test.your-api-server.com/api/v2/utilityPayment/referenceId/'

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"
        }
    }
}
Modified at 2025-07-08 20:00:34
Previous
Fetch Bulk Bill Details
Next
Get Utility Bill Status
Built with