These docs are for v1. Click to read the latest docs for v3.

Fetch Bills API

Helps you to fetch your bills of any operator

Please make sure you've activated your service for BBPS on production before using the APIs.
To activate - Refer here

👍

High commission channel (offline)

This will allow API partner to send fetch bill and pay bill transaction via new high commission channel parallel to existing instant channels. Note that it will only work for billers that has high_commission channel available to them. You can check that in fetch biller details API response. Note that high commission channel is parallel to that of regular instant channel. It will not affect transaction flow (including old request structure) from existing regular channel.
hc_channel is optional parameter; you can pass its value as 1 to choose high commissions channel for you transaction otherwise it will default channel as instant. Please note that high commission channel might take upto 6 hours to complete transaction on biller side.

🚧

For MSEB Operator:

You need to pass the cycle_number and authenticator parameters extra for MSEB operator

cycle_number : Cycle number of the Bill for this operator
authenticator: Password provided by this operator

🚧

Precautions

Check parameters required to pass in the body from that get operators info API.
Parameters name should be exactly same as param_name asked in operator info API
Value passed for request body should adhere param_type and regex

Query Params
string
required

The unique cell number with which you are onboarded on Eko's platform. For UAT refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

Form Data
string
required

User code value of the retailer from whom the request is coming

string
required

Unique transaction ID which you will generate from your end for every transaction. It should be more than 5 characters and less than 20 characters.

string
required

Account number provided by operator against which bill needs to be fetched / paid

string
required

Value of customer's mobile number

string
required

Valid Name of Customer

string
required

check the get operator API

string
required

IP of the user from whom the request is coming. We are asking this details in case any fraud happens so please make sure to pass the valid IP of the merchant's system.

string
required

latlong of the user from whom the request is coming. We are asking this details in case any fraud happens so please make sure to pass the valid location of the merchant's system.

int32
Defaults to 0

High commission channel flag

string
Defaults to DD/MM/YYYY

This parameter has to be added only in the case of LIC online & Offline

Headers
string
required

application/json

string
required

Your unique API key that will authenticate your request. For UAT, refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

string
required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

string
required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json