Enkash Developer Portal
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Home
  • Back to home
  • Bill Payment
  • 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
  1. Home

Create Bill API

POST
/api/v2/utilityPayment
API to create the bill post successful bill fetch

Request

Body Params application/json
referenceId
string 
optional
customer reference id
companyBillerId
string 
required
Id provided in the response of Fetch Bill API
billNetAmount
number 
required
Bill amount to pay(early payment amount/bill amount/late payment amount)
>= 1
billAmount
number 
required
Bill amount provided in response of bill fetch api
earlyPaymentAmount
number 
optional
Early payment amount provided in response of bill fetch api
latePaymentAmount
number 
optional
Late payment amount provided in response of bill fetch api
billDate
string <date>
optional
Bill date provided in response of bill fetch api
earlyPaymentDate
string <date>
optional
Early payment date provided in response of bill fetch api
billDueDate
string <date>
optional
Due date provided in response of bill fetch api
actualDueDate
string <date>
optional
Due date provided in response of bill fetch api
billStartDate
string <date>
optional
Bill start date
billEndDate
string <date>
optional
Bill end date
billNumber
string 
optional
Bill number provided in response of bill fetch api
validationId
string 
optional
Validation Id provided in the response of Bill Fetch
billId
string 
optional
Bill Id provided in the response of Bill Fetch
Example
{
    "referenceId": "string",
    "companyBillerId": "string",
    "billNetAmount": 1,
    "billAmount": 0,
    "earlyPaymentAmount": 0,
    "latePaymentAmount": 0,
    "billDate": "2019-08-24",
    "earlyPaymentDate": "2019-08-24",
    "billDueDate": "2019-08-24",
    "actualDueDate": "2019-08-24",
    "billStartDate": "2019-08-24",
    "billEndDate": "2019-08-24",
    "billNumber": "string",
    "validationId": "string",
    "billId": "string"
}

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/v2/utilityPayment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceId": "string",
    "companyBillerId": "string",
    "billNetAmount": 1,
    "billAmount": 0,
    "earlyPaymentAmount": 0,
    "latePaymentAmount": 0,
    "billDate": "2019-08-24",
    "earlyPaymentDate": "2019-08-24",
    "billDueDate": "2019-08-24",
    "actualDueDate": "2019-08-24",
    "billStartDate": "2019-08-24",
    "billEndDate": "2019-08-24",
    "billNumber": "string",
    "validationId": "string",
    "billId": "string"
}'

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 (UtilityPaymentV2Response) 
required
companyName
string 
required
utilityEnkashId
string 
required
amount
integer 
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
string 
required
failureCode
string 
required
paymentDate
string 
required
billpayDate
string 
required
paymentMode
string 
required
approvedDate
string 
required
billReferenceId
string 
required
billStartDate
string 
required
billEndDate
string 
required
remarks
string 
required
companyBiller
object 
required
billAmount
integer 
required
earlyPaymentDate
string 
required
earlyPaymentAmount
integer 
required
latePaymentAmount
integer 
required
actualDueDate
string 
required
companyId
string 
required
bankTransactionId
string 
required
referenceId
string 
required
refund
object 
required
Example
{
  "response_code": 0,
  "response_message": "string",
  "payload": {
    "companyName": "string",
    "utilityEnkashId": "string",
    "amount": 0,
    "consumerNumber": "string",
    "consumerName": "string",
    "billDate": "2025-06-02",
    "billDueDate": "2025-06-02",
    "createdDate": "2025-06-02T14:24:14.670Z",
    "billNumber": "string",
    "billerBillNumber": "string",
    "numberOfUnits": 0,
    "approvalStatus": "MAKER_APPROVAL_PENDING",
    "approvalRemarks": "string",
    "paymentStatus": "INIT",
    "billpayStatus": "SUCCESS",
    "failureReason": "string",
    "failureCode": "UTEX001",
    "paymentDate": "2025-06-02T14:24:14.670Z",
    "billpayDate": "2025-06-02T14:24:14.670Z",
    "paymentMode": "CREDIT_CARD",
    "approvedDate": "2025-06-02T14:24:14.670Z",
    "billReferenceId": "string",
    "billStartDate": "2025-06-02",
    "billEndDate": "2025-06-02",
    "remarks": "string",
    "companyBiller": {
      "companyBillerId": "string",
      "companyName": "string",
      "companyId": "string",
      "biller": {
        "billerId": 0,
        "name": "string",
        "billerType": "string",
        "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",
        "state": "ANDAMAN_AND_NICOBAR_ISLANDS",
        "circleStateMapping": {
          "additionalProp1": "ANDAMAN_AND_NICOBAR_ISLANDS",
          "additionalProp2": "ANDAMAN_AND_NICOBAR_ISLANDS",
          "additionalProp3": "ANDAMAN_AND_NICOBAR_ISLANDS"
        },
        "viewBillSupported": true
      },
      "circleEnum": "AP",
      "billInputParams": "string",
      "billerParams": [
        {
          "key": "string",
          "name": "string",
          "value": "string",
          "paramType": "NUMBER"
        }
      ],
      "consumerNumber": "string",
      "consumerName": "string",
      "createdDate": "2025-06-02T14:24:14.671Z",
      "lastDueDate": "2025-06-02",
      "billFetchFailureMessage": "string"
    },
    "billAmount": 0,
    "earlyPaymentDate": "2025-06-02",
    "earlyPaymentAmount": 0,
    "latePaymentAmount": 0,
    "actualDueDate": "2025-06-02",
    "companyId": "string",
    "bankTransactionId": "string",
    "referenceId": "string",
    "refund": {
      "refundDate": "2025-06-02T14:24:14.671Z",
      "refundAmount": 0,
      "refundMode": "CREDIT_CARD",
      "instrument": "string",
      "refundTransactionId": "string",
      "refundStatus": "string",
      "refundReason": "string"
    }
  }
}
Modified at 2025-06-02 14:26:24
Previous
Fetch Bill
Next
Create Bill Without Bill Fetch
Built with