BBPS Operator List API

GET https://api.billhub.in/reseller/bbps/operators/

BillHub API provides comprehensive access to a list of operators for various bill payment categories, such as electricity providers. With this API, you can retrieve operator details, input fields for user data entry, and validation rules to build dynamic user interfaces for bill payments.

Description

This request returns an array of available operators, their categories, biller details, and required input fields with validation rules. Use this information to dynamically generate and validate input forms for users.

Response Field Details

Operator Fields

• categoryId: Category identifier (e.g., electricity).
• name: Display name of the category.
• providerRoot: Array of providers within the category.

Provider Fields

• name: Name of the provider (e.g., Adani Electricity Mumbai Limited).
• billers: Array of billers available for the provider.
  • op: Operator code for transactions.
  • fields: List of input fields required for user entry.

Input Field Details

• id: Unique field identifier.
• name: Display name of the field.
• type: Type of input (INPUT, SELECT, etc.).
• isnumeric: Indicates whether the field accepts numeric input.
• regex: Regular expression for validation.
• maxLen: Maximum length of input.
• minLen: Minimum length of input (if applicable).
• icon: Icon identifier for UI representation.
• skipIfConnection: Skip the field if certain conditions are met.

Usage Example

1. Retrieve Operator List: Send a GET request to the endpoint.
2. Build Dynamic Forms: Use the fields data to generate form inputs.
3. Implement Validation: Apply regex patterns and numeric validations as specified.

Best Practices

• Input Validation: Always validate user input on both client and server sides.
• Dynamic UI: Leverage fields data to build adaptable forms.
• Security: Ensure sensitive data is transmitted securely using HTTPS.