Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Bill Payments
  • EnKash Developer Portal Overview
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment Gateway APIs
    • Web Integration
    • Server to Server Integration
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • About Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Modes
      • Get Dynamic QR Code
      • UPI Intent Links
    • Payments
      • About Payment
      • Submit Payment Detail
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
    • Refunds
      • About Refund
      • Refund
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
      • Search Settlement Payouts
    • Split Settlements
      • About Split Settlements
      • Create Split Settlement Account
      • Update Split Settlement Account
      • Get All Split Settlement Account
      • Deactivate Split Settlement Account
      • Activate Split Settlement Account
      • Submit Payment with Split Details
      • Edit/Deferred Split Settlement
    • E-Commerce Plugins
    • Payment Links
    • Payment Button
    • Qr Code
      • Create Qr Code
      • Get QR Code
      • Search QR Code
      • createCustomer
      • searchCustomer
      • Cancel QR Code
    • UPI Mandate
      • Create UPI Mandate
      • Update UPI Mandate
      • Revoke UPI Mandate
      • Get UPI Mandate
      • UPI mandate create callback
      • Mandate Pre-debit Notification
      • Execute mandate debit
      • Mandate Debit callback
  • Payment Links
    • Payment Links Overview
    • Payment Link APIs
    • Payment Link
      • Create Payment Link
      • Get Payment Link Details
      • Delete Payment Link
    • Payment Link Webhook
      • Payment Link Webhook Request
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
        • Confirm Invoice
        • Status Change Invoice
        • Edit Invoice
      • Payment
        • Pay Invoices
        • Payment Confirmation
      • Financing
        • Request Financing
        • Share Bid
        • Respond Bid
      • Onboarding
        • Register Check Entity
        • Search Entity
        • Register Entity
        • Registration Id
      • cdNote
        • Send CdNote Request
        • Confirm CdNote Request
        • Status Change CdNote Request
      • Purchase Order
        • Send Purchase Order Request
        • Confirm Purchase Order Request
        • Edit Purchase Order Request
        • Status Change Purchase Order Request
      • webhook-invoice
        • Webhook Create Invoice Request
        • Webhook Create Invoice Response
        • Webhook Confirm Invoice Request
        • Webhook Confirm Invoice Response
        • Webhook Status Change Invoice Request
        • Webhook Status Change Invoice Response
        • Webhook Edit Invoice Request
        • Webhook Edit Invoice Response
      • webhook-payments
        • Webhook Payment Request
        • Webhook Payment Confirmation Request
        • Webhook Payment Response
        • Webhook Payment Confirmation Response
      • webhook-business-onboarding
        • Webhook Check Entity Response
        • Webhook Register Entity Response
        • Webhook Search Entity Response
        • Webhook Registration Id Response
      • webhook-financing
        • Webhook Financing Response
        • Webhook Respond Bid Response
        • Webhook Share Bid Request
      • webhook-cdNote
        • Webhook Send CdNote Request
        • Webhook Send CdNote Response
        • Webhook Confirm CdNote Request
        • Webhook Confirm CdNote Response
        • Webhook Status Change CdNote Request
        • Webhook Status Change CdNote Response
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
        • Webhook Send Purchase Order Response
        • Webhook Confirm Purchase Order Request
        • Webhook Confirm Purchase Order Response
        • Webhook Edit Purchase Order Request
        • Webhook Edit Purchase Order Response
        • Webhook Status Change Purchase Order Request
        • Webhook Status Change Purchase Order Response
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
        POST
      • Get BillerTypes
        GET
      • Get Billers
        GET
      • Fetch Bill
        POST
      • Create Bill API
        POST
      • Create Bill Without Bill Fetch
        POST
      • Bill Payment
        POST
      • Utility Bill Approval API
        PUT
      • Get Utility Bill Status
        GET
      • Get Utility Bill by Reference Id
        GET
      • Get Utility Bills Detail
        POST
      • Bill Payment Webhook
        POST
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payout API Response Codes
    • Payouts Integration Steps
    • Encrypting and Decrypting Payload
    • Payouts Status Codes
    • Get Authentication Token
      • Get Authentication Token
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Balance
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Fetch Bank Statement
    • Webhook Data Apis
      • Get Webhook Data
      • Create Webhook Data
  • Accounts Payable Management Tool
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
      • Create Bulk Vendors
      • Update Bulk Vendors
      • Get Beneficiaries (V1)
      • Get Beneficiaries
      • Change Vendor Status
      • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • validateInvoices
        • initiate
        • Search Payouts V1
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
      • Payment Request
    • Update Beneficiary
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • deleteCustomerByCustomerId
        • updateCustomer
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
    • Invoice Management
      • invoice-controller
        • createInvoice
        • invoiceBulkUpload
        • Dispatch Invoice Collection
        • Delete Invoice Collection
        • searchCollectionInvoices
        • getInvoice
        • updateInvoice
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
        • getCustomerReminders
        • getCustomerReminder
        • deleteReminder
        • updateCustomerReminder
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
      • Change Invoice Status Request
      • Bulk Create Invoice
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
    • Expenses
    • Advance
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
        • SSO LOGIN (Single Sign On)
      • Create And Allocate point
      • Bulk Create And Allocate Points
      • Get Card Account Details
      • Get Transaction details
      • List Users Details
      • Get User Card Details
    • Channel Incentives
      • Incentive Create And Allocate point
      • Reward Get Transaction details
      • Incentive Get User Details
    • Points Redemption
      • User Authentication
      • Get Cart for User
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
      • Add to cart
      • Update Cart
      • Create Order
      • Order Search
      • create order
      • Fetch Order Info by Partner order Reference id
    • Point Management APIs
      • Overview
      • Create Event
      • Get Event
      • Update Event
      • Allocate Coins
      • Get Balance
  • Card Management
    • EnKash Card Management Systems Overview
    • Cards We Issue
    • API Reference
    • VKYC
    • Developer Guide
    • Cards Integration Steps
    • Encryption / Decryption of API requests / Response
    • Encryption & Decryption Guide
    • Token Api
      • Partner auth Token
    • Gift Card
      • Create
      • Request Physical
      • Block
      • Replace
      • Get User Details
      • Get Transaction Details
      • Get All Transaction details
    • Meal Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Prepaid Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Fuel_cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Advance Card Feature
      • Create Card Account
      • Set Pin
      • Get Card Account Details
      • Generate Otp Card
      • View Card
      • Update Card Velocity Rules
      • Get Card Velocity Rules
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
    • GSTN Verification
      • Gstin Verification
    • PAN Verification
      • Pan Verification
    • UPI(VPA) Verification
      • Vpa Verification
  1. Bill Payments

