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

Fetch Bulk Bill Details

POST
/api/v1/utilityPayment/search
📌
Use this API to retrieve bill details in bulk, with a maximum of 5,000 records returned per request.
To improve performance and manage response sizes efficiently, it is recommended to use the limit and offset parameters. For optimal results, set the limit to less than 100.
Important:
The API parameters work using an AND condition, meaning the response will include only data that matches all specified filter values.

Request

Header Params
Authorization
string 
optional
Body Params application/json
utilityEnkashIds
array[string]
required
amountRangeStart
integer 
required
amountRangeEnd
integer 
required
consumerNumber
string 
required
consumerNumbers
array[string]
required
billerType
string 
required
billerName
string 
required
paymentStatus
string 
required
paymentStartDate
string 
required
paymentEndDate
string 
required
createdDateFrom
string 
required
createdDateTo
string 
required
billDueDateFrom
string 
required
billDueDateTo
string 
required
billpayStatus
string 
required
offset
integer 
required
limit
integer 
required
statuses
array[string]
required
Payment Status filter
Allowed values:
PROCESSSUCCESSFAILEDPENDINGCANCELLEDEXPIREDPARTIAL_REFUNDEDREFUNDEDIN_PROCESSREFUND_REQUESTEDPENDING_WITH_BANK
billpayDateFrom
string 
required
billpayDateTo
string 
required
refundDateFrom
string 
required
refundDateTo
string 
required
billPayStatuses
array[string]
required
billReferenceId
string 
required
Example
{
  "companyName": "string",
  "companyId": "string",
  "utilityEnkashId": "string",
  "utilityEnkashIds": [
    "string"
  ],
  "amountRangeStart": 0,
  "amountRangeEnd": 0,
  "makerUser": "string",
  "checkerUser": "string",
  "consumerNumber": "string",
  "consumerNumbers": [
    "string"
  ],
  "companyBillerIds": [
    "string"
  ],
  "billerType": "ELECTRICITY",
  "billerName": "string",
  "billNumber": "string",
  "approvalStatus": "MAKER_APPROVAL_PENDING",
  "paymentStatus": "INIT",
  "serviceProvider": "MK",
  "paymentStartDate": "2024-12-17",
  "paymentEndDate": "2024-12-17",
  "createdDateFrom": "2024-12-17",
  "createdDateTo": "2024-12-17",
  "billDueDateFrom": "2024-12-17",
  "billDueDateTo": "2024-12-17",
  "payoutStartDate": "2024-12-17",
  "payoutEndDate": "2024-12-17",
  "payoutStatus": "SUCCESS",
  "billpayStatus": "SUCCESS",
  "utr": "string",
  "offset": 0,
  "limit": 5000,
  "pgTransactionId": "string",
  "pgCode": "KOTAK_D2I",
  "pgIds": [
    0
  ],
  "companyBranchCodeIds": [
    0
  ],
  "statuses": [
    "INIT"
  ],
  "cpCompanyId": 0,
  "billpayDateFrom": "2024-12-17",
  "billpayDateTo": "2024-12-17",
  "refundDateFrom": "2024-12-17",
  "refundDateTo": "2024-12-17",
  "pendingForMe": true,
  "approvedByMe": true,
  "rejectedByMe": true,
  "approvedByUser": "string",
  "groupIds": [
    "string"
  ],
  "branchCodes": [
    "string"
  ],
  "branchNames": [
    "string"
  ],
  "costCentres": [
    "string"
  ],
  "branchCities": [
    "string"
  ],
  "branchStates": [
    "string"
  ],
  "companyIdLong": 0,
  "billpayDataModifiedOnFrom": "2024-12-17T04:27:27.585Z",
  "billpayDataModifiedOnTo": "2024-12-17T04:27:27.585Z",
  "billPayStatuses": [
    "SUCCESS"
  ],
  "approvalStatuses": [
    "MAKER_APPROVAL_PENDING"
  ],
  "userGroupIds": [
    "string"
  ],
  "billReferenceId": "string",
  "paymentStatusesNot": [
    "INIT"
  ],
  "attachment": true,
  "billCopyStatus": "FAILED"
}

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 POST 'https://test.your-api-server.com/api/v1/utilityPayment/search' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "companyName": "string",
  "companyId": "string",
  "utilityEnkashId": "string",
  "utilityEnkashIds": [
    "string"
  ],
  "amountRangeStart": 0,
  "amountRangeEnd": 0,
  "makerUser": "string",
  "checkerUser": "string",
  "consumerNumber": "string",
  "consumerNumbers": [
    "string"
  ],
  "companyBillerIds": [
    "string"
  ],
  "billerType": "ELECTRICITY",
  "billerName": "string",
  "billNumber": "string",
  "approvalStatus": "MAKER_APPROVAL_PENDING",
  "paymentStatus": "INIT",
  "serviceProvider": "MK",
  "paymentStartDate": "2024-12-17",
  "paymentEndDate": "2024-12-17",
  "createdDateFrom": "2024-12-17",
  "createdDateTo": "2024-12-17",
  "billDueDateFrom": "2024-12-17",
  "billDueDateTo": "2024-12-17",
  "payoutStartDate": "2024-12-17",
  "payoutEndDate": "2024-12-17",
  "payoutStatus": "SUCCESS",
  "billpayStatus": "SUCCESS",
  "utr": "string",
  "offset": 0,
  "limit": 5000,
  "pgTransactionId": "string",
  "pgCode": "KOTAK_D2I",
  "pgIds": [
    0
  ],
  "companyBranchCodeIds": [
    0
  ],
  "statuses": [
    "INIT"
  ],
  "cpCompanyId": 0,
  "billpayDateFrom": "2024-12-17",
  "billpayDateTo": "2024-12-17",
  "refundDateFrom": "2024-12-17",
  "refundDateTo": "2024-12-17",
  "pendingForMe": true,
  "approvedByMe": true,
  "rejectedByMe": true,
  "approvedByUser": "string",
  "groupIds": [
    "string"
  ],
  "branchCodes": [
    "string"
  ],
  "branchNames": [
    "string"
  ],
  "costCentres": [
    "string"
  ],
  "branchCities": [
    "string"
  ],
  "branchStates": [
    "string"
  ],
  "companyIdLong": 0,
  "billpayDataModifiedOnFrom": "2024-12-17T04:27:27.585Z",
  "billpayDataModifiedOnTo": "2024-12-17T04:27:27.585Z",
  "billPayStatuses": [
    "SUCCESS"
  ],
  "approvalStatuses": [
    "MAKER_APPROVAL_PENDING"
  ],
  "userGroupIds": [
    "string"
  ],
  "billReferenceId": "string",
  "paymentStatusesNot": [
    "INIT"
  ],
  "attachment": true,
  "billCopyStatus": "FAILED"
}'

