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