- APIs
- Generate Authentication TokenPOST
- Fetch Current BillPOST
- Fetch Biller ListGET
- Fetch Biller CategoriesGET
- Fetch Bulk Bill DetailsPOST
- Get Utility Bill By Reference IDGET
- Get Utility Bill StatusGET
- Confirm Debit for Bill PaymentPUT
- Initiate Bill Payment via EnKash PGPOST
- Create Bill Without Bill FetchPOST
- Create Bill After Successful Bill FetchPOST
- Webhook
Get Utility Bill Status
GET
/api/v2/utilityPayment/{utilityEnkashId}
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
response_message
stringÂ
required
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