get https://apis.wattbuy.com/v3/form
This endpoint returns a comprehensive list of input fields necessary for user data collection in the retail electricity enrollment process.
Key features include:
- Input Fields: Provides all required and optional fields for the enrollment form.
- Validation Rules: Each field includes appropriate validation rules in regex format.
- Field Options: Some fields come with supported options and their corresponding labels.
- Conditional Fields: Certain fields are required based on dependent keys and values.
- Agreement Fields: Includes necessary text and agreement fields for terms of service.
- Service Types & Dates: Includes supported service types (switch, forward switch, move, priority move) with corresponding available dates. (For Texas only)
- Utility Validations:
- For Non-Texas: Specific validation rules for Utility Account Numbers (UAN)
- For Texas: ESIID (Electric Service Identifier) validation rules
- Optional Fields: Includes fields for deposit, autopay, and deposit with autopay scenarios.
These are particularly useful for validating card details when the enrollment requires
deposit, autopay, deposit with autopay or deposit waiver based on credit-check response.
Payment Metrix:
Supplier | Deposit Options | Autopay Options | DepositAutopay Options |
---|---|---|---|
Payless Power | credit card | credit card | credit card |
Chariot Energy | credit card/deposit waiver | ||
4Change Energy | credit card | credit card | credit card |
Veteran Energy | credit card | credit card | credit card |
Express Energy | credit card | credit card | credit card |
The API requires a plan_id as input, which should be selected from the "offers" endpoint.