GETFetch BBPS Bill
Retrieve outstanding bill details from a biller before processing payment.
Fetches the live bill for a customer from the biller's system. Required for operators where billFetchResponse = 1. The response includes the outstanding amount, due date, and a billfetchresponse token that must be forwarded verbatim in the subsequent Pay Bill call. Pass hc_channel=1 to use the higher-commission delayed channel.
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
initiator_id | string | required | Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729 |
user_code | string | required | User code of the retailer/agent the service is run for.e.g. 20810200 |
utility_acc_no | string | required | Customer's account / consumer number with the biller.e.g. 1234567890 |
confirmation_mobile_no | string | required | Customer's mobile number for transaction confirmation.e.g. 9999988888 |
sender_name | string | required | Customer's full name.e.g. Ramesh Kumar |
operator_id | string | required | Biller identifier from the Get Operators response.e.g. 83 |
source_ip | string | required | IP address of the agent or retailer making this request.e.g. 192.168.1.1 |
latlong | string | required | Agent's GPS coordinates as `latitude,longitude`. Mandatory for agent activation compliance.e.g. 28.6139,77.2090 |
hc_channel | number | optional | Payment channel: 0 = Instant (default), 1 = Delayed (higher commissions).e.g. 0 |
dob | string | optional | Date of birth of the policy holder in DD/MM/YYYY format. Required for LIC policies.e.g. 15/08/1985 |
cycle_number | string | optional | Electricity bill cycle number. Required for MSEB billers.e.g. 202406 |
authenticator | string | optional | MSEB portal password. Required for certain MSEB accounts.e.g. mypassword123 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
user_codestringRequiredUser code of the retailer/agent the service is run for.
example: 20810200
utility_acc_nostringRequiredCustomer's account / consumer number with the biller.
example: 1234567890
confirmation_mobile_nostringRequiredCustomer's mobile number for transaction confirmation.
example: 9999988888
sender_namestringRequiredCustomer's full name.
example: Ramesh Kumar
operator_idstringRequiredBiller identifier from the Get Operators response.
example: 83
source_ipstringRequiredIP address of the agent or retailer making this request.
example: 192.168.1.1
latlongstringRequiredAgent's GPS coordinates as `latitude,longitude`. Mandatory for agent activation compliance.
example: 28.6139,77.2090
hc_channelnumberoptionalPayment channel: 0 = Instant (default), 1 = Delayed (higher commissions).
example: 0
dobstringoptionalDate of birth of the policy holder in DD/MM/YYYY format. Required for LIC policies.
example: 15/08/1985
cycle_numberstringoptionalElectricity bill cycle number. Required for MSEB billers.
example: 202406
authenticatorstringoptionalMSEB portal password. Required for certain MSEB accounts.
example: mypassword123
Headers
| Field | Type | Required | Description |
|---|---|---|---|
developer_key | string | required | Static API key issued to your account after KYC. |
secret-key | string | required | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
secret-key-timestamp | string | required | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
content-type | string | required | application/jsone.g. application/json |
developer_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Responses
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberGranular status id; see the shared error-codes table.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
bill_amountstringOutstanding bill amount in paise (divide by 100 for rupees).
due_datestringBill due date returned by the biller.
bill_numberstringBiller-assigned bill or reference number.
bill_datestringDate the bill was generated.
customer_namestringCustomer name as registered with the biller.
billfetchresponsestringOpaque token from the biller's system. Must be passed as-is in the Pay Bill request body when the operator requires it.