- Explore Our Product Suite
- Payment Gateway
- Payouts
- Prepaid Cards
- About Prepaid Card
- Key Capabilities
- Getting Started
- APIs
- API Access & Authorization
- Encryption & Decryption Guide
- Auth Token
- Create Card Account
- Create Gift Card
- Create Prepaid Card
- Set Card PIN
- Load Card Balance
- Get Card Account Details
- Generate Card OTP
- View Card Details
- Card Usage Controls
- Get Card Usage Limits
- Request Card Replacement
- Block Card
- Order Physical Card
- Get Card Details
- Get Transaction Details
- Get All Transaction details
- Bharat Connect (BBPS)
- About Bharat Connect
- Invoice Payments
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- 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
- Utility API Response Handling
- Get Authentication TokenPOST
- Get BillerTypesGET
- Get BillersGET
- Fetch BillPOST
- Create Bill APIPOST
- Create Bill Without Bill FetchPOST
- Bill PaymentPOST
- Utility Bill Approval APIPUT
- Get Utility Bill StatusGET
- Get Utility Bill by Reference IdGET
- Get Utility Bills DetailPOST
- Bill Payment WebhookPOST
- Accounts Payable
- Account Receivable
- Expense Management
- Rewards & Incentives
- Verification Suite
Get Utility Bills Detail
POST
/api/v1/utilityPayment/search
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
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) {32}]
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
},
"utilityBillMetaData": {
"uuid": "string",
"clientId": "string",
"boardId": "string",
"branchCode": "string",
"billAmount": 0,
"billDate": "string",
"dueDate": "string",
"billGenerationStatus": true,
"downloadAndExtractionStatus": "string",
"documentUrl": "string",
"createdOn": "string",
"modifiedOn": "string",
"boardName": "string",
"address": "string",
"customerId": "string",
"meterNumber": "string",
"customerName": "string",
"connectedLoad": 0,
"sanctionedLoad": 0,
"openingMeterReading": 0,
"closingMeterReading": 0,
"unitConsumption": 0,
"amountBeforeDueDate": 0,
"amountAfterDueDate": 0,
"category": "string",
"contractDemand": 0,
"earlyPaymentAmount": 0,
"earlyPaymentDate": "string",
"excessDemandCharges": 0,
"latePaymentPenalty": 0,
"maximumDemand": 0,
"powerFactor": 0,
"powerFactorPenalty": 0,
"powerFactorIncentive": 0,
"tariff": "string",
"digitalPaymentBenefit": 0,
"openMeterReadingDate": "string",
"closingMeterReadingDate": "string",
"billMonth": "string",
"previousAmountPaidDate": "string",
"previousAmountPaid": 0,
"kva40PercentDemand": 0,
"kvamaximumDemand": 0
}
}
]
}
}