Skip to main content

Biza to CDS Endpoint Mapping

This page maps the Consumer Data Standards (CDS) endpoints to their corresponding Biza Data Adapter operations and versions. Use it as a reference to identify which Data Adapter operation delivers the response for a given CDS endpoint, along with the applicable obligation dates and request/response versions.

For detailed per-endpoint guidance and CDR error mappings, see the individual endpoint pages.

The versions in this table are a baseline mapping for quick reference. Some operations (marked with an asterisk *) apply conditional upgrade/downgrade logic so that a Data Adapter version remains compliant across multiple CDR endpoint versions. For those operations, the authoritative, per-version behaviour is documented in the Data Adapter version to CDR version mapping section of the relevant endpoint page. See the footnotes below the Banking and Energy sector tables.

Common Sector​

CDS EndpointCDS Endpoint VersionObligation DateAdapter VersionAdapter OperationAdapter RequestAdapter Response
Get CustomerV12020-07-01>= 2.0.0getCustomerV0V0
Get Customer DetailV22022-11-31>= 2.0.0getCustomerV0V0
Get StatusV12020-07-01N/AN/AN/AN/A
Get OutagesV12020-07-01N/AN/AN/AN/A

Banking Sector​

CDS EndpointCDS Endpoint VersionObligation DateAdapter VersionAdapter OperationAdapter RequestAdapter Response
Get AccountsV22023-07-10>= 2.0.0listBankingAccounts*N/AV0
V32026-11-09>= 2.3.0listBankingAccounts*N/AV2
Get Account DetailV32023-07-10>= 2.0.0listBankingAccounts*N/AV0
V42026-03-16>= 2.3.0listBankingAccounts*N/AV1
V52026-11-09>= 2.3.0listBankingAccounts*N/AV2
V52026-11-09>= 2.4.0listBankingAccounts*N/AV3
Get Account BalanceV12020-07-01>= 2.0.0listBankingAccounts*N/AV0
Get Bulk BalancesV12020-07-01>= 2.0.0listBankingAccounts*N/AV0
V22026-11-09>= 2.3.0listBankingAccounts*N/AV2
Get Balances for Specific AccountsV12020-07-01>= 2.0.0listBankingAccounts*N/AV0
Get Transactions for AccountV12020-07-01>= 2.0.0listBankingTransactions*N/AV0
V22026-11-09>= 2.4.0listBankingTransactions*N/AV1
Get Transaction DetailV12020-07-01>= 2.0.0listBankingTransactions*N/AV0
V22025-07-14>= 2.0.0listBankingTransactions*N/AV1
V32026-11-09>= 2.4.0listBankingTransactions*N/AV2
Get Direct Debits for AccountV12020-11-01>= 2.0.0listBankingPayments*N/AV0
Get Bulk Direct DebitsV12020-11-01>= 2.0.0listBankingPayments*N/AV0
V22026-11-09>= 2.0.0listBankingPayments*N/AV2
Get Direct Debits for Specific AccountsV12020-11-01>= 2.0.0listBankingPayments*N/AV0
Get Scheduled Payments for AccountsV12020-11-01>= 2.0.0listBankingPayments*N/AV0
V22024-03-11>= 2.0.0listBankingPayments*N/AV1
Get Scheduled Payments for Specific AccountsV12020-11-01>= 2.0.0listBankingPayments*N/AV0
V22024-03-11>= 2.0.0listBankingPayments*N/AV1
Get Scheduled Payments BulkV12020-11-01>= 2.0.0listBankingPayments*N/AV0
V22024-03-11>= 2.0.0listBankingPayments*N/AV1
V32026-11-09>= 2.0.0listBankingPayments*N/AV2
Get PayeesV22022-07-31>= 2.0.0listBankingPayeesN/AV0
Get Payee DetailV22022-07-31>= 2.0.0listBankingPayeesN/AV0
Get Instalment Plans BulkV12026-11-09>= 2.4.0listBankingInstalmentPlansV1V1
Get Instalment Plans for AccountV12026-11-09>= 2.4.0listBankingInstalmentPlansV1V1
Get ProductsV32021-02-28>= 2.0.0N/AN/AN/A
V42026-03-16>= 2.3.0N/AN/AN/A
V52026-07-13>= 2.3.0N/AN/AN/A
Get Product DetailV42022-11-31>= 2.0.0N/AN/AN/A
V52025-07-14>= 2.0.0N/AN/AN/A
V62026-03-16>= 2.3.0N/AN/AN/A
V72026-07-13>= 2.3.0N/AN/AN/A

* This operation applies conditional upgrade/downgrade logic. Where a Data Holder holds the data in the newer schema version, it is obliged to return it, and the response should be at the baseline mapping shown above for that obligation date. The upgrade logic is only compliant where the Data Holder does not hold the newer-schema data for that version. For the exact per-version behaviour, see the Data Adapter version to CDR version mapping section on the relevant endpoint page: List Banking Accounts Β· List Payments Β· List Transactions.

Energy Sector​

info

Get Generic Plans and Get Generic Plan Detail are not currently supported because they are not mandated for Energy Data Holders.

