Eko Platform Services Logo

    GETGet Operator Parameters

    Fetch the custom input fields required by a specific biller before payment.

    GET/customer/payment/bbps/operator/{operator_id}/parameters

    Returns the operator-specific parameter schema — field names, labels, data types, and validation regex — needed to build a dynamic payment form. Also returns fetchBill (1 = mandatory Fetch Bill step) and BBPS (1 = show Bharat BillPay branding). Call this once per operator and cache the result.

    Path parameters

    operator_idnumberRequired

    The operator/biller ID from the Get Operators response.

    example: 83

    Query parameters

    initiator_idstringRequired

    Registered mobile number of the API user (see Platform Credentials).

    example: 9962981729

    Headers

    developer_keystringRequired

    Static API key issued to your account after KYC.

    secret-keystringRequired

    Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

    secret-key-timestampstringRequired

    Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

    content-typestringRequired

    application/json

    example: application/json

    Responses

    • statusnumber

      Primary success indicator (0 = success).

    • messagestring

      Human-readable response / error message.

    • response_status_idnumber

      Granular status id; see the shared error-codes table.

    • response_type_idnumber

      A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.

    • dataobject

      API-specific response payload.

      • fetchBillnumber

        1 = Fetch Bill API must be called before Pay Bill; 0 = direct payment allowed.

      • BBPSnumber

        1 = biller is on the BBPS network; display the Bharat BillPay logo per NPCI guidelines.

      • dataarray

        List of input parameters required by this biller.

        • param_namestring

          API field name to send in the Fetch Bill / Pay Bill request.

        • param_labelstring

          UI label to display to the end user.

        • param_typestring

          Input type: Numeric, Decimal, AlphaNumeric, or List.

        • regexstring

          Regular expression to validate the user's input before submission.

        • error_messagestring

          Validation error message to show when the regex does not match.