Enkash Developer Portal
Home
Home
Login
  1. Webhook
  • Back to home
  • Bill Payment
  • APIs
    • Generate Authentication Token
    • Fetch Current Bill
    • Fetch Biller List
    • Fetch Biller Categories
    • Fetch Bulk Bill Details
    • Get Utility Bill By Reference ID
    • Get Utility Bill Status
    • Confirm Debit for Bill Payment
    • Initiate Bill Payment via EnKash PG
    • Create Bill Without Bill Fetch
    • Create Bill After Successful Bill Fetch
  • Webhook
    • Setup Webhook Endpoint
      POST
  1. Webhook

Setup Webhook Endpoint

POST
merchant_url
📌
Use these API details to setup a webhook endpoint on your side that can receive event notifications from EnKash.
The webhook supports:
Static headers for security validation, ensuring that incoming requests can be authenticated.
A custom payload, allowing flexibility in the event data delivered to your system.

Request

Body Params application/json
utilityEnkashId
string 
required
amount
number 
required
consumerNumber
string 
required
consumerName
string 
required
billDate
string 
required
billDueDate
string 
required
createdDate
string 
required
billNumber
string 
required
billerBillNumber
string 
required
numberOfUnits
integer 
required
approvalStatus
string 
required
approvalRemarks
string 
required
paymentStatus
string 
required
billpayStatus
string 
required
failureReason
null 
required
failureCode
null 
required
paymentDate
string 
required
billpayDate
string 
required
approvedDate
string 
required
billReferenceId
string 
required
billStartDate
string 
required
billEndDate
string 
required
remarks
string 
required
refundDate
null 
required
companyBiller
object 
required
companyBillerId
string 
required
companyName
string 
required
biller
object 
required
circleEnum
string 
required
billInputParams
string 
required
billerParams
array [object {3}] 
required
consumerNumber
string 
required
consumerName
string 
required
billAmount
number 
required
earlyPaymentDate
string 
required
earlyPaymentAmount
integer 
required
latePaymentAmount
number 
required
actualDueDate
string 
required
companyId
string 
required
bankTransactionId
string 
required
referenceId
string 
required
Example
{
    "utilityEnkashId": "UTIL-87654321",
    "amount": 2450.75,
    "consumerNumber": "CN123456789",
    "consumerName": "Tech Solutions Ltd",
    "billDate": "2025-05-10",
    "billDueDate": "2025-06-05",
    "createdDate": "2025-05-12T14:30:25",
    "billNumber": "BILL-123456",
    "billerBillNumber": "BILLER-654321",
    "numberOfUnits": 215,
    "approvalStatus": "APPROVED",
    "approvalRemarks": "Verified and approved by finance department",
    "paymentStatus": "COMPLETED",
    "billpayStatus": "COMPLETED",
    "failureReason": null,
    "failureCode": null,
    "paymentDate": "2025-05-20T10:15:30",
    "billpayDate": "2025-05-20T10:20:45",
    "approvedDate": "2025-05-15T09:45:20",
    "billReferenceId": "REF-987654321",
    "billStartDate": "2025-04-10",
    "billEndDate": "2025-05-09",
    "remarks": "Corporate office electricity bill payment",
    "refundDate": null,
    "companyBiller": {
        "companyBillerId": "CB-54321",
        "companyName": "Tech Solutions Ltd",
        "biller": {
            "billerId": 2001,
            "name": "Metropolitan Power Corporation",
            "billerType": "ELECTRICITY"
        },
        "circleEnum": "MUMBAI",
        "billInputParams": "consumer_number=CN123456789",
        "billerParams": [
            {
                "key": "cn",
                "name": "Consumer Number",
                "value": "CN123456789"
            },
            {
                "key": "ad1",
                "name": "Billing Unit",
                "value": "MUMBAI-WEST"
            }
        ],
        "consumerNumber": "CN123456789",
        "consumerName": "Tech Solutions Ltd"
    },
    "billAmount": 2450.75,
    "earlyPaymentDate": "2025-05-25",
    "earlyPaymentAmount": 2400.00,
    "latePaymentAmount": 2525.50,
    "actualDueDate": "2025-06-05",
    "companyId": "COMP-123456",
    "bankTransactionId": "TXN-987654321",
    "referenceId": "REF-XYZABC123456"
}

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.commerchant_url' \
--header 'Content-Type: application/json' \
--data-raw '{
    "utilityEnkashId": "UTIL-87654321",
    "amount": 2450.75,
    "consumerNumber": "CN123456789",
    "consumerName": "Tech Solutions Ltd",
    "billDate": "2025-05-10",
    "billDueDate": "2025-06-05",
    "createdDate": "2025-05-12T14:30:25",
    "billNumber": "BILL-123456",
    "billerBillNumber": "BILLER-654321",
    "numberOfUnits": 215,
    "approvalStatus": "APPROVED",
    "approvalRemarks": "Verified and approved by finance department",
    "paymentStatus": "COMPLETED",
    "billpayStatus": "COMPLETED",
    "failureReason": null,
    "failureCode": null,
    "paymentDate": "2025-05-20T10:15:30",
    "billpayDate": "2025-05-20T10:20:45",
    "approvedDate": "2025-05-15T09:45:20",
    "billReferenceId": "REF-987654321",
    "billStartDate": "2025-04-10",
    "billEndDate": "2025-05-09",
    "remarks": "Corporate office electricity bill payment",
    "refundDate": null,
    "companyBiller": {
        "companyBillerId": "CB-54321",
        "companyName": "Tech Solutions Ltd",
        "biller": {
            "billerId": 2001,
            "name": "Metropolitan Power Corporation",
            "billerType": "ELECTRICITY"
        },
        "circleEnum": "MUMBAI",
        "billInputParams": "consumer_number=CN123456789",
        "billerParams": [
            {
                "key": "cn",
                "name": "Consumer Number",
                "value": "CN123456789"
            },
            {
                "key": "ad1",
                "name": "Billing Unit",
                "value": "MUMBAI-WEST"
            }
        ],
        "consumerNumber": "CN123456789",
        "consumerName": "Tech Solutions Ltd"
    },
    "billAmount": 2450.75,
    "earlyPaymentDate": "2025-05-25",
    "earlyPaymentAmount": 2400.00,
    "latePaymentAmount": 2525.50,
    "actualDueDate": "2025-06-05",
    "companyId": "COMP-123456",
    "bankTransactionId": "TXN-987654321",
    "referenceId": "REF-XYZABC123456"
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-07-08 20:15:17
Previous
Create Bill After Successful Bill Fetch
Built with