{ "info": { "_postman_id": "ea1f0f4d-1b6d-4d2c-ae52-d6006e120e3b", "name": "WhizzoPay API Documentation", "description": "**Welcome to the WhizzoPay API!** 🌟\n\nWhizzoPay is here to make bill management easy, accessible, and transparent. With the WhizzoPay API, you have free, unrestricted access to your utility billing and usage information from a wide range of providers.\n\nOur **Presentment API** enables users to seamlessly track their energy usage, view detailed billing information, and gain insights into their utility costs—all in real time.\n\n_While this first version focuses on energy, future releases will expand to other sectors, going beyond just utility bills._\n\nBuilt with convenience in mind, WhizzoPay empowers you to stay on top of your energy data and finances, no matter where you are.\n\n### Why Use WhizzoPay?\n\n- **Transparent Access**: WhizzoPay’s Presentment API offers unrestricted access to billing and utility data from multiple providers, allowing anyone to stay informed about their energy use and expenses.\n \n- **User-Friendly Integration**: Whether you’re building a financial dashboard, a utility management tool, or a simple bill tracker, our API makes it easy to access and integrate billing data.\n \n- **Commitment to Privacy**: We NEVER store PII (Personally Identifiable Information) of our users. All user-provided credentials are processed in real-time and are never stored on our servers.\n \n\n### Getting Started 🚀\n\n1. **Create a WhizzoPay Account**: If you haven’t already, [sign up here](https://whizzopay.com/) to create your WhizzoPay account.\n \n2. **Generate Your API Token**: Use your account’s username and password with the `/account/generate-token` endpoint to obtain an API token. This token will allow you to authenticate and access the Presentment API.\n \n\nWith your API token in hand, you’re all set to start exploring the rich data available through our Presentment API!\n\n### Supported Services\n\nOur Presentment API supports data retrieval from a variety of major utility providers. Check out the full list in the API documentation and make sure to use the correct `utility` value for each service provider.\n\n### Join Us on the Journey\n\nWhizzoPay is committed to evolving and improving, and we’re excited to have you join us on this journey. This API is currently in **alpha** and available for early testing and feedback. Help us shape the future by sharing any issues, suggestions, or feature requests at [product@whizzopay.com](https://null).\n\nEnjoy the power of WhizzoPay and make bill management a breeze! 🎉", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "39726611", "_collection_link": "https://www.postman.com/technical-specialist-62510593/whizzopay-api/collection/gx3oyf3/whizzopay-api-documentation?action=share&source=collection_link&creator=39726611" }, "item": [ { "name": "Account", "item": [ { "name": "generate-token", "item": [ { "name": "Generate API token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"test@test.com\",\n \"password\": \"password\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/account/generate-token", "host": [ "{{baseUrl}}" ], "path": [ "account", "generate-token" ] }, "description": "Generate API token for the Presentment endpoints. You need a registered [WhizzoPay](https://whizzopay.com) account to generate a token.\n" }, "response": [ { "name": "API token for the Presentment endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/account/generate-token", "host": [ "{{baseUrl}}" ], "path": [ "account", "generate-token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/account/generate-token", "host": [ "{{baseUrl}}" ], "path": [ "account", "generate-token" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/account/generate-token", "host": [ "{{baseUrl}}" ], "path": [ "account", "generate-token" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ], "description": "Generate API token for the Presentment endpoints. You need a registered [WhizzoPay](https://whizzopay.com) account to generate a token." } ], "description": "The **Account** section provides endpoints for managing WhizzoPay account access, including generating API tokens required to authenticate requests.\n\n### Key Features:\n\n- **Generate API Token**: Obtain an API token by authenticating with your WhizzoPay account credentials. This token is necessary for accessing other endpoints, such as those in the Presentment API.\n \n\nTo get started, use your WhizzoPay account email and password with the `/account/generate-token` endpoint. This token will be used in subsequent requests to ensure secure access to your billing and usage data." }, { "name": "Presentment", "item": [ { "name": "Query for service provider bill data", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{vault:authorization-secret}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"utility\": \"pge\",\n \"username\": \"test@test.com\",\n \"password\": \"password\",\n \"aggregate_type\": \"bill\",\n \"start_date\": \"2024-06-01\",\n \"end_date\": \"2024-07-01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/presentment", "host": [ "{{baseUrl}}" ], "path": [ "presentment" ] }, "description": "### Supported Services:\n\n- **American Electric Power (AEP) subsidiaries:**\n - AEP Ohio (aepohio)\n - AEP Texas (aeptexas)\n - Appalachian Power (appalachianpower)\n - Indiana Michigan Power (indianamichiganpower)\n - Kentucky Power (kentuckypower)\n - Public Service Company of Oklahoma (PSO) (psoklahoma)\n - Southwestern Electric Power Company (SWEPCO) (swepco)\n- **City of Austin Utilities (coautilities)**\n- **Consolidated Edison (ConEd):**\n - Consolidated Edison (coned)\n - Orange & Rockland Utilities (ORU) (oru)\n- **Duquesne Light Company (DQE) (duquesnelight)**\n- **Enmax Energy (enmax)**\n- **Evergy (evergy)**\n- **Exelon subsidiaries:**\n - Atlantic City Electric (atlanticcityelectric)\n - Baltimore Gas and Electric (BGE) (bge)\n - Commonwealth Edison (ComEd) (comed)\n - Delmarva Power (delmarva)\n - PECO Energy Company (PECO) (peco)\n - Potomac Electric Power Company (Pepco) (pepco)\n- **Mercury NZ Limited (mercury)**\n- **National Grid NY Upstate (nationalgridupstate)**\n- **Pacific Gas & Electric (PG&E) (pge)**\n- **Portland General Electric (PGE) (portlandgeneral)**\n- **Puget Sound Energy (PSE) (pse)**\n- **Sacramento Municipal Utility District (SMUD) (smud)**\n- **Seattle City Light (SCL) (scl)**\n\nMake sure to use the correct `utility` value as shown in the list of supported services above.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"utility\": \"indianamichiganpower\",\n \"username\": \"\",\n \"password\": \"\",\n \"aggregate_type\": \"bill\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/presentment", "host": [ "{{baseUrl}}" ], "path": [ "presentment" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"utility\": \"indianamichiganpower\",\n \"username\": \"\",\n \"password\": \"\",\n \"aggregate_type\": \"bill\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/presentment", "host": [ "{{baseUrl}}" ], "path": [ "presentment" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"utility\": \"indianamichiganpower\",\n \"username\": \"\",\n \"password\": \"\",\n \"aggregate_type\": \"bill\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/presentment", "host": [ "{{baseUrl}}" ], "path": [ "presentment" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ], "description": "The Presentment API lets you quickly access utility providers' detailed billing and usage data. This endpoint provides valuable insights into your utility consumption and billing details, helping you stay informed and manage your finances confidently.\n\n### Supported Services\n\nWith the Presentment API, you can retrieve data from many major utility providers, including:\n\n- **American Electric Power (AEP) subsidiaries**:\n \n - AEP Ohio (aepohio)\n \n - AEP Texas (aeptexas)\n \n - Appalachian Power (appalachianpower)\n \n - Indiana Michigan Power (indianamichiganpower)\n \n - Kentucky Power (kentuckypower)\n \n - Public Service Company of Oklahoma (PSO) (psoklahoma)\n \n - Southwestern Electric Power Company (SWEPCO) (swepco)\n \n- **Other Major Providers**:\n \n - City of Austin Utilities (coautilities)\n \n - Consolidated Edison (ConEd) and Orange & Rockland Utilities (ORU) (oru)\n \n - Duquesne Light Company (DQE) (duquesnelight)\n \n - Enmax Energy (enmax)\n \n - Evergy (evergy)\n \n - Exelon subsidiaries (e.g., BGE, PECO, Pepco)\n \n - Mercury NZ Limited (mercury)\n \n - National Grid NY Upstate (nationalgridupstate)\n \n - Pacific Gas & Electric (PG&E) (pge)\n \n - Portland General Electric (PGE) (portlandgeneral)\n \n - Puget Sound Energy (PSE) (pse)\n \n - Sacramento Municipal Utility District (SMUD) (smud)\n \n - Seattle City Light (SCL) (scl)\n \n\nBe sure to refer to this **Supported Services** list and use the correct `utility` value when making API requests.\n\n**Supported Aggregate Types:**\n\nDefault: `\"bill\"`\n\nEnum: `\"day\" \"hour\" \"half_hour\" \"quarter_hour\" \"bill\"`\n\n### Getting Started\n\nTo get started with the Presentment API:\n\n1. First, generate an API token by using the `/account/generate-token` endpoint in the **Account** section with your WhizzoPay account credentials.\n \n2. Include this token in the `Authorization` header as `{{vault:bearer-token}}` to authenticate your requests.\n \n\n### Request Structure\n\n- **Header Parameters**:\n \n - `Authorization` (required): Include your API token as `Bearer` .\n \n- **Body Parameters**:\n \n - `utility` (required): Specify the utility provider using one of the supported values.\n \n - Additional optional parameters let you customize data ranges and aggregation types to view data by day, hour, half-hour, quarter-hour, or billing periods.\n \n\nThe Presentment API makes retrieving historical and real-time utility data easy, giving you control over your energy usage and billing information. **Just remember to use the correct** **`utility`** **value for each provider** to ensure accurate data retrieval.\n\n### Feedback & Service Requests\n\nWe’re always looking to improve and expand our services. If you’d like to provide feedback or request additional utility providers to be added to our supported services list, please reach out to us at [product@whizzopay.com](https://null). We’d love to hear from you!" } ], "variable": [ { "key": "baseUrl", "value": "https://api.whizzopay.com" } ] }