Responses

🟢200Success
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object (GenericPaginationResponseUtilityPaymentV2Response) 
optional
recordsCount
integer <int64>
optional
data
array[object (UtilityPaymentV2Response) {35}] 
optional
Example
{
  "response_code": 0,
  "response_message": "string",
  "payload": {
    "recordsCount": 0,
    "data": [
      {
        "companyName": "string",
        "utilityEnkashId": "string",
        "amount": 0,
        "consumerNumber": "string",
        "consumerName": "string",
        "billDate": "2025-06-02",
        "billDueDate": "2025-06-02",
        "createdDate": "2025-06-02T14:29:53.262Z",
        "billNumber": "string",
        "billerBillNumber": "string",
        "numberOfUnits": 0,
        "approvalStatus": "MAKER_APPROVAL_PENDING",
        "approvalRemarks": "string",
        "paymentStatus": "INIT",
        "billpayStatus": "SUCCESS",
        "failureReason": "string",
        "failureCode": "UTEX001",
        "paymentDate": "2025-06-02T14:29:53.262Z",
        "billpayDate": "2025-06-02T14:29:53.262Z",
        "paymentMode": "CREDIT_CARD",
        "approvedDate": "2025-06-02T14:29:53.262Z",
        "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:29:53.262Z",
          "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:29:53.262Z",
          "refundAmount": 0,
          "refundMode": "CREDIT_CARD",
          "instrument": "string",
          "refundTransactionId": "string",
          "refundStatus": "string",
          "refundReason": "string"
        }
      }
    ]
  }
}
Modified at 2025-07-08 19:58:58
Previous
Fetch Biller Categories
Next
Get Utility Bill By Reference ID
Built with