CDS EndpointCDS Endpoint VersionObligation DateAdapter VersionAdapter OperationAdapter RequestAdapter Response
Get Energy AccountsV22022-11-15>= 2.0.0listEnergyAccounts*N/AV0
Get Energy Account DetailV22023-04-14>= 2.0.0listEnergyAccounts*N/AV0
V32023-11-01>= 2.0.0listEnergyAccounts*N/AV1
V42024-11-11>= 2.0.0listEnergyAccounts*N/AV2
Get Agreed Payment ScheduleV12022-11-15>= 2.0.0getEnergyPaymentScheduleN/AV0
Get ConcessionsV12022-11-15>= 2.0.0getEnergyConcessionsN/AV0
Get Balance for Energy AccountV12022-11-15>= 2.0.0listEnergyBalancesN/AV0
Get Bulk Balances for EnergyV12022-11-15>= 2.0.0listEnergyBalancesN/AV0
Get Balances for Specific Energy AccountsV12022-11-15>= 2.0.0listEnergyBalancesN/AV0
Get Invoices for AccountV12022-11-15>= 2.0.0listEnergyInvoicesN/AV0
Get Bulk InvoicesV12022-11-15>= 2.0.0listEnergyInvoicesN/AV0
Get Invoices for Specific AccountV12022-11-15>= 2.0.0listEnergyInvoicesN/AV0
Get Billing for AccountV12022-11-15>= 2.0.0listEnergyBillings*N/AV0
V22023-11-01>= 2.0.0listEnergyBillings*N/AV1
V3Optional>= 2.0.0listEnergyBillings*V2N/A
Get Bulk BillingV12022-11-15>= 2.0.0listEnergyBillings*N/AV0
V22023-11-01>= 2.0.0listEnergyBillings*N/AV1
V3N/A>= 2.0.0listEnergyBillings*N/ANA
Get Billing for Specific AccountsV12022-11-15>= 2.0.0listEnergyBillings*N/AV0
V22023-11-01>= 2.0.0listEnergyBillings*N/AV1
V3N/A>= 2.0.0listEnergyBillings*N/AN/A

* This operation applies conditional upgrade/downgrade logic. Where a Data Holder holds the data in the newer schema version, it is obliged to return it, and the response should be at the baseline mapping shown above for that obligation date. The upgrade logic is only compliant where the Data Holder does not hold the newer-schema data for that version. For the exact per-version behaviour, see the Data Adapter version to CDR version mapping section on the relevant endpoint page: List Energy Accounts Β· List Billing Transactions.

Shared Responsibility Endpoints​

note

The response data for these endpoints is served by the Secondary Data Holder (AEMO) rather than a dedicated Data Adapter endpoint. However, each call depends on two primary Data Adapter operations being resolved first:

  1. listEnergyAccounts (Request N/A, Response V1) is called to fetch the shared energy accounts and extract their service point IDs.
  2. getFRMPDetails (Request V0, Response V0) is then called to resolve the Financially Responsible Market Participant (FRMP) mapping for each eligible service point.

The resulting FRMP mapping is used to craft the downstream pass-through request to AEMO. See Retrieve FRMP Details for the full call flow. The Data Adapter Dependencies column below lists each prerequisite operation with its accepted request and response versions in the form operation (Request / Response).

CDS EndpointObligation DateSupported CDS Endpoint VersionData Adapter Dependencies
Get Service Points2022-11-01V1listEnergyAccounts β†’ getFRMPDetails
Get Service Point Detail2022-11-01V1listEnergyAccounts β†’ getFRMPDetails
Get Usage for Service Point2022-11-01V1listEnergyAccounts β†’ getFRMPDetails
Get Bulk Usage2022-11-01V1listEnergyAccounts β†’ getFRMPDetails
Get Usage for Specific Service Points2022-11-01V1listEnergyAccounts β†’ getFRMPDetails
Get DER for Service Point2022-11-01V1listEnergyAccounts β†’ getFRMPDetails
Get DER for Specific Service Points2022-11-01V1listEnergyAccounts β†’ getFRMPDetails

Administrative and Support Endpoints​

CDS EndpointSupported CDS Endpoint VersionObligation Date
Metadata UpdateV12020-07-01
Get MetricsV52024-05-13
Register Data Recipient OAuth Client1.14.02021-10-29
Get OAuth Client Registration1.14.02021-10-29
Update Data Recipient Registration1.14.02021-10-29
Delete Data Recipient OAuth Client Registration1.14.02021-10-29
CDR Arrangement Revocation Endpoint1.5.02020-11-01

Register Endpoints​

CDS EndpointSupported CDS Endpoint VersionObligation Date
Get JWKS1.14.02021-10-29
Get Software Product StatusesV22022-11-15
Get Data Recipient StatusesV22022-11-15
Get Data RecipientsV32022-11-15

Back Channel Endpoints​

note

These endpoints do not have a direct mapping CDR Data Standards but their versions may increment based on the evolving requirements of the Data Standards.

Adapter Operation Name (Operation ID)Adapter PathMax CDS VersionAdapter VersionAdapter RequestAdapter Response
Retrieve FRMP Details (getFRMPDetails)POST /devices/nmi/frmpCurrent>= 2.0.0V0V0
Send Notification (sendNotification)POST /notificationCurrent>= 2.0.0V0V0
note

The rows referencing adapter version >= 2.4.0 (Get Account Detail V5 via AdapterBankingAccountV5, Get Transaction Detail V3, and Get Instalment Plans Bulk / for Account) accompany the HaaS Data Adapter API 2.4.0 / DSB Standards 1.36.3 release and are subject to ongoing review by the docs team.