Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Bill Payments
  • Explore Our Product Suite
  • Payment Gateway
    • Payment Gateway Overview
    • Getting Started
    • Payment Methods
    • Integration
    • API Endpoints
    • APIs
      • Authorisation
        • Get Authorization Token
      • Order
        • Create Order
        • Get Order Status
        • Get Order By Merchant Order Id
        • Get BNPL Payment Modes
        • Get Dynamic QR Code
        • UPI Intent Links
      • Payment
        • Submit Payment Detail
        • Get Transaction Status
        • Validate OTP
        • Resend OTP
        • Payment Notify Request
        • Get UPI Transaction Status
        • Verify VPA
      • Refund
        • Refund
      • Settlement
        • Settlement Reporting
        • Get Settlement Payout By ID
        • Search Settlement Payouts
      • Split Settlement
        • 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 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
  • 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
  • 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
        • 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
      • Utility API Response Handling
      • 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
  • Accounts Payable
    • 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
    • About Authorization
    • Expenses
    • Advance
    • Token API
  • Rewards & Incentives
    • About Rewards
    • Getting Started
    • Encryption & Decryption Guide
    • Reward Allocation
    • Incentive Allocation
    • APIs
      • Token APIs
        • Authentication
        • Single Sign On (SSO)
      • Reward Allocation
        • Create And Allocate Points
        • Bulk Create And Allocate Rewards
        • Get Reward Account Details
        • Get Reward Transaction Details
        • Get User Details
        • Get User Card Details
      • Incentive Allocation
        • Incentive Create And Allocation
        • Get Incentive Transaction details
        • Get User Details
      • 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
        • Overview
        • Create Event
        • Get Event
        • Update Event
        • Allocate Coins
        • Get Balance
  • 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 Bill Status

GET
/api/v0/utilityPayment/{utilityEnkashId}
PaymentStatus -> SUCCESS means fund has been successfully debited from the user account
BillPayStatus refers to the status of the bill.
BillPayStatus ->
SUCCESS means bill is successfully paid.
FAILED means billpayment has been failed, paymentStatus will changed to REFUNDED
Any other status means billpay is still in process status

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/v0/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 (UtilityPaymentResponse) 
required
utilityEnkashId
string 
optional
enaksh unique id
referenceId
string 
optional
customer reference id
amount
number 
optional
Net bill amount
consumerNumber
string 
optional
consumerName
string 
optional
billDate
string <date>
optional
billDueDate
string <date>
optional
createdDate
string <date-time>
optional
billNumber
string 
optional
billerBillNumber
string 
optional
paymentStatus
enum<string> 
optional
Bill payment status
Allowed values:
INITPROCESSSUCCESSFAILEDPENDINGCANCELLEDEXPIREDPARTIAL_REFUNDEDREFUNDEDIN_PROCESSAUTHENTICATION_IN_PROCESSOTP_RENDEREDCHECKOUT_RENDEREDMPI_PROCESSEDMPI_RENDEREDREFUND_IN_PROGRESSREFUND_REQUESTEDPENDING_WITH_BANKSWAPPEDPAID_OFFLINEPARTIAL_PAID
paymentDate
string <date-time>
optional
Payment Date
billpayStatus
enum<string> 
optional
Billpay to bbps status
Allowed values:
SUCCESSFAILEDPENDINGIN_PROGRESSON_HOLDREINITIATEAGENCY_FAILED
billReferenceId
string 
optional
BBPS reference Id
billpayDate
string <date-time>
optional
Billpay date
failureReason
string 
optional
Bill payment failure reason
refundDate
string <date-time>
optional
Refund date in case bill payment failed
paymentMode
enum<string> 
optional
Allowed values:
CREDIT_CARDDEBIT_CARDNET_BANKINGUPIPREPAID_CARDINVALID_PAYMENT_MODESEAMLESS_BANKINGVIRTUAL_ACCOUNTTALLY_PAYMENTENKASH_COINCASHCHEQUEACCOUNT_TRANSFER
approvedDate
string <date-time>
optional
billStartDate
string <date>
optional
billEndDate
string <date>
optional
remarks
string 
optional
validationId
string 
optional
billAmount
number 
optional
earlyPaymentDate
string <date>
optional
earlyPaymentAmount
number 
optional
latePaymentAmount
number 
optional
actualDueDate
string <date>
optional
billCopyStatus
enum<string> 
optional
Allowed values:
FAILEDPENDINGSUCCESS
billCopyPdfUrl
string 
optional
companyBiller
object (CompanyBillerResponse) 
required
utilityBillMetaData
object (UtilityBillMetaDataResponse) 
optional
Bill meta data information, only available when feature opted in.
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "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
        }
    }
}
Previous
Utility Bill Approval API
Next
Get Utility Bill by Reference Id
Built with