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 Status

GET
/api/v2/utilityPayment/{utilityEnkashId}
📌
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.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
utilityEnkashId
string 
required

Request 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/'

Responses

🟢200Success
application/json
Body
response_code
integer 
required
This field holds the status or response code of the API request.
response_message
string 
required
This field represents the response message or status description associated with the API request.
payload
object (UtilityPaymentV2Response) 
required
companyName
string 
required
utilityEnkashId
string 
required
amount
integer 
required
consumerNumber
string 
required
consumerName
string 
required
billDate
string 
required
billDueDate
string 
required
createdDate
string 
required
billNumber
string 
required
billerBillNumber
string 
required
numberOfUnits
integer 
required
approvalStatus
string 
required
approvalRemarks
string 
required
paymentStatus
string 
required
billpayStatus
string 
required
failureReason
string 
required
failureCode
string 
required
paymentDate
string 
required
billpayDate
string 
required
paymentMode
string 
required
approvedDate
string 
required
billReferenceId
string 
required
billStartDate
string 
required
billEndDate
string 
required
remarks
string 
required
companyBiller
object 
required
billAmount
integer 
required
earlyPaymentDate
string 
required
earlyPaymentAmount
integer 
required
latePaymentAmount
integer 
required
actualDueDate
string 
required
companyId
string 
required
bankTransactionId
string 
required
referenceId
string 
required
refund
object 
required
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:02:00
Previous
Get Utility Bill By Reference ID
Next
Confirm Debit for Bill Payment
Built with