Enkash APIs
Fetch Bill
POST/api/v0/biller/fetchOrAddBillAPI takes the biller details and return current bill provided by the bbps.
Request
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
addBiller
boolean
optional
Mark consumer active for auto bill fetch
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",
"property1": "string",
"property2": "string"
},
"addBiller": true,
"remarks": "string",
"keyContactEmail": "string"
}Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
response_code
string
required
response_message
string
required
payload
object (BillFetchResponse)
required
companyBillerId
string
optional
billNumber
string
optional
userName
string
optional
name on the consumer on bill
billAmount
number
optional
billdate
string <date>
optional
dueDate
string <date>
optional
billPeriod
string
optional
billnetamount
number
optional
earlyPaymentAmount
number
optional
earlyPaymentDate
string <date>
optional
latePaymentAmount
number
optional
actualDueDate
string <date>
optional
statusMessage
string
optional
Message in case bill fetch failed
billId
string
optional
validationId
string
optional
billStartDate
string <date>
optional
billEnddate
string <date>
optional
Example
Not configured
Last modified: 10 days ago