Functional Requirements: Open Gateway (incl Test Tool) #
Last Updated: August 6, 2024
Definitions and Interpretations
The following definitions apply:
- Biza Guides
- refers to the technical documentation hosted at https://guides.biza.io
- Data Standards
- refers to the Data Standards website hosted at https://consumerdatastandardsaustralia.github.io/standards
CDR API Access #
Provide the following functional requirements related to accessing CDR APIs:
Functional Requirement | Category | Requirement |
---|---|---|
E1 | Energy API | The solution will provide, at a minimum, access to the following CDR APIs: Get Customer Get Service Points Get Bulk Usage Get Bulk DER Get Energy Accounts Get Bulk Balances Get Bulk Billing Get Bulk Invoices Get Bulk Billing |
E2 | Energy API | The solution will provide, at a minimum, after selection of an account returned by Get Energy Accounts, access to the following CDR APIs: Get Energy Account Detail Get Balance for Energy Account Get Invoices for Account Get Billing for Account |
E3 | Energy API | The solution will provide, at a minimum, after selection of a service point returned by Get Service Points, access to the following CDR APIs: Get Service Point Detail Get Usage for Service Point Get DER for Service Point |
B1 | Banking | The solution will provide, at a minimum, access to the following CDR APIs Get Accounts Get Bulk Balances Get Account Detail Get Bulk Direct Debits Get Scheduled Payments Bulk Get Payees |
B2 | Banking | The solution will provide, at a minimum, after selection of an account returned by Get Accounts, access to the following CDR APIs:Get Account Detail Get Account Balance Get Transactions for Account Get Direct Debits for Account Get Scheduled Payments for Account |
B3 | Banking | The solution will provide, at a minimum, after selection of a specific transaction returned by Get Transactions for Account, access to the following CDR APIs:Get Transaction Detail |
B4 | Banking | The solution will provide, at a minimum, after selection of a specific payee returned by Get Payees, access to the following CDR APIs:Get Payee Detail |
C1 | Common | The solution will provide, at a minimum, access to the following CDR APIs:Get Customer Get Customer Detail |
C1 | Common | The solution will allow for the application of query filters based on those prescribed by the CDR Data Standards. |
C1 | Common | The solution will allow for the application of pagination parameters based on those prescribed by the CD Data Standards. |
I1 | Identity | The solution will allow for authentication and authorisation to be established using an OAuth2 based authz server, notably Auth0 using scope based access control. |
Consent Management Dashboard #
If requested by the Client, provide a Consent Management Dashboard that is:
Functional Requirement | Category | Requirement |
---|---|---|
D1 | Consent Dashboard | Aligned with the prescribed CX Guidelines |
D2 | Consent Dashboard | Branded in accordance with the Theming guidelines of Biza Guides |
D3 | Consent Dashboard | Incorporates functionality required by the Data Standards |
D4 | Consent Dashboard | Single sign-on support for Consumer access in alignment with the technical specifications outlined on Biza Guides |
Recipient Consent Flow #
If requested by the Client, provide a CDR compliant Recipient Consent Flow that can:
Functional Requirement | Category | Requirement |
---|---|---|
F1 | Consent Flow | Aligned with the prescribed CX Guidelines |
F2 | Consent Flow | Branded in accordance with the Theming guidelines of Biza Guides |
F3 | Consent Flow | Incorporates functionality required by the Data Standards |
F4 | Consent Flow | Management Api providing consent template configuration as described on Biza Guides |
Open Gateway Administration Tool #
Administration web interface capability which provides
Functional Requirement | Category | Requirement |
---|---|---|
A1 | Administration | Single sign-on support for Workforce access in alignment with the technical specifications outlined on Biza Guides |
A2 | Administration | Web based interface to manage resources such as registrations and consumer consents |
Appliance Administration Tool #
Appliance Administration web interface capability which provides
Functional Requirement | Category | Requirement |
---|---|---|
AA1 | Administration | Single sign-on support for Workforce access in alignment with the technical specifications outlined on Biza Guides |
AA2 | Administration | Deployment software versions of major Open Gateway components |
AA3 | Administration | Control of major configuration parameters of Open Gateway software |
VT Tool #
Provide the following functional requirements related to Verification Testing Tool (VT Tool):
Functional Requirement | Category | Requirement |
---|---|---|
V1 | Arrangement | Allows for the establishment of a CDR Sharing Arrangement. The solution will align with the various CX Guidelines and Standards and branded as prescribed by Biza. The solution should allow for the following to be specified: Which Data Holder to request arrangement from Which CDR Data Clusters to request |
V2 | Arrangement | Provide a solution that allows for the listing of arrangements previously established by a user. |
V3 | Arrangement | Provide a solution that allows for the listing of arrangements that have been previously established and the viewing of metadata associated with an established arrangement. |
V4 | Arrangement | Provide a solution that allows an arrangement to be amended within a graphical user interface. The solution should allow for the following to be altered during amendment request: Which CDR Data Clusters to request What length of data sharing to request |
V5 | Arrangement | Provide a solution that allows an arrangement to be revoked within a graphical user interface. |
V6 | Arrangement | Single sign-on support for Workforce access in alignment with the technical specifications outlined on Biza Guides |