POSTPay BBPS Bill
Process a bill payment or recharge for any BBPS-connected biller.
The core money-debit API that executes a bill payment or prepaid recharge on the BBPS network. For operators where billFetchResponse = 1, the billfetchresponse token returned by the Fetch Bill API must be included.
Body 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 |
client_ref_id | string | optional | Unique reference id per API call, generated by your system.e.g. REQ-20260101-001 |
utility_acc_no | string | required | Customer's account or consumer number with the biller.e.g. 1234567890 |
confirmation_mobile_no | string | required | Customer's mobile number for payment 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 |
amount | string | required | Payment amount in rupees (e.g. '1350' for ₹1,350).e.g. 1350 |
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 |
billfetchresponse | string | optional | The opaque token returned by the Fetch Bill API. Required when the operator's `billFetchResponse = 1`.e.g. eyJhbGciOiJSUzI1NiJ9... |
dob | string | optional | Date of birth of the policy holder in DD/MM/YYYY format. Required for LIC policy payments.e.g. 15/08/1985 |
postalcode | number | optional | 6-digit PIN code of the customer. Required for MSEB electricity payments.e.g. 400001 |
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
client_ref_idstringoptionalUnique reference id per API call, generated by your system.
example: REQ-20260101-001
utility_acc_nostringRequiredCustomer's account or consumer number with the biller.
example: 1234567890
confirmation_mobile_nostringRequiredCustomer's mobile number for payment confirmation.
example: 9999988888
sender_namestringRequiredCustomer's full name.
example: Ramesh Kumar
operator_idstringRequiredBiller identifier from the Get Operators response.
example: 83
amountstringRequiredPayment amount in rupees (e.g. '1350' for ₹1,350).
example: 1350
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
billfetchresponsestringoptionalThe opaque token returned by the Fetch Bill API. Required when the operator's `billFetchResponse = 1`.
example: eyJhbGciOiJSUzI1NiJ9...
dobstringoptionalDate of birth of the policy holder in DD/MM/YYYY format. Required for LIC policy payments.
example: 15/08/1985
postalcodenumberoptional6-digit PIN code of the customer. Required for MSEB electricity payments.
example: 400001
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.
tx_statusstringTransaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold.
txstatus_descstringHuman-readable transaction status.
dataobjectAPI-specific response payload.
tidstringEko's unique transaction identifier. Use this for status enquiry and dispute resolution.
operator_ref_idstringReference number issued by the biller / BBPS network confirming receipt of payment.
amountstringAmount debited for this transaction.
balancestringRemaining wallet balance of the agent after this transaction.
utility_acc_nostringConsumer/account number against which the payment was made.
client_ref_idstringYour reference ID echoed back.