Get Utility Bills Detail

POST
/api/v1/utilityPayment/search
This api is to get the bill details in bulk. max 5000 records will be return. It is recommended to use limit and offset values for calling the API, API response is better if limit is set to less than 100.
Parameters in API works in and condition i.e data will be return which is common to all the 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 (GenericPaginationResponseUtilityPaymentResponse) 
optional
recordsCount
integer <int64>
optional
data
array[object (UtilityPaymentResponse) {31}] 
optional
Example
{
  "response_code": 0,
  "response_message": "string",
  "payload": {
    "recordsCount": 0,
    "data": [
      {
        "utilityEnkashId": "string",
        "referenceId": "string",
        "amount": 0,
        "consumerNumber": "string",
        "consumerName": "string",
        "billDate": "2019-08-24",
        "billDueDate": "2019-08-24",
        "createdDate": "2019-08-24T14:15:22Z",
        "billNumber": "string",
        "billerBillNumber": "string",
        "paymentStatus": "INIT",
        "paymentDate": "2019-08-24T14:15:22Z",
        "billpayStatus": "SUCCESS",
        "billReferenceId": "string",
        "billpayDate": "2019-08-24T14:15:22Z",
        "failureReason": "string",
        "refundDate": "2019-08-24T14:15:22Z",
        "paymentMode": "CREDIT_CARD",
        "approvedDate": "2019-08-24T14:15:22Z",
        "billStartDate": "2019-08-24",
        "billEndDate": "2019-08-24",
        "remarks": "string",
        "validationId": "string",
        "billAmount": 0,
        "earlyPaymentDate": "2019-08-24",
        "earlyPaymentAmount": 0,
        "latePaymentAmount": 0,
        "actualDueDate": "2019-08-24",
        "billCopyStatus": "FAILED",
        "billCopyPdfUrl": "string",
        "companyBiller": {
          "companyBillerId": "string",
          "companyName": "string",
          "biller": {
            "billerId": 0,
            "name": "string",
            "billerType": "string",
            "partialPayAllowed": true,
            "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"
          },
          "circleEnum": "AP",
          "billInputParams": "string",
          "billerParams": [
            {
              "key": "string",
              "name": "string",
              "value": "string"
            }
          ],
          "consumerNumber": "string",
          "consumerName": "string",
          "branchCode": "string",
          "branchName": "string",
          "costCentre": "string",
          "branchCity": "string",
          "branchState": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastDueDate": "2019-08-24",
          "active": true,
          "companyBillerValidationStatus": "PENDING",
          "billFetchFailureMessage": "string",
          "attachment": true,
          "autoDebit": true,
          "lastBillCreatedOn": "2019-08-24T14:15:22Z",
          "recoverableAmount": 0,
          "commencementDate": "2019-08-24",
          "remarks": "string",
          "lastBillCheckedAt": "2019-08-24T14:15:22Z",
          "lastBillFetchedAmount": 0,
          "lastBillFetchedMessage": "string",
          "lastBillFetchedReferenceId": "string",
          "keyContactEmail": "string",
          "billerCopyInputParamsData": {
            "property1": "string",
            "property2": "string"
          },
          "billCopyEnabled": true
        }
      }
    ]
  }
}
Modified at 2024-12-17 04:33:12
Previous
Get Utility Bill by Reference Id
Next
Bill Payment Webhook
Built with