Enkash APIs
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
Path Params
utilityEnkashId
string
required
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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
Not configured
Last modified: 10 days ago