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

Fetch Current Bill

POST
/api/v2/biller/fetchOrAddBill
📌
Use this API to submit biller details and retrieve the current bill information provided by Bharat Connect System (BBPS).
This allows you to obtain up-to-date billing data for a customer, enabling accurate payment processing and streamlined bill management.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
billerId
integer <int32>
required
Biller Id provided by the us/ Received in Get Billers API
circle
enum<string> 
optional
To be provided for biller specific to circle
Allowed values:
APASMBIHCHEDELGUJHARHPJKKKKERKOLMAHMPMUMNEORIPUNRAJTNUPEUPWWBALLAGRAAHMBHIWANDISURATSHILMUMBRAKALWA
billParams
object 
required
Biller input params for bill fetch
cn
string 
required
ConsumerNumber/Account Number
ad1
string 
optional
Additional Parameter 1
ad2
string 
optional
Additional Parameter 2
Additional properties
string 
optional
remarks
string 
optional
Optional remarks for the biller
keyContactEmail
string 
optional
emailIds for sending email after successful bill payment
Example
{
    "billerId": 0,
    "circle": "AP",
    "billParams": {
        "cn": "string",
        "ad1": "string",
        "ad2": "string"
    },
    "remarks": "string",
    "keyContactEmail": "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/biller/fetchOrAddBill' \
--header 'Content-Type: application/json' \
--data-raw '{
    "billerId": 0,
    "circle": "AP",
    "billParams": {
        "cn": "string",
        "ad1": "string",
        "ad2": "string"
    },
    "remarks": "string",
    "keyContactEmail": "string"
}'

Responses

🟢200OK
application/json
Body
response_code
string 
required
response_message
string 
required
payload
object (BillFetchV2Response) 
required
companyBillerId
string 
required
billNumber
string 
required
billAmount
integer 
required
billdate
string 
required
dueDate
string 
required
billPeriod
string 
required
billnetamount
integer 
required
maxBillAmount
integer 
required
minBillAmount
integer 
required
earlyPaymentAmount
integer 
required
earlyPaymentDate
string 
required
latePaymentAmount
integer 
required
actualDueDate
string 
required
statusMessage
string 
required
billId
string 
required
billStartDate
string 
required
billEnddate
string 
required
utilityEnkashId
string 
required
referenceId
string 
required
billParams
object 
required
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "companyBillerId": "string",
        "billNumber": "string",
        "billAmount": 0,
        "billdate": "2025-06-02",
        "dueDate": "2025-06-02",
        "billPeriod": "string",
        "billnetamount": 0,
        "maxBillAmount": 0,
        "minBillAmount": 0,
        "earlyPaymentAmount": 0,
        "earlyPaymentDate": "2025-06-02",
        "latePaymentAmount": 0,
        "actualDueDate": "2025-06-02",
        "statusMessage": "string",
        "billId": "string",
        "billStartDate": "2025-06-02",
        "billEnddate": "2025-06-02",
        "utilityEnkashId": "string",
        "referenceId": "string",
        "billParams": {
            "cn": "string",
            "ad1": "string",
            "ad2": "string"
        }
    }
}
Modified at 2025-07-08 19:52:05
Previous
Generate Authentication Token
Next
Fetch Biller List
Built with