Skip to main content

Open Gateway

Last Updated: December 3, 2025

See What's Changed

This Schedule outlines the functional requirements for Open Gateway.

  1. Definitions and Interpretations

    1. In this Agreement Terms defined in the Master Service Agreement (MSA) and used in this Schedule have the same defined meaning.

    2. The following additional 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
  2. Functional Requirements

    The following requirements apply, as prescribed further in the Data Standards, for the delivery of Open Gateway.

    1. General Capabilities

      The following general capabilities are included:

      Functional RequirementSectorsCategoryRequirement
      OA1AllCommonProvide programmatic access to prescribed query parameters, in accordance with the relevant Data Standard.
      OA2AllCommonProvide programmatic access to prescribed pagination parameters, in accordance with the relevant Data Standard.
      OI1AllIdentityAllow for authentication and authorisation to be established using a compatible OAuth2 server as prescribed within the Open Gateway documentation.
      OI2AllIdentityProvide branding in accordance with the Open Gateway documentation.
    2. Consumer Management

      The following Consumer facing functionality is included:

      Functional RequirementSectorsCategoryRequirement
      OD1AllConsent DashboardConsumer Dashboard aligned to the Consumer Experience Standards and CX Guidelines
      OD2AllConsent DashboardConsumer Dashboard branded according to the Consumer Experience Theming configuration
      OD3AllConsent DashboardConsumer Dashboard authenticated utilising OAuth2 tokens as prescribed in OAuth2 Clients
      ON1AllNotificationsProvide notification capability as prescribed under the CDR Rules Division 4.3A.8
    3. Data Holder API Access

      Provide programmatic access, where legal permission is granted, to the following Data Holder endpoints, as defined by the Data Standards:

      Functional RequirementSectorsCategoryRequirement
      OC1AllAuthenticated APIGet Customer
      OC2AllAuthenticated APIGet Customer Detail
      OB1Banking & NBLAuthenticated APIGet Accounts
      OB5Banking & NBLAuthenticated APIGet Account Detail
      OB2Banking & NBLAuthenticated APIGet Bulk Balances
      OB3Banking & NBLAuthenticated APIGet Balances for Specific Accounts
      OB4Banking & NBLAuthenticated APIGet Account Balance
      OB6Banking & NBLAuthenticated APIGet Transactions for Account
      OB7Banking & NBLAuthenticated APIGet Transaction Detail
      OB8Banking & NBLAuthenticated APIGet Direct Debits for Account
      OB9Banking & NBLAuthenticated APIGet Bulk Direct Debits
      OB10Banking & NBLAuthenticated APIGet Direct Debits for Specific Accounts
      OB11Banking & NBLAuthenticated APIGet Scheduled Payments for Accounts
      OB12Banking & NBLAuthenticated APIGet Scheduled Payments Bulk
      OB13Banking & NBLAuthenticated APIGet Scheduled Payments for Specific Accounts
      OB16Banking & NBLAuthenticated APIGet Instalment Plans for Account
      OB17Banking & NBLAuthenticated APIGet Instalment Plans Bulk
      OB14Banking & NBLAuthenticated APIGet Payees
      OB15Banking & NBLAuthenticated APIGet Payee Detail
      OE1EnergyAuthenticated APIGet Service Points
      OE2EnergyAuthenticated APIGet Service Point Detail
      OE3EnergyAuthenticated APIGet Usage for Service Points
      OE4EnergyAuthenticated APIGet Bulk Usage
      OE5EnergyAuthenticated APIGet Usage for Specific Service Points
      OE6EnergyAuthenticated APIGet DER for Service Points
      OE20EnergyAuthenticated APIGet Bulk DER
      OE21EnergyAuthenticated APIGet DER For Specific Service Points
      OE7EnergyAuthenticated APIGet Energy Accounts
      OE8EnergyAuthenticated APIGet Energy Account Detail
      OE9EnergyAuthenticated APIGet Agreed Payment Schedules
      OE10EnergyAuthenticated APIGet Concessions
      OE11EnergyAuthenticated APIGet Balance for Energy Accounts
      OE12EnergyAuthenticated APIGet Bulk Balances for Energy
      OE13EnergyAuthenticated APIGet Balances for Specific Energy Accounts
      OE14EnergyAuthenticated APIGet Invoices for Energy
      OE15EnergyAuthenticated APIGet Bulk Invoices
      OE16EnergyAuthenticated APIGet Invoices for Specific Accounts
      OE17EnergyAuthenticated APIGet Billing for Energy
      OE18EnergyAuthenticated APIGet Bulk Billing
      OE19EnergyAuthenticated APIGet Billing for Specific Accounts
    4. Management Access

      The following Client facing functionality is included:

      Functional RequirementSectorsCategoryRequirement
      OM1AllManagement APIProvide API for the establishment and modification of consent templates as prescribed within the Open Gateway documentation.