Introduction
The Version Delta tab can be used to see in context changes between this version of the standards and the immediately previous version of the standards.
This text is an example of a new addition to the standards:
+ New text added here
This text is an example of text removed from the standards:
- Old text removed
Note: changes to request and response payloads are listed at the beginning of the relevant API section due to the documentation being auto generated from OpenAPI specification files.
These standards have been developed as part of the Australian Government's introduction of the Consumer Data Right legislation to give Australians greater control over their data.
The Consumer Data Right (CDR) is intended to be applied sector by sector across the whole economy, beginning in the banking, energy and telecommunications sectors. These standards have been developed to facilitate the Consumer Data Right by acting as a specific baseline for implementation.
These standards are maintained by the Data Standards Body (DSB) within Treasury, with the Data Standards Chair as the independent decision maker. The work of standards development is conducted in consultation with the Australian Competition and Consumer Commission (ACCC) and Office of the Australian Information Commissioner) (OAIC) as co-regulators of the Consumer Data Right (CDR).
The standards are required to be published. The obligations on CDR participants to apply the published standards commence on the commencement of the Consumer Data Right rules:
- where the rules require compliance with the standards, non-compliance with the standards may constitute a breach of the rules.
- where the standards are specified as binding standards as required by the Consumer Data Right rules for the purposes of s56FA of the legislation, they apply as under contract between a data holder and an accredited data recipient. The legal effect of binding standards as between data holders and accredited data recipients is fully set out in s56FD and s56FE of the legislation.
Some of these standards will be binding data standards under the Competition and Consumer (Consumer Data Right) Data Standards (No. 1) 2023. See that instrument here. In summary, provisions of these standards (as they exist from time to time) that impose obligations or prohibitions on CDR entities are binding data standards. Provisions included in these standards merely by way of guidance are not binding data standards.
Added CX Guidelines link to side/footer navigation
Version
These standards represent version 1.32.0 of the high level standards. See the versioning section for more information on how versions are managed in the standard.
Interpretation
Note that, in these standards, the key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL are to be interpreted as described in [RFC2119].
Future Dated Obligations
The standards, as published from time to time, may include specific statements indicating that a specific section of the standards will not take effect until a future date or may cease to have effect on some future date.
Please also refer to the Obligation Date Schedule which summarises obligation milestones.
The table below highlights these areas of the standards.
| Section | Description | Applicable Date |
|---|---|---|
| Get Generic Plan Detail V2 |
|
November 1st 2023 |
| Get Energy Account Detail V3 |
|
November 1st 2023 |
| Get Billing For Account V2 |
|
November 1st 2023 |
| Get Bulk Billing V2 |
|
November 1st 2023 |
| Get Billing For Specific Accounts V2 |
|
November 1st 2023 |
| Get Accounts V1 | Data Holders MAY decommission v1 of this end point from March 11th 2024 | March 11th 2024 |
| Get Account Detail V2 | Data Holders MAY decommission v2 of this end point from March 11th 2024 | March 11th 2024 |
| Get Scheduled Payments for Account V2 |
|
March 11th 2024 |
| Get Scheduled Payments Bulk V2 |
|
March 11th 2024 |
| Get Scheduled Payments For Specific Accounts V2 |
|
March 11th 2024 |
| Get Metrics V3 |
|
May 13th 2024 |
| Get Metrics v5 |
|
May 13th 2024 |
| Data Holder Dashboards | Data Holders MUST implement the following CX Standards by July 1st 2024
|
July 1st 2024 |
| Get Billing For Account | Data Holders MAY retire v2 of this endpoint by September 9th 2024 if they implement v3 | September 9th 2024 |
| Get Bulk Billing | Data Holders MAY retire v2 of this endpoint by September 9th 2024 if they implement v3 | September 9th 2024 |
| Get Billing For Specific Accounts | Data Holders MAY retire v2 of this endpoint by September 9th 2024 if they implement v3 | September 9th 2024 |
| Get Generic Plan Detail |
|
November 11th 2024 |
| Get Energy Account Detail |
|
November 11th 2024 |
| Transaction Security Ciphers | Data Holders and Data Recipients MUST only support BCP195 recommended ciphers by March 17th 2025 | March 17th 2025 |
Register Implementation Schedule
The implementation of the Register APIs is managed by the ACCC.
Their implementation schedule is published here.
Endpoint Version Schedule
A table-view of all endpoint versioning is available here.
Normative References
+ Added BCP195 to the list of normative references
- Removed BCP195 from the list of informative references
| Reference | Description | Version |
|---|---|---|
| [BCP195] | Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS): https://tools.ietf.org/html/bcp195 | |
| [DCR] | OAuth 2.0 Dynamic Client Registration Protocol: https://datatracker.ietf.org/doc/html/rfc7591 | July 2015 |
| [FAPI-1.0-Baseline] | Financial-grade API Security Profile 1.0 - Part 1: Baseline: https://openid.net/specs/openid-financial-api-part-1-1_0.html | March 2021 |
| [FAPI-1.0-Advanced] | Financial-grade API Security Profile 1.0 - Part 2: Advanced: https://openid.net/specs/openid-financial-api-part-2-1_0.html | March 2021 |
| [JARM] | Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM): https://bitbucket.org/openid/fapi/src/master/Financial_API_JWT_Secured_Authorization_Response_Mode.md | October 2020 |
| [JSON] | The JavaScript Object Notation (JSON) Data Interchange Format: https://tools.ietf.org/html/rfc8259 | December 2017 |
| [JWA] | JSON Web Algorithms (JWA): https://tools.ietf.org/html/rfc7518 | May 2015 |
| [JWE] | JSON Web Encryption (JWE): https://tools.ietf.org/html/rfc7516 | May 2015 |
| [JWK] / [JWKS] | JSON Web Key (JWK): https://tools.ietf.org/html/rfc7517 | May 2015 |
| [JWS] | JSON Web Signature (JWS): https://tools.ietf.org/html/rfc7797 | February 2016 |
| [JWT] | JSON Web Token (JWT): https://tools.ietf.org/html/rfc7519 | May 2015 |
| [MTLS] | OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens: https://tools.ietf.org/html/rfc8705 | February 2020 |
| [OAUTH2] | The OAuth 2.0 Authorization Framework: https://tools.ietf.org/html/rfc6749 | October 2012 |
| [OIDC] | OpenID Connect Core 1.0 incorporating errata set 1: http://openid.net/specs/openid-connect-core-1_0.html | November 2014 |
| [OIDD] | OpenID Connect Discovery 1.0 incorporating errata set 1: http://openid.net/specs/openid-connect-discovery-1_0.html | November 2014 |
| [PAR] | OAuth 2.0 Pushed Authorization Requests RFC9126: https://tools.ietf.org/html/rfc9126 | September 2021 |
| [PKCE] / [RFC7636] | Proof Key for Code Exchange by OAuth Public Clients: https://datatracker.ietf.org/doc/html/rfc7636 | September 2015 |
| [TDIF] | Digital Transformation Agency - Trusted Digital Identity Framework https://www.digitalidentity.gov.au/tdif | April 2019 |
| [RFC2119] | Key words for use in RFCs to Indicate Requirement Levels https://tools.ietf.org/html/rfc2119 | March 1997 |
| [RFC2397] | The "data" URL scheme: https://tools.ietf.org/html/rfc2397 | August 1998 |
| [RFC3339] | Date and Time on the Internet: Timestamps: https://tools.ietf.org/html/rfc3339 | July 2002 |
| [RFC4122] | A Universally Unique IDentifier (UUID) URN Namespace: https://tools.ietf.org/html/rfc4122 | July 2005 |
| [RFC4627] | The application/json Media Type for JavaScript Object Notation (JSON): https://tools.ietf.org/html/rfc4627 | October 2006 |
| [RFC4648] | The Base16, Base32, and Base64 Data Encodings: https://tools.ietf.org/html/rfc4648 | October 2006 |
| [RFC5322] | Internet Message Format: https://tools.ietf.org/html/rfc5322 | October 2008 |
| [RFC6750] | The OAuth 2.0 Authorization Framework: Bearer Token Usage: https://tools.ietf.org/html/rfc6750 | October 2012 |
| [RFC7009] | OAuth 2.0 Token Revocation: https://tools.ietf.org/html/rfc7009 | August 2013 |
| [RFC7521] | Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants: https://tools.ietf.org/html/rfc7521 | May 2015 |
| [RFC7523] | JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants: https://tools.ietf.org/html/rfc7523 | May 2015 |
| [RFC7662] | OAuth 2.0 Token Introspection: https://tools.ietf.org/html/rfc7662 | October 2015 |
| [RFC8414] | OAuth 2.0 Authorization Server Metadata: https://tools.ietf.org/html/rfc8414 | June 2018 |
| [RFC9126] | OAuth 2.0 Pushed Authorization Requests: https://tools.ietf.org/html/rfc9126 | September 2021 |
Informative References
Improved styling of 'Code samples' displayed in the Non-Normative Examples tab
| Reference | Description |
|---|---|
| [ACCC] | The Australian Competition and Consumer Commission is responsible for accrediting data recipients to participate in CDR, building and maintaining the Register of data recipients and data holders, providing support and guidance to participants and promoting compliance with the CDR rules and standards, including taking enforcement action where necessary. https://www.accc.gov.au/focus-areas/consumer-data-right-cdr-0 |
| [ANZSCO] | ANZSCO - Australian and New Zealand Standard Classification of Occupations : http://www.abs.gov.au/ANZSCO |
| [ANZSIC-2006] | 1292.0 - Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) : http://www.abs.gov.au/anzsic |
| [CDR] | Consumer Data Right: https://www.cdr.gov.au |
| [E.164] | The international public telecommunication numbering plan: http://www.itu.int/rec/T-REC-E.164-201011-I/en |
| [FAPI] | Financial-Grade API - Home Page https://openid.net/wg/fapi/ |
| [OAIC] | The Office of the Australian Information Commissioner is responsible for regulating privacy and confidentiality under the CDR. The OAIC also handles complaints and notifications of eligible data breaches relating to CDR data. https://www.oaic.gov.au/consumer-data-right |
| [RFC3966] | The tel URI for Telephone Numbers: https://tools.ietf.org/html/rfc3966 |
| [RFC7231] | Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content: https://tools.ietf.org/html/rfc7231 |
| [Treasury] | The Treasury leads CDR policy, including development of rules and advice to Government on which sectors the CDR should apply to in the future. The DSB within Treasury is responsible for the creation of the technical standards for the sharing of product and consumer data. https://treasury.gov.au/consumer-data-right |
| [X.1254] | X.1254 - Entity authentication assurance framework: https://www.itu.int/rec/T-REC-X1254-201209-I/en |
High Level Standards
This section contains components of the standards that are foundational and generally applicable.
Principles
The following principles, classified as Outcome Principles, Technical Principles and Consumer Experience (CX) Principles, are the basis for the development of the standards for the Consumer Data Right.
Outcome Principles
These principles articulate qualitative outcomes that the API definitions should seek to deliver.
Outcome Principle 1: APIs are secure
The API definitions will consider and incorporate the need for a high degree of security to protect customer data. This includes the risk of technical breach but also additional concerns of inadvertent data leakage through overly broad data payloads and scopes. The security of customer data is a first order outcome that the API standards must seek to deliver.
Outcome Principle 2: APIs use open standards
In order to promote widespread adoption, open standards that are robust and widely used in the industry will be used wherever possible.
Outcome Principle 3: Data sharing provides a positive consumer experience
The standards will ensure that CDR consumers have simple, informed, and trustworthy data sharing experiences that provide them with positive outcomes over the short and long term.
Outcome Principle 4: APIs provide a good developer experience
To ensure that the entry hurdle for new developers is low the experience of the developers that are building clients using the APIs will be considered. The ability for a developer to easily understand and write code using the APIs in modern development environments should be facilitated by the API standards.
Outcome Principle 5: Standards are consistent across sectors
The standards will strive for consistency in patterns, structure, security mechanisms and user experience across sectors to facilitate the development of customer experiences and services that are able to integrate data from multiple sectors seamlessly and to reduce the cost of customer education for new sectors.
Technical Principles
These principles articulate specific technical outcomes that the API definitions should seek to deliver.
Technical Principle 1: APIs are RESTful
The API standards will adhere to RESTful API concepts where possible and sensible to do so. In particular the concepts of statelessness and resource orientation will be followed.
Technical Principle 2: APIs are implementation agnostic
The underlying implementation of the APIs should not be constrained or driven by the API definitions and standards. Conversely, the underlying implementation choices should not be visible or derivable to the client applications using the APIs.
Technical Principle 3: APIs are simple
As complexity will increase implementation costs for both holders and clients as well as reduce the utility of the APIs, API definitions should seek to be as simple as possible but no simpler.
Technical Principle 4: APIs are rich in capability
As the APIs are defined care should be taken to ensure that the data payloads defined represent rich data sets that can be used in many scenarios, including scenarios not necessarily front of mind during the design process.
Technical Principle 5: APIs are performant
The API definitions should consider and incorporate performance implications during design ensuring that repeated calls are not necessary for simple use cases and that payload sizes do not introduce performance issues.
Technical Principle 6: APIs are consistent
The API definitions across the full suite of APIs should be consistent with each other as much as possible. Where possible common data structures and patterns should be defined and reused.
Technical Principle 7: APIs are version controlled and backwards compatible
As the API definitions evolve care will be taken to ensure the operation of existing clients are protected when breaking changes occur. Breaking changes will be protected by a well-defined version control model and by a policy of maintaining previous versions for a period of time to allow for backwards compatibility.
Technical Principle 8: APIs are extensible
The API definitions and standards should be built for extensibility. This extensibility should accommodate future API categories and industry sectors but it should also allow for extension by data holders to create unique, value add offerings to the ecosystem.
Consumer Experience (CX) Principles
These principles articulate qualitative outcomes for consumer experience that the standards should seek to deliver.
CX Principle 1: The CDR is Consumer-centric
The CDR consumer experience is intuitive and is centred on consumer attitudes, needs, behaviours, and expectations – noting that these may change over time.
CX Principle 2: The CDR is Accessible and Inclusive
A diverse range of people are able to access, use, and comprehend the CDR ecosystem regardless of their background, situation, experience, or personal characteristics.
CX Principle 3: The CDR is Comprehensible
When interacting with the CDR, consumers are able to understand the following:
- who their data is shared with;
- what information is shared;
- when sharing begins and ceases;
- where data is shared to and from;
- why their data is being requested; and
- how they can manage and control the sharing and use of their data.
CX Principle 4: The CDR is Simple and Empowering
- Consumer interactions with the CDR are as simple as possible, but not at the expense of informed consent, consumer control, transparency, privacy, or comprehension.
- Consumers should be encouraged to be privacy conscious without experiencing cognitive loads that lead to disengagement.
- Consumers should also be empowered by the CDR without interactive burdens being placed on them.
CX Principle 5: Consent is Current
- Consent is granted at a point in time and is only as current as the consumer’s original intent.
- Consumer attitudes and behaviours may change over time and be impacted by external events such as the expansion of the CDR or consumer awareness.
- Consent terms should always align to current consumer preferences.
Versioning
The standards have adopted a two level versioning strategy. The high level standards (including principles, Uniform Resource Identifier structure, payload naming conventions, etc) be versioned and each API end point will have an additional version specific to that end point.
Documentation Versioning
Sample versioning of the standards documentation is as follows:
1.12.2 - meaning major version 1, minor version 12 and bugfix version 2
The standards documentation will be versioned using three version parts <major>.<minor>.<bug fix>. This version will be used to describe updates in the Changelog.
Each of the three components will be independently incrementing integers and are described as follows:
- major: Major version of the standards. Reserved for increment only when a set of changes are applied that are large enough to make co-existence in the same implementation environment with previous versions untenable. This would include major changes to the information security profile, major changes to the high level standards or a change in basic protocols.
- minor: Significant changes to the standards. This would include changes that require approval by the Chair of the Data Standards Body such as new end points and new versions of existing end points.
- bug fix: Minor documentation changes that clarify or correct the standards but do not meaningfully alter the standards.
Uniform Resource Identifier (URI) Versioning
The base path structure containing the "version" for this standard is:
https://<holder-path>/cds-au/v<major version>/<industry>
The high level standard will be versioned as described above. The major component of this version will be embedded in the URI Structure for the APIs. This allows for a data holder to support multiple major versions of the standards in production even if the significant breaking changes occur between major versions.
End Point Versioning
Each end point will have multiple versions independent of other end points. A specific end point version will be requested by a client using a HTTP header. This header will be supported by all end points under the API standards. See the section on HTTP Headers for more information on how versions are requested and supplied under the standards.
A table-view of all endpoint versioning is available here.
URI Structure
Some example URIs that meet this standard are:
1. https://www.bank.com.au/api/cds-au/v1/banking/accounts
2. https://www.bank.com.au/api/cds-au/v1/banking/accounts/abc123/transactions/?x=y#bar
3. https://www.bank.com.au/complex/uri/taxonomy/cds-au/v1/banking/products?page=2
4. https://www.energyretailer.com.au/api/cds-au/v1/energy/usage
5. https://www.energyretailer.com.au/api/cds-au/v1/ACME/apply
The holder path for each example is:
1. www.bank.com.au/api
2. www.bank.com.au/api
3. www.bank.com.au/complex/uri/taxonomy
4. www.energyretailer.com.au/api
5. www.energyretailer.com.au/api
The Base Path for each example is:
1. https://www.bank.com.au/api/cds-au/v1/banking
2. https://www.bank.com.au/api/cds-au/v1/banking
3. https://www.bank.com.au/complex/uri/taxonomy/cds-au/v1/banking
4. https://www.energyretailer.com.au/api/cds-au/v1/energy
5. https://www.energyretailer.com.au/api/cds-au/v1/ACME
The Resource Path for each example is:
1. https://www.bank.com.au/api/cds-au/v1/banking/accounts
2. https://www.bank.com.au/api/cds-au/v1/banking/accounts/abc123/transactions
3. https://www.bank.com.au/complex/uri/taxonomy/cds-au/v1/banking/products
4. https://www.energyretailer.com.au/api/cds-au/v1/energy/usage
5. https://www.energyretailer.com.au/api/cds-au/v1/ACME/apply
The URI structure for API end points in the standards MUST be implemented as follows:
uri-string = "https://" <holder-path> "/" cds-au "/" <version> "/" ( <industry> | <HID> ) "/" <resource>The components of this URI structure are described as follows:
- <holder-path> = string. The holder path is a path set by the data holder. It can be any URI desired by the holder. While all authenticated end points must be accessible under the same holder path the data holder may stipulate a different holder path for unauthenticated end points.
- cds-au = "cds-au" string. This is a static string representing the end points defined by the Consumer Data Standards for Australia. This static string allows for separation from other APIs available at the same base holder path and also allows for extension if the standards are adopted by another jurisdiction in whole or in part.
- <version> = "v1" string. The major version of the high level standards. This is not the version of the endpoint or the payload being requested but the version of the overall standards being applied. This version number will be “v” followed by the major version of the standards as a positive integer (e.g. v1, v12 or v76).
- <industry> = banking / energy / telco / common
A static string used to separate APIs for a specific industry. As standards for new industries are defined the list of industry strings will be extended.
Note that the currently accepted values for the
industrycomponent of the Base Path are:- banking = "banking" string. For APIs related to banking and potentially wider financial services data,
- energy = "energy" string. For APIs related to the energy distribution industry,
- telco = "telco" string. For APIs related to telecommunications,
- common = "common" string. For APIs that potentially span industries.
- <HID> = string. The Holder Identifier used to denote extension API categories for a specific holder.
- <resource> = string. The URI for the specific resource requested. This end point URI will be defined as part of the end point definitions for each API group.
Base Path
Base Path is intended to be the portion of the URL up to but not including the endpoint resource. In other words, the base path is the portion of the URL up to and including the <industry> or <HID> component. The Base Path string is defined as follows:
https:// <holder-path> / cds-au / <version> / ( <industry> | <HID> )
Resource Path
The Resource Path is intended to be the portion of the URL including the Base Path and resource location. The Resource Path string is defined as: <base-path> / <resource>.
Resource URIs
Resources that are collections, and members of collections, will follow the JSONAPI.org recommendation.
Under this model, collections, individual members and collection sub-resources would be accessed as follows:
GET …/accounts |
Returns an array of accounts |
GET …/accounts/{id} |
Returns the detail of a specific account |
GET …/accounts/transactions |
Returns the transactions of multiple accounts |
GET …/accounts/{id}/transactions |
Returns the transactions of a specific account |
POST …/accounts |
Create a new account |
POST …/accounts/search |
Returns an array of accounts based on a complex query |
The final example above represents a complex query accessed via a POST request. In this situation the POST URI should be applied to a sub-resource of the collection. A POST to a collection is reserved for the creation of a new collection member.
If no valid sub-resource exists then a dedicated sub-resource should be created, such as the “search” URI listed in the example above.
HTTP Headers
Supported HTTP headers, and their usage, for the standards are as laid out in the following sections.
Request Headers
A sample set of headers requesting version 3 to 5:
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8
x-v: 5
x-min-v: 3
x-fapi-interaction-id: 6ba7b814-9dad-11d1-80b4-00c04fd430c8
x-fapi-auth-date: Thu, 16 Jan 2020 16:50:15 GMT
x-fapi-customer-ip-address: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
x-cds-client-headers: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=A Data Holder must be able to process Content-Type headers in accordance with [RFC7231]. The following would be valid:
Content-Type: application/json;charset=UTF-8
Content-Type: application/json
Content-Type: AppliCAtion/JSon;Charset=uTf-8A Data Holder must be able to process Accept headers in accordance with [RFC7231]. The following would be valid:
Accept: */*
Accept: application/json;charset=UTF-8
Accept: application/json
Accept: AppliCAtion/JSon;Charset=uTf-8
| Header Field | Description | Mandatory? |
|---|---|---|
| Content-Type | Standard HTTP Header. Represents the format of the payload provided in the request. The media type must be set to application/json. Mandatory for PUT and POST calls. |
Conditional |
| Accept | If specified, the media type must be set to application/json, unless otherwise specified in the resource end point standard. If set to an unacceptable value the holder must respond with a 406 Not Acceptable. If not specified, or a wildcard (*/*) is provided, the default media type is application/json. |
Optional |
| x-v | Version of the API end point requested by the client. Must be set to a positive integer. The holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the holder must respond with a 406 Not Acceptable. |
Mandatory |
| x-min-v | Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the holder must respond with a 406 Not Acceptable. |
Optional |
| x-<HID>-v | A holder specific version of extension fields. Should not be used in conjunction with x-min-v. |
Optional |
| x-fapi-interaction-id | An optional [RFC4122] UUID used as a correlation id. If provided, the data holder must "play back" this value in the x-fapi-interaction-id response header. Not required for unauthenticated calls. |
Optional |
| x-fapi-auth-date | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. | Conditional |
| x-fapi-customer-ip-address | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. | Conditional |
| x-cds-client-headers | The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. This header is not required to include:
|
Conditional |
Response headers
| Header Field | Description | Mandatory? |
|---|---|---|
| Content-Type | Standard HTTP Header. Represents the format of the payload returned in the response. Must be application/json unless otherwise specified in the resource end point standard. |
Mandatory |
| Retry-After | Header indicating the time (in seconds) that the client should wait before retrying an operation. The holder should include this header along with responses with the HTTP status code of 429 Too many requests. |
Optional |
| x-v | The version of the API end point that the holder has responded with. | Mandatory |
| x-fapi-interaction-id | An [RFC4122] UUID used as a correlation id. The data holder must set the response header x-fapi-interaction-id to the value received from the corresponding request header or to a new [RFC4122] UUID value if the request header was not provided. This header MUST be responded for success and error responses for authenticated APIs. |
Mandatory |
Additional Headers
Generally understood headers used in HTTP transactions to provide caching guidance and the use of the compression are not specified but are considered acceptable. It is at the discretion of the data holder if these headers are used for a specific implementation. Data holders should not require these headers for successful API access, however.
HTTP Response Codes
The handling and usage of HTTP response codes for the standards will be according to the following table.
| Situation | HTTP Status | Notes | POST | GET | DELETE |
|---|---|---|---|---|---|
| Query completed successfully | 200 OK | Yes | Yes | No | |
| Normal execution. The request has succeeded. | 201 Created | The operation results in the creation of a new resource. | Yes | No | No |
| Delete operation completed successfully | 204 No Content | No | No | Yes | |
| The response is not modified since last call | 304 Not Modified | May be returned if standard caching headers such as ETag or If-modified-since are utilised | Yes | Yes | No |
| Request has malformed, missing or non-compliant JSON body or URL parameters | 400 Bad Request | The requested operation will not be carried out. | Yes | Yes | Yes |
| Authorization header missing or invalid token | 401 Unauthorized | The operation was refused access. Re-authenticating may result in an appropriate token that may be used. | Yes | Yes | Yes |
| Token has incorrect scope or a security policy was violated. | 403 Forbidden | The operation was refused access. Re-authenticating is unlikely to remediate the situation. It is expected that this error will result in an error payload | Yes | Yes | Yes |
| The resource matching the request URI is not known or is unable to be processed due to business logic specific to the resource being requested | 404 Not Found | No indication is given of whether the condition is temporary or permanent. This response code MUST NOT be used for resources presented in the body of the request. | Yes | Yes | Yes |
| The consumer tried to access the resource with a method that is not supported. | 405 Method Not Allowed | Yes | Yes | Yes | |
| The request contained an Accept header other than permitted media types, a character set other than UTF-8 or a version that was not supported | 406 Not Acceptable | Yes | Yes | Yes | |
| The operation was refused because the payload is in a format not supported by this method on the target resource. | 415 Unsupported Media Type | Yes | No | No | |
| The request was well formed but was unable to be processed due to business logic specific to the request | 422 Unprocessable Entity | If applicable to the HTTP method it is expected that this error will result in an error payload | Yes | Yes | No |
| The operation was refused as too many requests have been made within a certain timeframe. | 429 Too Many Requests | Throttling is a NFR. The data holder should include a Retry-After header in the response indicating how long the data consumer must wait before retrying the operation. | Yes | Yes | Yes |
| Something went wrong on the API gateway or micro-service | 500 Internal Server Error | The operation failed. | Yes | Yes | Yes |
| Service is currently unavailable | 503 Service Unavailable | Yes | Yes | Yes | |
| The server was unable to respond in a timely manner | 504 Gateway Timeout | Returned if a timeout has occurred but a resend of the original request is viable (otherwise use 500 instead) | Yes | Yes | Yes |
Payload Conventions
This section of the standard outlines the request and response payload structures for all API end points as well as the naming conventions for fields.
Request Payload Structure
A sample request would be structured as follows:
{
"data": {
...
},
"meta": {
...
}
}
Each API request payload MUST have a JSON object at the root level known as the root object. This object MUST contain a data object to hold the primary data for the request.
The root object will contain a meta object if, and only if, it is specifically REQUIRED by the end point. The meta object is used to provide additional information such as second factor authorisation data, traffic management, pagination counts or other purposes that are complementary to the workings of the API.
The definition of the contents for the data object and meta object will be defined separately for each end point.
Response Payload Structure
A sample successful response:
{
"data": {
...
},
"links": {
"self": "..."
},
"meta": {
...
}
}
A sample unsuccessful response:
{
"errors": [
{
"code": "...",
"title": "...",
"detail": "..."
}, {
"code": "...",
"title": "...",
"detail": "...",
"meta": {
...
}
}
]
}
Each API response payload MUST have a JSON object at the root level known as the root object.
The contents of the root object are as follows:
- If the response is successful (200 OK) the root object:
- MUST contain a
dataobject - MUST contain a
linksobject - MAY contain a
metaobject if REQUIRED by the definition of the specific end point
- MUST contain a
- If the response is unsuccessful (not 200 OK) the root object:
- MAY contain an
errorsobject (as per the specific end point definition)
- MAY contain an
The definition of the contents for the data object and meta object will be defined separately for each end point.
The links object will contain links to related API end points. This will include links to support pagination.
The links object MUST contain a field named self that will have the fully qualified URI to the current request as a value.
The errors object is defined in the Error Codes section.
Field Naming Conventions
Valid Characters In Field Names
All field names defined in either a request or response payload MUST be treated as case sensitive by clients and servers, and they MUST meet all of the following conditions:
- Member names MUST contain at least one character.
- Member names MUST contain only the allowed characters listed below:
- U+0061 to U+007A, a-z
- U+0041 to U+005A, A-Z
- U+0030 to U+0039, 0-9
- Additionally, the following characters are allowed in field names, except as the first or last character:
- U+002D HYPHEN-MINUS, '-'
- U+005F LOW LINE, '_'
- U+0024 DOLLAR SIGN, '$'
Any other character MUST NOT be used in field names.
Field Naming Style
Field names MUST be meaningful names with defined semantics.
Fields representing the same data in different payloads or different parts of a payload MUST have the same name.
Array types SHOULD have plural field names. All other field names SHOULD be singular.
Field names MUST be defined using camel case with the following clarifications:
- If a field name is a single acronym it SHOULD be lowercase
- If a field name contains an acronym along with other words it MAY be uppercase
- The first character in a field name SHOULD be lower case unless it is part of an acronym
Fields MUST NOT be named using reserved javascript tokens.
Maps
For JSON maps (i.e. key/value pairs) any Unicode character MAY be used as a field name and stylistic requirements do not apply.
Field Property Conventions
Field Data Types
Each field defined for the payloads of an end point MUST have an assigned data type.
The list of valid data types are set out in the common field types section. If a custom data type is required for a field then the field SHOULD be classified as a string with a clear description of how the property value is to be interpreted or defined.
Mandatory/Optional Fields
Each field defined for the payloads of an end point MUST have an assigned status of mandatory, optional or conditional.
Mandatory fields MUST be present and have a non-null value in a request or response payload for the payload to be considered valid.
Optional fields MAY be present but this is not guaranteed. It is also valid for these fields to be present but have a null value. Note that optional fields indicate that data may sometimes not be held by a Data Holder and this is an expected scenario.
Conditional fields MUST have an associated conditional statement. If the conditional statement is true in a specific request or response the field is considered mandatory. If the conditional statement is false then the field is considered optional.
Empty/Null Fields
An empty field (ie. a field that is not present in a payload) will be considered equivalent with a field that is present with a null value.
An empty string ("") is not considered to be equivalent to null.
A Boolean value of false is not considered to be equivalent to null. Optional Boolean fields, by implication, have three possible values: true, false and indeterminate (ie. null).
Object conventions
Sample union object structure:
"data": {
[
{
"shapeUType": "circle",
"circle": {
}
},
{
"shapeUType": "square",
"square": {
}
}
]
}
A specific convention will apply to union objects.
In the standards a union object is used in a situation where a set of data can be represented with different sets of fields depending on the context. To maintain strong typing of the fields one of a series of known object structures will be used. An example where this technique is used in the standard is in the definition of account balances where balance information can be represented differently, but unambiguously, for different account types.
For union objects an additional field, with a known suffix, is used to identify the object type that has been provided specifically.
As the name of this field is constant it can be used to perform an indirect lookup on the object type that has actually been provided removing the need to scan for which object is present.
A field of this type will always be specified with the suffix UType meaning Union Type.
Array Conventions
Samples for providing array values:
## Many-values:
"middleNames": ["Geoff", "John"],
"errors": [
{
"code": "...",
"title": "...",
"detail": "..."
}, {
"code": "...",
"title": "...",
"detail": "..."
}
]
## Single-value:
"middleNames": ["Geoff"],
"errors": [
{
"code": "...",
"title": "...",
"detail": "..."
}
]
## Empty array:
"middleNames": [ ],
"errors": [ ]
Unless otherwise stated within the data standards, arrays are explicitly expressed in response payloads.
Mandatory fields
In objects where an array field is defined as having 0..n values, the array field must be explicitly expressed as an array in the payload, even if it only contains one item or is empty.
This applies equally for object arrays. Where a field is defined as an array value, the response should be:
- an array of objects,
- an array of values, or
- an empty array (
[]).
An empty array is the representation for an array equivalent to an empty string.
Optional fields
If the field is optional a null value or omission of the field in the response is accepted.
Normative references
The only exception to this, unless explicitly stated, is normative standards. The requirements for expressing arrays within those normative standards apply per the normative references.
Common Field Types
Updated description of `AmountString` field clarifying the currency format and noting it defaults to AUD
Clarified formatting of RateString type
The following table outlines the common data types for fields used in the standard.
Change to URIString example:
- "http://www.google.com"
+ "https://www.example.com"
| Type | Description | Valid Examples |
|---|---|---|
| String | Standard UTF-8 string but unrestricted in content. Any valid Unicode character can be used. | |
| ASCIIString | Standard UTF-8 string but limited to the ASCII character set. | |
| Boolean | Standard JSON boolean | true false |
| Enum | String representing an option from a defined list of values - All possible values MUST be provided - Values MUST be in all caps - Spaces MUST be replaced with under bars '_' - Values MUST be limited to the ASCII character set |
“OPTION1” “ANOTHER_OPTION” “VAL_ABC_123” |
| NaturalNumber | A natural number (ie. a positive integer inclusive of zero) | 0 1 10000 |
| PositiveInteger | A positive integer (zero excluded) | 1 10000 |
| NegativeInteger | A negative integer inclusive of zero | 0 -1 -10000 |
| Integer | Any positive or negative integer inclusive of zero | 1 0 -1 |
| Number | An integer or decimal number. Can be positive, negative or zero | 0.1 -100.09 10 90.09 |
| Base64 | Base64 encoded string as per [RFC4648] | Q29uc3VtZXIgRGF0YSBSaWdodA== |
| DateTimeString | Combined Date and Time string as per [RFC3339] (labelled date-time in the RFC). As specified in [RFC3339] times MUST be offset relative to UTC | “2007-05-01T15:43:00.12345Z” “2012-12-25T15:43:00-08:00” “1997-01-12T15:43:00.121Z” |
| DateString | Date string as per [RFC3339] (labelled full-date in the RFC) | “2007-05-01” “2012-12-25” |
| TimeString | Time string as per [RFC3339] (labelled full-time in the RFC). As specified in [RFC3339] times MUST be offset relative to UTC | “15:43:00.12345Z” “15:43:00-12:00” |
| CurrencyString | Standard 3 character currency codes as per ISO-4217 | “AUD” “USD” “GBP” |
| RateString | A string representing a percentage (e.g., an interest rate). For example, a rate of 100% would be represented by the value "1" and a rate of -100% by "-1"- At least 1 and up to a total of 16 significant digits before a decimal point - Up to 16 digits following a decimal point if required - No formatting, e.g., thousand-separating commas. |
"0" or "0.0" (0%)"1" or "1.0" (100%)"-1.234567" (-123.4567%)"-0.056" (-5.6%)"0.03456789" (3.456789%)"0.2" (20%)"23.456" (2345.6%) |
| AmountString | A string representing a monetary amount in currency units with fractional units after a decimal point (e.g., if working with Australian dollars: "123.45" for one hundred and twenty-three dollars and forty-five cents). - A positive, zero or negative number - Negative numbers identified with a ‘-‘ prefix - Currency symbols MUST NOT be supplied - At least 1 and up to a total of 16 significant digits before decimal point - Minimum 2 digits following a decimal point (more digits allowable but only if required) - No additional formatting, eg thousand separating commas - Assumed to be in AUD unless specified otherwise |
“0.01” “10.00” “1234567.89” “-1001.23” “1.999” |
| MaskedPANString | Masked credit card number. Lower case ‘x’ MUST be used to mask numbers and only the last four digits MUST be exposed to facilitate identification. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234" |
| MaskedAccountString | Masked bank account number genericised for a variety of account types. MUST be represented as the full account number would normally be represented for display (including formatting) but with all digits except the last four replaced with a lowercase x. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234" "xxx-xxx xxxxx1234" |
| URIString | A valid URI | "https://www.example.com" |
| ExternalRef | The format is defined by an external reference such as ISO standard or an RFC | Swift bank codes using ISO 9362 |
Pagination
Each API end point that can return multiple records will stipulate whether pagination is supported for the end point or not. For end points that will return less than a reasonably sized page of results in the majority of circumstances support for paging may not be included.
Note that the use of paging for an end point does not require or preclude the use of filtering query parameters. It is expected that filtering and paging will be applied independently of each other.
Query Parameters
The consumer will stipulate pagination requirements on the request using query parameters. When paging is supported the consumer MAY provide the following query parameters:
- page – the page number being requested (with the first page being 1)
- page-size – the number of records to return in each page
If the query parameters are not provided the following defaults will be assumed:
- page – a default of 1 (the first page) will be assumed
- page-size – a default of 25 will be assumed
Response Fields
In addition to the data requested a holder MUST provide the following additional information in the response payload:
- In the links object the following fields are to be provided:
- first - A URI to request the first page. Mandatory if this response is not the first page.
- last - A URI to request the last page. Mandatory if this response is not the last page.
- prev - A URI to the previous page. Mandatory if this response is not the first page.
- next - A URI to the next page. Mandatory if this response is not the last page.
- In the
metaobject the following fields are to be provided:- totalRecords - The total number of records in the set. This field MUST be present.
- totalPages - The total number of pages in the set. This field MUST be present. If totalRecords is 0 totalPages MUST be 0.
For each of these fields the page size specified in the request should be assumed when calculating values.
Additional Pagination Rules
- Holders are not expected to implement pagination with transaction isolation. The underlying data-set may change between two subsequent requests. This may result in situations where the same transaction is returned on more than one page.
- A maximum page size of
1000records is assumed for all end points (unless otherwise stipulated in the end point definition). If a page size greater than this maximum is requested then an Invalid Page Size error SHOULD be returned.
Cursor Support
For performance reasons data holders may wish to support other pagination patterns such as cursors or continuation tokens. While the standard does not explicitly support these additional mechanisms it is considered allowable to implement these patterns and expose them via the pagination links.
In this scenario the URIs included in the links for other pages may not be compliant with the standard and may, instead, include other query parameters that support another pagination pattern. It is expected that all other pagination requirements such as link fields and meta fields will still be supported if other patterns are implemented.
To allow for a more performant implementation data consumers are encouraged to utilise pagination links wherever possible and only use constructed URIs for the first page or if random access to a specific set of records is required.
ID Permanence
Within these standards resource IDs are REQUIRED to comply with the following:
- An ID for a resource should only be specified in the API standard if an end point exists to obtain detail for that resource or to change the state of the resource.
- If an ID is specified in the standards for a resource then it is mandatory and MUST be supplied, by the data holder, in accordance with the standards.
- If an ID is specified the ID value MUST be entirely arbitrary and have no inherent meaning. For instance, an ID should not be a combination of other fields or a string that can be parsed to extract meaningful information.
- IDs SHOULD be unique but that uniqueness may be within a clearly bounded context. For example, a beneficiary ID may be unique but only in the context of a specific account. The bounds of uniqueness should be clearly described in the standards definition for the end point.
- IDs MUST be immutable across sessions and consents but MUST NOT be transferable across Data Recipient Software Products. For example, "Data Recipient Software Product "A" obtaining an account ID would get a different result from "Data Recipient Software Product B" obtaining the ID for the same account even if the same customer authorised the access. Under this constraint IDs cannot be usefully transferred between client organisations or data holders.
- IDs MUST NOT be transferable between different customers for the same Data Recipient Software Product. For example, a Data Recipient Software Product should obtain a different ID for a joint account if the ID was obtained independently using authorisations from both customers.
- In payloads the field name of “id” should NEVER be used. Each ID field should be meaningfully named so that wherever that ID is used across multiple end points it always refers to the same ID set. For instance, the IDs for accounts would be represented in JSON in a field named “accountId”.
Error Codes
These standards define a standard list of error codes that Data Recipient Software Products and Data Holders SHOULD or MUST conform to. Further,
- Data Recipient Software Products and Data Holders SHOULD use the standard error codes as defined
- Where a specific error code MUST be responded, this requirement is stated against the applicable error code or API endpoints
- Where a specific error code MAY be responded, this requirement is stated against the applicable error code or API endpoints
- Data Recipient Software Products and Data Holders MAY respond with application-specific error codes and in doing so, MUST respond with the
MetaError » urnfield populated with the standard CDR error code.
Error Response Structure
Non-Normative Example
{
"errors": [
{
"code": "urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount",
"title": "Unavailable Banking Account",
"detail": "808b5b1d-0798-4bdf-a3c8-f9cce2904eb2"
}
]
}
The errors object will be an array of zero or more unnamed objects. The fields in each of these objects will be as follows:
codefield MUST be present: holds an end point specific error code. This MAY be a standard CDR error code or an application-specific error code.titlefield MUST be present: holds a human readable label of the error that is constant percodedetailfield MUST be present: holds a human readable description of this specific errorisSecondaryDataHolderErrorfield MAY be present: an optional Boolean flag which indicates the error is propagated from a designated secondary data holdermetaobject MAY be present: holds additional end point specific data relevant to the error
If a Data Recipient Software Product or Data Holder responds with an application-specific error code, the standard CDR URN error code MUST be provided in the MetaError object.
URN Structure
When responding with a standard CDR error code, the URN structure is defined as follows:
urn-string = "urn:" NID ":" metatype ":" sub-type ":" error-category "/" error-code
- NID = "au-cds" string.
- metatype = "error" string.
- sub-type = cds-all / cds-register / cds-banking / cds-energy
- cds-all = "cds-all" string. An error code common to all API responses,
- cds-register = "cds-register" string. Reserved for CDR Register issued error codes only,
- cds-banking = "cds-banking" string. An error code specific to the CDR banking APIs only,
- cds-energy = "cds-energy" string. An error code specific to the CDR energy APIs only.
- error-category = string. The high-level category code for the error defined in the Consumer Data Standards
- error-code = string. The specific error encountered, defined in the Consumer Data Standards
Standard Error Codes
A list of standard error codes to help categorise an error response. The applicable HTTP response code is also given.
General Errors
Non-Normative Example
# A request to a Data Holder extension API is made where an application-specific error is returned
#
# Request
POST https://data.acme.com.au/cds-au/v1/banking/ACME-new-loan-application HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-ACME-v : 7
# Response
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"errors": [
{
"code": "ACME-APPLY-017",
"title": "Application Is Missing Product ID",
"detail": "A new loan application was requested but the product ID was not provided",
"meta": {
"urn": "urn:au-cds:error:cds-all:GeneralError/Expected"
}
}
]
}
400 Bad Request Errors
Non-Normative Example
# A request to Get Accounts is made however
# the value of is-owned is not a Boolean value
#
# Request
GET https://data.holder.com.au/cds-au/v1/banking/accounts?is-owned=2007-05-01 HTTP/1.1
Host: data.holder.com.au
Accept: application/json
# Response
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"errors": [
{
"code": "urn:au-cds:error:cds-all:Field/Invalid",
"title": "Invalid Field",
"detail": "is-owned"
}
]
}
| Error Title | Error Code | Description |
|---|---|---|
| Missing Required Field | urn:au-cds:error:cds-all: |
The request is missing a mandatory field required for the API. It MAY be a missing query parameter or missing field in the request payload. This error code can be used, where a more specific validation error is not applicable. The error detail SHOULD be the parameter name of the missing field.This error code MUST be supported for unauthenticated and authenticated APIs. |
| Missing Required Header | urn:au-cds:error:cds-all: |
A required HTTP header has not been provided. The error detail SHOULD be the HTTP header name.This error code SHOULD be supported for unauthenticated and authenticated APIs. |
| Invalid Field | urn:au-cds:error:cds-all: |
Applies when the value of the URL parameter or request body parameter is an invalid type or the value violates the field's constraints as defined by the interface contract. For example, is-owned is a Boolean but a DateString value is provided.The error detail SHOULD be the parameter name of the invalid field. The error detail MAY include further details explaining the valid format.This error code MUST be supported for unauthenticated and authenticated APIs. |
| Invalid Header | urn:au-cds:error:cds-all: |
Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards. The error detail SHOULD be the HTTP header name. The error detail MAY include further details explaining the valid format.This error code SHOULD be supported for unauthenticated and authenticated APIs. |
| Invalid Date | urn:au-cds:error:cds-all: |
An invalid date is provided. For example, a future date value is expected, but a date in past or current date is supplied. Applies to DateTimeString, DateString, and TimeString field types.The error detail SHOULD be the parameter name of the invalid date field. The error detail MAY include further details explaining the expected date value.This error code MUST be supported for unauthenticated and authenticated APIs. |
| Invalid Page Size | urn:au-cds:error:cds-all: |
The value provided in the page-size pagination field is greater than the maximum allowed by the Consumer Data Standards (page-size > 1000).This error code MUST be supported for unauthenticated and authenticated APIs. |
| Invalid Version | urn:au-cds:error:cds-all: |
A request is made for a version that is not a PositiveInteger.For example:
This error code MUST be supported for unauthenticated and authenticated APIs. If the version header is a PositiveInteger but is not a version supported by the Data Holder, the Unsupported Version code applies. |
403 (Forbidden) Errors
404 (Not Found) Errors
Non-Normative Examples
# A request to a resource endpoint that does not exist
#
# Request
GET https://data.holder.com.au/cds-au/v1/banking/payments/294819e6-7ae0-4e20-900a-6a733fd97854/location HTTP/1.1
Host: data.holder.com.au
Accept: application/json
# Response
HTTP/1.1 404 Not Found
Content-Type: application/json
{
"errors": [
{
"code": "urn:au-cds:error:cds-all:Resource/NotFound",
"title": "Resource Not Found"
}
]
}
# A request to a resource endpoint that exists in the data standards,
# but is not currently implemented
#
# Request
POST https://data.holder.com.au/cds-au/v1/admin/register/metadata HTTP/1.1
Host: data.holder.com.au
Accept: application/json
# Response
HTTP/1.1 404 Not Found
Content-Type: application/json
{
"errors": [
{
"code": "urn:au-cds:error:cds-all:Resource/NotImplemented",
"title": "Resource Not Implemented"
}
]
}
#
# A request to a resource that is temporarily unavailable
#
# Request
GET https://data.holder.com.au/cds-au/v1/banking/accounts/b3f0c9d0/transactions/52e443ae13c5 HTTP/1.1
Host: data.holder.com.au
Accept: application/json
# Response
HTTP/1.1 404 Not Found
Content-Type: application/json
{
"errors": [
{
"code": "urn:au-cds:error:cds-all:Resource/Unavailable",
"title": "Unavailable Resource",
"detail": "52e443ae13c5"
}
]
}
#
# A request to a get a banking account that is invalid
#
# Request
GET https://data.holder.com.au/cds-au/v1/banking/accounts/invalid-id/ HTTP/1.1
Host: data.holder.com.au
Accept: application/json
# Response
HTTP/1.1 404 Not Found
Content-Type: application/json
{
"errors": [
{
"code": "urn:au-cds:error:cds-banking:Authorisation/InvalidBankingAccount",
"title": "Invalid Banking Account",
"detail": "invalid-id"
}
]
}
406 (Not Acceptable) Errors
422 (Unprocessable Entity) Errors
Non-Normative Example
#
# A bulk request to a get a banking account that is unavailable
#
# Request
POST https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
Host: data.holder.com.au
Accept: application/json
{
"data": {
"accountIds": [
"b3f0c9d0-457d-4578-b0cd-52e443ae13c5",
"b1bccd84-d29a-4233-8e44-be01c74eb85b"
]
},
"meta": {}
}
# Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
{
"errors": [
{
"code": "urn:au-cds:error:cds-all:Authorisation/UnavailableBankingAccount",
"title": "Unavailable Banking Account",
"detail": "b3f0c9d0-457d-4578-b0cd-52e443ae13c5"
}
]
}
CDR Register Errors
The following error codes apply to responses from the CDR Register. Data Recipient Software Product and Data Holder clients requesting data from the CDR Register MAY expect the following standard CDR error codes to be encountered:
Processing Errors
When a server encounters multiple problems for a single request, the most generally applicable HTTP error code SHOULD be used in the response. For instance, 400 Bad Request might be appropriate for multiple 4xx errors or 500 Internal Server Error might be appropriate for multiple 5xx errors.
A server MAY choose to stop processing as soon as a problem is encountered, or it MAY continue processing and encounter multiple problems. For instance, a server might process multiple attributes and then return multiple validation problems in a single response.
Extensibility And Application Specific Errors
Error handling has been designed with extensibility in mind. Where an application supports error codes specific to that implementation, it is intended that implementations can extend the standard CDR error codes with application-specific error responses whilst maintaining interoperability for clients.
Non-Normative Example
# Application-specific error code extends a standard CDR error code with
# details specific to the Data Holder
{
"errors": [
{
"code": "acme-bank:JointAccountElectionRemoved",
"title": "Joint Account Consent Election Is Removed",
"detail": "Description of the specific error encountered",
"meta": {
"urn": "urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount"
}
}
]
}
To assist clients, the Data Recipient Software Product or Data Holder MUST provide the application-specific error code in the ResponseErrorListV2 » code and the standard CDR error code in the ResponseErrorListV2 » MetaError » urn field denoting the standard error code the implementation extends.
Transition arrangements
Non-Normative Examples
# Application-specific error code before transition
{ "errors": [
{
"code": "old error code",
"title": "error message",
"detail": "Description of the specific error encountered"
}
] }
# Application-specific error code during transition
{ "errors": [
{
"code": "old error code",
"title": "error message",
"detail": "Description of the specific error encountered",
"meta": {
"urn": "urn:au-cds:error:cdr-all:Header/UnsupportedVersion"
}
}
] }
# Standardised-error code after retirement of application-specific error code
{ "errors": [
{
"code": "urn:au-cds:error:cdr-all:Header/UnsupportedVersion",
"title": "Unsupported Version",
"detail": "'x-v' **MUST** be greater than or equal to '2'"
}
] }
If Data Recipient Software Products or Data Holders support custom error codes prior to February 1st 2022, the following transition arrangements apply:
Effective as soon as standardised error codes are supported by the Data Recipient Software Product or Data Holder:
- If the Data Recipient Software Product or Data Holder supports application-specific error codes they MUST publish a mapping of those codes to the standard CDR error codes in a developer friendly way that is discoverable and freely available.
- Data Recipient Software Products and Data Holders MAY publish this mapping any time prior to February 1st 2022.
Effective from February 1st 2022: Data Holders and Data Recipient Software Products MUST support standardised error codes by this date and continue to support any custom error codes.
- Standardised error codes MUST be provided in the
ResponseErrorListV2 » MetaError » urnfield - If applicable, application specific error codes MUST be provided in the
ResponseErrorListV2 » code - Data Recipient Software Products and Data Holders MAY phase their transition to support standardised error codes such as by endpoint or per error code if preferred prior to this date.
- Standardised error codes MUST be provided in the
Effective from November 1st 2022: Data Holders and Data Recipient Software Products MAY deprecate any custom error codes
- Standardised error codes MAY be provided in the
ResponseErrorListV2 » codefield if no application-specific error code applies - Application-specific error codes MAY be provided in the
ResponseErrorListV2 » code
- Standardised error codes MAY be provided in the
Extensibility
The Consumer Data Right standards will not cover all possible data sets or APIs that participants may wish to expose. Participants may also wish to innovate on top of the API standards by offering additional data to meet specific market opportunities. It is desirable that the standards not only allow for this to occur but actively encourage it with specific additions to the standards to enable such extension.
At the same time, it is important that a participant seeking to provide extensions does not hinder a data consumer that is only built for the published standards.
To accommodate these concerns the standards incorporate the following considerations specifically related to extension by data holders.
The three types of extension that the standards address are:
- Data holder offering entirely new API categories that are not covered by the API Standards
- Data holder offering additional end points to an API category that is already covered by the standards
- Data holder offering additional fields to the response payloads for an end point defined in the standards
Holder Identifier
For example, the prefixes for the four major Banks included in the first phases of implementation would be:
- CBA – Commonwealth Bank
- WBC – Westpac Banking Corporation
- ANZ – ANZ Banking Group
- NAB – National Australia Bank
Data holders seeking to extend the standards MUST nominate a prefix to identify all extensions. Extended fields and end points and would use this prefix consistently. This prefix would be, by preference, the ASX symbol for the holder. Care should be taken not to use a prefix already adopted by another holder in the regime.
In these standards, where a Holder Identifier would be included, the term <HID> will be used.
New API Categories
When extending by adding new API categories a holder MUST add these to the overall URI structure by substituting the industry element with the Holder (Provider) ID.
For instance, the standard URI base path is structured as:
https:// <holder-path> / cds-au / <version> / <industry> / <resource>
For the extension API categories for a specific holder they would be structured as:
https:// <holder-path> / cds-au / <version> / <HID> / <resource>
The end points defined under this structure, including the payloads of these end points do not need to be prefixed in any way. The fact that they are underneath the holder section implies that they are additional to the standard.
Note that:
- This mechanism MUST NOT be used to create modified duplicates of the end points defined in the API Standards
- The end points in this area MUST comply with the standard's conventions and principles including naming conventions and data types.
New End Points In Existing API Categories
When creating new end points that are in parallel to existing API categories in the standard the Holder Identifier MUST be used to prefix the highest URI element where divergence occurs.
For example, assume an existing balance end point is defined as follows:
<base-path>/accounts/{account ID}/transactions
and the holder wishes to add an end point that summarises balance movement for a specific time period then they may define the end point as:
<base-path>/account/{account ID}/<HID>-balance-movement
Note that:
- The prefix is defined as the Holder Identifier followed by a hyphen.
- As the entire end point is new, the request and payload fields do not need to be prefixed in any way.
- Care should be taken to ensure there is no collision with an end point defined in the standards by specifying an extension at the same level as a variable URI element (such as at the same level of the {account ID} in the example above).
- If an end point has multiple levels in the resource path only the highest point where divergence with the standard occurs needs to be prefixed.
- The new end point MUST comply with standard's conventions and principles including naming conventions and data types.
Additional Fields In An Existing Response Payload
When adding a new field in an existing payload the field can be added to the JSON by prefixing the string <HID>-.
If an object is being added as an extension only the highest level object name needs to be prefixed. Any fields inside the extended object can be named normally.
Note that:
- Existing fields MUST NOT be modified in any way. This includes adding new enumeration values to enum type fields.
- A mandatory field MUST NOT be made optional as the result of an extension.
- Request payloads can also be extended but the resulting end point should still execute successfully if the extension field is not present (by implication, extension fields in request payloads MUST be optional).
- New query parameters MAY be added along the same lines as a new field in a request payload (i.e. prefixed, non-mandatory and no side effects if not present).
- New headers MAY be added along the same lines as a new field in a request payload with the exception that the new header should be prefixed
x-<HID>-. - New fields MUST comply with the naming conventions and data type standards used.
Additional Query Parameters
When adding support for a new query parameter to an existing end point that a data consumer is expected to supply, the new parameter should be prefixed by the string <HID>- to avoid potential collision with extension by another data holder.
Extension Versioning
As described previously in the versioning section the standard provides for multiple versions of each API end point. This implies the need for extensions to also be versioned.
An optional header x-<HID>-v will be supported for all end points that can be used by the data consumer to request a specific version of extension fields to include in the response. See the section on HTTP Headers for more information on the use of this header.
Consumer Experience
The Consumer Experience (CX) Standards contain requirements for the creation of implementations by both Data Recipients and Data Holders. The full list of CX Standards can be found below.
The CX Guidelines provide examples and recommendations for how to implement key rules and standards that relate to the consumer experience. They can be accessed along with additional CX commentary from the CX Guidelines page.
Data Language Standards: Common
Example of data language standards presented in a consumer-facing interaction, where [1] refers to Data cluster language, and [2] refers to Data permission language.
In accordance with CDR Rule 8.11 (1)(d), a data standard must be made to provide descriptions of the types of data to be used by CDR participants in making and responding to requests. Adherence to this language will help ensure there is a consistent interpretation and description of the consumer data that will be shared across different CDR implementations.
| Area | CX Standard |
|---|---|
| Data Language Standards: Language to be used | Data Recipients and Data Holders MUST use data language standards to describe data clusters and permissions in consumer-facing interactions. See the Banking Language section for language to be used when requesting banking data; and the Energy Language section for language to be used when requesting energy data. Data language standards MUST be used when CDR data is being requested, reviewed, or access to such data is withdrawn. Data Recipients and Data Holders MUST use the appropriate data standards language for business consumers as denoted with an '*' for the relevant data. Data Recipients and Data Holders SHOULD expand on the proposed language where appropriate to communicate further details of what is being shared. Additional details MAY include additional information in context, such as in-line help or tool tips, and/or additional permissions where they may exist. Examples of permission details that MAY be used and provided as in-line help are denoted with an '†' for the relevant data. |
| Data Language Standards: Detailed scope requests | If a scenario requires it, Data Holders and Data Recipients MUST merge and amend Basic and Detailed data cluster and permission language to show that Detailed scopes include Basic data. Data Holders and Data Recipients MUST use the alternative language denoted with an '‡' for the relevant scope(s). See the Banking Language section for banking data and the Energy Language section for energy data. Example: A Data Recipient presents the Detailed data cluster in a data request to a consumer, but does not present the Basic data cluster. The Detailed scope includes Basic data, but this is not apparent to the consumer based on the data cluster language and permissions used for the Detailed scope. |
Customer Language: Common
See below for the customer data language standards, which are common across all sectors.
Individual Consumer
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Name and occupation | Name Occupation |
common:customer.basic:read |
| Contact Details | Phone; Email address; Mail address; Residential address; |
common:customer.detail:read |
| Name, occupation, contact details ‡ | Name; Occupation; Phone; Email address; Mail address; Residential address; |
common:customer.detail:read |
Business consumer
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Organisation profile * | Agent name and role; Organisation name; Organisation numbers (ABN or ACN);† Charity status; Establishment date; Industry; Organisation type Country of registration; |
common:customer.basic:read |
| Organisation contact details * | Organisation address; Mail address; Phone number; |
common:customer.detail:read |
| Organisation profile and contact details *‡ | Agent name and role; Organisation name; Organisation numbers (ABN or ACN),† Charity status; Establishment date; Industry; Organisation type; Country of registration; Organisation address; Mail address; Phone number; |
common:customer.detail:read |
Profile Scope and Standard Claims: Common
In accordance with [OIDC] section 5.4 and section 5.5, this language refers to the [OIDC] profile scope and request of individual claims for the authenticated End-User.
| Data cluster language | Permission language |
Authorisation Scopes | Required |
|---|---|---|---|
| Name | Full name and title(s) | OIDC Profile scope or one or more of these standard [OIDC] claims*:namegiven_namefamily_nameupdated_at*See 5.4. Requesting Claims using Scope Values on the OIDC website for more information. |
Required |
| Contact Details | Phone number; Email address; Mail address; |
One or more of these standard [OIDC] claims*:emailemail_verifiedphone_numberphone_number_verifiedaddress*See 5.4. Requesting Claims using Scope Values on the OIDC website for more information. |
Optional |
Note: For non-individual consumers, claims available via the profile scope will only return the details of the authenticated End-User and not the organisation or non-individual consumer.
Banking Language
Banking Accounts
See below for the data language standards for the banking account scopes:
| Data cluster language | Permission language |
Authorisation Scopes |
|---|---|---|
| Account name, type and balance | Name of account; Type of account; Account balance; |
bank:accounts.basic:read |
| Account numbers and features | Account number; Interest rates; Fees; Discounts; Account terms; Account mail address; |
bank:accounts.detail:read |
| Account balance and details‡ | Name of account; Type of account; Account balance; Account number; Interest rates; Fees; Discounts; Account terms; Account mail address; |
bank:accounts.detail:read |
Transactions
See below for the data language standards for the banking transactions scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Transaction details | Incoming and outgoing transactions; Amounts; Dates; Descriptions of transactions; Who you have sent money to and received money from; (e.g. their name)† |
bank:transactions:read |
Regular Payments
See below for the data language standards for the regular payments scope:
| Data cluster language | Permission language |
Authorisation Scopes |
|---|---|---|
| Direct debits and scheduled payments | Direct debits; Scheduled payments; |
bank:regular_payments:read |
Payees
See below for the data language standards for the payees scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Saved payees | Names and details of accounts you have saved; (e.g. their BSB and Account Number, BPAY CRN and Biller code, or NPP PayID)† | bank:payees:read |
Energy Language
Energy Accounts
See below for the data language standards for the energy accounts scopes:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Accounts and plans | Account and plan information; | energy:accounts.basic:read |
| Account and plan details | Account type; Fees, features, rates, and discounts; Additional account users; |
energy:accounts.detail:read |
| Account and plan details ‡ | Account and plan information; Account type; Fees, features, rates, and discounts; Additional account users; |
energy:accounts.detail:read |
Concessions
See below for the data language standards for the concession scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Concessions and assistance | Concession type; Concession information; |
energy:accounts.concessions:read |
Payments
See below for the data language standards for the payments schedule scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Payment preferences | Payment and billing frequency; Any scheduled payment details; |
energy:accounts.paymentschedule:read |
Billing
See below for the data language standards for the billing scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Billing payments and history | Account balance; Payment method; Payment status; Charges, discounts, credits; Billing date; Usage for billing period; Payment date; Invoice number; |
energy:billing:read |
NMI Standing Data
See below for the data language standards for the NMI standing data scopes:
| Data cluster language | Permission language |
Authorisation Scopes |
|---|---|---|
| Electricity connection | National Meter Identifier (NMI); Customer type; Connection point details; |
energy:electricity.servicepoints.basic:read |
| Electricity meter | Supply address; Meter details; Associated service providers; |
energy:electricity.servicepoints.detail:read |
| Electricity connection and meter ‡ | National Meter Identifier (NMI); Supply address; Customer type; Connection point details; Meter details; Associated service providers; |
energy:electricity.servicepoints.detail:read |
Distributed Energy Resources (DER)
See below for the data language standards for the Distributed Energy Resources (DER) scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Energy generation and storage | Generation information; Generation or storage device type; Device characteristics; Devices that can operate without the grid; Energy conversion information; |
energy:electricity.der:read |
Electricity Usage
See below for the data language standards for the electricity usage scope:
| Data cluster language | Permission language | Authorisation Scopes |
|---|---|---|
| Electricity usage | Usage; Meter details; |
energy:electricity.usage:read |
Accessibility Standards
| Area | CX Standard |
|---|---|
| Accessibility | At a minimum, all CDR participants MUST seek to comply with the following accessibility guidelines throughout the Consent Model. These standards SHOULD be assessed, tested, and refined further by accessibility consultants directly involved in implementation. |
| Accessibility Content distinction |
Data Recipients and Data Holders MUST seek to have all aspects of the Consent Model comply with WCAG 1.4. This will make it easier to see and hear content, including separate foreground information from the background. |
| Accessibility Keyboard functionality |
Data Recipients and Data Holders MUST seek to have all aspects of the Consent Model comply with WCAG 2.1. This will make all functionality available from a keyboard. |
| Accessibility Pointer interactions |
Data Recipients and Data Holders MUST seek to have all aspects of the Consent Model comply with WCAG 2.5. This will make it easier to operate functionality using various input devices |
| Accessibility Reading experiences |
Data Recipients and Data Holders MUST seek to have all aspects of the Consent Model comply with WCAG 3.1. This will make text content readable and understandable |
| Accessibility Input assistance |
Data Recipients and Data Holders MUST seek to have all aspects of the Consent Model comply with WCAG 3.3. This will help users avoid and correct mistakes. |
Consent Standards
| Area | CX Standard |
|---|---|
| Consent: Amendment of Collection Consents and Authorisations |
When notifying a Data Holder of an amended collection consent as per rules 4.18C or 4.20S, Data Recipients MUST supply the relevant CDR Arrangement ID to the Data Holder according to Specifying an existing arrangement. Providing the CDR Arrangement ID is necessary to trigger the Data Holder authorisation flow simplifications outlined in the Amending Authorisation Standards. Failure to supply the CDR Arrangement ID will result in the full authorisation flow and a disconnected data sharing arrangement history on consumer dashboards. |
| Consent: Redirection |
Data recipients MUST notify consumers of redirection prior to authentication. |
| Business consumer statement: Method | When seeking a business consumer statement, data recipients MUST invite the business consumer to give the business consumer statement in a manner that is explicit, express, and through an active selection or declaration. The giving of a business consumer statement MUST be clearly separated from any other interaction or information provided to the consumer and MUST NOT be implied or bundled with any other permission. |
| Business consumer statement: Content | Data recipients MUST use plain and concise language when inviting a consumer to give a business consumer statement. |
| Disclosure consent: Collection source |
In the course of seeking a consumer’s consent to disclose data as part of a disclosure consent:
|
| Disclosure Consent: Descriptions of Data to be Collected and Disclosed | If:
|
Disclosure Consent: Insight Descriptions
The standards in this section outline insight description requirements that apply where an insight disclosure consent is being sought and may also feature in CDR Receipts and Dashboards. These standards do not alter any existing rules obligations for CDR receipts or dashboards.
Note: The use of the term ‘data recipients’ to refer to accredited data recipients is consistent with the data standards nomenclature. Where these standards refer to ‘data recipient’, this should not be taken to mean a non-accredited person or trusted adviser.
| Area | CX Standard |
|---|---|
| Insight disclosure: Insight comprehension |
Data recipients MUST use plain and concise language to describe what an insight would reveal or describe. Where possible and practical, the actual insight SHOULD be displayed to the consumer prior to the insight being disclosed. Where it is not possible to display the actual insight, accredited data recipients SHOULD include an example of the insight that demonstrates what the insight may reveal or describe. Accredited data recipients SHOULD make clear that any such examples are hypothetical. |
| Insight disclosure: Insight timing |
Data recipients MUST specify the period the insight will refer to and MAY note when the insight will be or is expected to be generated. |
| Insight disclosure: Purpose of insight |
Data recipients SHOULD explain the purpose of generating the insight. |
| Insight disclosure: Insight generation |
Data recipients MAY explain how the insight will be generated using plain and concise language, which MAY include:
|
Disclosure Consent: Non-Accredited Person Disclosure Notification
The standards in this section outline requirements that apply when a disclosure consent is being sought to disclose data to a non-accredited person, which includes insight disclosure consents, business consumer disclosure consents, and trusted adviser disclosure consents.
These standards will feature where such a disclosure consent is being sought and may, as stated in any accompanying notes, also feature in CDR Receipts and Dashboards.
Note: The use of the term ‘data recipients’ to refer to accredited data recipients is consistent with the data standards nomenclature. Where these standards refer to ‘data recipient’, this should not be taken to mean a non-accredited person or trusted adviser.
| Area | CX Standard |
|---|---|
| Disclosure consent: CDR protections |
Data recipients MUST state that data disclosed to a non-accredited person will not be regulated as part of the Consumer Data Right. This information SHOULD be immediately viewable by the consumer without further interaction. Data recipients MAY include a plain and concise explanation of what this means, which MAY include information on the Consumer Data Right, and MAY include a link to the Office of the Australian Information Commissioner guidance on the Consumer Data Right. |
| Disclosure consent: Review |
Data recipients MUST advise the consumer to review how the non-accredited person will handle their data. |
| Disclosure consent: Data handling |
If available, data recipients MAY include a link to any relevant data handling policies of the non-accredited person, such as their Privacy Policy. |
| Disclosure consent: Complaints |
Data recipients MUST provide plain and concise information on dispute resolution and making a complaint. This SHOULD reflect the process and information contained in the data recipient’s CDR policy related to complaints. This MAY also include a link to the accredited data recipient’s CDR policy. |
| Disclosure consent: Insight records |
When seeking an insight disclosure consent, data recipients MUST provide instructions for how the consumer can access further records, including the actual insights (as per Rules 1.14 and 9.5). |
| Disclosure consent: Notification record |
Data recipients MUST provide the information contained in the disclosure notification otherwise than in the consent flow. This SHOULD be contained in the consumer’s CDR Receipt. This SHOULD also be accessible in the consumer dashboard as part of the data sharing arrangement details. Note 1: The information to be included is limited to the following standards: CDR Protections; Review; Data Handling; Complaints; and Insight Records. The scope of information to include will depend on the accredited person’s specific implementation. Note 2: This standard does not alter any existing rules obligations for CDR receipts or dashboards. |
Authentication Standards
| Area | CX Standard |
|---|---|
| Authentication: 'One Time Password' (OTP) |
Data Holders and Data Recipients MUST clearly refer to a "One Time Password" in consumer-facing interactions and communications. The use of the term "One Time Password" MAY be presented alongside an existing term used by a data holder (e.g. Netcode, one time pin etc.). |
| Authentication: Passwords |
Data Holders and Data Recipients MUST state in consumer-facing interactions and communications that services utilising the CDR do not need access to consumer passwords for the purposes of sharing data. The exact phrasing of this is at the discretion of the Data Holder and Data Recipient. |
| Authentication: Password link |
Data Holders MUST NOT include forgotten details links in redirect screens. The inclusion of such links is considered to increase the likelihood of phishing attacks. |
| Authentication: OTP expiry |
Data Holders MUST communicate the expiry period of the OTP to the consumer in the authentication flow. |
Authorisation Standards
| Area | CX Standard |
|---|---|
| Authorisation: Account selection |
Data holders MUST allow the consumer to select which of their accounts to share data from if the data request includes account-specific data and if there are multiple accounts available. The Data holder MAY omit this step if none of the data being requested is specific to an account (e.g. Saved Payees). |
| Authorisation: Account selection functionality |
Data holders MAY include additional functionality to support account discovery and selection where further navigation or interaction is required to view all accounts. This may, for example, include search, sort, filter, scroll, grouping, and pagination, or other controls in line with existing consumer experiences. Any such functionality MUST NOT introduce unwarranted friction. Note: Unwarranted friction should have regard to CDR Rule 4.24 and is considered to include the addition of any requirements beyond normal data holder practices for an equivalent account selection process. |
| Authorisation: Profile selection |
Data holders MAY add a 'profile selection' step or equivalent prior to the account selection step if a single identifier provides access to different customer accounts. For example, one customer ID may give access to business customer and individual customer accounts. The 'profile selection' step SHOULD only be considered if it is an existing customer experience, and SHOULD be as minimal as possible to avoid introducing unwarranted friction (having regard to CDR Rule 4.24). |
| Authorisation: Account confirm |
Data holders MUST show which accounts the data is being shared from prior to confirming authorisation if the data request includes account-specific data. The data holder MAY omit this information if none of the data being requested is specific to an account (e.g. Saved Payees). |
| Authorisation: Pending status |
Where an account requires further actions or approvals before data can be disclosed, data holders MUST indicate this to the user visually and MUST provide an explanation of what is required or expected. This MAY, for example, be achieved with a visual icon to indicate that the account is 'pending'. This indication MUST be accompanied by an in-context explanation to describe what the status means. This explanation SHOULD include any required actions and any specified time frames. |
| Unavailable Accounts: Displaying accounts |
If certain accounts are unavailable to share, data holders SHOULD show these unavailable accounts in the account-selection step. Data holders SHOULD communicate why these accounts cannot be selected, and this SHOULD be communicated as in-line help or as a modal to reduce on-screen content. Data holders MAY provide instructions on how to make these accounts available to share, and this SHOULD be communicated as in-line help or as a modal to reduce on-screen content. Note: Unavailable accounts are to be interpreted in accordance with the rules on eligible consumers and required consumer data. |
| Unavailable Accounts: No accounts can be shown |
If unavailable accounts cannot be shown in the account selection step, data holders MAY display a generic explanation and instructions. |
| Unavailable Accounts: Authorisation not permitted |
If a successfully authenticated user cannot proceed to establish an authorisation in accordance with the rules on eligible consumers and required consumer data, data holders MAY provide the option of concluding the authorisation process. |
| Unavailable Accounts: Request sharing rights |
If a user does not have sharing rights for a particular account or set of accounts, data holders MAY invite the user to request sharing rights from the authorisation flow. The presentation of this mechanism MUST NOT introduce unwarranted friction as defined in rule 4.24 on restrictions. |
Amending Authorisation Standards
| Area | CX Standard |
|---|---|
| Authorisation: Amending consent |
The following standards apply when a Data Holder invites a CDR consumer to amend a current authorisation as per rule 4.22A and in accordance with Specifying an existing arrangement: |
| Customer Profile | Where customer profile selection applies, Data Holders SHOULD omit the profile selection step and assume the customer profile associated with the existing authorisation. Data Holders MAY indicate which profile the authorisation relates to during the authorisation process. |
| Account Selection | Where account selection applies, Data Holders MUST pre-select accounts that were associated with the previous authorisation provided these accounts remain eligible and available to share. Data Holders MAY allow these accounts to be amended, and MAY provide information regarding the pre-selection of accounts. |
| Changing Attributes | Data Holders MUST indicate where a dataset is being added to an authorisation or a disclosure duration is being amended. Data Holders MAY apply this standard to other changing attributes, but this MUST ONLY apply where the attribute in the new authorisation differs to that of the previous authorisation. How a changed attribute is signified is at the Data Holder’s discretion. |
Notification Standards
The standards in this section apply where a relevant joint account holder is about to take an action that may or, where a data holder leverages rule 4A.15 and allows a vulnerable joint account holder to share joint account data as if it were from an individual account, may not result in the other joint account holder(s) being notified.
Notifications: Joint Account Alerts
| Area | CX Standard |
|---|---|
| Joint account notifications: Contextual alert |
Data holders MUST alert a joint account holder where an action they are about to perform may result in the other joint account holder(s) being notified. This standard applies to the authorisation flow, consumer dashboards, and the disclosure option management service where notifications to the other joint account holder(s) may be triggered. The precise wording of this notification is at the discretion of the data holder. |
| Joint account notifications: Rule 4A.15 exemptions |
Where rule 4A.15 is leveraged to allow a vulnerable requester to share their joint account data as if it were an individual account, the data holder MUST alert the requester, in the context of the authorisation flow, that the other joint account holder(s) will not be notified. This alert SHOULD be applied where appropriate for joint account management in general, including the consumer dashboard and the Disclosure Option Management Service (DOMS). |
| Joint account notifications: Further information |
In relation to the joint account alert standards in this section, data holders MAY provide further information about any services or processes in place for supporting vulnerable consumers or reporting risks of physical, psychological, or financial harm or abuse to the data holder. |
Alternative Notification Schedules for Joint Accounts
Rule 4A.14(3) requires data holders to (a) provide for alternative notification schedules (including reducing the frequency of notifications or not receiving notifications) and (b) give each joint account holder a means of selecting such an alternative, and of changing an election.
Alternative settings under 4A.14(3) only apply to the following notifications in 4A.14(1):
- The requester has given, amended, or withdrawn an authorisation
- Expiration of an authorisation
- A relevant account holder hasn't given approval within the relevant time frame
- A relevant account holder has withdrawn an approval
The standards in this section provide a non-exhaustive list of options that data holders may implement to support their compliance with these rules. The specific implementation of an alternative notification schedule and offering, which may or may not include options listed here, are at the data holder's discretion. It is the data holder's responsibility to ensure it is meeting its obligations under the CDR Rules. Compliance with the CDR Rules on alternative notification schedules would require, at a minimum, implementation of a combination of options (being a combination of options listed below, other measures, or both).
| Area | CX Standard |
|---|---|
| Joint account notifications: Reduced frequency |
Data holders MAY offer consumers the ability to receive their joint account notifications less frequently and as a periodic summary. This MAY, for example, outline all joint account activity at a frequency determined by the data holder and consumer, such as the previous quarter, month, fortnight, and so on. This MAY also, for example, be provided with or in relation to other CDR notifications such as a CDR Receipt, which is optional for data holders. |
| Joint account notifications: Granular control |
Data holders MAY offer consumers the ability to specify which joint account notifications they do and do not want to receive. This MAY, for example, allow a relevant joint account holder to only receive notifications when the requester gives or amends an authorisation. |
| Joint account notifications: Turn off notifications |
Data holders MAY allow consumers to elect to no longer receive any joint account notifications. |
| Joint account notifications: Consequences of amendment |
Data holders MAY inform the consumer of the consequences of amending their joint account notification schedule. This notification MAY include instructions for how to amend this schedule or reverse the amendment. |
| Joint account notifications: Contextual amendment |
Data holders MAY provide a mechanism or entry point for a notification schedule to be amended from or in relation to the notification itself. This MAY, for example, allow a consumer to stop receiving the type of notification(s) from the notification itself. The notification MAY also, for example, include a link to amend the notification schedule or instructions to direct the consumer to the appropriate place. |
| Joint account notifications: Amendment channels |
Data holders MAY allow a consumer to amend their notification schedule in line with existing notification management channels and experiences. This MAY, for example, allow the joint account notification schedule to be amended in the same location as other notifications. |
| Joint account notifications: Notification content |
For the content of the approval notification, data holders MAY provide the consumer with instructions for how any relevant authorisation(s) or approval(s) can be reviewed. |
Dashboard Standards
This section outlines standards for consumer dashboards. These are expected to be implemented on each specific data sharing arrangement.
Data Holder Dashboards
| Area | CX Standard |
|---|---|
| Data Holder Dashboard: Amending authorisation details |
Effective from July 1st 2024: When a consumer amends an authorisation in accordance with rule 4.22A, which is linked to a cdr_arrangement_id supplied by the data recipient as per the amending authorisation standards, data holders MUST display the details of each authorisation’s amendment on the consumer’s dashboard. Note: this requirement gives effect to rule 1.15(3)(h) |
| Data Holder Dashboard: Data recipient handling details |
Effective from July 1st 2024: Data holders MUST advise consumers to check with the relevant data recipient for information about how their data may be handled. The precise wording of this message is at the discretion of the data holder. The data holder MAY consider using or paraphrasing the following message:
|
Withdrawal Standards
| Area | CX Standard |
|---|---|
| Withdrawing consent | If a Data Recipient does not have a general policy to delete redundant data, and the consumer has not already requested that their redundant data be deleted:
|
| Withdrawing authorisation: Consequences |
As part of the withdrawal process, the data holder MUST advise the consumer to review the consequences of withdrawal with the Data Recipient before they stop sharing their data. The data holder MAY consider using or paraphrasing the following message(s):
|
| Withdrawing authorisation: Redundant data |
As part of the withdrawal process, the data holder MUST inform the consumer about the handling of redundant data and the right to delete. The Data Holder MAY consider using or paraphrasing the following message(s):
|
| Withdrawal: Disclosure consent | As part of the disclosure consent withdrawal process, Data Recipients MUST advise the consumer to review, with the recipient that the data was disclosed to:
|
| Withdrawal: Secondary User Instruction |
As part of the secondary user instruction withdrawal process, data holders MUST advise the consumer:
|
| Withdrawal: Joint accounts |
As part of the process of removing a joint account approval or changing to a more restrictive disclosure option, the data holder MUST advise the consumer:
Note: The exact phrasing of the withdrawal message is at the discretion of the data holder. This standard does not affect data holders’ other notification obligations, including under rule 4A.7(3). |
Security Profile
Overview
This information security profile builds upon the foundations of the Financial-grade API Advanced Profile [FAPI-1.0-Advanced] and other standards relating to Open ID Connect 1.0 [OIDC].
For information on the specific normative references that underpin this profile refer to the Normative References section.
Symbols and Abbreviated terms
- API: Application Programming Interface
- CA: Certificate Authority
- CDR: Consumer Data Right
- CDR-SP: Consumer Data Right Security Profile
- CL: Credential Level
- DH: Data Holder
- DR: Data Recipient
- DRSP: Data Recipient Software Product
- DTA: Digital Transformation Agency
- FAPI: Financial-grade API
- FQDN: Fully Qualified Domain Name
- HoK: Holder of Key
- JSON: The JavaScript Object Notation
- JARM: JWT Secured Authorization Response Mode
- JWA: JSON Web Algorithms
- JWE: JSON Web Encryption
- JWK: JSON Web Key
- JWKS: JSON Web Key Set
- JWS: JSON Web Signing
- JWT: JSON Web Token
- IP: Identity Proofing
- LoA: Level of Assurance
- LoAs: Levels of Assurance
- MTLS: Mutually Authenticated Transport Layer Security
- OIDC: Open ID Connect
- PAR: Pushed Authorisation Requests
- PI: Personal Information
- PKCE: Proof Key for Code Exchange
- PKI: Public Key Infrastructure
- PPID: Pairwise Pseudonymous Identifier
- REST: Representational State Transfer
- SP: Data Recipient Software Product
- TDIF: Trusted Digital Identity Framework
- TLS: Transport Layer Security
CDR Federation
The CDR Federation will facilitate the secure exchange of consumer data and federation metadata between multiple system entities which will assume one or more of the following roles:
- Data Holder:
- Multiple Data Holders will be supported.
- Data Recipient:
- Multiple Data Recipients will be supported.
- Software Product:
- Multiple Software Products will be supported for each Data Recipient.
- Register:
- A register will be supported and will be maintained by the Australian Competition and Consumer Commission (ACCC) acting in its capacity as the Registrar for the CDR.
- Customer:
- The authorising customer that is authenticated by a Data Holder.
Data Holder
The Data Holder (DH) is a system entity that authenticates a Customer (resource owner or user), as part of an authorisation process initiated by a Data Recipient, and issues an authorisation for that Data Recipient to access the Customer's data via published APIs.
A Data Holder assumes the role of an [OIDC] OpenID Provider.
For the purposes of this standard a single designated organisation MAY be represented via the Register as multiple separate Data Holders to support multiple brands or market identities.
Multi-Brand Support (Separate Issuers For Data Holder Brands)
From July 4th 2022
- Where a Data Holder has multiple brands, each brand MUST have a separate issuer.
Secondary Data Holder
A Secondary Data Holder (SDH) is a system entity that is designated to provide CDR data but does so via a standard Data Holder acting as a gateway. A Secondary Data Holder does not interact directly with Data Recipients and is not registered with the Register.
A request for data from a Secondary Data Holder by a standard Data Holder is known as a Shared Responsibility Data Request.
See the Shared Responsibility section contains standards related to Secondary Data Holders and Shared Responsibility Data Requests.
Data Recipient
A Data Recipient (DR) is a system entity that is accredited to collect CDR data from Data Holders or other DRs through authorised Software Products.
A Data Recipient MUST be accredited in order to participate in the CDR Federation. Accreditation rules for Data Recipients are beyond the scope of this artefact. The process of accreditation is managed by the CDR Registrar.
For the purposes of this standard a single accredited organisation is represented via the Register as a single Data Recipient and MAY be represented by multiple separate Software Products to support multiple applications or services.
Software Product
A Data Recipient Software Product (DRSP) is a system entity that is authorised by a Data Holder to access consumer resources (APIs). A Software Product MUST capture consumer consent prior to commencing an authorisation process with a Data Holder.
A Software Product MUST be registered with the Registrar and approved for use in order to participate in the CDR Federation.
A Software Product MAY be registered for use across one or more sectors (e.g. banking and energy).
A Software Product assumes the role of an [OIDC] Relying Party (Client).
Register
The Register is a central point of discovery for both Data Holders and Data Recipients. Data Holders and Data Recipients MUST be created as entities in the Register in order for them to participate as members of the CDR Federation. The functionality of the Register will include but will not be limited to:
- Management of Identities and Access: The Register will allow registered persons, on behalf of Data Holders and Data Recipients, to manage the metadata of their associated organisations and systems.
- Management of Certificates: The Register will facilitate the issuing, management and revocation of digital certificates.
- Discoverability and Search: The Register will expose APIs and Web Interfaces in order to support metadata queries across Register entities.
Customer
For the purposes of this standard a single person or individual MAY be represented as multiple Customers according to the practice of the Data Holder according to their existing digital channels.
Authentication Flows
This profile supports the authentication flows specified by OpenID Connect [OIDC] as constrained further by [FAPI].
Specifically the OIDC Hybrid Flow outlined at section 3.3 of [OIDC].
From July 4th 2022, Authorization Code Flow outlined at section 3.1 of [OIDC] is supported.
No other flows are currently supported.
Baseline Security Provisions
Data Holders
The request_uri parameter is only supported if the Data Holder supports PAR.
In addition, the following statements are applicable to both the OIDC Hybrid Flow and Authorization Code Flow:
- Data Holders MUST request a user identifier that can uniquely identify the customer and that is already known by the customer in the redirected page
- Data Holders MUST NOT request that the customer enter an existing password in the redirected page
- Data Holders MUST provide a one-time password (OTP) to the customer through an existing channel or mechanism that the customer can then enter into the redirected page
- The delivery mechanism for the OTP is at the discretion of the Data Holder but MUST align to existing and preferred channels for the customer and MUST NOT introduce unwarranted friction into the authentication process
- Data Holders SHOULD implement additional controls to minimise the risk of interception of the OTP through the selected delivery mechanism
- The provided OTP MUST be used only for authentication for CDR based sharing and MUST NOT be usable for the authorisation of other transactions or actions
- The provided OTP MUST be invalidated after a period of time at the discretion of the Data Holder. This expiry period SHOULD facilitate enough time for the customer to reasonably complete the authorisation process
- The provided OTP MUST be numeric digits and be between 4 and 6 digits in length
- The algorithm for the creation of the OTP is at the discretion of the Data Holder but SHOULD incorporate a level of pseudorandomness appropriate for the use case
- Data Holders SHOULD implement additional controls to minimise the risk of enumeration attacks via the redirect page
In line with CDR Rule 4.24 on restrictions when asking CDR consumers to authorise disclosure of CDR data, unwarranted friction for OTP delivery is considered to include:
- the addition of any requirements beyond normal data holder practices for verification code delivery
- providing or requesting additional information beyond normal data holder practices for verification code delivery
- offering additional or alternative services
reference or inclusion of other documents
Data Holders MUST support FAPI 1.0 Advanced Profile ([FAPI-1.0-Advanced]).
Data Holders MUST support Authorization Code Flow.
Data Holders MUST support the OIDC Hybrid Flow.
From July 10th 2023 (FAPI 1.0 Migration Phase 4),
- Data Holders MAY retire support for the OIDC Hybrid Flow.
Data Recipient Software Products
The following statements are applicable to both the OIDC Hybrid Flow and Authorization Code Flow:
Data Recipient Software Products SHOULD record the following information each time an authorisation flow is executed: username (consumer’s ID at the Data Recipient Software Product), timestamp, IP, consent scopes and duration.
Data Recipient Software Products SHOULD NOT reuse "authorization_code" values, and if reused, it will be rejected.
Data Recipient Software Products MAY send requests with a "x-fapi-customer-ip-address" header containing a valid IPv4 or IPv6 address.
Data Recipient Software Products MUST support FAPI 1.0 Advanced Profile ([FAPI-1.0-Advanced]).
Data Recipient Software Products MUST use [RFC9126] (PAR) with [PKCE] ([RFC7636]) and, if supported, MUST use S256 as the code challenge method.
Data Recipient Software Products SHOULD use Authorization Code Flow.
OIDC Hybrid Flow
The [OIDC] Hybrid Flow is a type of redirection flow where the consumer's user agent is redirected from a Data Recipient Software Product’s (Relying Party) web site to a Data Holder’s Authorisation end point in the context of an [OIDC] authentication request. The OIDC Hybrid Flow incorporates aspects of the both the implicit flow and authorisation code flow detailed under [OIDC].
Only a response_type (see section 3.3 of [OIDC]) of code id_token SHALL be allowed.
Authorization Code Flow
The following statements are applicable for this flow:
- Only a
response_type(see section 3.1 of [OIDC]) ofcodeSHALL be allowed. - Data Holders MUST also support [JARM] and [PKCE]
Data Holders
Data Holders MUST support [JARM] in accordance with [FAPI-1.0-Advanced] section 5.2.2.2.
JWT Secured Authorization Response Mode for OAuth 2.0 (JARM) Data Holders MAY support Authorisation Response encryption.
However, at present, there is no confidential information in the authorization response, hence encryption of the authorization response is not required for the purposes of security or confidentiality. In addition, whilst response encryption MAY be used, to achieve greater interoperability, it is not recommended to use encryption in this case at this time.
In addition,
- Data Holders MAY advertise they do not support authorisation response encryption: either by omitting these values from their OpenID Provider Metadata, or by presenting an empty array for the supported parameters.
- If the Data Holder supports authorisation response encryption and the
authorization_encrypted_response_algis omitted from the registration request, the Data Holder MAY require response encryption by returning a client registration response with the chosen “authorization_encrypted_response_alg” value.
Data Recipient Software Products
Data Recipients MUST support [JARM] in accordance with [FAPI-1.0-Advanced] section 5.2.3.2.
In addition,
- Data Recipients MUST request authorisation response signing using one of the
authorization_signing_alg_values_supportedvalues offered by the Data Holder. - Data Recipients MAY request response encryption using one of the advertised encryption sets.
- Data Recipients MAY request no response encryption by omitting the values in their client registration.
- If
authorization_signed_response_algis omitted, the default algorithm is "PS256".
Additional requirements and guidelines for the authentication flows are contained in the Consumer Experience section.
Client Authentication
This section outlines how participants in the CDR regime will authenticate clients seeking access to end points.
Note that, while [MTLS] is utilised for transaction security and as a Holder of Key mechanism, the PKI Mutual TLS OAuth Client Authentication Method SHALL NOT be supported as the mechanism for client authentication.
The following authentication methods are supported:
Data Holders SHALL authenticate the CDR Register client using one of the following Client Authentication methods:
- Self-signed JWT client assertion authenticated by the protected request endpoint according to Self-signed JWT Client Authentication, or
private_key_jwtauthentication usingclient_credentialsauthorisation grant flow according to Private Key JWT Client Authentication.
- Self-signed JWT client assertion authenticated by the protected request endpoint according to Self-signed JWT Client Authentication, or
Data Holders and the CDR Register MUST authenticate Data Recipient Software Products using the Private Key JWT Client Authentication method.
Data Recipient Software Products MUST authenticate Data Holders and the CDR Register using the Self-signed JWT Client Authentication method.
Private Key JWT Client Authentication
Private Key JWT Client Authentication Non-Normative Example - CDR Register calls the Data Holder's token end point to obtain an Access Token for the purposes of calling the Data Holder's Get Metrics endpoint.
POST /token HTTP/1.1
Host: www.holder.com.au
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&
client_id=5ntwEOpMdPxxy49Gt28SXWY6j3afl2CP2&
scope=admin%3Ametrics.basic%3Aread&
client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&
client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
## Decoded client assertion JWT
{
"alg": "PS256",
"typ": "JWT",
"kid": "12456"
}
{
"iss": "5ntwEOpMdPxxy49Gt28SXWY6j3afl2CP2",
"sub": "5ntwEOpMdPxxy49Gt28SXWY6j3aflCP2",
"iat": 1516239022,
"exp": 1516239322,
"aud": "https://www.holder.com.au/token",
"jti": "37747cd1-c105-4569-9f75-4adf28b73e31"
}
Authorisation Servers supporting private_key_jwt Client Authentication of clients MUST support the following requirements:
- Authorisation Servers MUST support the authentication of clients using the
private_key_jwtClient Authentication method specified at section 9 of [OIDC]. - The
private_key_jwtauthentication method is enabled through the delivery of an encoded [JWT] signed using the Data Recipient Software Product's private key and thus facilitates non-repudiation. - Client public keys are obtained from the [JWKS] endpoints.
For the client authentication assertion, the [JWT] represents an assertion that MUST contain the following REQUIRED Claim Values and MAY contain the following OPTIONAL Claim Values:
iss- REQUIRED. Issuer Identifier for the Issuer of the response. The client ID of the bearer.sub- REQUIRED. Subject Identifier. The client ID of the bearer.aud- REQUIRED. Audience(s) that the JWT is intended for. The issuer identifier URL of the authorisation server according to [RFC8414] SHOULD be used as the value of the audience. In order to facilitate interoperability, the authorisation server MUST accept its Issuer Identifier, Token Endpoint URL, or the URI of the endpoint being invoked as values that identify it as an intended audience.jti- REQUIRED. JWT ID. A unique identifier for the token, which can be used to prevent reuse of the token. These tokens MUST only be used once.exp- REQUIRED. Expiration time on or after which the ID Token MUST NOT be accepted for processing. Value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC expiry time.iat- OPTIONAL. Time at which the JWT was issued. Value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC issued at time.
The aforementioned assertion MUST be sent to the Authorisation Server's Token endpoint with the
POSTmethod and MUST include the following REQUIRED parameters, SHOULD include the following RECOMMENDED parameters and MAY contain the following OPTIONAL parameters:grant_type- REQUIRED. The grant type(s) supported by the Authorisation Server.client_id-- Until November 13th 2023
RECOMMENDED. The client ID of the bearer. - From November 13th 2023
OPTIONAL. The client ID of the bearer in accordance with [RFC7521].
- Until November 13th 2023
client_assertion_type- REQUIRED. This MUST be set tourn:ietf:params:oauth:client-assertion-type:jwt-bearer.client_assertion- REQUIRED. The encoded assertion JWT.scope- OPTIONAL. The requested scope as described in Section 3.3 of [RFC6749].
Self-signed JWT Client Authentication
Self-signed JWT Client Authentication Non-Normative Example - CDR Register calls the Data holder's Get Metrics end point using self-signed JWT Client Authentication (note that the “aud” claim represents the AdminBaseUri as defined in CDR Register Participant Endpoints).
GET https://admin.data.holder.com.au/cds-au/v1/admin/metrics HTTP:/1.1
Host: admin.data.holder.com.au
x-v: string
x-min-v: string
Authorization: Bearer eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
## Decoded Bearer token JWT
{
"alg":"PS256",
"typ":"JWT",
"kid":"12456"
}
{
"iss":"cdr-register",
"sub":"cdr-register",
"aud":"https://admin.data.holder.com.au",
"iat":1516239022,
"exp":1516239322,
"jti":"32358102-a44f-43cc-ad7c-42443d01507a"
}
Data Recipient Software Products and Data Holders supporting the self-signed JWT authentication of clients using a signed JWT MUST do so according to the following requirements:
The JWT MUST contain the following REQUIRED Claim Values and MAY contain the following OPTIONAL Claim Values:
iss- REQUIRED. Issuer Identifier for the Issuer of the response. The client ID of the bearer.sub- REQUIRED. Subject Identifier. The client ID of the bearer.aud- REQUIRED. Audience(s) that the JWT is intended for. The Data Holder or Data Recipient Software Product MUST verify that it is an intended audience for the token.Data Recipient hosted endpoints
The Resource Path for the end point being accessed SHOULD be used.
In order to facilitate interoperability and for Data Recipient Software Product hosted endpoints only, the endpoint MUST also accept the<RecipientBaseUri>as a value identifying the intended audience.
From July 31st 2022: The Resource Path for the end point being accessed MUST be used.Data Holder Metrics endpoints
The<AdminBaseUri>for the end point being accessed MUST be used.jti- REQUIRED. JWT ID. A unique identifier for the token, which can be used to prevent reuse of the token. These tokens MUST only be used once.exp- REQUIRED. Expiration time on or after which the ID Token MUST NOT be accepted for processing. Value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC expiry time.iat- OPTIONAL. Time at which the JWT was issued. Value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC issued at time.
Validation and use of the JWT and the claims described above MUST be performed in accordance with [JWT].
The JWT MUST be accepted from the client at the requested endpoint using the "Authorization Request Header Field" mechanism as described in section 2.1 of [RFC6750].
Note: In accordance with jti requirements, self-signed JWTs are one-time use only. The authenticating server MUST reject JWTs reuse.
CDR Register calling Data Holders
Data Holders MUST support either Private Key JWT Client Authentication or Self-signed JWT Client Authentication of the CDR Register.
Data Holders SHOULD support Private Key JWT Client Authentication but MAY support Self-signed JWT Client Authentication.
This method MAY be changed by updating Data Holder registration details with the CDR Register.
Private Key JWT authentication
If the Data Holder supports the Private Key JWT Client Authentication method for authenticating the CDR Register, it MUST also support the following requirements:
- Data Holders MUST issue a client ID that is provided to the CDR Register. The client ID is issued to the CDR Register during out of band registration processes, including, Data Holder onboarding. This MAY be a static client ID value of ‘cdr-register’.
- The authorisation grant's
grant_typeparameter MUST be set toclient_credentials. - The authorisation grant's
scopeparameter MUST be provided and MUST be set to the scope of the resource endpoint to be accessed. - Upon successful authentication, Data Holders MUST issue an Access Token to the CDR Register. In accordance with section 4.4 of [RFC6749] an Refresh Token SHOULD NOT be included.
Self-signed JWT authentication
If the Data Holder supports the Self-signed JWT Client Authentication method for authenticating the CDR Register, the client ID MUST be set to a value of cdr-register.
Data Holders calling Data Recipients
Non-Normative Example - Data Holder calls the Data Recipient Software Product's CDR Arrangement Revocation end point (note that the "aud" claim is "resource path" to the revocation end point).
POST https://data.recipient.com.au/arrangements/revoke HTTP/1.1
Host: data.recipient.com.au
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey …
cdr_arrangement_jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IjEyNDU2In0.ey ...
## Decoded Bearer token JWT
{
"alg":"PS256",
"typ":"JWT",
"kid":"12456"
}
{
"iss":"dataholderbrand-123",
"sub":"dataholderbrand-123",
"aud":"https://data.recipient.com.au/arrangements/revoke",
"iat":1516239022,
"exp":1516239322,
"jti":"dba86502-7cf5-4719-9638-c5339a0ddb06"
}
Non-Normative Example - Data Recipient Software Product calls Data Holder's token end point. This example uses PKCE to send the code_verifier which was previously encrypted in the request object submission as the code_challenge using S256 as the code_challenge_method
POST /token HTTP/1.1
Host: www.holder.com.au
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code&
code=i1WsRn1uB1&
redirect_uri=https%3A%2F%2Fwww.recipient.com.au%2Fcoolstuff&
client_id=s6BhdRkqt3&
code_verifier=4d9213fb-d68b-49d1-a2c9-486e5a0b4e14&
client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&
client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
## Decoded client assertion JWT
{
"alg": "PS256",
"typ": "JWT",
"kid": "12456"
}
{
"iss": "s6BhdRkqt3",
"sub": "s6BhdRkqt3",
"iat": 1516239022,
"exp": 1516239322,
"aud": "https://www.holder.com.au/token",
"jti": "37747cd1-c105-4569-9f75-4adf28b73e31"
}
In addition to the requirements for Self-signed JWT Client Authentication, the client_id is the Data Holder Brand ID as issued by CDR Register.
Data Recipients calling Data Holders
In addition to the requirements for Private Key JWT Client Authentication the following requirements MUST be supported:
- authorisation_code
+ authorization_code
Changed the statements regarding client ID issuance due to redundant statement. Removes:
- The client ID represents the ID issued to the Data Recipient Software Product by the Data Holder upon successful dynamic client registration.
- The authorisation grant's
client_idparameter value MUST represent the ID issued to the Data Recipient Software Product by the Data Holder upon successful dynamic client registration. - The authorisation grant's
grant_typeparameter value MUST only be included when invoking the Token End point and MUST be set toauthorization_codeorclient_credentials. The valuerefresh_tokenis also valid when refreshing an access token.
Data Recipients calling the CDR Register
Non-Normative Example - Data Recipient Software Product requests CDR Register Access Token
POST /token HTTP/1.1
Host: cdr.register
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&
client_id=<brand id> OR <software product id> &
client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&
client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...&
scope=cdr-register%3Abank%3Aread
## Decoded client assertion JWT
{
"alg": "PS256",
"typ": "JWT",
"kid": "b50641343f8f4717a4865d238b6297b8"
}
{
"iss": "<brand id> OR <software product id>",
"sub": "<brand id> OR <software product id>",
"exp": 1516239322,
"aud": "https://cdr.register/idp/connect/token",
"jti": "37747cd1-c105-4569-9f75-4adf28b73e31"
}
## Response
{
"access_token": "eyJhbGciOiJQUz...",
"expires_in": 7200,
"token_type": "Bearer",
"scope": "cdr-register:bank:read openid"
}
In addition to the requirements for Private Key JWT Client Authentication the following requirements MUST be supported:
grant_typeMUST be set toclient_credentials- Refresh tokens will not be provided for grant_type
client_credentials client_id,issandsubclaims MUST be set to the ID of the calling clientData Recipient Brand IDORSoftware Product IDissued by the CDR Register
Client Registration
Dynamic Client Registration
Data Recipients register with Data Holders according to [DCR] to obtain client credentials used to retrieve consumer data on behalf of a consumer.
Software Statement Assertion (SSA)
As per [DCR], a Software Statement is defined in as: A digitally signed JSON Web Token (JWT) created in accordance with [JWT] that asserts metadata values about the client software
An SSA is a digitally signed JSON Web Token (JWT) created in accordance with [JWT] that asserts metadata values about the client software.
Such that:
- The CDR Register MUST issue Software Statements to active Data Recipients for active Software Products
- The CDR Register MUST issue distinct Software Statements for each
Software Product ID - Software Statements are issued with a 10 minute expiry time
- As per [FAPI-1.0-Advanced], SSAs are signed by the CDR Register using PS256
- CDR Register public keys are exposed on a dedicated JWKS URI endpoint
- The CDR Register JWKS endpoint is an unauthenticated endpoint, using TLS
- Data Recipients MUST present a valid SSA when undertaking dynamic client registration
- Data Holders MUST NOT register Data Recipient software products unless they present a verified Registration Request with a verified SSA
Refer to the Register APIs section for the endpoint definitions that will be used to retrieve and validate SSAs.
SSA Definition
Example SSA:
eyJhbGciOiJQUzI1NiIsImtpZCI6ImI4ZmFjZjJmZjM5NDQ0Zjc4MWUwYmU1ZGI0YjE0ZjE2IiwidHlwIjoiSldUIn0.eyJpc3MiOiJjZHItcmVnaXN0ZXIiLCJpYXQiOjE1NzE4MDgxMTEsImV4cCI6MjE0NzQ4MzY0NiwianRpIjoiM2JjMjA1YTFlYmM5NDNmYmI2MjRiMTRmY2IyNDExOTYiLCJjbGllbnRfbmFtZSI6Ik1vY2sgU29mdHdhcmUiLCJjbGllbnRfZGVzY3JpcHRpb24iOiJBIG1vY2sgc29mdHdhcmUgcHJvZHVjdCIsImNsaWVudF91cmkiOiJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUiLCJsZWdhbF9lbnRpdHlfaWQiOiIzQjBCMEE3Qi0zRTdCLTRBMkMtOTQ5Ny1FMzU3QTcxRDA3QzciLCJsZWdhbF9lbnRpdHlfbmFtZSI6Ik1vY2sgQ29tcGFueSBQdHkgTHRkLiIsIm9yZ19pZCI6IjNCMEIwQTdCLTNFN0ItNEEyQy05NDk3LUUzNTdBNzFEMDdDOCIsIm9yZ19uYW1lIjoiTW9jayBDb21wYW55IEJyYW5kIiwicmVkaXJlY3RfdXJpcyI6WyJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvcmVkaXJlY3RzL3JlZGlyZWN0MSIsImh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS9yZWRpcmVjdHMvcmVkaXJlY3QyIl0sInNlY3Rvcl9pZGVudGlmaWVyX3VyaSI6Imh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS9zZWN0b3JfaWRlbnRpZmllci5qc29uIiwibG9nb191cmkiOiJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvbG9nb3MvbG9nbzEucG5nIiwidG9zX3VyaSI6Imh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS90b3MuaHRtbCIsInBvbGljeV91cmkiOiJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvcG9saWN5Lmh0bWwiLCJqd2tzX3VyaSI6Imh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS9qd2tzIiwicmV2b2NhdGlvbl91cmkiOiJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvcmV2b2NhdGlvbiIsInJlY2lwaWVudF9iYXNlX3VyaSI6Imh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdSIsInNvZnR3YXJlX2lkIjoiNzQwQzM2OEYtRUNGOS00RDI5LUEyRUEtMDUxNEE2NkIwQ0RFIiwic29mdHdhcmVfcm9sZXMiOiJkYXRhLXJlY2lwaWVudC1zb2Z0d2FyZS1wcm9kdWN0Iiwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBiYW5rOmFjY291bnRzLmJhc2ljOnJlYWQgYmFuazphY2NvdW50cy5kZXRhaWw6cmVhZCBiYW5rOnRyYW5zYWN0aW9uczpyZWFkIGJhbms6cGF5ZWVzOnJlYWQgYmFuazpyZWd1bGFyX3BheW1lbnRzOnJlYWQgZW5lcmd5OmVsZWN0cmljaXR5LnNlcnZpY2Vwb2ludHMuYmFzaWM6cmVhZCBlbmVyZ3k6ZWxlY3RyaWNpdHkuc2VydmljZXBvaW50cy5kZXRhaWw6cmVhZCBlbmVyZ3k6ZWxlY3RyaWNpdHkudXNhZ2U6cmVhZCBlbmVyZ3k6ZWxlY3RyaWNpdHkuZGVyOnJlYWQgZW5lcmd5OmFjY291bnRzLmJhc2ljOnJlYWQgZW5lcmd5OmFjY291bnRzLmRldGFpbDpyZWFkIGVuZXJneTphY2NvdW50cy5wYXltZW50c2NoZWR1bGU6cmVhZCBlbmVyZ3k6YWNjb3VudHMuY29uY2Vzc2lvbnM6cmVhZCBlbmVyZ3k6YmlsbGluZzpyZWFkIGNvbW1vbjpjdXN0b21lci5iYXNpYzpyZWFkIGNvbW1vbjpjdXN0b21lci5kZXRhaWw6cmVhZCBjZHI6cmVnaXN0cmF0aW9uIn0.XTSst96xOifAnaMaBj0I5nO5vbtNwvz304hJ9I_jPOcdD6vitmLiyWdkdW5GKA4JAa62_DmRIU_3zXQL0gSSJxoWhCSbuIlfwDtXFpFZzQAnTv-hOul-5clYmXvQqqEqWvbZZ4g7IKdWdROp4fzWFXB0VKf-_qzue_Kksy3A9CwdZRmNMDFtIApkSULqxK3S8D2nFa3lvGzegl76Ji7p0Zjkyu8YexFyKCahTEGzQrRQeVILpaN107XHNlSWlhsv4hr1PXwG2Pn1z54SCG9tVOZ10WaqZ5SMjRqsQN-lVYSVe5BCTpQ-N_GnYuUeWh0rOJ9CrA8CUN_twCJXyW3I5w
Associated JWKS:
{
"keys": [
{
"kid": "b8facf2ff39444f781e0be5db4b14f16",
"kty": "RSA",
"key_ops": [
"sign",
"verify"
],
"n": "s0zGoaOEJE8HDfHjWtO0xLXtuPcwio8BEoj0-uu9kxxDIF7jH0jb06EwoPkb83BET59x6C0TtRfc_I5ZDksQKRClWXzbazqi62M5YhCgwyB-S09PJb8P1GfQBYyK346nLKARHbFJ1t1SHARcVFJA_8NeHfQn_0fyEc55R3GGNDL3YQtjEoTb-LMR-KpcPB2BpyDuie-jk-3f1t0EfvnkVp-6co1_KTXrbwuYtH31YBZLgU4JeZEJLTnGdMKmJppZ9SnyrBB461hMmw0HJHJj6uZJSiP2onmvlrUezv1T3NM3HOE7WHxlps9MUJj3vcpea-O6n5JBX8emTduLuLuKuw",
"e": "AQAB"
}
]
}
Decoded SSA
{
"alg": "PS256",
"kid": "b8facf2ff39444f781e0be5db4b14f16",
"typ": "JWT"
}
{
"iss": "cdr-register",
"iat": 1571808111,
"exp": 2147483646,
"jti": "3bc205a1ebc943fbb624b14fcb241196",
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read energy:electricity.servicepoints.basic:read energy:electricity.servicepoints.detail:read energy:electricity.usage:read energy:electricity.der:read energy:accounts.basic:read energy:accounts.detail:read energy:accounts.paymentschedule:read energy:accounts.concessions:read energy:billing:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
The SSA will conform to the requirements of [DCR] with the following clarifications:
| Client Metadata | Required | Modifiable | Description |
|---|---|---|---|
| iss | Required | Contains the iss (issuer) claim denoting the party attesting to the claims in the software statementvalue: "cdr-register" |
|
| iat | Required | The time at which the request was issued by the CDR Register, expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC | |
| exp | Required | The time at which the SSA expires expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC | |
| jti | Required | Unique identifier for the JWT, used to prevent reuse of the SSA. | |
| legal_entity_id | Optional | A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Legal Entity | |
| legal_entity_name | Optional | Human-readable string name of the Accredited Data Recipient Legal Entity | |
| org_id | Required | A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Brand | |
| org_name | Required | Human-readable string name of the Accredited Data Recipient Brand to be presented to the end user during authorization | |
| client_name | Required | Human-readable string name of the software product to be presented to the end-user during authorization | |
| client_description | Required | Human-readable string name of the software product description to be presented to the end user during authorization | |
| client_uri | Required | URL string of a web page providing information about the client | |
| redirect_uris | Required | Array of redirection URI strings for use in redirect-based flows | |
| sector_identifier_uri | Optional | URL string referencing the client's sector identifier URI, used as an optional input to the Pairwise Identifier as described in section 8 of [OIDC] | |
| logo_uri | Required | URL string that references a logo for the client software product. The server SHOULD display this image to the end-user during approval | |
| tos_uri | Optional | URL string that points to a human-readable terms of service document for the Software Product | |
| policy_uri | Optional | URL string that points to a human-readable policy document for the Software Product | |
| jwks_uri | Required | URL string referencing the client's JSON Web Key (JWK) Set [RFC7517] document, which contains the client's public keys | |
| revocation_uri | Required | URI string that references the location of the Software Product consent revocation endpoint as per Consumer Data Standards Endpoints | |
| recipient_base_uri | Required | Base URI for the Consumer Data Standard Data Recipient endpoints. This SHOULD be the base to provide reference to all other Data Recipient Endpoints | |
| software_id | Required | String representing a unique identifier assigned by the Register and used by registration endpoints to identify the software product to be dynamically registered. The software_id will remain the same across multiple updates or versions of the same piece of software.The software_id SHOULD be used as the primary external identifier for the client to prevent duplicate client registrations |
|
| software_roles | Required | String containing a role of the software in the CDR Regime. Initially the only value used will be “data-recipient-software-product” | |
| scope | Required | String containing a space-separated list of scope values that the client can use when requesting access tokens. These CDS scope values are defined at: Authorisation ScopesThe DCR scope value is defined at: Client Registration ManagementAs per the CDS Scopes and Claims, openid and profile are included in the SSA |
Get Software Statement Assertion API v1 & v2 has the scope claim explicitly defined.
Registration Request using JWT
Example Request Client registration with OpenID Hybrid Flow
HTTP/1.1 POST /register
Content-Type: application/jwt
Accept: application/json
### Non-normative Decoded JWT
{
"alg":"PS256",
"typ":"JWT",
"kid":"12456"
}
{
"iss": "CDR Software Product ID",
"iat": 1571908322,
"exp": 2148483456,
"jti": "37747cd1c10545699f754adf28b73e31",
"aud": "https://secure.api.dataholder.com/issuer",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code id_token"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"request_object_signing_alg": "PS256",
"software_statement": "string"
}
{
"signature":...
}
Example Request This example creates a FAPI 1.0 Phase 3 client registration that uses Authorization Code Flow with JARM encryption
HTTP/1.1 POST /register
Content-Type: application/jwt
Accept: application/json
### Non-normative Decoded JWT
{
"alg":"PS256",
"typ":"JWT",
"kid":"12456"
}
{
"iss": "CDR Software Product ID",
"iat": 1571908322,
"exp": 2148483456,
"jti": "37747cd1c10545699f754adf28b73e31",
"aud": "https://secure.api.dataholder.com/issuer",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string"
}{
"signature":...
}
To register with a Data Holder, the Data Recipient sends an HTTP POST to the Data Holder registration endpoint.
- The request MUST be presented in the format of a [RFC7519] compliant JWT.
- The request MUST use the HTTP POST method, using the
application/jwtcontent type. - The JWT MUST be signed using algorithms specified in section 8.6 of [FAPI-1.0-Advanced]
The client registration request MUST contain the following claims in the JWT payload unless designated as Optional:
| Claim | Required | Description |
|---|---|---|
| iss | Required | Contains the identifier for the Data Recipient Software Product (SoftwareProductId) as defined in the CDR Register |
| iat | Required | The time at which the request was issued by the Data Recipient expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC |
| exp | Required | The time at which the request expires expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC |
| jti | Required | Unique identifier for the JWT, used to prevent reuse of the token. |
| aud | Required | Contains the DH issuer value as described in the OIDC Discovery Document |
| redirect_uris | Optional | Array of redirection URI strings for use in redirect-based flows. If used, redirect_uris MUST match or be a subset of the redirect_uris as defined in the SSA |
| token_endpoint_auth_method | Required | The requested authentication method for the token endpoint. The only supported method will be private_key_jwt |
| token_endpoint_auth_signing_alg | Required | The algorithm used for signing the JWT |
| grant_types | Required | Array of OAuth 2.0 grant type strings that the client can use at the token endpoint. Supported values: [client_credentials, authorization_code, refresh_token] |
| response_types | Required | Array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint. values: ["code", "code id_token"] Response type value “code” is required for Authorization Code Flow. Response type value “code id_token” is required for OIDC Hybrid Flow. |
| application_type | Optional | Kind of the application. The only supported application type will be web |
| id_token_signed_response_alg | Required | Algorithm with which an id_token is to be signedSupported values as constrained by [FAPI-1.0-Advanced]. Required for both Authorization Code Flow (response_type “code”) and OIDC Hybrid Flow (response_type “code id_token”). |
| id_token_encrypted_response_alg | Conditional | JWE alg algorithm with which an id_token is to be encrypted.Required if OIDC Hybrid Flow (response type code id_token) is registered. |
| id_token_encrypted_response_enc | Conditional | JWE enc algorithm with which an id_token is to be encrypted.Required if OIDC Hybrid Flow (response type code id_token) is registered. |
| authorization_signed_response_alg | Conditional | The JWS alg algorithm required for signing authorization responses. If this is specified, the response will be signed using JWS and the configured algorithm. The algorithm “none” is not allowed. Required if response_type of “code” is registered by the client. |
| authorization_encrypted_response_alg | Conditional | The JWE alg algorithm required for encrypting authorization responses. If unspecified, the default is that no encryption is performed. Required if “authorization_encrypted_response_enc” is included. |
| authorization_encrypted_response_enc | Optional | The JWE enc algorithm required for encrypting authorization responses. If “authorization_encrypted_response_alg” is specified, the default for this value is “A128CBC-HS256”. |
| request_object_signing_alg | Optional | Algorithm which the ADR expects to sign the request object if a request object will be part of the authorization request sent to the Data HolderIf field not present in the request, data holders are expected to respond with an appropriate default valueSupported values as constrained by [FAPI-1.0-Advanced] |
| software_statement | Required | Software statement assertion issued by the CDR Register |
ID Token Algorithm Selection Considerations
When requiring ID Token encryption, the following requirements are applicable.
Participants MUST support, at a minimum, the following ID Token algorithms:
| Claim | Values |
|---|---|
| id_token_encrypted_response_alg | RSA-OAEPRSA-OAEP-256 |
| id_token_encrypted_response_enc | A256GCMA128CBC-HS256 |
Data Holders MUST support at a minimum, 1 algorithm for each claim.
Data Recipients MUST support all the algorithms used in the ecosystem to ensure they can communicate with all Data Holders.
ID Token algorithm considerations remain relevant where the OIDC Hybrid Flow is leveraged as defined in the Consumer Data Standards and in accordance with sections 5.1.1, 5.2.2.1, and 5.2.3.1 of [FAPI-1.0-Advanced].
JARM Response Encryption Considerations
If Data Holders support authorisation response encryption, they MUST support, at a minimum, one of each of the following alg and enc algorithms:
| Claim | Values |
|---|---|
| authorization_encryption_alg_values_supported | RSA-OAEP RSA-OAEP-256 |
| authorization_encryption_enc_values_supported | A256GCM A128CBC-HS256 |
Data Recipients MUST support the minimum required algorithms.
Registration Validation
Validation and use of the JWT and the claims described above MUST be performed in accordance with [JWT].
SSA JWT signatures MUST be verified against the associated JWK published at the CDR Register JWKS endpoint.
The registration request JWT MUST be verified against the associated JWK published by the Data Recipient. Data Holders are required to verify the request JWT signature against an associated JWK from the jwks_uri extracted from the SSA.
Data Holders MUST NOT allow multiple active registrations for the same software_id.
From 31st August 2022, Data Holders MUST ignore unsupported authorisation scopes presented in the SSA for the creation and update of client registrations.
Data Holders MUST adhere to the NFR performance requirements when validating and responding to registration requests. Additional validation processes (such as outbound white-listing of data recipient endpoints) MUST NOT prevent specified response times being met.
Registration Response
Example Created Response OIDC Hybrid Flow
HTTP/1.1 201 Created
Content-Type: application/json
{
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code id_token"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
Example Created Response Authorization Code Flow This example creates a FAPI 1.0 Phase 3 client registration that uses Authorization Code Flow with JARM encryption
HTTP/1.1 201 Created
Content-Type: application/json
{
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
On successful registration, the response MUST be returned to the Data Recipient conforming to Section 3.2.1 of [DCR].
| Claim | Required | Description |
|---|---|---|
| client_id | Required | Contains the dynamically generated identifier for the Software Product issued by the Data Holder |
| client_id_issued_at | Optional | Time at which the client identifier was issued |
As per Section 3.2.1 of [DCR], additionally, the authorisation server MUST return all registered metadata about this client, including any fields provisioned by the authorisation server itself.
The Software Statement value MUST be returned unmodified. Client metadata elements used from the software statement MUST also be returned directly as top-level client metadata values in the registration response.
Any additional claims MUST be ignored and not returned on completion of the request.
Registration Errors
Example Error Response
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"error": "invalid_software_statement",
"error_description": "Duplicate registrations for a given software_id are not valid"
}
When an error condition occurs during a registration request, the response MUST be returned to the Accredited Data Recipient conforming to Section 3.2.2 of [DCR].
Duplicate registrations are not permitted so attempts to create a registration which already exists MUST return an HTTP 400 error.
Registration error responses schemas are defined in the DCR APIs section.
For those Registration errors which do not map to Section 3.2.2 of [DCR], HTTP Response Codes in the Consumer Data Standards SHOULD be used.
Registration Management
Non-Normative Example for access token retrieval to perform registration management
HTTP/1.1 POST /token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&
scope=cdr%3Aregistration&
client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&
client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
### Decoded client assertion JWT
{
"alg": "PS256",
"typ": "JWT",
"kid": "12456"
}
{
"iss": "12345",
"sub": "12345",
"iat": 1516239022,
"exp": 1516239322,
"aud": "https://www.holder.com.au/token",
"jti": "37747cd1-c105-4569-9f75-4adf28b73e31"
}
Data Holders MUST expose Client Registration Management endpoints as defined in the DCR APIs
| HTTP Verb | MTLS | HoK | Client Authentication | |
|---|---|---|---|---|
| POST /register | Required | N/A | ||
| GET /register/{clientID} | Required | Client Credentials with cdr:registration scope | ||
| PUT /register/{clientID} | Required | Client Credentials with cdr:registration scope | ||
| DELETE /register/{clientID} | Optional | Client Credentials with cdr:registration scope |
- Registration endpoints will be exposed in the OIDC Discovery Configuration Endpoint
- POST and PUT operations MUST accept the SSA payload.
- Fields data holders do not support are not persisted.
- Access tokens issued for consuming CDR Data SHOULD NOT be used for client registration maintenance and vice-versa
PUT Operations
Registrations MUST only be updated via Registration PUT operations
PUT operations are to be used for one of two scenarios:
- The client has updated their registration details on the CDR Register and updates this information to the data holder
- A new version of the SSA has been released and the client updates this information to the data holder
Participant Statuses
Data Recipient and Software Product Statuses
The accreditation status of Data Recipients, and the status of their associated Software Products, MAY traverse through multiple statuses in the CDR.
The status of participants is maintained in the CDR Register by the CDR Registrar according to determination of the CDR Accreditor or the participant themselves.
CDR data MAY only be disclosed to active Data Recipients. Data Holders MUST cease disclosing CDR data where the accreditation of a Data Recipient or Software Product is:
- Suspended or revoked by the CDR Registrar.
- Surrendered by the Data Recipient.
The CDR Register MUST notify all Data Holders of the above changes in Data Recipient and Software Product status via the Register APIs.
The CDR Register MUST expose the statuses of data recipients and their associated software products via the Register APIs, using the following state models:
Data Recipient Status
Software Product Status
Status Mapping
When the CDR Registrar changes the accreditation status for a Data Recipient for any status other than active, the associated Software Product statuses MUST be changed accordingly.
The cascading status mappings are as follows:
| Data Recipient Status | Cascaded Software Product Status |
|---|---|
| Suspended | Inactive |
| Revoked | Removed |
| Surrendered | Removed |
Archiving
Dormant entries will be identified and archived automatically within the CDR Register.
Dormant entries are defined as those records that have reached and maintained an end state in the CDR Register for the past 2 years.
The table below outlines the end state for each Register entry type:
| Register Entity | End State |
|---|---|
| Data Holder | Removed |
| Data Holder Brand | Removed |
| Data Recipient | Surrendered, Revoked |
| Data Recipient Brand | Removed |
| Data Recipient Software Product | Removed |
Data Holder Responsibilities
The CDR Registrar has the ability to change the status of a Software Product independently of the Data Recipient's accreditation status. Therefore, both the Data Recipient and Software Product statuses SHOULD be referenced, to determine the Data Holder's responsibilities for data disclosure, consent and registration management.
| Data Recipient Status |
Software Product Status |
Disclose of CDR Data | Facilitate Consent Authorisation | Facilitate Consent Withdrawal | Invalidate Consents | Cleanup Registration |
|---|---|---|---|---|---|---|
| Active | Active | |||||
| Active | Inactive | |||||
| Active | Removed | |||||
| Suspended | Inactive | |||||
| Suspended | Removed | |||||
| Revoked | Removed | |||||
| Surrendered | Removed |
- Disclosure of CDR data MUST be in response to valid requests in accordance with the CDR rules and standards
- The status of a Data Recipient Brand does not impact Data Holder responsibilities due to the cascade rules outlined above
- When a Data Recipient status is Suspended, Revoked or Surrendered the Software Product status cannot be Active
- Invalidation of consents and cleanup of registrations are bulk operations. It is reasonable to execute these as batch tasks performed overnight
- The CDR Register MUST NOT provide an undefined status for Data Recipient or Data Recipient Software Product Statuses
- If Data Holders do not receive a status for a Data Recipient or Data Recipient Software Product, or receives a status that is not recognised, Data Holders SHOULD ignore the value and use the previous status value retrieved from the CDR Register. Data Holders SHOULD continue to use the previous status value until a valid value is returned by the CDR Register or the ACCC informs the Data Holder using an alternative mechanism. There is no upper bound for how long previous status values should remain trusted.
Metadata Cache Management
Data Holders MUST react to Data Recipient and associated Software Statuses changes within 5 minutes of the change occurring on the CDR Register.
To achieve this, Data Holders will poll the Get Data Recipients Statuses, Get Software Products Statuses and Get Data Recipients APIs to retrieve the current statuses and cache these for use during requests for Consumer Data.
Data Holders MUST choose a frequency of polling which ensures their systems can respond to status changes within the required timeframe.
Data Holders and Data Recipients MUST cache all other participant data they use and periodically update this cache using a slow poll. This ensures that changes to participant configuration propagates throughout the ecosystem in a predictable timeframe.
The CDR Register MAY cache the responses for public APIs hosted by the CDR Register. If caching is supported the CDR Register MUST support ETag cache validators allowing participants to detect whether the content has changed.
Cache update periods
The following are the recommended caching times for data retrieved from the Register APIs.
| API | Type | Period |
|---|---|---|
| GetDataRecipientsStatus | Public | 2-5 minutes |
| GetSoftwareProductsStatus | Public | 2-5 minutes |
| GetDataRecipients (statuses) | Public | 2-5 minutes |
| GetDataRecipients (other data) | Public | 6 hours |
| GetDataHolderBrands | Private | 6 hours |
OIDC Client Types
Only Confidential Clients SHALL be supported under this profile. Therefore, Public clients SHALL NOT be supported.
In reference to the client types referenced in section 2.1 of [OAUTH2]:
- Confidential Clients MUST be supported under this profile.
- Public clients MUST NOT be supported.
JSON Web Key Sets
Data Holder public keys MUST only be obtained from the standard OIDC end point used for that purpose.
Data Recipient Software Product public keys MUST only be obtained from the URI registered with the CDR Register.
CDR Register public keys MUST only be obtained from the end point exposed for that purpose.
Consent
Consent requirements will be communicated between the Data Recipient Software Product and Data Holder via the authorisation request object. The primary mechanism for capturing consent will be scopes and claims under [OIDC].
Other patterns for the establishment of consent MAY be considered in the future, including the incorporation of fine-grained consent for specific use cases.
Scopes and Claims
OIDC Scopes
In addition to CDR data scopes the following scopes MUST be supported:
openid: As described as section 3.1.2.1 of [OIDC], this scope MUST be present on each authentication request.profile: Data Holders MUST support theprofilescope as described in section 5.4 of [OIDC]. This scope MAY be present on an authentication request.
Claims
The following normal [OIDC] and standard claims claims MUST be supported for the authenticated End-User*:
sub: Pairwise Pseudonymous Identifier (PPID) for the End-User at the Data Holder.acr: Authentication Context Class Reference. MUST contain a valid ordinal LoA value.auth_time: Time when the End-User authentication occurred. Its value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTCauth_time. It MUST be returned by the Data Holder in the ID Token when the Data Recipient Software Product has requested it as an essential claim according to section 2 of the [OIDC] standard. It SHOULD NOT be returned via the UserInfo endpoint.name: End-User's full name in displayable form including all name parts.given_name: Given name(s) or first name(s) of the End-User.family_name: Surname(s) or last name(s) of the End-User.updated_at: Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTCupdated_attime.
The following standard [OIDC] claims MAY be supported:
email: End-User's preferred e-mail address. Its value MUST conform to the [RFC5322] addr-spec syntax. The Data Recipient MUST NOT rely upon this value being unique, as discussed in Section 5.7 of [OIDC].email_verified: True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the Data Holder took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.phone_number: End-User's preferred telephone number. [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.phone_number_verified: True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the Data Holder took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context- specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in [E.164] format and any extensions MUST be represented in [RFC3966] format.address: End-User's preferred postal address. The value of the address member is a JSON [RFC4627] structure containing some or all of the members defined in Section 5.1.1.
Other [OIDC] Standard Claims MUST be ignored and not authorised.
Note: For non-individual consumers, claims available via the profile scope will only return the details of the authenticated End-User and not the organisation or non-individual consumer. Data Holders SHOULD explicitly capture Claims requested by the Data Recipient. If the data cluster or [OIDC] profile scope changes meaning in future this ensures the Data Holder only returns what the consumer initially authorised to disclose.
Tokens
ID Token
Non-Normative Example - FAPI 1.0 Final Phase 3 Obligations
{
"iss": "https://www.holder.com.au",
"sub": "a9ebbef6-1f0b-44eb-96cf-0c5b51b37ab2",
"aud": "12345",
"nonce": "n-0S6_WzA2Mj",
"exp": 1311281970,
"iat": 1311280970,
"nbf": 1311280970,
"auth_time": 1311280969,
"acr": "urn:cds.au:cdr:2"
}
ID Tokens are specified in section 2 of the [OIDC] standard.
Baseline ID Token requirements
In addition to the mandatory claims specified in section 2 of the [OIDC] standard, required claims for ID Tokens as part of Hybrid Flow authentication MUST align to section 3.3 (Authentication using the Hybrid Flow) of the [OIDC] standards and section 5.2.2 and section 8.4.3 of the [FAPI-1.0-Advanced] profile.
ID Tokens MUST be signed by Data Holders as specified in section 8.6 of [FAPI-1.0-Advanced].
OIDC Hybrid Flow requirements
In accordance with [FAPI-1.0-Advanced], ID Tokens MUST be signed and encrypted when returned to a Data Recipient Software Product from both the Authorisation End Point and Token End Point.
The ID Token returned from the Authorisation End Point MUST NOT contain any Personal Information (PI) claims.
Hashing value for state and authorisation code
The following requirements apply to the OIDC Hybrid Flow:
- The
c_hashvalue MUST be generated according to section 3.3.2.11 of [OIDC]. - The
s_hashvalue MUST be generated according to section 5.1.1 of [FAPI-1.0-Advanced].
Authorization Code Flow requirements
For response_type code, in accordance with [FAPI-1.0-Advanced], ID Tokens MUST be signed when returned to a Data Recipient Software Product from the Token End Point.
Access Token
Access Tokens MUST be used as specified in section 10.3 of [OAUTH2].
An Access Token MUST expire between 2 minutes to 10 minutes after the Data Holder issues it (at the discretion of the Data Holder).
The process for refreshing an Access Token is described in section 12.1 of [OIDC].
- Data Holders MUST reject token request with an authorization code (Section 1.3.1 of [RFC6749]) if it has been previously used
Refresh Token
Refresh Tokens MUST be supported by Data Holders.
The usage of Refresh Tokens is specified in section 12 of [OIDC].
The expiration time for a Refresh Token MUST be set by the Data Holder.
Refresh Token expiration MAY be any length of time greater than 28 days but MUST NOT exceed the end of the duration of sharing consented to by the Consumer.
- Data Holders MUST NOT cycle refresh tokens (rotation). In other words, Refresh Tokens SHOULD be issued with an "exp" equal to the sharing duration authorised by the Customer.
Token Expiry
The expiry time for issued access tokens and refresh tokens MUST be deterministic for the Data Recipient Software Product.
In order to achieve this:
- The Data Holder MUST indicate the lifetime in seconds of the access token in the
expires_infield of the JSON object returned by the token end-point (see section 4.2.2 of [OAUTH2]).
Identifiers and Subject Types
sub claim
The identifier for an authenticated end-user (subject) MUST be passed in the sub claim of an ID Token and UserInfo response as defined by [OIDC].
The Data Holder MUST generate the sub value as a Pairwise Pseudonymous Identifier (PPID) as described in section 8 of [OIDC]. Furthermore, the identifier MUST be unique per customer as per the definition of customer in the CDR Federation section of this profile.
The Data Holder MUST support the sector_identifier_uri in PPID generation according to [OIDC] if this field was supplied by the client during registration.
It is RECOMMENDED that the sub value is generated as a version 4 Universally Unique
Identifier (UUID) [RFC4122].
CDR Arrangement ID
Non-normative example: Token Endpoint hydration
Request
POST /token HTTP/1.1
Host: https://data.holder.com.au
Content-Type: application/x-www-form-urlencoded
client_id=s6BhdRkqt3
&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer
&client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
&grant_type=refresh_token
&refresh_token=8xLOxBtZp8
&scope=openid%20profile
Response
{
"access_token": "2YotnFZFEjr1zCsicMWpAA",
"expires_in": 3600,
"refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
"id_token": "eyJraWQiOiIxZTlnZGs3IiwiYWxnIjoiUl...",
"cdr_arrangement_id": "02e7c9d9-cfe7-4c3e-8f64-e91173c84ecb"
}
Decoded JWT - FAPI 1.0 Final Phase 3 Obligation
{
"iss": "https://data.holder.com.au",
"sub": "a9ebbef6-1f0b-44eb-96cf-0c5b51b37ab2",
"aud": "12345",
"nonce": "n-0S6_WzA2Mj",
"exp": 1311281970,
"iat": 1311280970,
"nbf": 1311280970,
"auth_time": 1311280969,
"acr": "urn:cds.au:cdr:3"
}
Non-normative example: Token Introspection Endpoint hydration
Request
POST /token/introspect HTTP/1.1
Host: https://data.holder.com.au
Content-Type: application/x-www-form-urlencoded
client_id=s6BhdRkqt3
&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer
&client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
&token=tGzv3JOkF0XG5Qx2TlKWIA
&token_type_hint=refresh_token
Response
{
"active": true,
"exp": 1311281970,
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read",
"cdr_arrangement_id": "02e7c9d9-cfe7-4c3e-8f64-e91173c84ecb"
}
The CDR Arrangement ID is a unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer.
The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile.
The Data Holder MUST provide the CDR Arrangement ID as the claim cdr_arrangement_id in the Token End Point response and Token Introspection End Point response.
Statements related to the CDR Arrangement ID:
- The CDR Arrangement ID MUST be unique to a Data Holder
- The CDR Arrangement ID MUST be non-guessable and MUST NOT identify a consumer
- A CDR Arrangement ID SHOULD be generated using an algorithm that reduces the chances of collision
- A CDR Arrangement ID MUST be static across consents within the one sharing arrangement (e.g. across consent renewal and re-authorisation)
Obtaining a CDR Arrangement ID
A Data Recipient Software Product can call either the Token or Token Introspection End Points at any point post-consent to obtain the CDR Arrangement ID in the response JSON as the claim cdr_arrangement_id.
Levels of Assurance (LoAs)
Levels Of Assurance (LoAs), returned after a successful authentication MUST be represented in Single Ordinal form where a single LoA value is represented.
Single Ordinal
A Single LoA value is carried in the acr claim which is described in section 2 of [OIDC].
An LoA of 2 is represented by the URI:
urn:cds.au:cdr:2- The authenticator used to attain this level MUST conform with the Credential Level
CL1rules specified under the Trusted Digital Identity Framework [TDIF] Authentication Credential Requirements specification.
- The authenticator used to attain this level MUST conform with the Credential Level
An LoA of 3 is represented by the URI:
urn:cds.au:cdr:3- The authenticators used to attain this level MUST conform with the Credential Level
CL2rules specified under the Trusted Digital Identity Framework [TDIF] Authentication Credential Requirements specification.
- The authenticators used to attain this level MUST conform with the Credential Level
READ operations SHALL only be allowed where at least an LoA of 2 has been achieved during the establishment of consent.
WRITE operations SHALL only be allowed where:
- At least an LoA of 3 has been achieved during the establishment of consent, or
- At least an LoA of 2 has been achieved during the establishment of consent and a subsequent challenge/response has resulted in an LoA of 3 being achieved within the lifespan of the current Access Token.
Transaction Security
Use of TLS
All HTTP calls MUST be made using HTTPS incorporating TLS >= 1.2.
Use of MTLS
All back-channel communication between Data Recipient Software Product and Data Holder systems MUST incorporate, unless stated otherwise, [MTLS] as part of the TLS handshake:
- The presented Client transport certificate MUST be issued by the CDR Certificate Authority (CA). The Server MUST NOT trust Client transport certificates issued by other authorities.
- The presented Server transport certificate MUST be issued by the CDR Certificate Authority (CA). The Client MUST NOT trust Server transport certificates issued by other authorities.
End points for transferring CDR Data that are classified as not requiring authentication do not require the use of [MTLS].
Holder of Key Mechanism
[MTLS] MUST be supported as a Holder of Key (HoK) Mechanism.
Note that, by implication, resource requests MUST be validated to ensure the client certificate and access token match.
OAUTB SHALL NOT be supported due to a lack industry support.
[MTLS] HoK allows issued tokens to be bound to a client certificate as specified in section 3 of [MTLS].
Ciphers
Obligation change from March 17th 2025:
- Removed specific named ciphers
+ Adopted BCP195
Until March 17th 2025, the following SHALL requirements apply:
Only the following cipher suites SHALL be permitted in accordance with section 8.5 of [FAPI-1.0-Advanced]:
-
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 -
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
The following cipher suites SHOULD NOT be supported:
-
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 -
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
From March 17th 2025, the following requirements SHALL apply:
In addition to section 8.5 of [FAPI-1.0-Advanced] only cipher suites recommended in [BCP195] SHALL be permitted.
Certificate Management
Issued by the Register for Data Holders
| Certificate | Function | Notes |
|---|---|---|
| Server Certificate(s) | Certificate is issued to a FQDNSecures the following endpoints:- Resource endpoints- InfoSec endpoints- Admin endpoints | It will be up to the DH on how these endpoints are segregated. They may all be on the one domain (so only one certificate required) or could be separated. |
Issued by the Register CA for Data Recipients
| Certificate | Function | Notes |
|---|---|---|
| Client Certificate | Secures the following:- Consuming Register APIs- Consuming Data Holder APIs | |
| Server Certificate(s) | Certificate is issued to a FQDN. Secures the following:- CDR Arrangement Revocation endpoint - JWKS endpoint |
ADRs may choose to secure their endpoints with the Register CA issued certificate or a certificate issued by a public CA. |
CDR Certificate Authority
DigiCert acts as the certificate authority that issues and manages certificates to CDR participants as directed by the ACCC Register in its capacity as the CDR Registrar.
Certificate Trust Model
The CDR utilises a private certificate trust chain for all Register CA secured endpoints being hosted by Data Holders, Data Recipients and the Register.
This trust chain encompasses a set of root and intermediate CAs issued for the test and production environments.
| Test Environment | Details provided to participants when they begin CTS process |
| Production Environment | CA Root ProductionCA Intermediate Production |
Certificate Signing Request Profile
When requesting the Register CA certificates, certificate signing requests will need to be provided, conforming to the following profile:
| CSR Field | Required | Server | Client |
|---|---|---|---|
| Common Name (CN) | Mandatory | Primary DNS Namee.g. api1.test.entity.com | Software Product Name |
| SAN | Optional | Secondary DNS Name(s) e.g. api2.test.entity.com | N/A |
| Organization (O) | Mandatory | Brand Name | Brand Name |
| Organizational Unit (OU) | Mandatory | Consumer Data Right | Consumer Data Right |
| Country (C) | Mandatory | Country of participante.g. AU | Country of participante.g. AU |
| State (ST) | Optional | State of the Participante.g. New South Wales | State of the Participante.g. New South Wales |
| Locality (L) | Optional | Locality of the Participante.g. Sydney | Locality of the Participante.g. Sydney |
| Email Address | Optional | Participant's email address to be displayed in the issued certificate | Participant's email address to be displayed in the issued certificate |
| Signature Algorithm | Mandatory | SHA256 | SHA256 |
| Key Algorithm | Mandatory | RSA | RSA |
| Key Size | Mandatory | 2048 | 2048 |
Note: optional values, if provided, will be validated to be correct.
Please refer to the Register onboarding guide for further information on certificate issuance.
Certificate Usage
Further details on the Register CA issued certificates can be found in the ACCC Certificate Practice Statement V1.0.
Certificate Validation
Certificate validation must check:
1. Checking for certificate validity
Verify private key signature is mathematically linked to the presented public key certificate, presented certificate identifies trusted User/Application and/or Service and certificate is both valid and not revoked.
2. Issuer‐to‐subject name chaining
Signatures from Issuing CA’s and associated CA public key certificates are trusted, valid and not revoked.
3. Policy and key use constraints
Each certificate has the applicable and appropriate x.509 certificate extensions, e.g. CA and CRL signing, Digital Signing, Client and Server Authentication, etc.
4. Revocation Status
Status is checked through Certificate Revocation Lists (CRL) or Online Certificate Status Protocol (OCSP) responders, identified in each certificate in the chain.
The Certificate Practice Statement provides details for DigiCert's certificate validation requirements and a summary has been provided in the CDR Support Portal article: Certificate Validation.
OCSP stapling
The use of OCSP Stapling within the CDR ecosystem is not recommended.
CORS
Cross-origin resource sharing (CORS) protections must be disabled (ie. Access-Control-Allow-Origin set to "*") for all unauthenticated end points unless specifically stated otherwise in these standards or in a normative reference.
Request Object
Non-Normative Example - acr as an Essential Claim
#Decoded Request Object JWT
{
"iss": "s6BhdRkqt3",
"exp": 1516239322,
"aud": "https://www.recipient.com.au",
"response_type": "code id_token",
"client_id": "s6BhdRkqt3",
"redirect_uri": "https://www.recipient.com.au/coolstuff",
"scope": "openid profile bank:accounts.basic:read
bank:accounts.detail:read",
"nonce": "n-0S6_WzA2Mj",
"state": "af0ifjsldkj",
"claims": {
"sharing_duration": 7776000,
"cdr_arrangement_id": "02e7c9d9-cfe7-4c3e-8f64-e91173c84ecb",
"id_token": {
"acr": {
"essential": true,
"values": ["urn:cds.au:cdr:3"]
}
},
"userinfo": {
"given_name": null,
"family_name": null
}
}
}
Non-Normative Example - FAPI 1.0 Final Phase 3 Obligation
#Decoded Request Object JWT
{
"iss": "s6BhdRkqt3",
"exp": 1680832800,
"nbf": 1680829200,
"aud": "https://www.recipient.com.au",
"response_type": "code",
"response_mode": "jwt",
"client_id": "s6BhdRkqt3",
"redirect_uri": "https://www.recipient.com.au/coolstuff",
"scope": "openid profile bank:accounts.basic:read
bank:accounts.detail:read",
"nonce": "n-0S6_WzA2Mj",
"state": "af0ifjsldkj",
"claims": {
"sharing_duration": 7776000,
"cdr_arrangement_id": "02e7c9d9-cfe7-4c3e-8f64-e91173c84ecb",
"id_token": {
"acr": {
"essential": true,
"values": ["urn:cds.au:cdr:3"]
}
},
"userinfo": {
"given_name": null,
"family_name": null
}
},
"code_challenge": "ZTA2ZmFkYjUyMjA2NDNhZGVkYzE1M2I5OTYzZDAxNGI2NWNiZjAxMzVhNDlmMTk2NTlmZWE0OWVhOTQxZjhmZg==",
"code_challenge_method": "S256"
}
The Request Object is a signed and encoded JWT specified in section 6.1 of [OIDC]. As per [FAPI-1.0-Advanced] section 5.2.2, the request parameter MUST be present on requests to the [OIDC] Hybrid Authorisation End Point. The Request Object enables [OIDC] requests to be passed in a single and self-contained parameter.
Request Objects MUST be signed by Data Recipient Software Products as specified in section 8.6 of [FAPI-1.0-Advanced].
Request Object references MUST be supported if the Data Holder supports Pushed Authorisation Requests (PAR).
Requesting Sharing Duration
To facilitate the specification of the duration for consent to share CDR data that is approved by the consumer, a mechanism for the Data Recipient Software Product to specify a sharing duration to the Data Holder is required.
To accomplish this, the Data Holder MUST support an additional claim in the authorisation request object named sharing_duration. The sharing_duration claim MUST be handled as follows:
- The
sharing_durationparameter is a number - The value of the
sharing_durationparameter will contain the requested duration for sharing, in seconds. - If the
sharing_durationvalue exceeds one year then a duration of one year will be assumed. - If the
sharing_durationvalue is less than or equal to 24 hours, then one-time collection will be assumed, and a Refresh Token SHOULD be provided by the Data Holder - If the
sharing_durationvalue is zero or absent then once off access will be assumed and only an Access Token (without a Refresh Token) will be provided on successful authorisation. - If a Refresh Token is issued for one-time collection the Data Recipient Software Product MUST call the Data Holder’s revocation endpoint after successful collection of the CDR data.
- If the
sharing_durationvalue is negative then the authorisation SHOULD fail.
Note that the period of one year in the above statements SHOULD be interpreted as 365, 24 hour days (or 31,536,000 seconds).
The Data Recipient Software Product is able to obtain the expiration of the sharing arrangement by presenting a refresh token to the token introspection endpoint. The expiration value is provided in the exp field in the response.
Specifying an existing arrangement
To facilitate the amending of an existing arrangement, the following statements apply:
- Data Holders MUST support the
cdr_arrangement_idclaim provided in the Request Object. - The Data Recipient Software Product MUST provide the
cdr_arrangement_idclaim in the Request Object if requesting to amend a current authorisation in accordance with Consent: Amendment of Collection Consents and Authorisations. - Data Holders MUST treat the request under the Amending Authorisation Standards if the
cdr_arrangement_idclaim is provided.
If a Data Recipient Software Product provides the cdr_arrangement_id claim in the request object to the Data Holder's PAR endpoint, the Data Holder MUST revoke any existing tokens related to the arrangement once the new consent is successfully established and a new set of tokens has been provided to the Data Recipient Software Product.
Request Object Submission
In addition:
- Request Object references SHALL NOT be supported in any mode of use other than [PAR]. If a Data Holder does not support [PAR], it MUST NOT support Request Object references.
- The Request URI is intended to be a single-use reference to the respective request object.
- The Request URI MUST expire between 10 seconds and 90 seconds
- Data Recipient Software Products MAY provide an existing
cdr_arrangement_idclaim in an authorisation request object to establish a new consent under an existing arrangement - Data Holders MUST revoke existing refresh tokens and access tokens when a
cdr_arrangement_idis provided in the Request Object but only after successful authorisation - If the
cdr_arrangement_idis not related to the consumer being authenticated it MUST be rejected - If the
cdr_arrangement_idis not recognised by to the Data Holder it MUST be rejected
Data Holders
Data Holders MUST support Pushed Authorisation Requests (PAR) via the pushed authorisation end point according to [PAR].
- Data Holders MUST support [RFC9126] (PAR) using [PKCE] ([RFC7636]) with S256 as the code challenge method in accordance with [FAPI-1.0-Advanced] section 5.2.2.
- Data Holders MUST require PAR for authorisation request data in accordance with [RFC9126] where "require_pushed_authorization_requests" parameter is set to
true. - Data Holders MUST require the request object to contain an "exp" claim that has a lifetime of no longer than 60 minutes after the "nbf" claim in accordance with [FAPI-1.0-Advanced] section 5.2.2.
- Authorisation request data MUST only be accepted using PAR.
- Data Holders MUST reject authorisation request containing "request" parameter
- Data Holders MUST reject the reuse of "request_uri" values.
Data Recipient Software Products
- Data Recipients Software Products MUST send request object containing a "nbf" claim and an "exp" claim that has a lifetime of no longer than 60 minutes after the "nbf" claim.
- Data Recipient Software Products MUST ONLY use a "request_uri" value once
- Data Recipients MUST ONLY send authorisation request data using [RFC9126] (PAR) and use [PKCE] ([RFC7636]) in accordance with [FAPI-1.0-Advanced].
- Data Recipients Software Products MUST support [PKCE] ([RFC7636]) and MUST use S256 as the code challenge method.
Security Endpoints
OpenID Provider Configuration End Point
Non-Normative Example
## Request
GET /.well-known/openid-configuration HTTP/1.1
Host: www.dh.com.au
## Response - FAPI 1.0 Final Phase 3 Obligations
HTTP/1.1 200 OK
Content-Type: application/json
{
"acr_values_supported": ["urn:cds.au:cdr:2","urn:cds.au:cdr:3"],
"authorization_endpoint": "https://www.dh.com.au/authorise",
"claims_supported": ["name", "given_name", "family_name", "acr", "auth_time", "sub"],
"grant_types_supported": ["authorization_code", "client_credentials", "urn:openid:params:modrna:grant-type:backchannel_request"],
"id_token_encryption_alg_values_supported": [ "RSA-OAEP", "RSA-OAEP-256", "dir", "ECDH-ES", "ECDH-ES+A128KW", "ECDH-ES+A192KW", "ECDH-ES+A256KW", "A128KW", "A192KW", "A256KW", "A128GCMKW", "A192GCMKW", "A256GCMKW" ],
"id_token_encryption_enc_values_supported": [ "A128CBC-HS256", "A192CBC-HS384", "A256CBC-HS512", "A128GCM", "A192GCM", "A256GCM" ],
"id_token_signing_alg_values_supported": ["ES256", "PS256"],
"issuer": "https://www.dh.com.au",
"jwks_uri": "https://www.dh.com.au/jwks",
"registration_endpoint": "https://www.dh.com.au/register",
"request_object_signing_alg_values_supported": ["ES256", "PS256"],
"response_modes_supported": ["fragment", "jwt"],
"response_types_supported": ["code id_token", "code"],
"subject_types_supported": ["pairwise"],
"scopes_supported": ["openid", "profile", "..."],
"token_endpoint": "https://www.dh.com.au/token",
"token_endpoint_auth_methods_supported": ["private_key_jwt"],
"token_endpoint_auth_signing_alg_values_supported": ["ES256", "PS256"],
"userinfo_endpoint": "https://www.dh.com.au/userinfo",
"code_challenge_methods_supported": ["S256"],
"introspection_endpoint": "https://www.dh.com.au/introspect",
"revocation_endpoint": "https://www.dh.com.au/revoke",
"tls_client_certificate_bound_access_tokens": true,
"pushed_authorization_request_endpoint": "https://data.holder.com.au/par",
"require_pushed_authorization_requests": true,
"authorization_encryption_alg_values_supported": ["RSA-OAEP", "RSA-OAEP-256"],
"authorization_encryption_enc_values_supported": ["A256GCM", "A128CBC-HS256"],
"authorization_signing_alg_values_supported": ["ES256", "PS256"],
"cdr_arrangement_revocation_endpoint": "https://data.holder.com.au/arrangements/revoke"
}
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | TLS |
| Client Authentication Required | No |
| Bearer Token Required | No |
Data Holders MUST make their OpenID Provider Metadata available via a configuration end point as outlined in Section 3 and 4 of the OpenID Connect Discovery standards [OIDD].
This endpoint does not require CORS.
At a minimum, the Data Holder metadata MUST include:
acr_values_supported: The supported ACR valuesauthorization_endpoint: URL of the Authorization End Pointclaims_supported: The list of supported claimsgrant_types_supported: The list of the OAuth 2.0 Grant Type values supportedid_token_encryption_alg_values_supported: The list of the supported JWE algorithms for securing the issued ID tokens. Must conform to [FAPI-1.0-Advanced] and [OIDD]. Required for Data Holders supporting OIDC Hybrid Flowid_token_encryption_enc_values_supported: The list of the supported JWE encryption methods for securing the issued ID tokens. Required for Data Holders supporting OIDC Hybrid Flowid_token_signing_alg_values_supported: The list of the JWS signing algorithms (algvalues) supportedissuer: URL that the Data Holder asserts as its Issuer Identifierjwks_uri: The JSON Web Key Set for the data holderregistration_endpoint: URL of the Client Registration End Pointrequest_object_signing_alg_values_supported: The list of the JWS signing algorithms (algvalues) supported for signing request objects.response_modes_supported: The list of the OAuth 2.0response_modevalues supportedresponse_types_supported: The list of the OAuth 2.0response_typevalues supportedscopes_supported: The list of supported scopessubject_types_supported: list of the Subject Identifier types supportedtoken_endpoint: URL of the Token End Pointtoken_endpoint_auth_methods_supported: The list of Client Authentication methods supported by the Token Endpointtoken_endpoint_auth_signing_alg_values_supported: The list of the JWS signing algorithms (algvalues) supported by the token endpoint for the signature on the JWT [JWT] used to authenticate the client at the token endpoint for the "private_key_jwt" authentication methoduserinfo_endpoint: URL of the UserInfo End Point
code_challenge_methods_supported: JSON array containing a list of [PKCE (RFC7636)] code challenge methods supportedintrospection_endpoint: URL of the Introspection End Pointrevocation_endpoint: URL of the Revocation End Point
tls_client_certificate_bound_access_tokens: Indicates support for mutual-TLS client certificate-bound access tokens. Value MUST be set totrue
pushed_authorization_request_endpoint: URL of the Pushed Authorisation End Point used to support [PAR]require_pushed_authorization_requests: Boolean parameter indicating whether the authorization server accepts authorization request data only via PAR
authorization_encryption_alg_values_supported: A JSON array containing a list of the JWE encryption algorithms (algvalues) supported by the authorization endpoint to encrypt the response. If response encryption is used, Data Holders must support at least one of "RSA-OAEP" or "RSA-OAEP-256"
Where Data Holders support authorisation response encryption according to [JARM], the following parameter provisions MUST be supported:
authorization_encryption_enc_values_supported: A JSON array containing a list of the JWE encryption algorithms (encvalues) supported by the authorization endpoint to encrypt the response. Required if “authorization_encryption_alg_values_supported” is provided. If response encryption is used, Data Holders must support at least one of "A256GCM" or "A128CBC-HS256"authorization_signing_alg_values_supported: A JSON array containing a list of the JWS signing algorithms (algvalues) supported by the authorization endpoint to sign the response. Required if Authorization Code Flow (response_type “code”) is supported
In addition, the Data Holder metadata MUST also include:
cdr_arrangement_revocation_endpoint: The URL of the CDR Arrangement Revocation End Point for consent revocation
Authorisation End Point
Non-Normative Example
This example demonstrates how an ADR may send an authorisation request object by value in the front-channel to the Data Holder.
## Request
GET /authorise?
response_type=code%20id_token&client_id=12345&
scope=openid%20profile%20bank:accounts.basic:read%20bank:accounts.detail:read&
request=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyMyJ9.ey ...
HTTP/1.1
Host: www.holder.com.au
## Decoded request JWT
{
"alg": "PS256",
"typ": "JWT",
"kid": "123"
}
{
"iss": "12345",
"exp": 1516239322,
"aud": "https://www.recipient.com.au",
"response_type": "code id_token",
"client_id": "12345",
"redirect_uri": "https://www.recipient.com.au/coolstuff",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read",
"state": "af0ifjsldkj",
"nonce": "n-0S6_WzA2Mj",
"claims": {
"sharing_duration": 7776000,
"userinfo": {
"given_name": {"essential": true},
"family_name": null
},
"id_token": {
"acr": {
"essential": true,
"values": ["urn:cds.au:cdr:2"]
}
}
}
}
Non-Normative Example - FAPI 1.0 Final Phase 3 Obligation This example demonstrates how an ADR may send a staged authorisation request (using PAR) in the back-channel to the Data Holder.
It demonstrates a FAPI 1.0 Final compliant authorisation request using the PAR to first submit the authorisation request object.
## Request
GET /authorize?client_id=12345&
scope=openid&
request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3A6esc_11ACC5bwc014ltc14eY22c
HTTP/1.1
Host: www.holder.com.au
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | TLS |
| Client Authentication Required | No |
| Bearer Token Required | No |
The requirements for the Authorisation End Point are specified in section 3.3.2 of [OIDC] and further specified under section 5.2.2 of [FAPI-1.0-Advanced]. This end point is invoked as part of the Hybrid Authentication flow.
This endpoint does not require CORS.
JSON Web Key Set End Point
| Description | Value |
|---|---|
| Hosted By | Data Holder & Data Recipient Software Product |
| Transport Security | TLS |
| Client Authentication Required | No |
| Bearer Token Required | No |
The requirements for the JWKS End Point are specified in various sections of [OIDC].
This end point is used by the Data Holder to provide the public keys they will use when required.
Data Holders MUST support a JWKS End Point.
This endpoint does not require CORS.
JWKS URIs
In addition to [FAPI-1.0-Advanced] section 8.9 from July 4th 2022, the following requirements apply:
- Data Holders and Data Recipients JWK sets MUST NOT contain multiple keys with the same "kid"
Token End Point
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | MTLS |
| Client Authentication Required | Yes |
| Bearer Token Required | No |
The requirements for the Token End Point are specified in section 3.3.3 of [OIDC].
To obtain an Access Token, an ID Token, and a Refresh Token, the Data Recipient Software Product sends a Token Request to the Token End Point.
Data Holders MUST support a Token End Point.
UserInfo End Point
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | MTLS |
| Client Authentication Required | No |
| Bearer Token Required | Yes |
The requirements for the UserInfo End Point are specified in section 5.3 of [OIDC].
Data Holders MUST support a UserInfo End Point.
Introspection End Point
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | MTLS |
| Client Authentication Required | Yes |
| Bearer Token Required | No |
Data Holders MUST implement an Introspection End Point to allow Data Recipient Software Products to determine the status and expiry date of Refresh Tokens. The requirements for an Introspection End Point are described in section 2 of [RFC7662].
Introspection of Refresh Tokens MUST be supported.
Introspection of Access Tokens and ID Tokens MUST NOT be supported.
For currently active tokens, a Token Introspection End Point Response SHALL include, at least, the following fields:
active: Boolean indicator of whether or not the presented token is currently active.exp: A JSON number representing the number of seconds from 1970-01-01T00:00:00Z to the UTC expiry time.scope: A JSON string containing a space-separated list of scopes associated with this token.cdr_arrangement_id: A unique identifier of the CDR arrangement related to the authorisation.
A Token Introspection End Point Response MAY include claims defined in Section 2.2 of [RFC7662] but username SHALL NOT be allowed.
Token Revocation End Point
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | MTLS |
| Client Authentication Required | Yes |
| Bearer Token Required | No |
Requirements for Data Holder implementations
Data Holders MUST implement a Token Revocation End Point as described in section 2 of [RFC7009].
The Revocation End Point serves as a revocation mechanism that allows a Data Recipient Software Product to invalidate its tokens as required to allow for token clean up.
Revocation of Refresh Tokens and Access Tokens MUST be supported.
CDR Arrangement Revocation End Point
Non-Normative Example: Data Holder end point
(Data Recipients calling Data Holders)
Request
POST https://data.holder.com.au/arrangements/revoke
HTTP/1.1
Host: data.holder.com.au
Content-Type: application/x-www-form-urlencoded
client_id=s6BhdRkqt3&
client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&
client_assertion=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...&
cdr_arrangement_id=5a1bf696-ee03-408b-b315-97955415d1f0
| Description | Value |
|---|---|
| Hosted By | Data Holder & Data Recipient Software Product |
| Transport Security | MTLS for Data Holders, TLS for Data Recipient Software Products |
| Client Authentication Required | Yes (for Data Holders verifying Data Recipient Software Products) |
| Bearer Token Required | Yes (for Data Recipient Software Products verifying Data Holders) |
HTTP Method: POST
Data Holder Path: The cdr_arrangement_revocation_endpoint defined using OIDC Discovery
Data Recipient Software Product Path: <RecipientBaseUri>/arrangements/revoke where <RecipientBaseUri> is registered with the CDR Register.
Data Holders and Data Recipient Software Products MUST implement a CDR Arrangement Revocation End Point that can be used to revoke an existing sharing arrangement.
CDR Arrangement Form Parameter method
The request MUST include the following parameters using the application/x-www-form-urlencoded format in the HTTP request entity-body:
cdr_arrangement_id: The ID of the arrangement that the client wants to revoke.
CDR Arrangement JWT method
The request MUST include the following parameters using the application/x-www-form-urlencoded format in the HTTP request entity-body:
cdr_arrangement_jwt: A signed JWT that includes thecdr_arrangement_id.cdr_arrangement_jwt: A newly signed JWT with the following parameters in accordance with [JWT]:cdr_arrangement_id: The ID of the arrangement that the client wants to revoke.
The cdr_arrangement_jwt SHOULD include all parameters in accordance with Data Holders calling Data Recipients using Self-Signed JWT Client Authentication.
Data Holder hosted endpoint
The location of the Data Holder CDR Arrangement Revocation End Point is determined by the cdr_arrangement_revocation_endpoint in the Data Holder's OpenID Provider metadata.
This end point will be implemented according to the following:
- Data Holders MUST only support "CDR Arrangement Form Parameter" method
- Data Recipient Software Products MUST revoke consent by calling the CDR Arrangement Revocation End Point with a valid CDR Arrangement ID
- Data Holders MUST publish their CDR Arrangement Revocation End Point using their OpenID Provider Metadata Discovery End Point
- Consent revocation MUST also revoke associated refresh and/or access tokens
- If the
cdr_arrangement_idis not related to the client making the call it MUST be rejected
Non-Normative Example: Data Recipient end point
Until July 31st 2022
(Data Holders calling Data Recipients)
Request
POST https://data.recipient.com.au/arrangements/revoke
HTTP/1.1
Host: data.recipient.com.au
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
cdr_arrangement_id=5a1bf696-ee03-408b-b315-97955415d1f0
Non-Normative Example: Data Recipient end point
From March 31st 2022
(Data Holders calling Data Recipients)
Request
POST https://data.recipient.com.au/arrangements/revoke
HTTP/1.1
Host: data.recipient.com.au
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyNDU2In0.ey ...
cdr_arrangement_id=5a1bf696-ee03-408b-b315-97955415d1f0&
cdr_arrangement_jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IjEyNDU2In0.ey ...
## Decoded cdr_arrangement_jwt JWT
{
"typ": "JWT",
"alg": "PS256",
"kid":"12456"
}
{
"cdr_arrangement_id": "5a1bf696-ee03-408b-b315-97955415d1f0",
"iss":"dataholderbrand-123",
"sub":"dataholderbrand-123",
"aud":"https://data.recipient.com.au/arrangements/revoke",
"iat":1516239022,
"exp":1516239322,
"jti":"dba86502-7cf5-4719-9638-c5339a0ddb06"
}
Data Recipient hosted endpoint
The location of the Data Recipient Software Product CDR Arrangement Revocation End Point is determined by the RecipientBaseURI provided by the Data Recipient Software Product in the client Software Statement Assertion (SSA).
This end point will be implemented according to the following:
- Data Recipient Software Products MUST expose their CDR Arrangement Revocation End Point under their
recipient_base_uripublished in their Software Statement Assertion. - Data Holders must be authenticated when they call this end point according to the guidance in the Client Authentication section.
- If the
cdr_arrangement_idis not related to the client making the call it MUST be rejected. - From March 31st 2022, Data Recipients MUST support the "CDR Arrangement JWT" method.
- From July 31st 2022, Data Holders MUST send the
cdr_arrangement_idusing the "CDR Arrangement JWT" method. - Data Holders MAY additionally send a duplicate of the
cdr_arrangement_idas a form parameter. - Data Recipient Software Products MUST NOT reject requests including the
cdr_arrangement_idas a form parameter. - If the
cdr_arrangement_idis presented as a form parameter, Data Recipient Software Products SHOULD validate it is identical to thecdr_arrangement_idpresented in the "CDR Arrangement JWT". - From November 15th 2022, if the
cdr_arrangement_idis presented as a form parameter, Data Recipient Software Products MUST validate it is identical to thecdr_arrangement_idpresented in the "CDR Arrangement JWT". - From November 15th 2022, if the Self-Signed JWT claims are presented in the "CDR Arrangement JWT", Data Recipient Software Products MUST validate in accordance with Data Holders calling Data Recipients using Self-Signed JWT Client Authentication.
Response Codes
The following responses are in addition to error responses covered by normative references. Error scenarios in the following table MUST use the error structure defined in the Payload Conventions.
| Response Code | Situation | Description |
|---|---|---|
| 204 No Content | Success | The sharing arrangement has been revoked successfully |
| 422 Unprocessable Entity | Invalid Arrangement ID | The client submitted an invalid arrangement identifier or the identifier could not be found. The server MUST respond with Invalid Consent Arrangement. |
Revoking consent
Data Recipient Software Products MUST use the Data Holder's CDR Arrangement Revocation endpoint with a valid cdr_arrangement_id to notify the Data Holder when consent is withdrawn or otherwise expires, except for the following reasons:
- The withdrawal was initiated via the Data Holder,
- The consent expires at its natural expiry time, defined by the Data Recipient in the authorisation request and available in the token introspection endpoint,
- Invalidation of the consent due to a change in the Data Holder or Data Holder Brand status on the Register.
Data Holder's MUST use the Data Recipient Software Product's CDR Arrangement Revocation endpoint with a valid cdr_arrangement_id to notify the Data Recipient Software Product when an authorisation is withdrawn or otherwise expires, except for the following reasons:
- The withdrawal was initiated via the Data Recipient,
- The authorisation expires at its natural expiry time, defined by the Data Recipient in the authorisation request and available in the token introspection endpoint,
- Invalidation of the authorisation due to a change in the Data Recipient or Software Product status on the Register.
Pushed Authorisation End Point
Non-Normative Example
Utilising RFC9126 and OIDC Hybrid FlowRequest
POST /par HTTP/1.1
Host: data.holder.com.au
Content-Type: application/x-www-form-urlencoded
request=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyMyJ9.ey...
Decoded Request
This example shows an authorisation request using the OIDC Hybrid Flow
{
"iss": "s6BhdRkqt3",
"exp": 1516239322,
"aud": "https://www.recipient.com.au",
"response_type": "code id_token",
"client_id": "s6BhdRkqt3",
"redirect_uri": "https://www.recipient.com.au/coolstuff",
"scope": "openid profile bank:accounts.basic:read
bank:accounts.detail:read",
"nonce": "n-0S6_WzA2Mj",
"state": "af0ifjsldkj",
"claims": {
"sharing_duration": 7776000,
"cdr_arrangement_id": "02e7c9d9-cfe7-4c3e-8f64-e91173c84ecb",
"id_token": {
"acr": {
"essential": true,
"values": ["urn:cds.au:cdr:3"]
}
},
"userinfo": {
"given_name": null,
"family_name": null
}
}
}
Response
HTTP/1.1 201 Created
Content-Type: application/json
Cache-Control: no-cache, no-store
{
"request_uri": "urn:data.holder.com.au:bwc4JK-ESC0w8acc191e-Y1LTC2",
"expires_in": 3600
}
Authorise
## The request_uri is used by the ADR in the subsequent authorisation request as follows
## (note this example is pre-RFC using Draft 01 of the PAR standard, hence it includes
## the mandatory oAuth parameters as per FAPI R/W for confidential clients must be
## replayed in the request URL):
GET /authorise?client_id=s6BhdRkqt3&
response_type=code%20id_token&
scope=openid%20profile%20bank:accounts.basic:read%20bank:accounts.detail:read&
request_uri=urn%3Adata.holder.com.au%3Abwc4JK-ESC0w8acc191e-Y1LTC2
HTTP/1.1
Host: data.holder.com.au
Non-Normative Example - FAPI 1.0 Final Phase 3 Obligations
Utilising FAPI 1.0 Final, PAR RFC9126, PKCE, JARM and Authorization Code FlowRequest
POST /par HTTP/1.1
Host: data.holder.com.au
Content-Type: application/x-www-form-urlencoded
request=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEyMyJ9.ey...
Decoded Request - FAPI 1.0 Final Phase 3 Obligation
This example shows an authorisation request using the Authorisation Code Flow (FAPI 1.0 migration Phase 3)
{
"iss": "s6BhdRkqt3",
"exp": 1680832800,
"nbf": 1680829200,
"aud": "https://www.recipient.com.au",
"response_type": "code",
"response_mode": "jwt",
"client_id": "s6BhdRkqt3",
"redirect_uri": "https://www.recipient.com.au/coolstuff",
"scope": "openid profile bank:accounts.basic:read
bank:accounts.detail:read",
"nonce": "n-0S6_WzA2Mj",
"state": "af0ifjsldkj",
"claims": {
"sharing_duration": 7776000,
"cdr_arrangement_id": "02e7c9d9-cfe7-4c3e-8f64-e91173c84ecb",
"id_token": {
"acr": {
"essential": true,
"values": ["urn:cds.au:cdr:3"]
}
},
"userinfo": {
"given_name": null,
"family_name": null
}
},
"code_challenge": "ZTA2ZmFkYjUyMjA2NDNhZGVkYzE1M2I5OTYzZDAxNGI2NWNiZjAxMzVhNDlmMTk2NTlmZWE0OWVhOTQxZjhmZg==",
"code_challenge_method": "S256"
}
Response - FAPI 1.0 Final Phase 3 Obligation
HTTP/1.1 201 Created
Content-Type: application/json
Cache-Control: no-cache, no-store
{
"request_uri": "urn:data.holder.com.au:bwc4JK-ESC0w8acc191e-Y1LTC2",
"expires_in": 3600
}
Authorise - FAPI 1.0 Final Phase 3 Obligation
## This is used by the ADR in the subsequent authorisation request as follows
## (this example uses PAR RFC 9126 and Authorization Code Flow):
GET /authorise?client_id=s6BhdRkqt3&
request_uri=urn%3Adata.holder.com.au%3Abwc4JK-ESC0w8acc191e-Y1LTC2
HTTP/1.1
Host: data.holder.com.au
Authorisation response using JARM response encryption - FAPI 1.0 Final Phase 3 Obligation
eyJraWQiOiIwZWQ3YTNkZi1hMGJlLTRhZjQtOTk0YS1jNDBhODc0ODQwNjMiLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiIxMjM0NSIsImNvZGUiOiJpMVdzUm4xdUIxIiwiaXNzIjoiaHR0cHM6Ly9kYXRhLmhvbGRlci5jb20uYXUvIiwic3RhdGUiOiJhZjBpZmpzbGRraiIsImV4cCI6MTY2NzI2ODAwMH0.flBD3bTUHUFiNMbfgt-Uqt4wnEFHY79QYx0f9qrqPGPZLB-RBb-F20aPTyB9XaJ1JJ3ie1m0YxdMC7t6aiXSchZZQXBmYpIjvlbTceOVBYlr88llqeLAfQ5nCDD4p2axqyedpA83OgPF8i_Ngw0oRsCwBTueo6C40wYeI3ZT_n0hucQqGHcSoR1im7IY1rY0x99EZjJI3pxVtGwst6e-msomipnYedCdkNuPHE_Rnj0g897zi_NdK6m3dhxcpwaoMXcaYfMkkkzTlbz5_Ic9lWMx_z01C2wRNjRBArEJsNXW0Q8Vdhk_vtOAmO92Pr3cI8BpTr5KdY2O1iD-yRnkug
## Decoded Response
{
"kid": "0ed7a3df-a0be-4af4-994a-c40a87484063",
"alg": "PS256"
}
{
"aud": "12345",
"code": "i1WsRn1uB1",
"iss": "https://data.holder.com.au/",
"state": "af0ifjsldkj",
"exp": 1667268000
}
| Description | Value |
|---|---|
| Hosted By | Data Holder |
| Transport Security | MTLS |
| Client Authentication Required | Yes |
| Bearer Token Required | No |
Data Holders MUST support Pushed Authorisation Requests (PAR) via the pushed authorisation end point according to [PAR].
Data Recipient Software Products MUST send authorisation requests using [PAR] if supported by the Data Holder.
The Data Holder response provides the Data Recipient Software Product with a Request URI in the response. The Request URI is then passed to the Data Holder’s Authorisation End Point to initiate an authorisation flow.
Dynamic Client Registration Endpoints
Data Holders MUST expose the following endpoints in accordance with [DCR].
For more details of these endpoints see the DCR APIs section.
For additional statements on the operation of these endpoint during client registration see the Client Registration section.
| HTTP Verb | Auth Server Support | TLS-MA | HoK | Grant Type | Access Token Scope |
|---|---|---|---|---|---|
| POST /register | Required | N/A | None | ||
| GET /register/{clientID} | Required | Client Credentials | cdr:registration | ||
| PUT /register/{clientID} | Required | Client Credentials | cdr:registration | ||
| DELETE /register/{clientID} | Optional | Client Credentials | cdr:registration |
Additional statements regarding these endpoints:
- During registration management requests, Data Holders MUST validate that the scope of access tokens provided includes
cdr:registration - Registration requests and responses must conform to the specification in the DCR APIs section.
- Any fields the Data Holder does not support MUST be ignored without error.
- Registrations MUST only be updated via a PUT operation on the registration endpoint
- POST and PUT operations MUST accept the SSA payload
- Update (PUT) operations are to be used for one of two scenarios:
- The client has updated their registration details on the CDR Register and updates this information to the data holder brands
- A new version of the SSA has been released and the client updates this information to the data holder brands
Register Endpoints
The CDR Register exposes an OIDC Configuration Endpoint with associated JWKS and token endpoints to facilitate issuance of access tokens to consume the protected Register APIs.
Retrieve CDR Register OIDC Discovery Endpoint
GET /.well-known/openid-configuration HTTP/1.1
Host: cdr.register
## Response
{
"issuer": "https://cdr.register/idp",
"jwks_uri": "https://cdr.register/idp/.well-known/openid-configuration/jwks",
"token_endpoint": "https://cdr.register/idp/connect/token",
"claims_supported": ["sub"],
"id_token_signing_alg_values_supported": ["PS256"],
"subject_types_supported": ["public"],
"scopes_supported": ["cdr-register:bank:read"],
"response_types_supported": ["token"],
"grant_types_supported": ["client_credentials"],
"token_endpoint_auth_methods_supported": ["private_key_jwt"],
"tls_client_certificate_bound_access_tokens": true,
"request_object_signing_alg_values_supported": ["PS256"]
}
Participant Endpoints
OIDC Discovery Configuration Endpoint
<InfoSecBaseUri>/.well-known/openid-configuration
Participants will be required to register base URIs against each of their brands to facilitate the implementation of the Consumer Data Standards
| Base URI | DH Brand | ADR Brand | Description |
|---|---|---|---|
| PublicBaseUri | Base URI for the Consumer Data Standard public endpoints. This should encompass all endpoints not requiring authentication. Data Holders designated for the Energy sector are not required to expose energy product reference endpoints via their public base URI and are not required, but MAY, provide a redirect to the product reference endpoints hosted by the designated data holder. |
||
| ResourceBaseUri | Base URI for the Consumer Data Standard resource endpoints. This should encompass all CDS resource endpoints requiring authentication | ||
| InfoSecBaseUri | Base URI for the Consumer Data Standard InfoSec endpoints. This provides ADRs reference to the OIDC Discovery Endpoint | ||
| AdminBaseUri | Base URI for the Consumer Data Standard admin endpoints called by the CDR Register | ||
| ExtensionBaseUri | Base URI for the Data Holder extension endpoints to the Consumer Data Standard (optional) | ||
| RevocationUri | Used for consent withdrawal notification from a Data Holder and is populated in the SSA | ||
| RecipientBaseUri | Base URI for the Consumer Data Standard Data Recipient Software Product endpoints. This should be the base to provide reference to Data Recipient Endpoints | ||
| JwksUri | DH: Used for client authentication for DH -> DRSP communication and is populated in the GetDataHolderBrands API DR: Used for client authentication for DRSP -> DH & Register communication and is populated in the SSA |
DCR APIs
Fixed typos and formatting in multiple specification files (documentation)
This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints.
| DCR OpenAPI Specification (JSON) |
| DCR OpenAPI Specification (YAML) |
Register Data Recipient oAuth Client
Code samples
POST https://data.holder.com.au/register HTTP/1.1
Host: data.holder.com.au
Content-Type: application/jwt
Accept: application/json
const fetch = require('node-fetch');
const inputBody = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
const headers = {
'Content-Type':'application/jwt',
'Accept':'application/json'
};
fetch('https://data.holder.com.au/register', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /register
Register a client using a CDR Register issued Software Statement Assertion.
This endpoint does not require CORS.
Body parameter
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Endpoint Version
| Version | Versioning is not supported for this endpoint |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ClientRegistrationRequest | mandatory | The registration request JWT to be used to register with a Data Holder. |
Example responses
201 Response
{
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Client registration success | RegistrationProperties |
| 400 | Bad Request | Request failed due to client error | RegistrationError |
Get oAuth Client Registration
Code samples
GET https://data.holder.com.au/register/{ClientId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
Authorization: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string'
};
fetch('https://data.holder.com.au/register/{ClientId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /register/{ClientId}
Get a Client Registration for a given Client ID.
Endpoint Version
| Version | Versioning is not supported for this endpoint |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ClientId | path | string | mandatory | The client ID issued by the target Data Holder |
| Authorization | header | ExternalRef | mandatory | An Authorisation Token as per [RFC6750] |
Example responses
200 Response
{
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Client registration retrieval success | RegistrationProperties |
| 401 | Unauthorized | Request failed due to unknown or invalid Client or invalid access token | None |
| 403 | Forbidden | The client does not have permission to read, update or delete the Client | None |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 401 | WWW-Authenticate | ExternalRef | The Response Header Field as per [RFC6750] |
Update Data Recipient Registration
Code samples
PUT https://data.holder.com.au/register/{ClientId} HTTP/1.1
Host: data.holder.com.au
Content-Type: application/jwt
Accept: application/json
Authorization: string
const fetch = require('node-fetch');
const inputBody = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
const headers = {
'Content-Type':'application/jwt',
'Accept':'application/json',
'Authorization':'string'
};
fetch('https://data.holder.com.au/register/{ClientId}', {
method: 'PUT',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT /register/{ClientId}
Update a Client Registration for a given Client ID.
Body parameter
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Endpoint Version
| Version | Versioning is not supported for this endpoint |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ClientId | path | string | mandatory | The client ID issued by the target Data Holder |
| Authorization | header | ExternalRef | mandatory | An Authorisation Token as per [RFC6750] |
| body | body | ClientRegistrationRequest | mandatory | The registration request JWT to be used to register with a Data Holder. |
Example responses
200 Response
{
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Client registration update success | RegistrationProperties |
| 400 | Bad Request | Request failed due to client error | RegistrationError |
| 401 | Unauthorized | Request failed due to unknown or invalid Client or invalid access token | None |
| 403 | Forbidden | The client does not have permission to read, update or delete the Client | None |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 401 | WWW-Authenticate | ExternalRef | The Response Header Field as per [RFC6750] |
Delete Data Recipient oAuth Client Registration
Code samples
DELETE https://data.holder.com.au/register/{ClientId} HTTP/1.1
Host: data.holder.com.au
Authorization: string
const fetch = require('node-fetch');
const headers = {
'Authorization':'string'
};
fetch('https://data.holder.com.au/register/{ClientId}', {
method: 'DELETE',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE /register/{ClientId}
Delete a Client Registration for a given Client ID.
Endpoint Version
| Version | Versioning is not supported for this endpoint |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ClientId | path | string | mandatory | The client ID issued by the target Data Holder |
| Authorization | header | ExternalRef | mandatory | An Authorisation Token as per [RFC6750] |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Client deleted | None |
| 401 | Unauthorized | Request failed due to unknown or invalid Client or invalid access token | None |
| 403 | Forbidden | The client does not have permission to read, update or delete the Client | None |
| 405 | Method Not Allowed | Method Not Allowed. The requested method is unsupported | None |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 401 | WWW-Authenticate | ExternalRef | The Response Header Field as per [RFC6750] |
Schemas
ClientRegistrationRequest
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
The registration request JWT to be used to register with a Data Holder. The schema of the payload section of the decoded string(JWT) is defined in ClientRegistration.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | string(JWT) | mandatory | The registration request JWT to be used to register with a Data Holder. The schema of the payload section of the decoded string(JWT) is defined in ClientRegistration. |
RegistrationProperties
{
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| client_id | string | mandatory | Data Holder issued client identifier string |
| client_id_issued_at | ExternalRef | optional | Time at which the client identifier was issued expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC |
| client_name | string | mandatory | Human-readable string name of the software product to be presented to the end-user during authorization |
| client_description | string | mandatory | Human-readable string name of the software product description to be presented to the end user during authorization |
| client_uri | URIString | mandatory | URL string of a web page providing information about the client |
| legal_entity_id | string | optional | A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Legal Entity |
| legal_entity_name | string | optional | Human-readable string name of the Accredited Data Recipient Legal Entity |
| org_id | string | mandatory | A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Brand |
| org_name | string | mandatory | Human-readable string name of the Accredited Data Recipient to be presented to the end user during authorization |
| redirect_uris | [URIString] | mandatory | Array of redirection URI strings for use in redirect-based flows. If used, redirect_uris MUST match or be a subset of the redirect_uris as defined in the SSA |
| sector_identifier_uri | URIString | optional | URL string referencing the client sector identifier URI, used as an optional input to the Pairwise Identifier |
| logo_uri | URIString | mandatory | URL string that references a logo for the client. If present, the server SHOULD display this image to the end-user during approval |
| tos_uri | URIString | optional | URL string that points to a human-readable terms of service document for the Software Product |
| policy_uri | URIString | optional | URL string that points to a human-readable policy document for the Software Product |
| jwks_uri | URIString | mandatory | URL string referencing the client JSON Web Key (JWK) Set [RFC7517] document, which contains the client public keys |
| revocation_uri | URIString | optional | URI string that references the location of the Software Product consent revocation endpoint |
| recipient_base_uri | URIString | optional | Base URI for the Consumer Data Standard Data Recipient endpoints. This should be the base to provide reference to all other Data Recipient Endpoints |
| token_endpoint_auth_method | Enum | mandatory | The requested authentication method for the token endpoint |
| token_endpoint_auth_signing_alg | Enum | mandatory | The algorithm used for signing the JWT |
| grant_types | [Enum] | mandatory | Array of OAuth 2.0 grant type strings that the client can use at the token endpoint |
| response_types | [Enum] | mandatory | Array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint. Response type value code is required for Authorization Code Flow. Response type value code id_token is required for OIDC Hybrid Flow. |
| application_type | Enum | optional | Kind of the application. The only supported application type will be web |
| id_token_signed_response_alg | Enum | mandatory | Algorithm with which an id_token is to be signed |
| id_token_encrypted_response_alg | ExternalRef | conditional | JWE alg algorithm with which an id_token is to be encrypted.Required if OIDC Hybrid Flow (response type code id_token) is registered. |
| id_token_encrypted_response_enc | ExternalRef | conditional | JWE enc algorithm with which an id_token is to be encrypted.Required if OIDC Hybrid Flow (response type code id_token) is registered. |
| authorization_signed_response_alg | Enum | conditional | The JWS alg algorithm required for signing authorization responses. If this is specified, the response will be signed using JWS and the configured algorithm. The algorithm “none” is not allowed.Required if response_type of “code” is registered by the client. |
| authorization_encrypted_response_alg | Enum | conditional | The JWE alg algorithm required for encrypting authorization responses. If unspecified, the default is that no encryption is performed.Required if “authorization_encrypted_response_enc” is included. |
| authorization_encrypted_response_enc | Enum | optional | The JWE enc algorithm required for encrypting authorization responses. If “authorization_encrypted_response_alg” is specified, the default for this value is “A128CBC-HS256”. |
| request_object_signing_alg | Enum | mandatory | Algorithm which the ADR expects to sign the request object if a request object will be part of the authorization request sent to the Data Holder |
| software_statement | string(JWT) | mandatory | The Software Statement Assertion, as defined in CDR standards |
| software_id | string | mandatory | String representing a unique identifier assigned by the Register and used by registration endpoints to identify the software product to be dynamically registered. The "software_id" will remain the same for the lifetime of the product, across multiple updates and versions |
| software_roles | Enum | optional | String containing a role of the software in the CDR Regime. Initially the only value used will be data-recipient-software-product |
| scope | string | mandatory | String containing a space-separated list of scope values that the client can use when requesting access tokens. |
Enumerated Values
| Property | Value |
|---|---|
| token_endpoint_auth_method | private_key_jwt |
| token_endpoint_auth_signing_alg | PS256 |
| token_endpoint_auth_signing_alg | ES256 |
| grant_types | client_credentials |
| grant_types | authorization_code |
| grant_types | refresh_token |
| response_types | code |
| response_types | code id_token |
| application_type | web |
| id_token_signed_response_alg | PS256 |
| id_token_signed_response_alg | ES256 |
| authorization_signed_response_alg | PS256 |
| authorization_signed_response_alg | ES256 |
| authorization_encrypted_response_alg | RSA-OAEP |
| authorization_encrypted_response_alg | RSA-OAEP-256 |
| authorization_encrypted_response_enc | A256GCM |
| authorization_encrypted_response_enc | A128CBC-HS256 |
| request_object_signing_alg | PS256 |
| request_object_signing_alg | ES256 |
| software_roles | data-recipient-software-product |
ClientRegistration
{
"iss": "CDR Software Product ID",
"iat": 1571808167,
"exp": 2147483646,
"jti": "37747cd1c10545699f754adf28b73e31",
"aud": "https://secure.api.dataholder.com/issuer",
"client_id": "2cfefa98-7d4a-4bcb-95da-47063b84d410",
"client_id_issued_at": 1574398833,
"client_name": "Mock Software",
"client_description": "A mock software product",
"client_uri": "https://www.mockcompany.com.au",
"legal_entity_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C7",
"legal_entity_name": "Mock Company Pty Ltd.",
"org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
"org_name": "Mock Company Brand",
"redirect_uris": [
"https://www.mockcompany.com.au/redirects/redirect1",
"https://www.mockcompany.com.au/redirects/redirect2"
],
"sector_identifier_uri": "https://www.mockcompany.com.au/sector_identifier.json",
"logo_uri": "https://www.mockcompany.com.au/logos/logo1.png",
"tos_uri": "https://www.mockcompany.com.au/tos.html",
"policy_uri": "https://www.mockcompany.com.au/policy.html",
"jwks_uri": "https://www.mockcompany.com.au/jwks",
"revocation_uri": "https://www.mockcompany.com.au/revocation",
"recipient_base_uri": "https://www.mockcompany.com.au",
"token_endpoint_auth_method": "private_key_jwt",
"token_endpoint_auth_signing_alg": "PS256",
"grant_types": [
"client_credentials",
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"application_type": "web",
"id_token_signed_response_alg": "PS256",
"id_token_encrypted_response_alg": "RSA-OAEP",
"id_token_encrypted_response_enc": "A256GCM",
"authorization_signed_response_alg": "PS256",
"authorization_encrypted_response_alg": "RSA-OAEP",
"authorization_encrypted_response_enc": "A128CBC-HS256",
"request_object_signing_alg": "PS256",
"software_statement": "string",
"software_id": "740C368F-ECF9-4D29-A2EA-0514A66B0CDE",
"software_roles": "data-recipient-software-product",
"scope": "openid profile bank:accounts.basic:read bank:accounts.detail:read bank:transactions:read bank:payees:read bank:regular_payments:read common:customer.basic:read common:customer.detail:read cdr:registration"
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » iss | string | mandatory | Contains the identifier for the ADR Software Product (SoftwareProductId) as defined in the CDR Register |
| » iat | ExternalRef | mandatory | The time at which the request was issued by the Data Recipient expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC |
| » exp | ExternalRef | mandatory | The time at which the request expires expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC |
| » jti | string | mandatory | Unique identifier for the JWT, used to prevent replay of the token |
| » aud | URIString | mandatory | Contains the Data Holder issuer value as described in the OIDC Discovery Document |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | RegistrationProperties | mandatory | none |
RegistrationError
{
"error": "invalid_redirect_uri",
"error_description": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| error | Enum | mandatory | Predefined error code as described in section 3.3 OIDC Dynamic Client Registration |
| error_description | ASCIIString | optional | Additional text description of the error for debugging. |
Enumerated Values
| Property | Value |
|---|---|
| error | invalid_redirect_uri |
| error | invalid_client_metadata |
| error | invalid_software_statement |
| error | unapproved_software_statement |
Register APIs
The following section provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata. These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients.
Updated the server URL placeholder in the Register spec to refer to the actual Base URLs
- "url": "https://<register-base-url>/"
+ "url": "https://api.cdr.gov.au"
+ "description": "Production TLS"
+ "url": "https://secure.api.cdr.gov.au"
+ "description": "Production MTLS"
| Register OpenAPI Specification (JSON) |
| Register OpenAPI Specification (YAML) |
| API | Caller | Description | MTLS | TLS | Bearer Token |
|---|---|---|---|---|---|
| Get OpenId Provider Config | Data Recipient Brand or Software Product | Discovery of CDR Register OpenID Configuration | |||
| Get JWKS | Data Holder | Validate SSA and CDR Register authentication JWT signatures | |||
| Get Data Holder Brands | Data Recipient Brand or Software Product | Discovery of Data Holder Brands and their associated endpoints | |||
| Get Data Holder Brands Summary | Public Client | Discovery of Data Holder Brands and their associated public details | |||
| Get Software Statement Assertion (SSA) | Data Recipient Brand or Software Product | Get SSA for a Software Product to be used in Dynamic Client Registration | |||
| Get Data Holder Statuses | Data Recipient | Data Holder Statuses to check validity of Data Holder | |||
| Get Software Products Statuses | Data Holder Brand | Software Product Statuses to check validity of ADR requests | |||
| Get Data Recipients Statuses | Data Holder Brand | Data Recipient Statuses to check validity of ADR requests | |||
| Get Data Recipients | Data Holder Brand | Data Recipient, brand and product details to render Data Holder Consumer Dashboard |
Base URLs:
| Production TLS | https://api.cdr.gov.au |
| Production mTLS | https://secure.api.cdr.gov.au |
Get OpenId Provider Config
Code samples
GET https://api.cdr.gov.au/idp/.well-known/openid-configuration HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.cdr.gov.au/idp/.well-known/openid-configuration', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /idp/.well-known/openid-configuration
Endpoint used by participants to discover the CDR Register OpenID configuration and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.
This endpoint does not require CORS.
Endpoint Version
| Version | Versioning is not supported for this endpoint |
Example responses
200 Response
{
"issuer": "string",
"jwks_uri": "string",
"token_endpoint": "string",
"claims_supported": [
"string"
],
"id_token_signing_alg_values_supported": [
"string"
],
"subject_types_supported": [
"string"
],
"code_challenge_methods_supported": [
"string"
],
"scopes_supported": [
"string"
],
"response_types_supported": [
"string"
],
"grant_types_supported": [
"string"
],
"token_endpoint_auth_methods_supported": [
"string"
],
"tls_client_certificate_bound_access_tokens": true,
"token_endpoint_auth_signing_alg_values_supported": [
"string"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The OpenID Provider Configuration Metadata values | ResponseOpenIDProviderConfigMetadata |
Get JWKS
Code samples
GET https://api.cdr.gov.au/cdr-register/v1/jwks HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.cdr.gov.au/cdr-register/v1/jwks', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/jwks
JWKS endpoint containing the public keys used by the CDR Register to validate the signature of issued SSAs and authenticate outbound calls to participants in the CDR.
This endpoint does not require CORS.
Endpoint Version
| Version | Versioning is not supported for this endpoint |
Example responses
200 Response
{
"keys": [
{
"alg": "string",
"e": "string",
"key_ops": [
"string"
],
"kid": "string",
"kty": "string",
"n": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A JSON object that represents a set of JWKs | ResponseJWKS |
Get Data Holder Brands
Code samples
GET https://secure.api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/brands HTTP/1.1
Host: secure.api.cdr.gov.au
Accept: application/json
Authorization: string
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://secure.api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/brands', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-holders/brands
Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem.
Obsolete versions: v1
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| Authorization | header | ExternalRef | mandatory | An Authorisation Token as per [RFC6750]. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. |
| updated-since | query | DateTimeString | optional | query filter returns results updated since the specified date-time |
| page | query | PositiveInteger | optional | the page number to return |
| page-size | query | PositiveInteger | optional | the number of records to return per page |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
{
"data": [
{
"dataHolderBrandId": "string",
"brandName": "string",
"industries": [
"banking"
],
"logoUri": "string",
"legalEntity": {
"legalEntityId": "string",
"legalEntityName": "string",
"logoUri": "string",
"registrationNumber": "string",
"registrationDate": "string",
"registeredCountry": "string",
"abn": "string",
"acn": "string",
"arbn": "string",
"anzsicDivision": "string",
"organisationType": "SOLE_TRADER",
"status": "ACTIVE"
},
"status": "ACTIVE",
"endpointDetail": {
"version": "string",
"publicBaseUri": "string",
"resourceBaseUri": "string",
"infosecBaseUri": "string",
"extensionBaseUri": "string",
"websiteUri": "string"
},
"authDetails": [
{
"registerUType": "SIGNED-JWT",
"jwksEndpoint": "string"
}
],
"lastUpdated": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string",
"self": "string"
},
"meta": {
"totalPages": 0,
"totalRecords": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseRegisterDataHolderBrandList |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 401 | Unauthorized | Invalid Bearer Token | None |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 401 | WWW-Authenticate | ExternalRef | The Response Header Field as per [RFC6750] |
Get Data Holder Brands Summary
Code samples
GET https://api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/brands/summary HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
x-v: string
x-min-v: string
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'If-None-Match':'string'
};
fetch('https://api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/brands/summary', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-holders/brands/summary
Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. |
| If-None-Match | header | ASCIIString | optional | Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value. |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
{
"data": [
{
"dataHolderBrandId": "string",
"interimId": "string",
"brandName": "string",
"publicBaseUri": "string",
"logoUri": "string",
"industries": [
"banking"
],
"lastUpdated": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseDataHoldersBrandSummaryList |
| 304 | Not Modified | Not Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request header | None |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 404 | Not Found | Industry Not Found | ResponseErrorListV2 |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 200 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
| 304 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
Get Software Statement Assertion (SSA)
Code samples
GET https://secure.api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa HTTP/1.1
Host: secure.api.cdr.gov.au
Accept: application/json
x-v: string
x-min-v: string
Authorization: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'Authorization':'string'
};
fetch('https://secure.api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa
Get a Software Statement Assertion (SSA) for a software product on the CDR Register to be used for Dynamic Client Registration with a Data Holder Brand.
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. |
| dataRecipientBrandId | path | string | mandatory | Unique id for the Accredited Data Recipient Brand that the Software Product is associated with in the CDR Register |
| softwareProductId | path | string | mandatory | Unique id for the Accredited Data Recipient Software Product in the CDR Register |
| Authorization | header | ExternalRef | mandatory | An Authorisation Token as per [RFC6750]. |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 401 | Unauthorized | Invalid Bearer Token | None |
| 403 | Forbidden | Invalid BrandId | ResponseErrorListV2 |
| 404 | Not Found | Invalid Software Product | ResponseErrorListV2 |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
| 422 | Unprocessable Entity | SSA validation failed | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 401 | WWW-Authenticate | ExternalRef | The Response Header Field as per [RFC6750] |
Get Data Holder Statuses
Code samples
GET https://api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/status HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
x-v: 1
x-min-v: string
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'1',
'x-min-v':'string',
'If-None-Match':'string'
};
fetch('https://api.cdr.gov.au/cdr-register/v1/{industry}/data-holders/status', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-holders/status
Endpoint used by participants to discover the statuses for Data Holders from the CDR Register
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| x-v | header | string | optional | The version of the API endpoint requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained |
| x-min-v | header | string | optional | The minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. |
| If-None-Match | header | ASCIIString | optional | Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value. |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
{
"data": [
{
"legalEntityId": "string",
"status": "ACTIVE"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DataHoldersStatusList |
| 304 | Not Modified | Not Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request header | None |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 200 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
| 304 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
Get Software Products Statuses
Code samples
GET https://api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients/brands/software-products/status HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
x-v: string
x-min-v: string
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'If-None-Match':'string'
};
fetch('https://api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients/brands/software-products/status', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-recipients/brands/software-products/status
Endpoint used by participants to discover the statuses for software products from the CDR Register.
Obsolete versions: v1
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. |
| If-None-Match | header | ASCIIString | optional | Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value. |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
{
"data": [
{
"softwareProductId": "string",
"status": "ACTIVE"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SoftwareProductsStatusList |
| 304 | Not Modified | Not Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request header | None |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 200 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
| 304 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
Get Data Recipients Statuses
Code samples
GET https://api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients/status HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
x-v: string
x-min-v: string
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'If-None-Match':'string'
};
fetch('https://api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients/status', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-recipients/status
Endpoint used by participants to discover the statuses for Data Recipients from the CDR Register.
Obsolete versions: v1
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. |
| If-None-Match | header | ASCIIString | optional | Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value. |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
{
"data": [
{
"legalEntityId": "string",
"status": "ACTIVE"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DataRecipientsStatusList |
| 304 | Not Modified | Not Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request header | None |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 200 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
| 304 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
Get Data Recipients
Code samples
GET https://api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients HTTP/1.1
Host: api.cdr.gov.au
Accept: application/json
x-v: string
x-min-v: string
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'If-None-Match':'string'
};
fetch('https://api.cdr.gov.au/cdr-register/v1/{industry}/data-recipients', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /cdr-register/v1/{industry}/data-recipients
Endpoint used by participants to discover data recipients and associated brands and software products, available in the CDR ecosystem.
Obsolete versions: v2
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| industry | path | Enum | mandatory | The industry the participant is retrieving data for (Banking, etc) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. |
| If-None-Match | header | ASCIIString | optional | Makes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value. |
Enumerated Values
| Parameter | Value |
|---|---|
| industry | banking |
| industry | energy |
| industry | telco |
| industry | all |
Example responses
200 Response
{
"data": [
{
"legalEntityId": "string",
"legalEntityName": "string",
"accreditationNumber": "string",
"accreditationLevel": "UNRESTRICTED",
"logoUri": "string",
"dataRecipientBrands": [
{
"dataRecipientBrandId": "string",
"brandName": "string",
"logoUri": "string",
"softwareProducts": [
{
"softwareProductId": "string",
"softwareProductName": "string",
"softwareProductDescription": "string",
"logoUri": "string",
"status": "ACTIVE"
}
],
"status": "ACTIVE"
}
],
"status": "ACTIVE",
"lastUpdated": "string"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseRegisterDataRecipientList |
| 304 | Not Modified | Not Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request header | None |
| 400 | Bad Request | Missing Required Header / Invalid Version / Invalid Path Parameter | ResponseErrorListV2 |
| 406 | Not Acceptable | Unsupported Version | ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the CDR Register has responded with. |
| 200 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
| 304 | Etag | ASCIIString | Entity tag that uniquely represents the requested resource. |
Schemas
ResponseOpenIDProviderConfigMetadata
{
"issuer": "string",
"jwks_uri": "string",
"token_endpoint": "string",
"claims_supported": [
"string"
],
"id_token_signing_alg_values_supported": [
"string"
],
"subject_types_supported": [
"string"
],
"code_challenge_methods_supported": [
"string"
],
"scopes_supported": [
"string"
],
"response_types_supported": [
"string"
],
"grant_types_supported": [
"string"
],
"token_endpoint_auth_methods_supported": [
"string"
],
"tls_client_certificate_bound_access_tokens": true,
"token_endpoint_auth_signing_alg_values_supported": [
"string"
]
}
Response containing the Open ID Provider Configuration Metadata
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| issuer | URIString | mandatory | URL using the https scheme with no query or fragment component that the CDR Register asserts as its Issuer Identifier |
| jwks_uri | URIString | mandatory | URL of the CDR Register's JSON Web Key Set [JWK] document. This contains the signing key(s) used to validate access tokens issued from the CDR Register. Note that this differs from the JWKS endpoint used to validate SSAs and CDR Register client authentication |
| token_endpoint | URIString | mandatory | URL of the CDR Register's OAuth 2.0 Token Endpoint |
| claims_supported | [string] | mandatory | JSON array containing a list of the Claim Names of the Claims that the CDR Register supplies values for |
| id_token_signing_alg_values_supported | [string] | mandatory | JSON array containing a list of the JWS signing algorithms (alg values) supported by the CDR Register for the ID Token to encode the Claims in a JWT. Given the CDR Register does not issue ID tokens, this field can be safely ignored |
| subject_types_supported | [string] | mandatory | JSON array containing a list of the Subject Identifier types that the CDR Register supports. Given the CDR Register does not issue ID tokens, this field can be safely ignored |
| code_challenge_methods_supported | [string] | mandatory | JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server. Given the CDR Register does not support PKCE, this field can be safely ignored |
| scopes_supported | [string] | mandatory | JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that the CDR Register supports |
| response_types_supported | [string] | mandatory | JSON array containing a list of the OAuth 2.0 response_type values that the CDR Register supports. |
| grant_types_supported | [string] | mandatory | JSON array containing a list of the OAuth 2.0 Grant Type values that the CDR Register supports |
| token_endpoint_auth_methods_supported | [string] | mandatory | JSON array containing a list of Client Authentication methods supported by this Token Endpoint |
| tls_client_certificate_bound_access_tokens | Boolean | mandatory | Boolean value indicating server support for mutual TLS client certificate bound access tokens |
| token_endpoint_auth_signing_alg_values_supported | [string] | mandatory | JSON array containing a list of the JWS signing algorithms (alg values) supported by the token endpoint for the signature on the JWT [JWT] used to authenticate the client at the token endpoint for the "private_key_jwt" authentication method |
ResponseJWKS
{
"keys": [
{
"alg": "string",
"e": "string",
"key_ops": [
"string"
],
"kid": "string",
"kty": "string",
"n": "string"
}
]
}
Response containing the JSON Web Key Set
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| keys | [JWK] | mandatory | The value of the "keys" parameter is an array of JWK values |
JWK
{
"alg": "string",
"e": "string",
"key_ops": [
"string"
],
"kid": "string",
"kty": "string",
"n": "string"
}
Object representing a JSON Web Key
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| alg | ExternalRef | mandatory | The "alg" (algorithm) parameter identifies the algorithm intended for use with the key |
| e | ExternalRef | mandatory | The "e" RSA public exponent parameter |
| key_ops | [ExternalRef] | mandatory | The "key_ops" (key operations) parameter identifies the operation(s) for which the key is intended to be used |
| kid | ExternalRef | mandatory | The "kid" (key ID) parameter is partially used to match a specific key. Note the "kid" parameter is not guaranteed to be unique and additional parameters should be used to progressively identify a key within a set |
| kty | ExternalRef | mandatory | The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key |
| n | ExternalRef | mandatory | The "n" RSA public modulus parameter |
ResponseRegisterDataHolderBrandList
{
"data": [
{
"dataHolderBrandId": "string",
"brandName": "string",
"industries": [
"banking"
],
"logoUri": "string",
"legalEntity": {
"legalEntityId": "string",
"legalEntityName": "string",
"logoUri": "string",
"registrationNumber": "string",
"registrationDate": "string",
"registeredCountry": "string",
"abn": "string",
"acn": "string",
"arbn": "string",
"anzsicDivision": "string",
"organisationType": "SOLE_TRADER",
"status": "ACTIVE"
},
"status": "ACTIVE",
"endpointDetail": {
"version": "string",
"publicBaseUri": "string",
"resourceBaseUri": "string",
"infosecBaseUri": "string",
"extensionBaseUri": "string",
"websiteUri": "string"
},
"authDetails": [
{
"registerUType": "SIGNED-JWT",
"jwksEndpoint": "string"
}
],
"lastUpdated": "string"
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string",
"self": "string"
},
"meta": {
"totalPages": 0,
"totalRecords": 0
}
}
Response containing a list of CDR Register Data Holder Brand objects
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | [RegisterDataHolderBrand] | mandatory | Response data for the query |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
RegisterDataHolderBrand
{
"dataHolderBrandId": "string",
"brandName": "string",
"industries": [
"banking"
],
"logoUri": "string",
"legalEntity": {
"legalEntityId": "string",
"legalEntityName": "string",
"logoUri": "string",
"registrationNumber": "string",
"registrationDate": "string",
"registeredCountry": "string",
"abn": "string",
"acn": "string",
"arbn": "string",
"anzsicDivision": "string",
"organisationType": "SOLE_TRADER",
"status": "ACTIVE"
},
"status": "ACTIVE",
"endpointDetail": {
"version": "string",
"publicBaseUri": "string",
"resourceBaseUri": "string",
"infosecBaseUri": "string",
"extensionBaseUri": "string",
"websiteUri": "string"
},
"authDetails": [
{
"registerUType": "SIGNED-JWT",
"jwksEndpoint": "string"
}
],
"lastUpdated": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dataHolderBrandId | string | mandatory | Unique id of the Data Holder Brand issued by the CDR Register |
| brandName | string | mandatory | The name of Data Holder Brand |
| industries | [Enum] | mandatory | The industries the Data Holder Brand belongs to |
| logoUri | URIString | mandatory | Brand logo URI |
| legalEntity | LegalEntityDetail | mandatory | The data that is common to all organisations, regardless of the type (e.g. company, trust, partnership, government) |
| status | Enum | mandatory | none |
| endpointDetail | RegisterDataHolderBrandServiceEndpoint | mandatory | Endpoints related to Data Holder Brand services |
| authDetails | [RegisterDataHolderAuth] | mandatory | [Defines the mechanism used and associated endpoints for Data Holder to Data Recipient authentication] |
| lastUpdated | DateTimeString | mandatory | The date/time that the Data Holder Brand data was last updated in the Register |
Enumerated Values
| Property | Value |
|---|---|
| industries | banking |
| industries | energy |
| industries | telco |
| status | ACTIVE |
| status | INACTIVE |
| status | REMOVED |
ResponseDataHoldersBrandSummaryList
{
"data": [
{
"dataHolderBrandId": "string",
"interimId": "string",
"brandName": "string",
"publicBaseUri": "string",
"logoUri": "string",
"industries": [
"banking"
],
"lastUpdated": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | [DataHolderBrandSummary] | mandatory | Response data for the query |
| links | Links | mandatory | none |
| meta | Meta | mandatory | none |
DataHolderBrandSummary
{
"dataHolderBrandId": "string",
"interimId": "string",
"brandName": "string",
"publicBaseUri": "string",
"logoUri": "string",
"industries": [
"banking"
],
"lastUpdated": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dataHolderBrandId | string | optional | Unique id of the Data Holder Brand issued by the CDR Register |
| interimId | string | optional | Interim id of the Data Holder Brand issued by the CDR Register. This is to be used to uniquely identify the record when dataHolderBrandId is not populated and is not to be reused |
| brandName | string | mandatory | The name of Data Holder Brand |
| publicBaseUri | URIString | mandatory | Base URI for the Data Holder's Consumer Data Standard public endpoints |
| logoUri | URIString | mandatory | Brand logo URI |
| industries | [Enum] | mandatory | The industries the Data Holder Brand belongs to |
| lastUpdated | DateTimeString | mandatory | The date/time that the Data Holder Brand data was last updated in the Register |
| abn | string | optional | Australian Business Number for the organisation |
| acn | string | optional | Australian Company Number for the organisation |
| arbn | string | optional | Australian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies |
Enumerated Values
| Property | Value |
|---|---|
| industries | banking |
| industries | energy |
| industries | telco |
DataHoldersStatusList
{
"data": [
{
"legalEntityId": "string",
"status": "ACTIVE"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | [DataHolderStatus] | mandatory | Response data for the query |
| links | Links | mandatory | none |
| meta | Meta | mandatory | none |
DataHolderStatus
{
"legalEntityId": "string",
"status": "ACTIVE"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| legalEntityId | string | mandatory | Unique id of the Data Holder Legal Entity issued by the CDR Register. |
| status | Enum | mandatory | Data Holder status in the CDR Register |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | REMOVED |
SoftwareProductsStatusList
{
"data": [
{
"softwareProductId": "string",
"status": "ACTIVE"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | [SoftwareProductStatus] | mandatory | Response data for the query |
| links | Links | mandatory | none |
| meta | Meta | mandatory | none |
SoftwareProductStatus
{
"softwareProductId": "string",
"status": "ACTIVE"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| softwareProductId | string | mandatory | Unique id of the software product issued by the CDR Register |
| status | Enum | mandatory | Software product status in the CDR Register |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | INACTIVE |
| status | REMOVED |
DataRecipientsStatusList
{
"data": [
{
"legalEntityId": "string",
"status": "ACTIVE"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | [DataRecipientStatus] | mandatory | Response data for the query |
| links | Links | mandatory | none |
| meta | Meta | mandatory | none |
DataRecipientStatus
{
"legalEntityId": "string",
"status": "ACTIVE"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| legalEntityId | string | mandatory | Unique id of the Data Recipient Legal Entity issued by the CDR Register |
| status | Enum | mandatory | Data Recipient status in the CDR Register |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | SUSPENDED |
| status | REVOKED |
| status | SURRENDERED |
ResponseRegisterDataRecipientList
{
"data": [
{
"legalEntityId": "string",
"legalEntityName": "string",
"accreditationNumber": "string",
"accreditationLevel": "UNRESTRICTED",
"logoUri": "string",
"dataRecipientBrands": [
{
"dataRecipientBrandId": "string",
"brandName": "string",
"logoUri": "string",
"softwareProducts": [
{
"softwareProductId": "string",
"softwareProductName": "string",
"softwareProductDescription": "string",
"logoUri": "string",
"status": "ACTIVE"
}
],
"status": "ACTIVE"
}
],
"status": "ACTIVE",
"lastUpdated": "string"
}
],
"links": {
"self": "string"
},
"meta": {}
}
Response containing a list of Data Recipients in the CDR Register
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | [RegisterDataRecipient] | mandatory | Response data for the query |
| links | Links | mandatory | none |
| meta | Meta | mandatory | none |
RegisterDataRecipient
{
"legalEntityId": "string",
"legalEntityName": "string",
"accreditationNumber": "string",
"accreditationLevel": "UNRESTRICTED",
"logoUri": "string",
"dataRecipientBrands": [
{
"dataRecipientBrandId": "string",
"brandName": "string",
"logoUri": "string",
"softwareProducts": [
{
"softwareProductId": "string",
"softwareProductName": "string",
"softwareProductDescription": "string",
"logoUri": "string",
"status": "ACTIVE"
}
],
"status": "ACTIVE"
}
],
"status": "ACTIVE",
"lastUpdated": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| legalEntityId | string | mandatory | Unique id of the Data Recipient Legal Entity issued by the CDR Register. |
| legalEntityName | string | mandatory | Legal name of the Data Recipient |
| accreditationNumber | string | mandatory | CDR Register issued human readable unique number given to Data Recipients upon accreditation |
| accreditationLevel | Enum | mandatory | Accreditation level of the Data Recipient in the CDR Register |
| logoUri | URIString | mandatory | Legal Entity logo URI |
| dataRecipientBrands | [DataRecipientBrandMetaData] | optional | [Metadata related to Data Recipient Brand] |
| status | Enum | mandatory | Data Recipient status in the CDR Register |
| lastUpdated | DateTimeString | mandatory | The date/time that the Legal Entity was last updated in the CDR Register |
Enumerated Values
| Property | Value |
|---|---|
| accreditationLevel | UNRESTRICTED |
| accreditationLevel | SPONSORED |
| status | ACTIVE |
| status | SUSPENDED |
| status | REVOKED |
| status | SURRENDERED |
DataRecipientBrandMetaData
{
"dataRecipientBrandId": "string",
"brandName": "string",
"logoUri": "string",
"softwareProducts": [
{
"softwareProductId": "string",
"softwareProductName": "string",
"softwareProductDescription": "string",
"logoUri": "string",
"status": "ACTIVE"
}
],
"status": "ACTIVE"
}
Metadata related to Data Recipient Brand
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dataRecipientBrandId | string | mandatory | Unique id of the Data Recipient brand issued by the CDR Register |
| brandName | string | mandatory | Data Recipient Brand name |
| logoUri | URIString | mandatory | Data Recipient Brand logo URI |
| softwareProducts | [SoftwareProductMetaData] | optional | [Data Recipient Brand Software Products] |
| status | Enum | mandatory | Data Recipient Brand status in the CDR Register |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | INACTIVE |
| status | REMOVED |
SoftwareProductMetaData
{
"softwareProductId": "string",
"softwareProductName": "string",
"softwareProductDescription": "string",
"logoUri": "string",
"status": "ACTIVE"
}
Data Recipient Brand Software Products
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| softwareProductId | string | mandatory | Unique id of the Data Recipient software product issued by the CDR Register |
| softwareProductName | string | mandatory | Name of the software product |
| softwareProductDescription | string | mandatory | Description of the software product |
| logoUri | URIString | mandatory | Software product logo URI |
| status | Enum | mandatory | Software Product status in the CDR Register |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | INACTIVE |
| status | REMOVED |
LegalEntityDetail
{
"legalEntityId": "string",
"legalEntityName": "string",
"logoUri": "string",
"registrationNumber": "string",
"registrationDate": "string",
"registeredCountry": "string",
"abn": "string",
"acn": "string",
"arbn": "string",
"anzsicDivision": "string",
"organisationType": "SOLE_TRADER",
"status": "ACTIVE"
}
The data that is common to all organisations, regardless of the type (e.g. company, trust, partnership, government)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| legalEntityId | string | mandatory | Unique id of the organisation issued by the CDR Register |
| legalEntityName | string | mandatory | Unique legal name of the organisation |
| logoUri | URIString | mandatory | Legal Entity logo URI |
| registrationNumber | string | optional | Unique registration number (if the company is registered outside Australia) |
| registrationDate | DateString | optional | Date of registration (if the company is registered outside Australia) |
| registeredCountry | string | optional | Country of registration (if the company is registered outside Australia) |
| abn | string | optional | Australian Business Number for the organisation |
| acn | string | optional | Australian Company Number for the organisation |
| arbn | string | optional | Australian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies |
| anzsicDivision | ExternalRef | optional | ANZSIC division of the organisation. [ANZSIC-2006] |
| organisationType | Enum | optional | Legal organisation type |
| status | Enum | mandatory | none |
Enumerated Values
| Property | Value |
|---|---|
| organisationType | SOLE_TRADER |
| organisationType | COMPANY |
| organisationType | PARTNERSHIP |
| organisationType | TRUST |
| organisationType | GOVERNMENT_ENTITY |
| organisationType | OTHER |
| status | ACTIVE |
| status | REMOVED |
RegisterDataHolderBrandServiceEndpoint
{
"version": "string",
"publicBaseUri": "string",
"resourceBaseUri": "string",
"infosecBaseUri": "string",
"extensionBaseUri": "string",
"websiteUri": "string"
}
Endpoints related to Data Holder Brand services
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| version | string | mandatory | The major version of the high level standards. This is not the version of the endpoint or the payload being requested but the version of the overall standards being applied. This version number will be "v" followed by the major version of the standards as a positive integer (e.g. v1, v12 or v76) |
| publicBaseUri | URIString | mandatory | Base URI for the Data Holder's Consumer Data Standard public endpoints |
| resourceBaseUri | URIString | mandatory | Base URI for the Data Holder's Consumer Data Standard resource endpoints |
| infosecBaseUri | URIString | mandatory | Base URI for the Data Holder's Consumer Data Standard information security endpoints |
| extensionBaseUri | URIString | optional | Base URI for the Data Holder extension endpoints to the Consumer Data Standard (optional) |
| websiteUri | URIString | mandatory | Publicly available website or web resource URI |
RegisterDataHolderAuth
{
"registerUType": "SIGNED-JWT",
"jwksEndpoint": "string"
}
Defines the mechanism used and associated endpoints for Data Holder to Data Recipient authentication
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| registerUType | Enum | mandatory | The type of authentication and authorisation mechanism in use |
| jwksEndpoint | URIString | mandatory | JWKS endpoint used for authentication by the Data Holder with the Data Recipient |
Enumerated Values
| Property | Value |
|---|---|
| registerUType | SIGNED-JWT |
LinksPaginated
{
"first": "string",
"last": "string",
"next": "string",
"prev": "string",
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| first | URIString | optional | URI to the first page of this set. Mandatory if this response is not the first page |
| last | URIString | optional | URI to the last page of this set. Mandatory if this response is not the last page |
| next | URIString | optional | URI to the next page of this set. Mandatory if this response is not the last page |
| prev | URIString | optional | URI to the previous page of this set. Mandatory if this response is not the first page |
| self | URIString | mandatory | Fully qualified link to this API call |
MetaPaginated
{
"totalPages": 0,
"totalRecords": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalPages | NaturalNumber | mandatory | The total number of pages in the full set |
| totalRecords | NaturalNumber | mandatory | The total number of records in the full set |
Links
{
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link to this API call |
Meta
{}
Properties
None
MetaError
{
"urn": "string"
}
Additional data for customised error codes
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| urn | string | conditional | The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ResponseErrorListV2_errors] | mandatory | none |
ResponseErrorListV2_errors
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| code | string | mandatory | The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| title | string | mandatory | A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| detail | string | mandatory | A human-readable explanation specific to this occurrence of the problem. |
| meta | MetaError | optional | Additional data for customised error codes |
Authorisation Scopes
The following authorisation scopes have been defined for the standards. Each API end point will specify which scopes are required to access the data available via that end point.
Public
| Scope Name | Scope ID | Description |
|---|---|---|
| Public | NA | Openly accessible information. A customer would never need to grant this scope. This scope is included so that end points that can be called without requiring authorisation can be identified. Includes access to openly available information such as generic product information. |
OpenID Connect End-User Data
These scopes are used to access OpenID Connect scopes and individually requested claims of the authenticated End-User.
| Scope Name | Scope ID | Description |
|---|---|---|
| Profile Data | profile | This scope would allow for the third party to access basic profile information of the authenticated End-User. Further details are provided in CX Data Language: Profile Scope section. |
CDR Data
These scopes are used to access authenticated resource endpoints that can be used to obtain CDR Data.
| Scope Name | Scope ID | Description |
|---|---|---|
| Basic Bank Account Data | bank:accounts.basic:read | This scope would allow for the third party to access basic information of the customer’s accounts. Includes simple account information including balance. Does not include detailed account information such as account numbers, product information or transaction data. |
| Detailed Bank Account Data | bank:accounts.detail:read | This scope would allow for the third party to access detailed information of the customer’s accounts. This scope is effectively additional authorisation to the Basic Bank Account Data scope. Granting this authorisation only makes sense if the Bank Account Data scope is also authorised. Includes basic account information plus account identifiers and product information. Does not include transaction data. |
| Bank Transaction Data | bank:transactions:read | This scope would allow the third party to access transaction data for accounts. This scope is effectively additional authorisation to the Basic Bank Account Data scope. Granting this authorisation only makes sense if the Basic Bank Account Data scope is also authorised. Includes all account transaction data. |
| Bank Payee Data | bank:payees:read | This scope allows access to payee information stored by the customer. Includes payee information such as billers, international beneficiaries and domestic payees. |
| Bank Regular Payments | bank:regular_payments:read | The scope would allow the third party to access regular payments. Includes Direct Debits and Scheduled Payments. |
| Basic Service Point Data | energy:electricity.servicepoints.basic:read | This scope would allow for the third party to access basic standing data information of the customer’s service points. Includes simple standing data including the National Meter Identifier (NMI). Does not include detailed service point information such as loaction or meter attributres. |
| Detailed Service Point Data | energy:electricity.servicepoints.detail:read | This scope would allow for the third party to access detailed information of the customer’s service point connection. This scope is effectively additional authorisation to the Basic Service Point Data scope. Granting this authorisation only makes sense if the Service Point Data scope is also authorised. Includes basic service point information plus account identifiers and meter information. Does not include meter usage data. |
| Electricity Usage Data | energy:electricity.usage:read | This scope would allow the third party to access electricity usage data for service points. This scope is effectively additional authorisation to the Basic Service Point Data scope. Granting this authorisation only makes sense if the Basic Service Point Data scope is also authorised. Includes all electricity usage data including basic and interval meter meters. |
| Distributed Energy Resource Data | energy:electricity.der:read | This scope would allow the third party to access data about distributed energy resources for service points. This scope is effectively additional authorisation to the Basic Service Point Data scope. Granting this authorisation only makes sense if the Basic Service Point Data scope is also authorised. Includes distributed energy resource data available in AEMOs DER Register |
| Basic Energy Account Data | energy:accounts.basic:read | This scope would allow for the third party to access basic information of the customer’s energy accounts with retailers. Includes simple energy account information basic plan information and service points that are part of the account. Does not include detailed account information such as tailored plans, electricity contract details or discounts. |
| Detailed Energy Account Data | energy:accounts.detail:read | This scope would allow for the third party to access detailed information of the customer’s energy accounts with retailers. This scope is effectively additional authorisation to the Basic Energy Account Data scope. Granting this authorisation only makes sense if the Energy Account Data scope is also authorised. Includes basic energy account information plus tailored tariff information including charges included in the account or plan. Does not include usage data. |
| Energy Regular Payments Data | energy:accounts.paymentschedule:read | The scope would allow the third party to access payment schedules for energy accounts. Includes Direct Debit or Credit based Scheduled Payments and Manual Payments. |
| Energy Concession Data | energy:accounts.concessions:read | The scope would allow the third party to access the details of any concessions for a customer’s energy account. |
| Energy Billing Data | energy:billing:read | The scope would allow the third party to access the billing and invoice data for a customer’s energy account. |
| Basic Customer Data | common:customer.basic:read | The scope would allow the third party to access personally identifiable information about the customer. For retail customers this would be information about the customer themselves. For business customers it would imply the name of specific user but also information about the business. Includes name and occupation for individuals or name, business numbers and industry code for organisations |
| Detailed Customer Data | common:customer.detail:read | The scope would allow the third party to access more detailed information about the customer. Includes the data available with the Basic Customer Data scope plus contact details. Includes basic data plus phone, email and address information. |
Admin & Registration
The following scopes are used for administrative interactions. These scopes MUST never be included in the same access token as a CDR Data scope.
| Scope Name | Scope ID | Description |
|---|---|---|
| Basic Admin Metrics Data | admin:metrics.basic:read | Metrics data accessible ONLY to the CDR Register. If the Data Holder uses Private Key JWT Client Authentication to authenticate the CDR Register, this scope is required. Includes access to basic Metrics data. |
| Admin Metadata Update Data | admin:metadata:update | Update notification accessible ONLY to the CDR Register. If the Data Holder uses Private Key JWT Client Authentication to authenticate the CDR Register, this scope is required. Includes permission to notify Data Holders of changes to Data Recipient metadata held by the CDR Register. |
| Bank Participant Data | cdr-register:bank:read | This scope would allow Data Recipients and Data Holders access to participant metadata in the banking sector, held by the CDR Register. This scope is valid for the following endpoint versions:This scope is replaced by cdr-register:read for newer versions of these endpoints. |
| Participant Data | cdr-register:read | This scope would allow Data Recipients and Data Holders access to participant metadata held by the CDR Register. Replaces cdr-register:bank:read for the following endpoint versions: |
| Register Client | cdr:registration | This scope would allow a Data Recipient to register or manage a software product client with a Data Holder. |
Non-functional Requirements
The non-functional requirements (NFRs) for the Consumer Data Right regime cover a number of considerations:
- Minimum performance and availability expectations for data holders. Included to ensure a reliable and performant service is offered to Data Recipients and customers.
- Maximum traffic expectations for data holders. Included to ensure there is a ceiling for the amount of traffic that a data holder is expected to service.
- Requirements for reporting of performance. Included to provide transparency of performance without the need for time consuming auditing or inspection.
- Requirements for data latency and quality. Included to give a clear indication to the depth and recency of the data available under the regime.
- Limitations on the number of calls that a Data Recipient Software Product can make to a single provider. Included to protect data holders from poorly designed or overly transactional Data Recipient implementations.
Definitions
In the following definition of NFRs specific terms have the following meanings:
- Data Recipient Software Product: For the purposes of these NFRs a Data Recipient Software Product is defined, inline with the definition given in the CDR Federation, as a configured application presented in the register meta data. This acknowledges that a single accredited entity may be able to register multiple independent services (or apps) that can obtain authorisations from consumers independently of each other.
- Shared Responsibility Data Request: A request made to a secondary data holder by a Data Holder for designated data to fulfil a Consumer Data Request made by a Data Recipient Software Product.
- Session: A session is defined as the life span of a unique Access Token. Multiple API requests made with a single, valid, Access Token would be considered part of a single Session.
- Customer Present: Authenticated API requests made in direct response to interactions by the end customer using the digital services of the Data Recipient Software Product will be considered “Customer Present”. Technically a data holder will define an API request as “Customer Present” if, and only if, the
x-fapi-customer-ip-addressheader is populated with a valid IP address of the end customer’s device. - Customer Not Present: Authenticated API requests that are not deemed to be “Customer Present”
- Unattended: A synonym of “Customer Not Present”
- Authenticated: API requests to API end points that the standards require to be protected by security mechanisms that enforce explicit customer authorisation
- Unauthenticated: API requests to API end points that the standards deem to be publicly available. This implies that these end points may be accessed by any client without the client performing any authentication or authorisation actions
- High Traffic Period: Any time in the 18 hour period between 6am and 12am (midnight) is considered to be a high traffic period
- Low Traffic Period: Any time of the day not considered to be included in a high traffic period.
- Large Payload: An API which is capable of returning a large data response that would reasonably impose higher data retrieval times on the resource server. Typically bulk request end points.
Session Requirements
The expiry time of a unique session should be set according to the statements included in the Security Profile.
After a unique session is expired it is expected that the Data Recipient Software Product, for the same customer, may establish a new session as long as the authorisation is still valid.
Availability Requirements
Service availability requirement for data holders and secondary data holders: 99.5% per month
The definition of a period of unavailability is any period of time when any of the API end points defined in the standard is unable to reliably provide a successful response to an appropriately constructed request.
The availability requirement applies to both authenticated and unauthenticated end points.
The availability requirement does not include planned outages. Planned outages should be:
- Commensurate in length and frequency to other primary digital channels offered by the data holder,
- Published to Data Recipient Software Products with at least one week lead time for normal outages,
- May occur without notification if the change is to resolve a critical service or security issue.
The unavailability of a secondary data holder will mean that some requests cannot be fulfilled by a data holder making a Shared Responsibility Data Request. This will not be taken to mean that the data holder is unavailable.
Performance Requirements
API end point performance will be measured in response time of individual API requests from receipt of request to delivery of response.
It is understood that different response times can be measured depending on which technical layer of an API implementation stack is instrumented and that not all of the technical layers between the Data Recipient Software Product and the Data Holder will be in the control of the Data Holder. As this is implementation specific it is expected that the Data Holder will ensure that the measurement of response time occurs as close to the Data Recipient Software Product as practicable.
In light of these considerations, the performance requirement for Data Holders is:
95% of calls per hour responded to within a nominated threshold
The nominated threshold for each end point will be according to the following table:
| Tier | Response Time | Applies To… |
|---|---|---|
| Unauthenticated | 1500ms | All Unauthenticated end points not otherwise specified in a separate threshold. |
| High Priority | 1000ms | All calls to the following end points:
Energy Common |
| Low Priority | 1500ms | Customer Present calls to the following end points:
Energy |
| Unattended | 4000ms | Unattended calls to the following end points:
Energy Common Admin |
| Large Payload | 6000ms | Any calls to the following end points:
Energy |
| Secondary Request | 1000ms (for data holders) 1500ms (for secondary data holders) |
Customer Present calls to the following end points:
|
| Large Secondary Request | 1500ms (for data holders) 4500ms (for secondary data holders) |
Unattended calls to the following end points:
|
Note that calls initiated in excess of a traffic threshold (see next section) may be excluded from the performance requirement.
Traffic Thresholds
Calls in excess of the following traffic thresholds will be able to be freely throttled or rejected by a data holder without impact to their performance or availability requirements.
Traffic thresholds will be set using the following metrics:
- Number of sessions per day – the number of individual sessions initiated in a calendar day.
- Transactions Per Second (TPS) – the number of concurrent transactions each second.
- Number of calls – the number of end point calls initiated for a specified duration.
For Customer Present and authorisation traffic the following traffic thresholds will apply:
- Unlimited sessions per day
- 10 TPS per customer
- 50 TPS per Data Recipient Software Product
For Unattended traffic the following traffic thresholds will apply for low traffic periods:
- 20 sessions per day, per customer, per Data Recipient Software Product
- 100 total calls per session
- 5TPS per session
- 50 TPS per Data Recipient Software Product
For Unattended traffic during high traffic periods only best effort support is required.
For secure traffic (both Customer Present and Unattended) the following traffic thresholds will apply:
- For Data Holders with 0 to 10,000 active authorisations, 150 peak TPS total across all consumers
- For Data Holders with 10,001 to 20,000 active authorisations, 200 peak TPS total across all consumers
- For Data Holders with 20,001 to 30,000 active authorisations, 250 peak TPS total across all consumers
- For Data Holders with 30,001 to 40,000 active authorisations, 300 peak TPS total across all consumers
- For Data Holders with 40,001 to 50,000 active authorisations, 350 peak TPS total across all consumers
- For Data Holders with 50,001 to 60,000 active authorisations, 400 peak TPS total across all consumers
- For Data Holders with more than 60,000 active authorisations, 450 peak TPS total across all consumers
For Public traffic (i.e. traffic to unauthenticated end points) the following traffic thresholds will apply:
- 300 TPS total across all consumers (additive to secure traffic)
As traffic from Data Recipient Software Products to Data Holders will be shaped by the thresholds above, there are no specific thresholds applicable to secondary Data Holders.
Data Recipient Requirements
Data Recipient Software Products will be limited by the traffic thresholds documented in the previous section. In addition to this Data Recipients are expected to design their services according to the following principles:
- Services should be designed to minimise traffic with Data Holders
- Services should be designed to be resilient in the case of the rejection of a call by a Data Holder due to traffic threshold breaches
- Services should schedule unattended calls to avoid high traffic periods
- Unattended calls should be managed to avoid short term bursts of traffic
Low Velocity Data Sets
For endpoints that provide access to data that is low velocity (ie. the data does not change frequently) the Data Recipient Software Product is expected to cache the results of any data they receive and not request the same resource again until the data may reasonably have changed.
For low velocity data sets, if the same data is requested repeatedly a Data Holder may reject subsequent requests for the same data during a specified period.
Identified low velocity data sets are to be handled according to the following table noting that:
- the Velocity Time Period is a continuous period of time in which calls beyond a specific threshold MAY be rejected by the Data Holder
- the Allowable Call Volume is the threshold number of calls to the same resource for the same arrangement above which calls MAY be rejected by the Data Holder
| Data Set | Impacted Endpoints | Velocity Time Period | Allowable Call Volume |
|---|---|---|---|
| NMI Standing Data | Get Service Point Detail | 24 hours | 10 calls |
| Energy Usage Data | Get Usage For Service Point, Get Bulk Usage, Get Usage For Specific Service Points | 24 hours | 10 calls |
| DER Data | Get DER For Service Point, Get Bulk DER, Get DER For Specific Service Points | 24 hours | 10 calls |
Reporting Requirements
The mechanism for reporting will be via the CDR Administration Endpoints.
The following information is to be reported:
- Availability for current month
- Availability for each of the previous twelve months
- Percentage of calls within performance threshold for current day
- Percentage of calls within performance threshold for each of the previous seven days
- Number of calls within each performance tier for current day
- Number of calls within each performance tier for each of the previous seven days
- Average response time within each performance tier for current day
- Average response time within each performance tier for each of the previous seven days
- Number of sessions for current day
- Number of sessions for each of the previous seven days
- Peak total TPS for current day
- Peak total TPS for each of the previous seven days
- Average TPS for current day
- Average TPS for each of the previous seven days
- Number of calls resulting in error due to server execution for current day
- Number of calls resulting in error due to server execution for each of the previous seven days
- Number of calls rejected due to traffic thresholds for current day
- Number of calls rejected due to traffic thresholds for each of the previous seven days
- Number of customers with active authorisations
- Number of Data Recipient Software Products with active authorisations
Data Latency
Within this proposal there is no specific requirement with regard to data latency (ie. how up to date data should be). Instead, the requirement for data latency is that data presented via API end points should be commensurate to data presented via other primary digital channels.
For example, for a Bank that provides a mobile application as their primary digital experience, a balance presented via one of the balance end points should be the same as the balance presented through the mobile application.
To be able to manage network efficiency using normal mechanisms, a data holder making Shared Responsibility Data Requests may cache the results from the secondary data holder for a short period of time to accommodate repeated, duplicate, calls from the Data Recipient Software Product. Any such cache should be short lived.
Data Quality
If a Data Holder of CDR data is required or authorised under the Consumer Data Rules to disclose product data, the Data Holder must take reasonable steps to ensure that the product data is, having regard to the purpose for which it is held, accurate, up to date and complete.
Data Holders are required to be able to demonstrate that reasonable steps to maintain data quality of product data are being undertaken.
Note: For the data quality requirements that apply to CDR data for which there are one or more CDR consumers, see Privacy Safeguard 11 (section 56EN of the Competition and Consumer Act 2010). There are requirements in Privacy Safeguard 11 for both Data Holders and Data Recipients. See Chapter 11 (Privacy Safeguard 11) of the OAIC’s CDR Privacy Safeguard Guidelines for further information.
Exemptions To Protect Service
In the event of the following extreme circumstances data holders will be able to obtain relief from non-functional requirements:
- Periods of time when the digital channels for the data holder are the target for a distributed denial of service or equivalent form of attack (this should result in http error
429 Too Many Requestsbeing returned). - A significant increase in traffic from a poorly designed or misbehaving Data Recipient Software Product (this should result in http error
429 Too Many Requestsbeing returned). - If the data holder identifies a situation where there is the potential for physical or financial harm or abuse (this should result in http error
403 Forbiddenbeing returned).
Banking APIs
Updated styling of field names in the description of the 'effective' parameter of Get Products and 'type' parameter of Get Payees.
This specification defines the APIs for Data Holders exposing Banking endpoints.
| Banking OpenAPI Specification (JSON) |
| Banking OpenAPI Specification (YAML) |
Get Accounts
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts
Obtain a list of accounts.
Obsolete versions: v1.
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product-category | query | Enum | optional | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. |
| open-status | query | Enum | optional | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed. |
| is-owned | query | Boolean | optional | Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| product-category | BUSINESS_LOANS |
| product-category | CRED_AND_CHRG_CARDS |
| product-category | LEASES |
| product-category | MARGIN_LOANS |
| product-category | OVERDRAFTS |
| product-category | PERS_LOANS |
| product-category | REGULATED_TRUST_ACCOUNTS |
| product-category | RESIDENTIAL_MORTGAGES |
| product-category | TERM_DEPOSITS |
| product-category | TRADE_FINANCE |
| product-category | TRANS_AND_SAVINGS_ACCOUNTS |
| product-category | TRAVEL_CARDS |
| open-status | ALL |
| open-status | CLOSED |
| open-status | OPEN |
Example responses
200 Response
{
"data": {
"accounts": [
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingAccountListV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk Balances
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/balances
Obtain balances for multiple, filtered accounts.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product-category | query | Enum | optional | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. |
| open-status | query | Enum | optional | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed. |
| is-owned | query | Boolean | optional | Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| product-category | BUSINESS_LOANS |
| product-category | CRED_AND_CHRG_CARDS |
| product-category | LEASES |
| product-category | MARGIN_LOANS |
| product-category | OVERDRAFTS |
| product-category | PERS_LOANS |
| product-category | REGULATED_TRUST_ACCOUNTS |
| product-category | RESIDENTIAL_MORTGAGES |
| product-category | TERM_DEPOSITS |
| product-category | TRADE_FINANCE |
| product-category | TRANS_AND_SAVINGS_ACCOUNTS |
| product-category | TRAVEL_CARDS |
| open-status | ALL |
| open-status | CLOSED |
| open-status | OPEN |
Example responses
200 Response
{
"data": {
"balances": [
{
"accountId": "string",
"currentBalance": "string",
"availableBalance": "string",
"creditLimit": "string",
"amortisedLimit": "string",
"currency": "string",
"purses": [
{
"amount": "string",
"currency": "string"
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingAccountsBalanceList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Balances For Specific Accounts
Code samples
POST https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /banking/accounts/balances
Obtain balances for a specified list of accounts.
Body parameter
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestAccountIds | mandatory | The list of accountId values to obtain balances for. |
Example responses
200 Response
{
"data": {
"balances": [
{
"accountId": "string",
"currentBalance": "string",
"availableBalance": "string",
"creditLimit": "string",
"amortisedLimit": "string",
"currency": "string",
"purses": [
{
"amount": "string",
"currency": "string"
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingAccountsBalanceList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Account Balance
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}/balance
Obtain the balance for a single specified account.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | ASCIIString | mandatory | ID of the specific account requested. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"accountId": "string",
"currentBalance": "string",
"availableBalance": "string",
"creditLimit": "string",
"amortisedLimit": "string",
"currency": "string",
"purses": [
{
"amount": "string",
"currency": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingAccountsBalanceById |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Account Detail
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}
Obtain detailed information on a single account.
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | ASCIIString | mandatory | A tokenised identifier for the account which is unique but not shareable. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"isActivated": true
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"addresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingAccountByIdV3 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Transactions For Account
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}/transactions
Obtain transactions for a specific account.
Some general notes that apply to all endpoints that retrieve transactions:
- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
- As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as:
- Posted date/time if available, then
- Execution date/time if available, then
- A reasonable date/time nominated by the data holder using internal data structures
- For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account
- For aggregated transactions (i.e. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information across the subsidiary transactions as possible, is required to be shared.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | ASCIIString | mandatory | ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints. |
| oldest-time | query | DateTimeString | optional | Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type. |
| newest-time | query | DateTimeString | optional | Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type. |
| min-amount | query | AmountString | optional | Filter transactions to only transactions with amounts higher than or equal to this amount. |
| max-amount | query | AmountString | optional | Filter transactions to only transactions with amounts less than or equal to this amount. |
| text | query | string | optional | Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not). |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"transactions": [
{
"accountId": "string",
"transactionId": "string",
"isDetailAvailable": true,
"type": "DIRECT_DEBIT",
"status": "PENDING",
"description": "string",
"postingDateTime": "string",
"valueDateTime": "string",
"executionDateTime": "string",
"amount": "string",
"currency": "string",
"reference": "string",
"merchantName": "string",
"merchantCategoryCode": "string",
"billerCode": "string",
"billerName": "string",
"crn": "string",
"apcaNumber": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0,
"isQueryParamUnsupported": false
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingTransactionList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Transaction Detail
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}/transactions/{transactionId}
Obtain detailed information on a transaction for a specific account.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | ASCIIString | mandatory | ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints. |
| transactionId | path | ASCIIString | mandatory | ID of the transaction obtained from a previous call to one of the other transaction endpoints. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"accountId": "string",
"transactionId": "string",
"isDetailAvailable": true,
"type": "DIRECT_DEBIT",
"status": "PENDING",
"description": "string",
"postingDateTime": "string",
"valueDateTime": "string",
"executionDateTime": "string",
"amount": "string",
"currency": "string",
"reference": "string",
"merchantName": "string",
"merchantCategoryCode": "string",
"billerCode": "string",
"billerName": "string",
"crn": "string",
"apcaNumber": "string",
"extendedData": {
"payer": "string",
"payee": "string",
"extensionUType": "x2p101Payload",
"x2p101Payload": {
"extendedDescription": "string",
"endToEndId": "string",
"purposeCode": "string"
},
"service": "X2P1.01"
}
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingTransactionById |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Direct Debits For Account
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}/direct-debits
Obtain direct debit authorisations for a specific account.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | ASCIIString | mandatory | ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"directDebitAuthorisations": [
{
"accountId": "string",
"authorisedEntity": {
"description": "string",
"financialInstitution": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
},
"lastDebitDateTime": "string",
"lastDebitAmount": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingDirectDebitAuthorisationList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk Direct Debits
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/direct-debits
Obtain direct debit authorisations for multiple, filtered accounts.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product-category | query | Enum | optional | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. |
| open-status | query | Enum | optional | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed. |
| is-owned | query | Boolean | optional | Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| product-category | BUSINESS_LOANS |
| product-category | CRED_AND_CHRG_CARDS |
| product-category | LEASES |
| product-category | MARGIN_LOANS |
| product-category | OVERDRAFTS |
| product-category | PERS_LOANS |
| product-category | REGULATED_TRUST_ACCOUNTS |
| product-category | RESIDENTIAL_MORTGAGES |
| product-category | TERM_DEPOSITS |
| product-category | TRADE_FINANCE |
| product-category | TRANS_AND_SAVINGS_ACCOUNTS |
| product-category | TRAVEL_CARDS |
| open-status | ALL |
| open-status | CLOSED |
| open-status | OPEN |
Example responses
200 Response
{
"data": {
"directDebitAuthorisations": [
{
"accountId": "string",
"authorisedEntity": {
"description": "string",
"financialInstitution": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
},
"lastDebitDateTime": "string",
"lastDebitAmount": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingDirectDebitAuthorisationList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Direct Debits For Specific Accounts
Code samples
POST https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /banking/accounts/direct-debits
Obtain direct debit authorisations for a specified list of accounts.
Body parameter
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestAccountIds | mandatory | Array of accountId values to obtain authorisations for. |
Example responses
200 Response
{
"data": {
"directDebitAuthorisations": [
{
"accountId": "string",
"authorisedEntity": {
"description": "string",
"financialInstitution": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
},
"lastDebitDateTime": "string",
"lastDebitAmount": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingDirectDebitAuthorisationList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Scheduled Payments for Account
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}/payments/scheduled
Obtain scheduled, outgoing payments for a specific account.
Obsolete versions: v1.
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | ASCIIString | mandatory | ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"scheduledPayments": [
{
"scheduledPaymentId": "string",
"nickname": "string",
"payerReference": "string",
"payeeReference": "string",
"status": "ACTIVE",
"from": {
"accountId": "string"
},
"paymentSet": [
{
"to": {
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"isAmountCalculated": true,
"amount": "string",
"currency": "string"
}
],
"recurrence": {
"nextPaymentDate": "string",
"recurrenceUType": "eventBased",
"onceOff": {
"paymentDate": "string"
},
"intervalSchedule": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
},
"lastWeekDay": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
},
"eventBased": {
"description": "string"
}
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingScheduledPaymentsListV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Scheduled Payments Bulk
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/payments/scheduled
Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments.
Obsolete versions: v1.
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| product-category | query | Enum | optional | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. |
| open-status | query | Enum | optional | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed. |
| is-owned | query | Boolean | optional | Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| product-category | BUSINESS_LOANS |
| product-category | CRED_AND_CHRG_CARDS |
| product-category | LEASES |
| product-category | MARGIN_LOANS |
| product-category | OVERDRAFTS |
| product-category | PERS_LOANS |
| product-category | REGULATED_TRUST_ACCOUNTS |
| product-category | RESIDENTIAL_MORTGAGES |
| product-category | TERM_DEPOSITS |
| product-category | TRADE_FINANCE |
| product-category | TRANS_AND_SAVINGS_ACCOUNTS |
| product-category | TRAVEL_CARDS |
| open-status | ALL |
| open-status | CLOSED |
| open-status | OPEN |
Example responses
200 Response
{
"data": {
"scheduledPayments": [
{
"scheduledPaymentId": "string",
"nickname": "string",
"payerReference": "string",
"payeeReference": "string",
"status": "ACTIVE",
"from": {
"accountId": "string"
},
"paymentSet": [
{
"to": {
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"isAmountCalculated": true,
"amount": "string",
"currency": "string"
}
],
"recurrence": {
"nextPaymentDate": "string",
"recurrenceUType": "eventBased",
"onceOff": {
"paymentDate": "string"
},
"intervalSchedule": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
},
"lastWeekDay": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
},
"eventBased": {
"description": "string"
}
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingScheduledPaymentsListV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Scheduled Payments For Specific Accounts
Code samples
POST https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /banking/payments/scheduled
Obtain scheduled payments for a specified list of accounts.
Obsolete versions: v1.
Body parameter
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestAccountIds | mandatory | Array of accountId values to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned. |
Example responses
200 Response
{
"data": {
"scheduledPayments": [
{
"scheduledPaymentId": "string",
"nickname": "string",
"payerReference": "string",
"payeeReference": "string",
"status": "ACTIVE",
"from": {
"accountId": "string"
},
"paymentSet": [
{
"to": {
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"isAmountCalculated": true,
"amount": "string",
"currency": "string"
}
],
"recurrence": {
"nextPaymentDate": "string",
"recurrenceUType": "eventBased",
"onceOff": {
"paymentDate": "string"
},
"intervalSchedule": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
},
"lastWeekDay": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
},
"eventBased": {
"description": "string"
}
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingScheduledPaymentsListV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Payees
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/payees HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/payees', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/payees
Obtain a list of pre-registered payees.
Obsolete versions: v1.
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | query | Enum | optional | Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| type | ALL |
| type | BILLER |
| type | DIGITAL_WALLET |
| type | DOMESTIC |
| type | INTERNATIONAL |
Example responses
200 Response
{
"data": {
"payees": [
{
"payeeId": "string",
"nickname": "string",
"description": "string",
"type": "BILLER",
"creationDate": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingPayeeListV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Payee Detail
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/payees/{payeeId}
Obtain detailed information on a single payee.
Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient.
Obsolete versions: v1.
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| payeeId | path | ASCIIString | mandatory | The ID used to locate the details of a particular payee. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"payeeId": "string",
"nickname": "string",
"description": "string",
"type": "BILLER",
"creationDate": "string",
"payeeUType": "biller",
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingPayeeByIdV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Products
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/products HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/products', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/products
Obtain a list of products that are currently openly offered to the market.
Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.
Conventions
In the product reference payloads there are a number of recurring conventions that are explained here, in one place.
Arrays Of Features
In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:
- Each element in an array has the same structure so that clients can reliably interpret the payloads
- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.
- Each element has a field named additionalValue. This is a generic field with contents that will vary based on the type of object being described. The contents of this field for the
ADDITIONAL_CARDSfeature is the number of cards allowed while the contents of this field for theMAX_LIMITconstraint would be the maximum credit limit allowed for the product. - An element in these arrays of the same type may appear more than once. For instance, a product may offer two separate loyalty programs that the customer can select from. A fixed term mortgage may have different rates for different term lengths.
- An element in these arrays may contain an additionalInfo and additionalInfoUri field. The additionalInfo field is used to provide displayable text clarifying the purpose of the element in some way when the product is presented to a customer. The additionalInfoUri provides a link to externally hosted information specifically relevant to that feature of the product.
- Depending on the type of data being represented there may be additional specific fields.
URIs To More Information
As the complexities and nuances of a financial product can not easily be fully expressed in a data structure without a high degree of complexity it is necessary to provide additional reference information that a potential customer can access so that they are fully informed of the features and implications of the product. The payloads for product reference therefore contain numerous fields that are provided to allow the product holder to describe the product more fully using a web page hosted on their online channels.
These URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use different HTML anchors to focus on a specific topic such as eligibility or fees.
Linkage To Accounts
From the moment that a customer applies for a product and an account is created the account and the product that spawned it will diverge. Rates and features of the product may change and a discount may be negotiated for the account.
For this reason, while productCategory is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime.
Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process.
Dates
It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.
In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no longer offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| effective | query | Enum | optional | Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are CURRENT, FUTURE and ALL. If absent defaults to CURRENT. |
| updated-since | query | DateTimeString | optional | Only include products that have been updated after the specified date and time. If absent defaults to include all products. |
| brand | query | string | optional | Filter results based on a specific brand. |
| product-category | query | Enum | optional | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination). |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination). |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Enumerated Values
| Parameter | Value |
|---|---|
| effective | ALL |
| effective | CURRENT |
| effective | FUTURE |
| product-category | BUSINESS_LOANS |
| product-category | CRED_AND_CHRG_CARDS |
| product-category | LEASES |
| product-category | MARGIN_LOANS |
| product-category | OVERDRAFTS |
| product-category | PERS_LOANS |
| product-category | REGULATED_TRUST_ACCOUNTS |
| product-category | RESIDENTIAL_MORTGAGES |
| product-category | TERM_DEPOSITS |
| product-category | TRADE_FINANCE |
| product-category | TRANS_AND_SAVINGS_ACCOUNTS |
| product-category | TRAVEL_CARDS |
Example responses
200 Response
{
"data": {
"products": [
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingProductListV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Get Product Detail
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/products/{productId} HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/banking/products/{productId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/products/{productId}
Obtain detailed information on a single product offered openly to the market.
Obsolete versions: v1, v2, v3.
Endpoint Version
| Version | 4 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productId | path | ASCIIString | mandatory | ID of the specific product requested. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Example responses
200 Response
{
"data": {
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
],
"bundles": [
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"constraints": [
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"eligibility": [
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseBankingProductByIdV4 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Schemas
RequestAccountIds
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » accountIds | [ASCIIString] | mandatory | Array of accountId values. |
| meta | Meta | optional | none |
ResponseBankingProductListV2
{
"data": {
"products": [
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » products | [BankingProductV4] | mandatory | The list of products returned. If the filter results in an empty set then this array may have no records. |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
BankingProductV4
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| productId | ASCIIString | mandatory | A data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines. |
| effectiveFrom | DateTimeString | optional | The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate. |
| effectiveTo | DateTimeString | optional | The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products. |
| lastUpdated | DateTimeString | mandatory | The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered). |
| productCategory | BankingProductCategory | mandatory | The category to which a product or account belongs. See here for more details. |
| name | string | mandatory | The display name of the product. |
| description | string | mandatory | A description of the product. |
| brand | string | mandatory | A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required. |
| brandName | string | optional | An optional display name of the brand. |
| applicationUri | URIString | optional | A link to an application web page where this product can be applied for. |
| isTailored | Boolean | mandatory | Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable. |
| additionalInformation | BankingProductAdditionalInformationV2 | optional | Object that contains links to additional information on specific topics. |
| cardArt | [object] | optional | An array of card art images. |
| » title | string | optional | Display label for the specific image. |
| » imageUri | URIString | mandatory | URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]. |
BankingProductAdditionalInformationV2
{
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
}
Object that contains links to additional information on specific topics.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| overviewUri | URIString | conditional | General overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents. |
| termsUri | URIString | conditional | Terms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents. |
| eligibilityUri | URIString | conditional | Eligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents. |
| feesAndPricingUri | URIString | conditional | Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents. |
| bundleUri | URIString | conditional | Description of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents. |
| additionalOverviewUris | [BankingProductAdditionalInformationV2_additionalInformationUris] | optional | An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri. |
| additionalTermsUris | [BankingProductAdditionalInformationV2_additionalInformationUris] | optional | An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri. |
| additionalEligibilityUris | [BankingProductAdditionalInformationV2_additionalInformationUris] | optional | An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri. |
| additionalFeesAndPricingUris | [BankingProductAdditionalInformationV2_additionalInformationUris] | optional | An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri. |
| additionalBundleUris | [BankingProductAdditionalInformationV2_additionalInformationUris] | optional | An array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri. |
BankingProductAdditionalInformationV2_additionalInformationUris
{
"description": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | optional | Display text providing more information about the document URI. |
| additionalInfoUri | URIString | mandatory | The URI describing the additional information. |
ResponseBankingProductByIdV4
{
"data": {
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
],
"bundles": [
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"constraints": [
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"eligibility": [
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | BankingProductDetailV4 | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
BankingProductDetailV4
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
],
"bundles": [
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"constraints": [
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"eligibility": [
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | BankingProductV4 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » bundles | [BankingProductBundle] | optional | An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also. |
| » features | [BankingProductFeatureV2] | optional | Array of features available for the product. |
| » constraints | [BankingProductConstraint] | optional | Constraints on the application for or operation of the product such as minimum balances or limit thresholds. |
| » eligibility | [BankingProductEligibility] | optional | Eligibility criteria for the product. |
| » fees | [BankingProductFee] | optional | Fees applicable to the product. |
| » depositRates | [BankingProductDepositRate] | optional | Interest rates available for deposits. |
| » lendingRates | [BankingProductLendingRateV2] | optional | Interest rates charged against lending balances. |
BankingProductBundle
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | mandatory | Name of the bundle. |
| description | string | mandatory | Description of the bundle. |
| additionalInfo | string | optional | Display text providing more information on the bundle. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on the bundle criteria and benefits. |
| productIds | [ASCIIString] | optional | Array of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints. |
BankingProductFeatureV2
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| featureType | Enum | mandatory | The type of feature described. For further details, refer to Product Feature Types. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType. |
| additionalInfo | string | conditional | Display text providing more information on the feature. Mandatory if featureType is set to OTHER. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this feature. |
Enumerated Values
| Property | Value |
|---|---|
| featureType | ADDITIONAL_CARDS |
| featureType | BALANCE_TRANSFERS |
| featureType | BILL_PAYMENT |
| featureType | BONUS_REWARDS |
| featureType | CARD_ACCESS |
| featureType | CASHBACK_OFFER |
| featureType | COMPLEMENTARY_PRODUCT_DISCOUNTS |
| featureType | DIGITAL_BANKING |
| featureType | DIGITAL_WALLET |
| featureType | DONATE_INTEREST |
| featureType | EXTRA_REPAYMENTS |
| featureType | FRAUD_PROTECTION |
| featureType | FREE_TXNS |
| featureType | FREE_TXNS_ALLOWANCE |
| featureType | GUARANTOR |
| featureType | INSURANCE |
| featureType | INSTALMENT_PLAN |
| featureType | INTEREST_FREE |
| featureType | INTEREST_FREE_TRANSFERS |
| featureType | LOYALTY_PROGRAM |
| featureType | NOTIFICATIONS |
| featureType | NPP_ENABLED |
| featureType | NPP_PAYID |
| featureType | OFFSET |
| featureType | OTHER |
| featureType | OVERDRAFT |
| featureType | REDRAW |
| featureType | RELATIONSHIP_MANAGEMENT |
| featureType | UNLIMITED_TXNS |
BankingProductConstraint
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| constraintType | Enum | mandatory | The type of constraint described. For further details, refer to Product Constraint Types. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType. |
| additionalInfo | string | optional | Display text providing more information on the constraint. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on the constraint. |
Enumerated Values
| Property | Value |
|---|---|
| constraintType | MAX_BALANCE |
| constraintType | MAX_LIMIT |
| constraintType | MIN_BALANCE |
| constraintType | MIN_LIMIT |
| constraintType | OPENING_BALANCE |
BankingProductEligibility
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| eligibilityType | Enum | mandatory | The type of eligibility criteria described. For further details, refer to Product Eligibility Types. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType. |
| additionalInfo | string | conditional | Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this eligibility criteria. |
Enumerated Values
| Property | Value |
|---|---|
| eligibilityType | BUSINESS |
| eligibilityType | EMPLOYMENT_STATUS |
| eligibilityType | MAX_AGE |
| eligibilityType | MIN_AGE |
| eligibilityType | MIN_INCOME |
| eligibilityType | MIN_TURNOVER |
| eligibilityType | NATURAL_PERSON |
| eligibilityType | OTHER |
| eligibilityType | PENSION_RECIPIENT |
| eligibilityType | RESIDENCY_STATUS |
| eligibilityType | STAFF |
| eligibilityType | STUDENT |
BankingProductFee
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | mandatory | Name of the fee. |
| feeType | Enum | mandatory | The type of fee. For further details, refer to Product Fee Types. |
| amount | AmountString | conditional | The amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| balanceRate | RateString | conditional | A fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| transactionRate | RateString | conditional | A fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| accruedRate | RateString | conditional | A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| accrualFrequency | ExternalRef | optional | The indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| currency | CurrencyString | optional | The currency the fee will be charged in. Assumes AUD if absent. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType. |
| additionalInfo | string | optional | Display text providing more information on the fee. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this fee. |
| discounts | [BankingProductDiscount] | optional | An optional list of discounts to this fee that may be available. |
Enumerated Values
| Property | Value |
|---|---|
| feeType | DEPOSIT |
| feeType | EVENT |
| feeType | EXIT |
| feeType | PAYMENT |
| feeType | PERIODIC |
| feeType | PURCHASE |
| feeType | TRANSACTION |
| feeType | UPFRONT |
| feeType | VARIABLE |
| feeType | WITHDRAWAL |
BankingProductDiscount
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | mandatory | Description of the discount. |
| discountType | Enum | mandatory | The type of discount. For further details, refer to Product Discount Types. |
| amount | AmountString | conditional | Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. |
| balanceRate | RateString | conditional | A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee. |
| transactionRate | RateString | conditional | A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. |
| accruedRate | RateString | conditional | A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee. |
| feeRate | RateString | conditional | A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType. |
| additionalInfo | string | optional | Display text providing more information on the discount. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this discount. |
| eligibility | [BankingProductDiscountEligibility] | conditional | Eligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY. |
Enumerated Values
| Property | Value |
|---|---|
| discountType | BALANCE |
| discountType | DEPOSITS |
| discountType | ELIGIBILITY_ONLY |
| discountType | FEE_CAP |
| discountType | PAYMENTS |
BankingProductDiscountEligibility
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| discountEligibilityType | Enum | mandatory | The type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType. |
| additionalInfo | string | conditional | Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this eligibility constraint. |
Enumerated Values
| Property | Value |
|---|---|
| discountEligibilityType | BUSINESS |
| discountEligibilityType | EMPLOYMENT_STATUS |
| discountEligibilityType | INTRODUCTORY |
| discountEligibilityType | MAX_AGE |
| discountEligibilityType | MIN_AGE |
| discountEligibilityType | MIN_INCOME |
| discountEligibilityType | MIN_TURNOVER |
| discountEligibilityType | NATURAL_PERSON |
| discountEligibilityType | OTHER |
| discountEligibilityType | PENSION_RECIPIENT |
| discountEligibilityType | RESIDENCY_STATUS |
| discountEligibilityType | STAFF |
| discountEligibilityType | STUDENT |
BankingProductDepositRate
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| depositRateType | Enum | mandatory | The type of rate (FIXED, VARIABLE, BONUS, etc.) For further details, refer to Product Deposit Rate Types. |
| rate | RateString | mandatory | The rate to be applied. |
| calculationFrequency | ExternalRef | optional | The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| applicationFrequency | ExternalRef | optional | The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| tiers | [BankingProductRateTierV3] | optional | Rate tiers applicable for this rate. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType. |
| additionalInfo | string | optional | Display text providing more information on the rate. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this rate. |
Enumerated Values
| Property | Value |
|---|---|
| depositRateType | BONUS |
| depositRateType | BUNDLE_BONUS |
| depositRateType | FIXED |
| depositRateType | FLOATING |
| depositRateType | INTRODUCTORY |
| depositRateType | MARKET_LINKED |
| depositRateType | VARIABLE |
BankingProductLendingRateV2
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| lendingRateType | Enum | mandatory | The type of rate (FIXED, VARIABLE, etc.) For further details, refer to Product Lending Rate Types. |
| rate | RateString | mandatory | The rate to be applied. |
| comparisonRate | RateString | optional | A comparison rate equivalent for this rate. |
| calculationFrequency | ExternalRef | optional | The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| applicationFrequency | ExternalRef | optional | The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| interestPaymentDue | Enum | optional | When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered. |
| repaymentType | Enum | optional | Options in place for repayments. If absent, the lending rate is applicable to all repayment types. |
| loanPurpose | Enum | optional | The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes. |
| tiers | [BankingProductRateTierV3] | optional | Rate tiers applicable for this rate. |
| additionalValue | string | conditional | Generic field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType. |
| additionalInfo | string | optional | Display text providing more information on the rate. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this rate. |
Enumerated Values
| Property | Value |
|---|---|
| lendingRateType | BUNDLE_DISCOUNT_FIXED |
| lendingRateType | BUNDLE_DISCOUNT_VARIABLE |
| lendingRateType | CASH_ADVANCE |
| lendingRateType | DISCOUNT |
| lendingRateType | FIXED |
| lendingRateType | FLOATING |
| lendingRateType | INTRODUCTORY |
| lendingRateType | MARKET_LINKED |
| lendingRateType | PENALTY |
| lendingRateType | PURCHASE |
| lendingRateType | VARIABLE |
| interestPaymentDue | IN_ADVANCE |
| interestPaymentDue | IN_ARREARS |
| repaymentType | INTEREST_ONLY |
| repaymentType | PRINCIPAL_AND_INTEREST |
| loanPurpose | INVESTMENT |
| loanPurpose | OWNER_OCCUPIED |
BankingProductRateTierV3
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Defines the criteria and conditions for which a rate applies.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | mandatory | A display name for the tier. |
| unitOfMeasure | Enum | mandatory | The unit of measure that applies to the minimumValue and maximumValue values e.g.,
|
| minimumValue | Number | mandatory | The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value. |
| maximumValue | Number | optional | The number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. |
| rateApplicationMethod | Enum | optional | The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps'). |
| applicabilityConditions | BankingProductRateCondition | optional | Defines a condition for the applicability of a tiered rate. |
| additionalInfo | string | optional | Display text providing more information on the rate tier. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this rate tier. |
Enumerated Values
| Property | Value |
|---|---|
| unitOfMeasure | DAY |
| unitOfMeasure | DOLLAR |
| unitOfMeasure | MONTH |
| unitOfMeasure | PERCENT |
| rateApplicationMethod | PER_TIER |
| rateApplicationMethod | WHOLE_BALANCE |
BankingProductRateCondition
{
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Defines a condition for the applicability of a tiered rate.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| additionalInfo | string | optional | Display text providing more information on the condition. |
| additionalInfoUri | URIString | optional | Link to a web page with more information on this condition. |
ResponseBankingAccountListV2
{
"data": {
"accounts": [
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » accounts | [BankingAccountV2] | mandatory | The list of accounts returned. If the filter results in an empty set then this array may have no records. |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
BankingAccountV2
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | ASCIIString | mandatory | A unique ID of the account adhering to the standards for ID permanence. |
| creationDate | DateString | optional | Date that the account was created (if known). |
| displayName | string | mandatory | The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type. |
| nickname | string | optional | A customer supplied nick name for the account. |
| openStatus | Enum | optional | Open or closed status for the account. If not present then OPEN is assumed. |
| isOwned | Boolean | optional | Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then true is assumed. |
| accountOwnership | Enum | mandatory | Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers. |
| maskedNumber | MaskedAccountString | mandatory | A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number. |
| productCategory | BankingProductCategory | mandatory | The category to which a product or account belongs. See here for more details. |
| productName | string | mandatory | The unique identifier of the account as defined by the data holder (akin to model number for the account). |
Enumerated Values
| Property | Value |
|---|---|
| openStatus | CLOSED |
| openStatus | OPEN |
| accountOwnership | UNKNOWN |
| accountOwnership | ONE_PARTY |
| accountOwnership | TWO_PARTY |
| accountOwnership | MANY_PARTY |
| accountOwnership | OTHER |
ResponseBankingAccountByIdV3
{
"data": {
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"isActivated": true
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"addresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | BankingAccountDetailV3 | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
BankingAccountDetailV3
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"isActivated": true
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"addresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | BankingAccountV2 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » bsb | string | optional | The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. |
| » accountNumber | string | optional | The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. |
| » bundleName | string | optional | Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer. |
| » specificAccountUType | Enum | optional | The type of structure to present account specific fields. |
| » termDeposit | [BankingTermDepositAccount] | conditional | none |
| » creditCard | BankingCreditCardAccount | conditional | none |
| » loan | BankingLoanAccountV2 | conditional | none |
| » depositRate | RateString | optional | Current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call. |
| » lendingRate | RateString | optional | The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call. |
| » depositRates | [BankingProductDepositRate] | optional | Fully described deposit rates for this account based on the equivalent structure in Product Reference. |
| » lendingRates | [BankingProductLendingRateV2] | optional | Fully described lending rates for this account based on the equivalent structure in Product Reference. |
| » features | [allOf] | optional | Array of features of the account based on the equivalent structure in Product Reference with the following additional field. |
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| »» anonymous | BankingProductFeatureV2 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| »» anonymous | object | mandatory | none |
| »»» isActivated | Boolean | optional | true if the feature is already activated and false if the feature is available for activation. Defaults to true if absent.Note: this is an additional field appended to the feature object defined in the Product Reference payload. |
continued
| Name | Type | Required | Description |
|---|---|---|---|
| » fees | [BankingProductFee] | optional | Fees and charges applicable to the account based on the equivalent structure in Product Reference. |
| » addresses | [CommonPhysicalAddress] | optional | The addresses for the account to be used for correspondence. |
Enumerated Values
| Property | Value |
|---|---|
| specificAccountUType | creditCard |
| specificAccountUType | loan |
| specificAccountUType | termDeposit |
BankingTermDepositAccount
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| lodgementDate | DateString | mandatory | The lodgement date of the original deposit. |
| maturityDate | DateString | mandatory | Maturity date for the term deposit. |
| maturityAmount | AmountString | optional | Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated. |
| maturityCurrency | CurrencyString | optional | If absent assumes AUD. |
| maturityInstructions | Enum | mandatory | Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments. |
Enumerated Values
| Property | Value |
|---|---|
| maturityInstructions | HOLD_ON_MATURITY |
| maturityInstructions | PAID_OUT_AT_MATURITY |
| maturityInstructions | ROLLED_OVER |
BankingCreditCardAccount
{
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| minPaymentAmount | AmountString | mandatory | The minimum payment amount due for the next card payment. |
| paymentDueAmount | AmountString | mandatory | The amount due for the next card payment. |
| paymentCurrency | CurrencyString | optional | If absent assumes AUD. |
| paymentDueDate | DateString | mandatory | Date that the next payment for the card is due. |
BankingLoanAccountV2
{
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| originalStartDate | DateString | optional | Optional original start date for the loan. |
| originalLoanAmount | AmountString | optional | Optional original loan value. |
| originalLoanCurrency | CurrencyString | optional | If absent assumes AUD. |
| loanEndDate | DateString | optional | Date that the loan is due to be repaid in full. |
| nextInstalmentDate | DateString | optional | Next date that an instalment is required. |
| minInstalmentAmount | AmountString | optional | Minimum amount of next instalment. |
| minInstalmentCurrency | CurrencyString | optional | If absent assumes AUD. |
| maxRedraw | AmountString | optional | Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account. |
| maxRedrawCurrency | CurrencyString | optional | If absent assumes AUD. |
| minRedraw | AmountString | optional | Minimum redraw amount. |
| minRedrawCurrency | CurrencyString | optional | If absent assumes AUD. |
| offsetAccountEnabled | Boolean | optional | Set to true if one or more offset accounts are configured for this loan account. |
| offsetAccountIds | [ASCIIString] | optional | The accountId values of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation. |
| repaymentType | Enum | optional | Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST. |
| repaymentFrequency | ExternalRef | optional | The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
Enumerated Values
| Property | Value |
|---|---|
| repaymentType | INTEREST_ONLY |
| repaymentType | PRINCIPAL_AND_INTEREST |
ResponseBankingTransactionList
{
"data": {
"transactions": [
{
"accountId": "string",
"transactionId": "string",
"isDetailAvailable": true,
"type": "DIRECT_DEBIT",
"status": "PENDING",
"description": "string",
"postingDateTime": "string",
"valueDateTime": "string",
"executionDateTime": "string",
"amount": "string",
"currency": "string",
"reference": "string",
"merchantName": "string",
"merchantCategoryCode": "string",
"billerCode": "string",
"billerName": "string",
"crn": "string",
"apcaNumber": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0,
"isQueryParamUnsupported": false
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » transactions | [BankingTransaction] | mandatory | none |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginatedTransaction | mandatory | none |
BankingTransaction
{
"accountId": "string",
"transactionId": "string",
"isDetailAvailable": true,
"type": "DIRECT_DEBIT",
"status": "PENDING",
"description": "string",
"postingDateTime": "string",
"valueDateTime": "string",
"executionDateTime": "string",
"amount": "string",
"currency": "string",
"reference": "string",
"merchantName": "string",
"merchantCategoryCode": "string",
"billerCode": "string",
"billerName": "string",
"crn": "string",
"apcaNumber": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | ASCIIString | mandatory | ID of the account for which transactions are provided. |
| transactionId | ASCIIString | conditional | A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if isDetailAvailable is set to true. |
| isDetailAvailable | Boolean | mandatory | true if extended information is available using the transaction detail endpoint. false if extended data is not available. |
| type | Enum | mandatory | The type of the transaction. |
| status | Enum | mandatory | Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction. |
| description | string | mandatory | The transaction description as applied by the financial institution. |
| postingDateTime | DateTimeString | conditional | The time the transaction was posted. This field is Mandatory if the transaction has status POSTED. This is the time that appears on a standard statement. |
| valueDateTime | DateTimeString | optional | Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. |
| executionDateTime | DateTimeString | optional | The time the transaction was executed by the originating customer, if available. |
| amount | AmountString | mandatory | The value of the transaction. Negative values mean money was outgoing from the account. |
| currency | CurrencyString | optional | The currency for the transaction amount. AUD assumed if not present. |
| reference | string | mandatory | The reference for the transaction provided by the originating institution. Empty string if no data provided. |
| merchantName | string | optional | Name of the merchant for an outgoing payment to a merchant. |
| merchantCategoryCode | string | optional | The merchant category code (or MCC) for an outgoing payment to a merchant. |
| billerCode | string | optional | BPAY Biller Code for the transaction (if available). |
| billerName | string | optional | Name of the BPAY biller for the transaction (if available). |
| crn | string | conditional | BPAY CRN for the transaction (if available). Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type. |
| apcaNumber | string | optional | 6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable. |
Enumerated Values
| Property | Value |
|---|---|
| type | DIRECT_DEBIT |
| type | FEE |
| type | INTEREST_CHARGED |
| type | INTEREST_PAID |
| type | OTHER |
| type | PAYMENT |
| type | TRANSFER_INCOMING |
| type | TRANSFER_OUTGOING |
| status | PENDING |
| status | POSTED |
ResponseBankingTransactionById
{
"data": {
"accountId": "string",
"transactionId": "string",
"isDetailAvailable": true,
"type": "DIRECT_DEBIT",
"status": "PENDING",
"description": "string",
"postingDateTime": "string",
"valueDateTime": "string",
"executionDateTime": "string",
"amount": "string",
"currency": "string",
"reference": "string",
"merchantName": "string",
"merchantCategoryCode": "string",
"billerCode": "string",
"billerName": "string",
"crn": "string",
"apcaNumber": "string",
"extendedData": {
"payer": "string",
"payee": "string",
"extensionUType": "x2p101Payload",
"x2p101Payload": {
"extendedDescription": "string",
"endToEndId": "string",
"purposeCode": "string"
},
"service": "X2P1.01"
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | BankingTransactionDetail | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
BankingTransactionDetail
{
"accountId": "string",
"transactionId": "string",
"isDetailAvailable": true,
"type": "DIRECT_DEBIT",
"status": "PENDING",
"description": "string",
"postingDateTime": "string",
"valueDateTime": "string",
"executionDateTime": "string",
"amount": "string",
"currency": "string",
"reference": "string",
"merchantName": "string",
"merchantCategoryCode": "string",
"billerCode": "string",
"billerName": "string",
"crn": "string",
"apcaNumber": "string",
"extendedData": {
"payer": "string",
"payee": "string",
"extensionUType": "x2p101Payload",
"x2p101Payload": {
"extendedDescription": "string",
"endToEndId": "string",
"purposeCode": "string"
},
"service": "X2P1.01"
}
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | BankingTransaction | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » extendedData | object | mandatory | none |
| »» payer | string | conditional | Label of the originating payer. Mandatory for inbound payment. |
| »» payee | string | conditional | Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID). |
| »» extensionUType | Enum | optional | Optional extended data specific to transactions originated via NPP. |
| »» x2p101Payload | object | conditional | none |
| »»» extendedDescription | string | conditional | An extended string description. Required if the extensionUType field is x2p101Payload. |
| »»» endToEndId | string | optional | An end to end ID for the payment created at initiation. |
| »»» purposeCode | string | optional | Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service. |
| »» service | Enum | mandatory | Identifier of the applicable overlay service. Valid values are: X2P1.01. |
Enumerated Values
| Property | Value |
|---|---|
| extensionUType | x2p101Payload |
| service | X2P1.01 |
ResponseBankingAccountsBalanceList
{
"data": {
"balances": [
{
"accountId": "string",
"currentBalance": "string",
"availableBalance": "string",
"creditLimit": "string",
"amortisedLimit": "string",
"currency": "string",
"purses": [
{
"amount": "string",
"currency": "string"
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » balances | [BankingBalance] | mandatory | The list of balances returned. |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
ResponseBankingAccountsBalanceById
{
"data": {
"accountId": "string",
"currentBalance": "string",
"availableBalance": "string",
"creditLimit": "string",
"amortisedLimit": "string",
"currency": "string",
"purses": [
{
"amount": "string",
"currency": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | BankingBalance | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
BankingBalance
{
"accountId": "string",
"currentBalance": "string",
"availableBalance": "string",
"creditLimit": "string",
"amortisedLimit": "string",
"currency": "string",
"purses": [
{
"amount": "string",
"currency": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | ASCIIString | mandatory | A unique ID of the account adhering to the standards for ID permanence. |
| currentBalance | AmountString | mandatory | The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing. |
| availableBalance | AmountString | mandatory | Balance representing the amount of funds available for transfer. Assumed to be zero or positive. |
| creditLimit | AmountString | optional | Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent. |
| amortisedLimit | AmountString | optional | Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent. |
| currency | CurrencyString | optional | The currency for the balance amounts. If absent assumed to be AUD. |
| purses | [BankingBalancePurse] | optional | Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards. |
BankingBalancePurse
{
"amount": "string",
"currency": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | AmountString | mandatory | The balance available for this additional currency purse. |
| currency | CurrencyString | optional | The currency for the purse. |
ResponseBankingPayeeListV2
{
"data": {
"payees": [
{
"payeeId": "string",
"nickname": "string",
"description": "string",
"type": "BILLER",
"creationDate": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » payees | [BankingPayeeV2] | mandatory | The list of payees returned. |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
ResponseBankingPayeeByIdV2
{
"data": {
"payeeId": "string",
"nickname": "string",
"description": "string",
"type": "BILLER",
"creationDate": "string",
"payeeUType": "biller",
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | BankingPayeeDetailV2 | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
BankingPayeeV2
{
"payeeId": "string",
"nickname": "string",
"description": "string",
"type": "BILLER",
"creationDate": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| payeeId | ASCIIString | mandatory | ID of the payee adhering to the rules of ID permanence. |
| nickname | string | mandatory | The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels. |
| description | string | optional | A description of the payee provided by the customer. |
| type | Enum | mandatory | The type of payee.
|
| creationDate | DateString | optional | The date the payee was created by the customer. |
Enumerated Values
| Property | Value |
|---|---|
| type | BILLER |
| type | DIGITAL_WALLET |
| type | DOMESTIC |
| type | INTERNATIONAL |
BankingPayeeDetailV2
{
"payeeId": "string",
"nickname": "string",
"description": "string",
"type": "BILLER",
"creationDate": "string",
"payeeUType": "biller",
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | BankingPayeeV2 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » payeeUType | Enum | mandatory | Type of object included that describes the payee in detail. |
| » biller | BankingBillerPayee | conditional | none |
| » domestic | BankingDomesticPayee | conditional | none |
| » digitalWallet | BankingDigitalWalletPayee | conditional | none |
| » international | BankingInternationalPayee | conditional | none |
Enumerated Values
| Property | Value |
|---|---|
| payeeUType | biller |
| payeeUType | digitalWallet |
| payeeUType | domestic |
| payeeUType | international |
BankingDomesticPayee
{
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| payeeAccountUType | Enum | mandatory | Type of account object included. Valid values are:
|
| account | BankingDomesticPayeeAccount | conditional | none |
| card | BankingDomesticPayeeCard | conditional | none |
| payId | BankingDomesticPayeePayId | conditional | none |
Enumerated Values
| Property | Value |
|---|---|
| payeeAccountUType | account |
| payeeAccountUType | card |
| payeeAccountUType | payId |
BankingDomesticPayeeAccount
{
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountName | string | optional | Name of the account to pay to. |
| bsb | string | mandatory | BSB of the account to pay to. |
| accountNumber | string | mandatory | Number of the account to pay to. |
BankingDomesticPayeeCard
{
"cardNumber": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| cardNumber | MaskedPANString | mandatory | Name of the account to pay to. |
BankingDomesticPayeePayId
{
"name": "string",
"identifier": "string",
"type": "ABN"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The name assigned to the PayID by the owner of the PayID. |
| identifier | string | mandatory | The identifier of the PayID (dependent on type). |
| type | Enum | mandatory | The type of the PayID. |
Enumerated Values
| Property | Value |
|---|---|
| type | ABN |
| type | |
| type | ORG_IDENTIFIER |
| type | TELEPHONE |
BankingBillerPayee
{
"billerCode": "string",
"crn": "string",
"billerName": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| billerCode | string | mandatory | BPAY Biller Code of the Biller. |
| crn | string | conditional | BPAY CRN of the Biller (if available). Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type. |
| billerName | string | mandatory | Name of the Biller. |
BankingInternationalPayee
{
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| beneficiaryDetails | object | mandatory | none |
| » name | string | optional | Name of the beneficiary. |
| » country | ExternalRef | mandatory | Country where the beneficiary resides. A valid ISO 3166 Alpha-3 country code. |
| » message | string | optional | Response message for the payment. |
| bankDetails | object | mandatory | none |
| » country | ExternalRef | mandatory | Country of the recipient institution. A valid ISO 3166 Alpha-3 country code. |
| » accountNumber | string | mandatory | Account Targeted for payment. |
| » bankAddress | object | optional | none |
| »» name | string | mandatory | Name of the recipient Bank. |
| »» address | string | mandatory | Address of the recipient Bank. |
| » beneficiaryBankBIC | ExternalRef | optional | Swift bank code. Aligns with standard ISO 9362. |
| » fedWireNumber | string | optional | Number for Fedwire payment (Federal Reserve Wire Network). |
| » sortCode | string | optional | Sort code used for account identification in some jurisdictions. |
| » chipNumber | string | optional | Number for the Clearing House Interbank Payments System. |
| » routingNumber | string | optional | International bank routing number. |
| » legalEntityIdentifier | ExternalRef | optional | The legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442. |
BankingDigitalWalletPayee
{
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | mandatory | The display name of the wallet as given by the customer, else a default value defined by the data holder. |
| identifier | string | mandatory | The identifier of the digital wallet (dependent on type). |
| type | Enum | mandatory | The type of the digital wallet identifier. |
| provider | Enum | mandatory | The provider of the digital wallet. |
Enumerated Values
| Property | Value |
|---|---|
| type | |
| type | CONTACT_NAME |
| type | TELEPHONE |
| provider | PAYPAL_AU |
| provider | OTHER |
ResponseBankingDirectDebitAuthorisationList
{
"data": {
"directDebitAuthorisations": [
{
"accountId": "string",
"authorisedEntity": {
"description": "string",
"financialInstitution": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
},
"lastDebitDateTime": "string",
"lastDebitAmount": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » directDebitAuthorisations | [BankingDirectDebit] | mandatory | The list of authorisations returned. |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
BankingDirectDebit
{
"accountId": "string",
"authorisedEntity": {
"description": "string",
"financialInstitution": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
},
"lastDebitDateTime": "string",
"lastDebitAmount": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | ASCIIString | mandatory | A unique ID of the account adhering to the standards for ID permanence. |
| authorisedEntity | BankingAuthorisedEntity | mandatory | none |
| lastDebitDateTime | DateTimeString | optional | The date and time of the last debit executed under this authorisation. |
| lastDebitAmount | AmountString | optional | The amount of the last debit executed under this authorisation. |
BankingAuthorisedEntity
{
"description": "string",
"financialInstitution": "string",
"abn": "string",
"acn": "string",
"arbn": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | optional | Description of the authorised entity derived from previously executed direct debits. |
| financialInstitution | string | conditional | Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme. |
| abn | string | optional | Australian Business Number for the authorised entity. |
| acn | string | optional | Australian Company Number for the authorised entity. |
| arbn | string | optional | Australian Registered Body Number for the authorised entity. |
ResponseBankingScheduledPaymentsListV2
{
"data": {
"scheduledPayments": [
{
"scheduledPaymentId": "string",
"nickname": "string",
"payerReference": "string",
"payeeReference": "string",
"status": "ACTIVE",
"from": {
"accountId": "string"
},
"paymentSet": [
{
"to": {
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"isAmountCalculated": true,
"amount": "string",
"currency": "string"
}
],
"recurrence": {
"nextPaymentDate": "string",
"recurrenceUType": "eventBased",
"onceOff": {
"paymentDate": "string"
},
"intervalSchedule": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
},
"lastWeekDay": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
},
"eventBased": {
"description": "string"
}
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » scheduledPayments | [BankingScheduledPaymentV2] | mandatory | The list of scheduled payments to return. |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
BankingScheduledPaymentV2
{
"scheduledPaymentId": "string",
"nickname": "string",
"payerReference": "string",
"payeeReference": "string",
"status": "ACTIVE",
"from": {
"accountId": "string"
},
"paymentSet": [
{
"to": {
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"isAmountCalculated": true,
"amount": "string",
"currency": "string"
}
],
"recurrence": {
"nextPaymentDate": "string",
"recurrenceUType": "eventBased",
"onceOff": {
"paymentDate": "string"
},
"intervalSchedule": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
},
"lastWeekDay": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
},
"eventBased": {
"description": "string"
}
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| scheduledPaymentId | ASCIIString | mandatory | A unique ID of the scheduled payment adhering to the standards for ID permanence. |
| nickname | string | optional | The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels. |
| payerReference | string | mandatory | The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided. |
| payeeReference | string | conditional | The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided. |
| status | Enum | mandatory | Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped. |
| from | BankingScheduledPaymentFrom | mandatory | Object containing details of the source of the payment. Currently only specifies an accountId but provided as an object to facilitate future extensibility and consistency with the to object. |
| paymentSet | [BankingScheduledPaymentSetV2] | mandatory | [The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.] |
| recurrence | BankingScheduledPaymentRecurrence | mandatory | Object containing the detail of the schedule for the payment. |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | INACTIVE |
| status | SKIP |
BankingScheduledPaymentSetV2
{
"to": {
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
},
"isAmountCalculated": true,
"amount": "string",
"currency": "string"
}
The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| to | BankingScheduledPaymentToV2 | mandatory | Object containing details of the destination of the payment. Used to specify a variety of payment destination types. |
| isAmountCalculated | Boolean | optional | Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed. |
| amount | AmountString | conditional | The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present. |
| currency | CurrencyString | optional | The currency for the payment. AUD assumed if not present. |
BankingScheduledPaymentToV2
{
"toUType": "accountId",
"accountId": "string",
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU"
},
"domestic": {
"payeeAccountUType": "account",
"account": {
"accountName": "string",
"bsb": "string",
"accountNumber": "string"
},
"card": {
"cardNumber": "string"
},
"payId": {
"name": "string",
"identifier": "string",
"type": "ABN"
}
},
"biller": {
"billerCode": "string",
"crn": "string",
"billerName": "string"
},
"international": {
"beneficiaryDetails": {
"name": "string",
"country": "string",
"message": "string"
},
"bankDetails": {
"country": "string",
"accountNumber": "string",
"bankAddress": {
"name": "string",
"address": "string"
},
"beneficiaryBankBIC": "string",
"fedWireNumber": "string",
"sortCode": "string",
"chipNumber": "string",
"routingNumber": "string",
"legalEntityIdentifier": "string"
}
}
}
Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| toUType | Enum | mandatory | The type of object provided that specifies the destination of the funds for the payment. |
| accountId | ASCIIString | conditional | Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent. |
| payeeId | ASCIIString | conditional | Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead. |
| nickname | string | conditional | The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels. |
| payeeReference | string | conditional | The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level. |
| digitalWallet | BankingDigitalWalletPayee | conditional | none |
| domestic | BankingDomesticPayee | conditional | none |
| biller | BankingBillerPayee | conditional | none |
| international | BankingInternationalPayee | conditional | none |
Enumerated Values
| Property | Value |
|---|---|
| toUType | accountId |
| toUType | biller |
| toUType | digitalWallet |
| toUType | domestic |
| toUType | international |
| toUType | payeeId |
BankingScheduledPaymentFrom
{
"accountId": "string"
}
Object containing details of the source of the payment. Currently only specifies an accountId but provided as an object to facilitate future extensibility and consistency with the to object.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | ASCIIString | mandatory | accountId of the account that is the source of funds for the payment. |
BankingScheduledPaymentRecurrence
{
"nextPaymentDate": "string",
"recurrenceUType": "eventBased",
"onceOff": {
"paymentDate": "string"
},
"intervalSchedule": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
},
"lastWeekDay": {
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
},
"eventBased": {
"description": "string"
}
}
Object containing the detail of the schedule for the payment.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| nextPaymentDate | DateString | optional | The date of the next payment under the recurrence schedule. |
| recurrenceUType | Enum | mandatory | The type of recurrence used to define the schedule. |
| onceOff | BankingScheduledPaymentRecurrenceOnceOff | conditional | Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff. |
| intervalSchedule | BankingScheduledPaymentRecurrenceIntervalSchedule | conditional | Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule. |
| lastWeekDay | BankingScheduledPaymentRecurrenceLastWeekday | conditional | Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay. |
| eventBased | BankingScheduledPaymentRecurrenceEventBased | conditional | Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased. |
Enumerated Values
| Property | Value |
|---|---|
| recurrenceUType | eventBased |
| recurrenceUType | intervalSchedule |
| recurrenceUType | lastWeekDay |
| recurrenceUType | onceOff |
BankingScheduledPaymentRecurrenceOnceOff
{
"paymentDate": "string"
}
Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| paymentDate | DateString | mandatory | The scheduled date for the once off payment. |
BankingScheduledPaymentRecurrenceIntervalSchedule
{
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"nonBusinessDayTreatment": "AFTER",
"intervals": [
{
"interval": "string",
"dayInInterval": "string"
}
]
}
Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| finalPaymentDate | DateString | optional | The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely. |
| paymentsRemaining | PositiveInteger | optional | Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely. |
| nonBusinessDayTreatment | Enum | optional | Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
|
| intervals | [BankingScheduledPaymentInterval] | mandatory | An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry. |
Enumerated Values
| Property | Value |
|---|---|
| nonBusinessDayTreatment | AFTER |
| nonBusinessDayTreatment | BEFORE |
| nonBusinessDayTreatment | ON |
| nonBusinessDayTreatment | ONLY |
BankingScheduledPaymentInterval
{
"interval": "string",
"dayInInterval": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| interval | ExternalRef | mandatory | An interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate. |
| dayInInterval | ExternalRef | optional | Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday. |
BankingScheduledPaymentRecurrenceLastWeekday
{
"finalPaymentDate": "string",
"paymentsRemaining": 1,
"interval": "string",
"lastWeekDay": "FRI",
"nonBusinessDayTreatment": "AFTER"
}
Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| finalPaymentDate | DateString | optional | The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely. |
| paymentsRemaining | PositiveInteger | optional | Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely. |
| interval | ExternalRef | mandatory | The interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate. |
| lastWeekDay | Enum | mandatory | The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval. |
| nonBusinessDayTreatment | Enum | optional | Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
|
Enumerated Values
| Property | Value |
|---|---|
| lastWeekDay | FRI |
| lastWeekDay | MON |
| lastWeekDay | SAT |
| lastWeekDay | SUN |
| lastWeekDay | THU |
| lastWeekDay | TUE |
| lastWeekDay | WED |
| nonBusinessDayTreatment | AFTER |
| nonBusinessDayTreatment | BEFORE |
| nonBusinessDayTreatment | ON |
| nonBusinessDayTreatment | ONLY |
BankingScheduledPaymentRecurrenceEventBased
{
"description": "string"
}
Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | mandatory | Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer. |
CommonPhysicalAddress
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| addressUType | Enum | mandatory | The type of address object present. |
| simple | CommonSimpleAddress | conditional | none |
| paf | CommonPAFAddress | conditional | Australian address formatted according to the file format defined by the PAF file format. |
Enumerated Values
| Property | Value |
|---|---|
| addressUType | paf |
| addressUType | simple |
CommonSimpleAddress
{
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| mailingName | string | optional | Name of the individual or business formatted for inclusion in an address used for physical mail. |
| addressLine1 | string | mandatory | First line of the standard address object. |
| addressLine2 | string | optional | Second line of the standard address object. |
| addressLine3 | string | optional | Third line of the standard address object. |
| postcode | string | conditional | Mandatory for Australian addresses. |
| city | string | mandatory | Name of the city or locality. |
| state | string | mandatory | Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT. |
| country | ExternalRef | optional | A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present. |
CommonPAFAddress
{
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
Australian address formatted according to the file format defined by the PAF file format.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dpid | string | optional | Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. |
| thoroughfareNumber1 | PositiveInteger | optional | Thoroughfare number for a property (first number in a property ranged address). |
| thoroughfareNumber1Suffix | string | optional | Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated. |
| thoroughfareNumber2 | PositiveInteger | optional | Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25). |
| thoroughfareNumber2Suffix | string | optional | Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated. |
| flatUnitType | string | optional | Type of flat or unit for the address. |
| flatUnitNumber | string | optional | Unit number (including suffix, if applicable). |
| floorLevelType | string | optional | Type of floor or level for the address. |
| floorLevelNumber | string | optional | Floor or level number (including alpha characters). |
| lotNumber | string | optional | Allotment number for the address. |
| buildingName1 | string | optional | Building/Property name 1. |
| buildingName2 | string | optional | Building/Property name 2. |
| streetName | string | optional | The name of the street. |
| streetType | string | optional | The street type. Valid enumeration defined by Australia Post PAF code file. |
| streetSuffix | string | optional | The street type suffix. Valid enumeration defined by Australia Post PAF code file. |
| postalDeliveryType | string | optional | Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file. |
| postalDeliveryNumber | PositiveInteger | optional | Postal delivery number if the address is a postal delivery type. |
| postalDeliveryNumberPrefix | string | optional | Postal delivery number prefix related to the postal delivery number. |
| postalDeliveryNumberSuffix | string | optional | Postal delivery number suffix related to the postal delivery number. |
| localityName | string | mandatory | Full name of locality. |
| postcode | string | mandatory | Postcode for the locality. |
| state | string | mandatory | State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT. |
Links
{
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document. |
Meta
{}
Properties
None
LinksPaginated
{
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document. |
| first | URIString | conditional | URI to the first page of this set. Mandatory if this response is not the first page. |
| prev | URIString | conditional | URI to the previous page of this set. Mandatory if this response is not the first page. |
| next | URIString | conditional | URI to the next page of this set. Mandatory if this response is not the last page. |
| last | URIString | conditional | URI to the last page of this set. Mandatory if this response is not the last page. |
MetaPaginated
{
"totalRecords": 0,
"totalPages": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalRecords | NaturalNumber | mandatory | The total number of records in the full set. See pagination. |
| totalPages | NaturalNumber | mandatory | The total number of pages in the full set. See pagination. |
MetaPaginatedTransaction
{
"totalRecords": 0,
"totalPages": 0,
"isQueryParamUnsupported": false
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | MetaPaginated | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » isQueryParamUnsupported | Boolean | optional | true if text query parameter is not supported. |
MetaError
{
"urn": "string"
}
Additional data for customised error codes.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| urn | string | conditional | The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [object] | mandatory | none |
| » code | string | mandatory | The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| » title | string | mandatory | A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| » detail | string | mandatory | A human-readable explanation specific to this occurrence of the problem. |
| » meta | MetaError | optional | Additional data for customised error codes. |
BankingProductCategory
"BUSINESS_LOANS"
The category to which a product or account belongs. See here for more details.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | Enum | mandatory | The category to which a product or account belongs. See here for more details. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | BUSINESS_LOANS |
| anonymous | CRED_AND_CHRG_CARDS |
| anonymous | LEASES |
| anonymous | MARGIN_LOANS |
| anonymous | OVERDRAFTS |
| anonymous | PERS_LOANS |
| anonymous | REGULATED_TRUST_ACCOUNTS |
| anonymous | RESIDENTIAL_MORTGAGES |
| anonymous | TERM_DEPOSITS |
| anonymous | TRADE_FINANCE |
| anonymous | TRANS_AND_SAVINGS_ACCOUNTS |
| anonymous | TRAVEL_CARDS |
Product Categories
Updated the description of the Product Categories section
- The Product Category enumeration lists the available product categories for categorising products and accounts.
+ The productCategory enumeration provides the values for categorising products and accounts.
The productCategory enumeration provides the values for categorising products and accounts. These are explained in the following tables:
Deposit Products
| Enum | Description |
|---|---|
| REGULATED_TRUST_ACCOUNTS | This grouping of products includes accounts were funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers. |
| TERM_DEPOSITS | This grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds. |
| TRANS_AND_SAVINGS_ACCOUNTS | This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc. |
| TRAVEL_CARDS | This grouping of products includes prepaid cards with multi-currency capabilities. |
Lending Products
| Enum | Description |
|---|---|
| BUSINESS_LOANS | This grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease. |
| CRED_AND_CHRG_CARDS | This grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards. |
| LEASES | This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc. |
| MARGIN_LOANS | This grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds. |
| OVERDRAFTS | This grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements. |
| PERS_LOANS | This grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans. |
| RESIDENTIAL_MORTGAGES | This grouping of products includes all lending products that are available for the primary purpose of borrowing for the purpose of purchasing or renovating residential property, where a residential property will be used as security. This group will include both fixed, variable & secured overdraft types of product and may include both owner-occupied and investment purpose borrowing. |
| TRADE_FINANCE | This grouping of products includes specialised lending products specifically designed to facilitate domestic & international trade. This includes the issuance of letters of credit, factoring, export credit. |
Product & Account Components
Product Feature Types
Updated styling of text referring to field names and values and added links to common field types
Description of the usage of the featureType field as it applies to products.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| ADDITIONAL_CARDS | Additional cards can be requested. | The maximum number of additional cards. If no maximum then should be set to null. |
| BALANCE_TRANSFERS | Balance transfers can be made to the account (e.g., for credit cards). | N/A |
| BILL_PAYMENT | The product can be attached to an automatic budgeting and bill payment service. | Optional name of the service. |
| BONUS_REWARDS | Bonus loyalty rewards points are available. | Number of points available. |
| CARD_ACCESS | A card is available for the product to access funds. | Text describing list of card types that this product can be linked to. |
| CASHBACK_OFFER | Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. | The amount of the cashback offer (in AUD). |
| COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available. | Description of the complementary offering. |
| DIGITAL_BANKING | Access is available to online banking features for the product. | N/A |
| DIGITAL_WALLET | A Digital wallet can be attached to the product. | The name or brand of the wallet. |
| DONATE_INTEREST | Indicates that interest generated from the product can be automatically donated to a charity or community group. | N/A |
| EXTRA_REPAYMENTS | Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis). | N/A |
| FRAUD_PROTECTION | The product includes fraud protection features. | N/A |
| FREE_TXNS | A set number of free transactions available per month. | The number of free transactions. |
| FREE_TXNS_ALLOWANCE | A set amount of transaction fee value that is discounted per month. | The amount of transaction fee discounted (in AUD). |
| GUARANTOR | Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. | N/A |
| INSURANCE | Insurance is provided as an additional feature of the product. | Text description of the type of insurance (e.g., Travel Insurance). |
| INSTALMENT_PLAN | The product has the option to pay for eligible purchases over time with a set number of payments. | N/A |
| INTEREST_FREE | Interest free period for purchases. | Interest free period. Formatted according to ISO 8601 Durations. |
| INTEREST_FREE_TRANSFERS | Interest free period for balance transfers. | Interest free period. Formatted according to ISO 8601 Durations. |
| LOYALTY_PROGRAM | A points based loyalty program is available. | Name of the loyalty program. |
| NOTIFICATIONS | Advanced notifications are available for the product. | Description of the notification capability. |
| NPP_ENABLED | An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment. | N/A |
| NPP_PAYID | An account of this product type can be used as the target of an NPP PayID. | N/A |
| OFFSET | An offset account can be connected to the product. | N/A |
| OTHER | Another feature that can not be included in any of the other categories. The additionalInfo field is mandatory for this type. | N/A |
| OVERDRAFT | An overdraft can be applied for. | N/A |
| REDRAW | Redraw of repaid principal above minimum required is available. | N/A |
| RELATIONSHIP_MANAGEMENT | Relationship management is available for eligible customers. | N/A |
| UNLIMITED_TXNS | Unlimited free transactions available. | N/A |
Product Constraint Types
Description of the usage of the constraintType field as it applies to products.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| MAX_BALANCE | A maximum balance is required for the product. | The maximum balance in AmountString format. |
| MAX_LIMIT | A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit). | The maximum limit in AmountString format. |
| MIN_BALANCE | A minimum balance is required for the product. | The minimum balance in AmountString format. |
| MIN_LIMIT | A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit). | The minimum limit in AmountString format. |
| OPENING_BALANCE | An opening balance is required for the product. | The minimum opening balance in AmountString format. |
Product Eligibility Types
Description of the usage of the eligibilityType field as it applies to products.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| BUSINESS | Only business may apply for the account. | N/A |
| EMPLOYMENT_STATUS | An eligibility constraint based on employment status applies. | A description of the status required. |
| MAX_AGE | Only customers younger than a maximum age may apply. | The maximum age in years. |
| MIN_AGE | Only customers older than a minimum age may apply. | The minimum age in years. |
| MIN_INCOME | The customer must have an income greater than a specified threshold to obtain the product. | Minimum income in AmountString format. |
| MIN_TURNOVER | Only a business with greater than a minimum turnover may apply. | Minimum turnover in AmountString format. |
| NATURAL_PERSON | The customer must be a natural person rather than another legal entity. | N/A |
| OTHER | Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory). | N/A |
| PENSION_RECIPIENT | Only a recipient of a government pension may apply for the product. | N/A |
| RESIDENCY_STATUS | An eligibility constraint based on residency status applies. | A description of the status required. |
| STAFF | Only a staff member of the provider may apply. | N/A |
| STUDENT | Only students may apply for the product. | N/A |
Product Fee Types
Description of the usage of the feeType field as it applies to products.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| DEPOSIT | A fee associated with making a deposit. | N/A |
| EVENT | A fee in relation to a particular event (e.g., ordering a new card, viewing a balance or stopping a cheque). | N/A |
| EXIT | A fee for closing the product. | N/A |
| PAYMENT | A fee associated with making a payment. | N/A |
| PERIODIC | A periodic fee such as a monthly account servicing fee. | The period of charge. Formatted according to ISO 8601 Durations. |
| PURCHASE | A fee associated with making a purchase at a merchant. | N/A |
| TRANSACTION | A fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE). |
N/A |
| UPFRONT | A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee. | N/A |
| VARIABLE | An at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customer. | N/A |
| WITHDRAWAL | A fee associated with making a withdrawal. | N/A |
Product Discount Types
Description of the usage of the discountType field as it applies to products.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| BALANCE | Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee. | The minimum balance in AmountString format. |
| DEPOSITS | Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. | The minimum deposit amount in AmountString format. |
| ELIGIBILITY_ONLY | Discount applies based on customer eligibility (eligibility array must be populated). | N/A |
| FEE_CAP | The amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time period. | The time period for which the fee cap applies. Formatted according to ISO 8601 Durations. |
| PAYMENTS | Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. | The payment threshold amount in AmountString format. |
Product Discount Eligibility Types
Description of the usage of the discountEligibilityType field as it applies to products.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| BUSINESS | A business or other non-person legal entity. | N/A |
| EMPLOYMENT_STATUS | An eligibility constraint based on employment status applies. | A description of the status required. |
| INTRODUCTORY | The discount is only available during an introductory period. | The period of time for the introductory discount. Formatted according to ISO 8601 Durations. |
| MAX_AGE | Only customers younger than a maximum age receive the discount. | The maximum age in years. |
| MIN_AGE | Only customers older than a minimum age receive the discount. | The minimum age in years. |
| MIN_INCOME | The customer must have an income greater than a specified threshold to obtain the discount. | Minimum income in AmountString format. |
| MIN_TURNOVER | Only a business with greater than a minimum turnover is eligible. | Minimum turnover in AmountString format. |
| NATURAL_PERSON | The customer must be a natural person rather than another legal entity. | N/A |
| OTHER | Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory). | N/A |
| PENSION_RECIPIENT | Only a recipient of a government pension may receive the discount. | Optional. Should contain a description of which pensions qualify. |
| RESIDENCY_STATUS | An eligibility constraint based on residency status applies. | A description of the status required. |
| STAFF | Only a staff member of the provider may receive the discount. | N/A |
| STUDENT | Only students may receive the discount. | Optional. Should contain a description of who qualifies as a student, e.g., do apprentices qualify? |
Product Deposit Rate Types
Description of the usage of the depositRateType field as it applies to products.
- Deposit Base Rate Types
A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| FIXED | Fixed rate for a period of time. | The period of time fixed. Formatted according to ISO 8601 Durations. |
| FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances. | Details of the float parameters. |
| MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class. | Details of the market linkage. |
| VARIABLE | A variable base rate for the product. | N/A |
- Deposit Adjustment Rate Types
Clarified the format of deposit 'bonus' adjustment rate values
A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| BONUS | A bonus rate available by meeting a specific criteria. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). | A description of the criteria to obtain the bonus. |
| BUNDLE_BONUS | A bonus rate obtained by originating a bundle instead of a standalone product. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). | The name of the bundle. |
| INTRODUCTORY | An introductory bonus that will expire after a set period. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). | The period of time for the introductory rate. Formatted according to ISO 8601 Durations. |
Product Lending Rate Types
Description of the usage of the lendingRateType field as it applies to products.
- Lending Base Rate Types
A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.
Card products may have two or more base rates, including CASH_ADVANCE and PURCHASE as they may apply to different transaction types within an account. The PURCHASE lendingRateType is considered the rate commonly applicable to a card.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| CASH_ADVANCE | Specific rate applied to cash advances from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. |
N/A |
| FIXED | Fixed rate for a period of time. | The period of time fixed. Formatted according to ISO 8601 Durations. |
| FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances. | Details of the float parameters. |
| MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class. | Details of the market linkage. |
| PURCHASE | Specific rate applied to purchases from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. |
N/A |
| VARIABLE | A variable base rate for the product. | N/A |
- Lending Adjustment Rate Types
Clarified the format of lending 'discount' and 'penalty' adjustment rate values
A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| BUNDLE_DISCOUNT_FIXED | A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | The name of the bundle. |
| BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate obtained by originating a bundle instead of a standalone product. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | The name of the bundle. |
| DISCOUNT | A specific discount rate that may be applied. A discount rate reduces the interest payable. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | Description of the discount rate that is applicable. |
| INTRODUCTORY | An introductory discount that will expire after a set period. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). | The period of time for the introductory rate. Formatted according to ISO 8601 Durations. |
| PENALTY | A specific penalty rate that may be applied. A penalty rate increases the interest payable. A lending 'penalty' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Penalty). | Description of the penalty rate that is applicable. |
Banking Term Deposit Account Types
Description of the usage of the maturityInstructions field as it applies to accounts.
| Value | Description | Use of additionalValue Field |
|---|---|---|
| HOLD_ON_MATURITY | Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer. | N/A |
| PAID_OUT_AT_MATURITY | Funds are to be paid out at maturity. | N/A |
| ROLLED_OVER | Funds are to be rolled over at maturity. | N/A |
Energy APIs
Updated description of EnergyPlanTariffPeriodV2.dailySupplyChargeType from:
- Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided with a new line.
to:
+ Specifies if daily supply charge is single or banded.
This specification defines the APIs for Data Holders exposing Energy endpoints.
| Energy OpenAPI Specification (JSON) |
| Energy OpenAPI Specification (YAML) |
For tariffUType the in EnergyPlanSolarFeedInTariffV3, the following change has been made:
- The type of the payer
+ Reference to the applicable tariff structure
Corrected mistake in the timeVaryingTariffs schema which specified amount as a required property
Get Generic Plans
Code samples
GET /energy/plans HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('/energy/plans', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/plans
Obtain a list of energy plans that are currently offered to the market.
Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | query | Enum | optional | Used to filter results on the type field. Any one of the valid values for this field can be supplied plus 'ALL'. If absent defaults to 'ALL' |
| fuelType | query | Enum | optional | Used to filter results on the fuelType field. Any one of the valid values for this field can be supplied plus 'ALL'. If absent defaults to 'ALL' |
| effective | query | Enum | optional | Allows for the filtering of plans based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' |
| updated-since | query | DateTimeString | optional | Only include plans that have been updated after the specified date and time. If absent defaults to include all plans |
| brand | query | string | optional | Used to filter results on the brand field. If absent defaults to include all plans |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Enumerated Values
| Parameter | Value |
|---|---|
| type | STANDING |
| type | MARKET |
| type | REGULATED |
| type | ALL |
| fuelType | ELECTRICITY |
| fuelType | GAS |
| fuelType | DUAL |
| fuelType | ALL |
| effective | CURRENT |
| effective | FUTURE |
| effective | ALL |
Example responses
200 Response
{
"data": {
"plans": [
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyPlanListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Get Generic Plan Detail
Code samples
GET /energy/plans/{planId} HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('/energy/plans/{planId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/plans/{planId}
Obtain detailed information on a single energy plan offered openly to the market.
Endpoint Version
| Version | 3 |
Version Notes
- The dailySupplyChargeType field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the v1.32.0 release notes for more details.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | string | mandatory | ID of the specific plan requested |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Example responses
200 Response
{
"data": {
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
},
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyPlanResponseV3 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Get Service Points
Code samples
GET /energy/electricity/servicepoints HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints
Obtain a list of service points owned by the customer that has authorised the current session
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"servicePoints": [
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyServicePointListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Service Point Detail
Code samples
GET /energy/electricity/servicepoints/{servicePointId} HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/{servicePointId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints/{servicePointId}
Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| servicePointId | path | string | mandatory | ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data endpoint. Note that it is not a nationalMeteringId. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyServicePointDetailResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Usage For Service Point
Code samples
GET /energy/electricity/servicepoints/{servicePointId}/usage HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/{servicePointId}/usage', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints/{servicePointId}/usage
Obtain a list of electricity usage data from a particular service point
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| servicePointId | path | string | mandatory | ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data endpoint. Note that it is not a nationalMeteringId. |
| oldest-date | query | DateString | optional | Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| newest-date | query | DateString | optional | Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| interval-reads | query | Enum | optional | Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| interval-reads | NONE |
| interval-reads | MIN_30 |
| interval-reads | FULL |
Example responses
200 Response
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyUsageListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk Usage
Code samples
GET /energy/electricity/servicepoints/usage HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/usage', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints/usage
Obtain usage data for all service points associated with the customer
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| interval-reads | query | Enum | optional | Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| oldest-date | query | DateString | optional | Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| newest-date | query | DateString | optional | Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| interval-reads | NONE |
| interval-reads | MIN_30 |
| interval-reads | FULL |
Example responses
200 Response
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyUsageListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Usage For Specific Service Points
Code samples
POST /energy/electricity/servicepoints/usage HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/usage', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /energy/electricity/servicepoints/usage
Obtain the electricity usage data for a specific set of service points
Body parameter
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| oldest-date | query | DateString | optional | Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| newest-date | query | DateString | optional | Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| interval-reads | query | Enum | optional | Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestServicePointIdList | mandatory | Request payload containing list of specific Service Points to obtain data for |
Enumerated Values
| Parameter | Value |
|---|---|
| interval-reads | NONE |
| interval-reads | MIN_30 |
| interval-reads | FULL |
Example responses
200 Response
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyUsageListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get DER For Service Point
Code samples
GET /energy/electricity/servicepoints/{servicePointId}/der HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/{servicePointId}/der', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints/{servicePointId}/der
Obtain a list of DER data from a particular service point
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| servicePointId | path | string | mandatory | ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data endpoint. Note that it is not a nationalMeteringId. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyDerDetailResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk DER
Code samples
GET /energy/electricity/servicepoints/der HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/der', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/electricity/servicepoints/der
Obtain DER data for all service points associated with the customer
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"derRecords": [
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyDerListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get DER For Specific Service Points
Code samples
POST /energy/electricity/servicepoints/der HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/electricity/servicepoints/der', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /energy/electricity/servicepoints/der
Obtain DER data for a specific set of service points
Body parameter
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestServicePointIdList | mandatory | Request payload containing list of specific Service Points to obtain data for |
Example responses
200 Response
{
"data": {
"derRecords": [
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyDerListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Energy Accounts
Code samples
GET /energy/accounts HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts
Obtain the list of energy accounts available under the authorised consent
Other Versions: v1
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| open-status | query | Enum | optional | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Enumerated Values
| Parameter | Value |
|---|---|
| open-status | ALL |
| open-status | CLOSED |
| open-status | OPEN |
Example responses
200 Response
{
"data": {
"accounts": [
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
}
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyAccountListResponseV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Energy Account Detail
Code samples
GET /energy/accounts/{accountId} HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/{accountId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/{accountId}
Obtain detailed information for a specific energy account
Endpoint Version
| Version | 4 |
Version Notes
- The dailySupplyChargeType field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the v1.32.0 release notes for more details.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | mandatory | ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
},
"planDetail": {
"fuelType": "ELECTRICITY",
"isContingentPlan": false,
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [],
"period": "string",
"timeVariations": []
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [],
"period": "string",
"timeVariations": []
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
},
"authorisedContacts": [
{
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyAccountDetailResponseV4 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Agreed Payment Schedule
Code samples
GET /energy/accounts/{accountId}/payment-schedule HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/{accountId}/payment-schedule', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/{accountId}/payment-schedule
Obtain the agreed payment schedule and details, if any, for a specific energy account.
Some general notes about this endpoint:
- This API describes how the consumer has elected to pay for their account
- Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments
- Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields
- Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | mandatory | ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"paymentSchedules": [
{
"amount": "string",
"paymentScheduleUType": "cardDebit",
"cardDebit": {
"cardScheme": "VISA",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"directDebit": {
"isTokenised": true,
"bsb": "string",
"accountNumber": "string",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"manualPayment": {
"billFrequency": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyPaymentScheduleResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Concessions
Code samples
GET /energy/accounts/{accountId}/concessions HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/{accountId}/concessions', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/{accountId}/concessions
Obtain the details of any concessions or arrangements applied to a specific energy account
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | mandatory | ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"concessions": [
{
"type": "FIXED_AMOUNT",
"displayName": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"startDate": "string",
"endDate": "string",
"discountFrequency": "string",
"amount": "string",
"percentage": "string",
"appliedTo": [
"INVOICE"
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyConcessionsResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Balance For Energy Account
Code samples
GET /energy/accounts/{accountId}/balance HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/{accountId}/balance', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/{accountId}/balance
Obtain the current balance for a specific account
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | mandatory | ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"balance": "string"
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyBalanceResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk Balances for Energy
Code samples
GET /energy/accounts/balances HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/balances', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/balances
Obtain the current balance for all accounts
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"balances": [
{
"accountId": "string",
"balance": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyBalanceListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Balances For Specific Energy Accounts
Code samples
POST /energy/accounts/balances HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/balances', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /energy/accounts/balances
Obtain the current balance for a specified set of accounts
Body parameter
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestAccountIdList | mandatory | Request payload containing list of specific Accounts to obtain data for |
Example responses
200 Response
{
"data": {
"balances": [
{
"accountId": "string",
"balance": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyBalanceListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Invoices For Account
Code samples
GET /energy/accounts/{accountId}/invoices HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/{accountId}/invoices', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/{accountId}/invoices
Obtain the invoices for a specific account
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | mandatory | ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| newest-date | query | DateString | optional | Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| oldest-date | query | DateString | optional | Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"invoices": [
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "string",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "string",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "string"
},
"paymentStatus": "PAID"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyInvoiceListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk Invoices
Code samples
GET /energy/accounts/invoices HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/invoices', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/invoices
Obtain the invoices for all accounts
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| newest-date | query | DateString | optional | Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| oldest-date | query | DateString | optional | Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"invoices": [
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "string",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "string",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "string"
},
"paymentStatus": "PAID"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyInvoiceListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Invoices For Specific Accounts
Code samples
POST /energy/accounts/invoices HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/invoices', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /energy/accounts/invoices
Obtain invoices for a specified set of accounts
Body parameter
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| newest-date | query | DateString | optional | Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| oldest-date | query | DateString | optional | Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestAccountIdList | mandatory | Request payload containing list of specific Accounts to obtain data for |
Example responses
200 Response
{
"data": {
"invoices": [
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "string",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "string",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "string"
},
"paymentStatus": "PAID"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyInvoiceListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Billing For Account
Code samples
GET /energy/accounts/{accountId}/billing HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/{accountId}/billing', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/{accountId}/billing
Obtain the billing transactions for a specific account
Deprecated Versions:
- v1 - This version is to be ceased to be called by data recipients by September 9th 2024 and MAY be decommissioned by data holders as of that date
- v2 - This version MAY be retired by September 9th 2024 if v3 is implemented.
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | string | mandatory | ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| newest-time | query | DateTimeString | optional | Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type |
| oldest-time | query | DateTimeString | optional | Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"transactions": [
{
"accountId": "string",
"executionDateTime": "string",
"gst": "string",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyBillingListResponseV3 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Bulk Billing
Code samples
GET /energy/accounts/billing HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/billing', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /energy/accounts/billing
Obtain billing transactions for all accounts
Deprecated Versions:
- v1 - This version is to be ceased to be called by data recipients by September 9th 2024 and MAY be decommissioned by data holders as of that date
- v2 - This version MAY be retired by September 9th 2024 if v3 is implemented.
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| newest-time | query | DateTimeString | optional | Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type |
| oldest-time | query | DateTimeString | optional | Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"transactions": [
{
"accountId": "string",
"executionDateTime": "string",
"gst": "string",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyBillingListResponseV3 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Billing For Specific Accounts
Code samples
POST /energy/accounts/billing HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('/energy/accounts/billing', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /energy/accounts/billing
Obtain billing for a specified set of accounts
Deprecated Versions:
- v1 - This version is to be ceased to be called by data recipients by September 9th 2024 and MAY be decommissioned by data holders as of that date
- v2 - This version MAY be retired by September 9th 2024 if v3 is implemented.
Body parameter
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 3 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| newest-time | query | DateTimeString | optional | Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type |
| oldest-time | query | DateTimeString | optional | Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
| body | body | RequestAccountIdList | mandatory | Request payload containing list of specific Accounts to obtain data for |
Example responses
200 Response
{
"data": {
"transactions": [
{
"accountId": "string",
"executionDateTime": "string",
"gst": "string",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyBillingListResponseV3 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Schemas
EnergyPlanListResponse
{
"data": {
"plans": [
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » plans | [EnergyPlan] | mandatory | Array of plans |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyPlanResponseV3
{
"data": {
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
},
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | EnergyPlanDetailV3 | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyServicePointListResponse
{
"data": {
"servicePoints": [
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » servicePoints | [EnergyServicePoint] | mandatory | none |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyServicePointDetailResponse
{
"data": {
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | EnergyServicePointDetail | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyUsageListResponse
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » reads | [EnergyUsageRead] | mandatory | Array of meter reads sorted by NMI in ascending order followed by readStartDate in descending order |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyDerListResponse
{
"data": {
"derRecords": [
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » derRecords | [EnergyDerRecord] | mandatory | Array of meter reads |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyDerDetailResponse
{
"data": {
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | EnergyDerRecord | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyAccountListResponseV2
{
"data": {
"accounts": [
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
}
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » accounts | [EnergyAccountV2] | mandatory | Array of accounts |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyAccountDetailResponseV4
{
"data": {
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
},
"planDetail": {
"fuelType": "ELECTRICITY",
"isContingentPlan": false,
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [],
"period": "string",
"timeVariations": []
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [],
"period": "string",
"timeVariations": []
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [],
"period": "string",
"timeOfUse": [],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
},
"authorisedContacts": [
{
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | EnergyAccountDetailV4 | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyPaymentScheduleResponse
{
"data": {
"paymentSchedules": [
{
"amount": "string",
"paymentScheduleUType": "cardDebit",
"cardDebit": {
"cardScheme": "VISA",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"directDebit": {
"isTokenised": true,
"bsb": "string",
"accountNumber": "string",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"manualPayment": {
"billFrequency": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » paymentSchedules | [EnergyPaymentSchedule] | mandatory | Array may be empty if no payment schedule exist |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyConcessionsResponse
{
"data": {
"concessions": [
{
"type": "FIXED_AMOUNT",
"displayName": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"startDate": "string",
"endDate": "string",
"discountFrequency": "string",
"amount": "string",
"percentage": "string",
"appliedTo": [
"INVOICE"
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » concessions | [EnergyConcession] | mandatory | Array may be empty if no concessions exist |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyBalanceListResponse
{
"data": {
"balances": [
{
"accountId": "string",
"balance": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » balances | [object] | mandatory | Array of account balances |
| »» accountId | string | mandatory | The ID of the account |
| »» balance | AmountString | mandatory | The current balance of the account. A positive value indicates that amount is owing to be paid. A negative value indicates that the account is in credit |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyBalanceResponse
{
"data": {
"balance": "string"
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » balance | AmountString | mandatory | The current balance of the account. A positive value indicates that amount is owing to be paid. A negative value indicates that the account is in credit |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyInvoiceListResponse
{
"data": {
"invoices": [
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "string",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "string",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "string"
},
"paymentStatus": "PAID"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » invoices | [EnergyInvoice] | mandatory | Array of invoices sorted by issue date in descending order |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyBillingListResponseV3
{
"data": {
"transactions": [
{
"accountId": "string",
"executionDateTime": "string",
"gst": "string",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » transactions | [EnergyBillingTransactionV3] | mandatory | Array of transactions sorted by date and time in descending order |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [object] | mandatory | none |
| » code | string | mandatory | The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| » title | string | mandatory | A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| » detail | string | mandatory | A human-readable explanation specific to this occurrence of the problem. |
| » meta | object | optional | Additional data for customised error codes |
| »» urn | string | conditional | The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
EnergyPlan
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| planId | ASCIIString | mandatory | The ID of the specific plan |
| effectiveFrom | DateTimeString | optional | The date and time from which this plan is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate |
| effectiveTo | DateTimeString | optional | The date and time at which this plan will be retired and will no longer be offered. Used to enable the managed deprecation of plans |
| lastUpdated | DateTimeString | mandatory | The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered) |
| displayName | string | optional | The display name of the plan |
| description | string | optional | A description of the plan |
| type | Enum | mandatory | The type of the plan |
| fuelType | Enum | mandatory | The fuel types covered by the plan |
| brand | ASCIIString | mandatory | The ID of the brand under which this plan is offered |
| brandName | string | mandatory | The display name of the brand under which this plan is offered |
| applicationUri | URIString | optional | A link to an application web page where this plan can be applied for |
| additionalInformation | object | optional | Object that contains links to additional information on specific topics |
| » overviewUri | URIString | optional | A link to a general overview of the plan |
| » termsUri | URIString | optional | A link to terms and conditions for the plan |
| » eligibilityUri | URIString | optional | A link to detail on eligibility criteria for the plan |
| » pricingUri | URIString | optional | A link to detail on pricing for the plan |
| » bundleUri | URIString | optional | A link to detail on bundles that this plan can be a part of |
| customerType | Enum | optional | The type of customer that the plan is offered to. If absent then the plan is available to all customers |
| geography | object | optional | Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited |
| » excludedPostcodes | [string] | optional | Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999) |
| » includedPostcodes | [string] | optional | Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999) |
| » distributors | [string] | mandatory | Array of distributors for the plan. Must have at least one entry |
Enumerated Values
| Property | Value |
|---|---|
| type | STANDING |
| type | MARKET |
| type | REGULATED |
| fuelType | ELECTRICITY |
| fuelType | GAS |
| fuelType | DUAL |
| customerType | RESIDENTIAL |
| customerType | BUSINESS |
EnergyPlanDetailV3
{
"planId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"displayName": "string",
"description": "string",
"type": "STANDING",
"fuelType": "ELECTRICITY",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"pricingUri": "string",
"bundleUri": "string"
},
"customerType": "RESIDENTIAL",
"geography": {
"excludedPostcodes": [
"string"
],
"includedPostcodes": [
"string"
],
"distributors": [
"string"
]
},
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | EnergyPlan | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » meteringCharges | [object] | optional | Charges for metering included in the plan |
| »» displayName | string | mandatory | Display name of the charge |
| »» description | string | optional | Description of the charge |
| »» minimumValue | AmountString | mandatory | Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified |
| »» maximumValue | AmountString | optional | The upper limit of the charge if the charge could occur in a range |
| »» period | ExternalRef | optional | The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| » gasContract | EnergyPlanContractFullV3 | conditional | The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL |
| » electricityContract | EnergyPlanContractFullV3 | conditional | The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL |
EnergyPlanContractV3
{
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| additionalFeeInformation | string | optional | Free text field containing additional information of the fees for this contract |
| pricingModel | Enum | mandatory | The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:
|
| timeZone | Enum | conditional | Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent |
| isFixed | boolean | mandatory | Flag indicating whether prices are fixed or variable |
| variation | string | conditional | Free text description of price variation policy and conditions for the contract. Mandatory if isFixed is false |
| onExpiryDescription | string | optional | Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period |
| paymentOption | [Enum] | mandatory | Payment options for this contract |
| intrinsicGreenPower | object | optional | Describes intrinsic green power for the plan. If present then the plan includes a percentage of green power in the base plan. Should not be present for gas contracts |
| » greenPercentage | RateString | mandatory | Percentage of green power intrinsically included in the plan |
| controlledLoad | EnergyPlanControlledLoadV2 | conditional | Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD |
| incentives | EnergyPlanIncentives | optional | Optional list of incentives available for the contract |
| discounts | EnergyPlanDiscounts | optional | Optional list of discounts available for the contract |
| greenPowerCharges | EnergyPlanGreenPowerCharges | optional | Optional list of charges applicable to green power |
| eligibility | EnergyPlanEligibility | optional | Eligibility restrictions or requirements |
| fees | EnergyPlanFees | optional | An array of fees applicable to the plan |
| solarFeedInTariff | EnergyPlanSolarFeedInTariffV3 | optional | Array of feed in tariffs for solar power |
| tariffPeriod | EnergyPlanTariffPeriodV2 | mandatory | Array of tariff periods |
Enumerated Values
| Property | Value |
|---|---|
| pricingModel | SINGLE_RATE |
| pricingModel | SINGLE_RATE_CONT_LOAD |
| pricingModel | TIME_OF_USE |
| pricingModel | TIME_OF_USE_CONT_LOAD |
| pricingModel | FLEXIBLE |
| pricingModel | FLEXIBLE_CONT_LOAD |
| pricingModel | QUOTA |
| timeZone | LOCAL |
| timeZone | AEST |
| paymentOption | PAPER_BILL |
| paymentOption | CREDIT_CARD |
| paymentOption | DIRECT_DEBIT |
| paymentOption | BPAY |
| paymentOption | OTHER |
EnergyPlanContractFullV3
{
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
],
"termType": "1_YEAR",
"benefitPeriod": "string",
"terms": "string",
"meterTypes": [
"string"
],
"coolingOffDays": 0,
"billFrequency": [
"string"
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | EnergyPlanContractV3 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » termType | Enum | optional | The term for the contract. If absent assumes no specified term |
| » benefitPeriod | string | conditional | Description of the benefit period. Should only be present if termType has the value ONGOING |
| » terms | string | optional | Free text description of the terms for the contract |
| » meterTypes | [string] | optional | An array of the meter types that this contract is available for |
| » coolingOffDays | PositiveInteger | conditional | Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET |
| » billFrequency | [string] | mandatory | An array of the available billing schedules for this contract. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
Enumerated Values
| Property | Value |
|---|---|
| termType | 1_YEAR |
| termType | 2_YEAR |
| termType | 3_YEAR |
| termType | 4_YEAR |
| termType | 5_YEAR |
| termType | ONGOING |
| termType | OTHER |
EnergyPlanControlledLoadV2
[
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"type": "PEAK"
}
]
}
]
Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| displayName | string | mandatory | A display name for the controlled load |
| rateBlockUType | Enum | mandatory | Specifies the type of controlloed load rate |
| startDate | DateString | optional | Optional start date of the application of the controlled load rate |
| endDate | DateString | optional | Optional end date of the application of the controlled load rate |
| singleRate | object | conditional | Object representing a single controlled load rate. Required if rateBlockUType is singleRate |
| » displayName | string | mandatory | Display name of the controlled load rate |
| » description | string | optional | Description of the controlled load rate |
| » dailySupplyCharge | AmountString | optional | The daily supply charge (exclusive of GST) for this controlled load tier |
| » rates | [object] | mandatory | Array of controlled load rates in order of usage volume |
| »» unitPrice | AmountString | mandatory | Unit price of usage per measure unit (exclusive of GST) |
| »» measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| »» volume | number | optional | Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period |
| » period | ExternalRef | optional | Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent |
| timeOfUseRates | [object] | conditional | Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates |
| » displayName | string | mandatory | Display name of the controlled load rate |
| » description | string | optional | Description of the controlled load rate |
| » dailySupplyCharge | AmountString | optional | The daily supply charge (exclusive of GST) for this controlled load tier |
| » rates | [object] | mandatory | Array of controlled load rates in order of usage volume |
| »» unitPrice | AmountString | mandatory | Unit price of usage per measure unit (exclusive of GST) |
| »» measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| »» volume | number | optional | Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period |
| » period | ExternalRef | optional | Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent |
| » timeOfUse | [object] | mandatory | Array of times of use. |
| »» days | [Enum] | optional | The days that the rate applies to |
| »» startTime | ExternalRef | conditional | The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» endTime | ExternalRef | conditional | The end of the time period per day for which the controlled load rate applies. Required if startTime provided. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» additionalInfo | string | conditional | Display text providing more information on the contrlled load, for e.g. controlled load availability if specific day/time is not known. Required if startTime and endTime absent or if additionalInfoUri provided |
| »» additionalInfoUri | URIString | optional | Optional link to additional information regarding the controlled load |
| » type | Enum | mandatory | The type of usage that the rate applies to |
Enumerated Values
| Property | Value |
|---|---|
| rateBlockUType | singleRate |
| rateBlockUType | timeOfUseRates |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| days | SUN |
| days | MON |
| days | TUE |
| days | WED |
| days | THU |
| days | FRI |
| days | SAT |
| days | PUBLIC_HOLIDAYS |
| type | PEAK |
| type | OFF_PEAK |
| type | SHOULDER |
| type | SOLAR_SPONGE |
EnergyPlanIncentives
[
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
]
Optional list of incentives available for the contract
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| displayName | string | mandatory | The display name of the incentive |
| description | string | mandatory | The description of the incentive |
| category | Enum | mandatory | The type of the incentive |
| eligibility | string | optional | A display message outlining an eligibility criteria that may apply |
Enumerated Values
| Property | Value |
|---|---|
| category | GIFT |
| category | ACCOUNT_CREDIT |
| category | OTHER |
EnergyPlanDiscounts
[
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
]
Optional list of discounts available for the contract
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| displayName | string | mandatory | The display name of the discount |
| description | string | optional | The description of the discount |
| type | Enum | mandatory | The type of the discount |
| category | Enum | optional | The type of the discount. Mandatory if the discount type is CONDITIONAL |
| endDate | DateString | optional | Optional end date for the discount after which the discount is no longer available |
| methodUType | Enum | mandatory | The method of calculation of the discount |
| percentOfBill | object | conditional | Required if methodUType is percentOfBill |
| » rate | RateString | mandatory | The rate of the discount applied to the bill amount |
| percentOfUse | object | conditional | Required if methodUType is percentOfUse |
| » rate | RateString | mandatory | The rate of the discount applied to the usageamount |
| fixedAmount | object | conditional | Required if methodUType is fixedAmount |
| » amount | AmountString | mandatory | The amount of the discount |
| percentOverThreshold | object | conditional | Required if methodUType is percentOverThreshold |
| » rate | RateString | mandatory | The rate of the discount over the usage amount |
| » usageAmount | AmountString | mandatory | The usage amount threshold above which the discount applies |
Enumerated Values
| Property | Value |
|---|---|
| type | CONDITIONAL |
| type | GUARANTEED |
| type | OTHER |
| category | PAY_ON_TIME |
| category | DIRECT_DEBIT |
| category | GUARANTEED_DISCOUNT |
| category | OTHER |
| methodUType | percentOfBill |
| methodUType | percentOfUse |
| methodUType | fixedAmount |
| methodUType | percentOverThreshold |
EnergyPlanGreenPowerCharges
[
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
]
Optional list of charges applicable to green power
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| displayName | string | mandatory | The display name of the charge |
| description | string | optional | The description of the charge |
| scheme | Enum | mandatory | The applicable green power scheme |
| type | Enum | mandatory | The type of charge |
| tiers | [object] | mandatory | Array of charge tiers based on the percentage of green power used for the period implied by the type. Array is in order of increasing percentage of green power |
| » percentGreen | RateString | mandatory | The upper percentage of green power used applicable for this tier |
| » rate | RateString | conditional | The rate of the charge if the type implies the application of a rate |
| » amount | AmountString | conditional | The amount of the charge if the type implies the application of a fixed amount |
Enumerated Values
| Property | Value |
|---|---|
| scheme | GREENPOWER |
| scheme | OTHER |
| type | FIXED_PER_DAY |
| type | FIXED_PER_WEEK |
| type | FIXED_PER_MONTH |
| type | FIXED_PER_UNIT |
| type | PERCENT_OF_USE |
| type | PERCENT_OF_BILL |
EnergyPlanEligibility
[
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
]
Eligibility restrictions or requirements
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type | Enum | mandatory | The type of the eligibility restriction. The CONTINGENT_PLAN value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up) |
| information | string | mandatory | Information of the eligibility restriction specific to the type of the restriction |
| description | string | optional | A description of the eligibility restriction |
Enumerated Values
| Property | Value |
|---|---|
| type | EXISTING_CUST |
| type | EXISTING_POOL |
| type | EXISTING_SOLAR |
| type | EXISTING_BATTERY |
| type | EXISTING_SMART_METER |
| type | EXISTING_BASIC_METER |
| type | SENIOR_CARD |
| type | SMALL_BUSINESS |
| type | NO_SOLAR_FIT |
| type | NEW_CUSTOMER |
| type | ONLINE_ONLY |
| type | REQ_EQUIP_SUPPLIER |
| type | THIRD_PARTY_ONLY |
| type | SPORT_CLUB_MEMBER |
| type | ORG_MEMBER |
| type | SPECIFIC_LOCATION |
| type | MINIMUM_USAGE |
| type | LOYALTY_MEMBER |
| type | GROUP_BUY_MEMBER |
| type | CONTINGENT_PLAN |
| type | OTHER |
EnergyPlanFees
[
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
]
An array of fees applicable to the plan
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type | Enum | mandatory | The type of the fee |
| term | Enum | mandatory | The term of the fee |
| amount | AmountString | conditional | The fee amount. Required if term is not PERCENT_OF_BILL |
| rate | RateString | conditional | The fee rate. Required if term is PERCENT_OF_BILL |
| description | string | optional | A description of the fee |
Enumerated Values
| Property | Value |
|---|---|
| type | EXIT |
| type | ESTABLISHMENT |
| type | LATE_PAYMENT |
| type | DISCONNECTION |
| type | DISCONNECT_MOVE_OUT |
| type | DISCONNECT_NON_PAY |
| type | RECONNECTION |
| type | CONNECTION |
| type | PAYMENT_PROCESSING |
| type | CC_PROCESSING |
| type | CHEQUE_DISHONOUR |
| type | DD_DISHONOUR |
| type | MEMBERSHIP |
| type | CONTRIBUTION |
| type | PAPER_BILL |
| type | OTHER |
| term | FIXED |
| term | 1_YEAR |
| term | 2_YEAR |
| term | 3_YEAR |
| term | 4_YEAR |
| term | 5_YEAR |
| term | PERCENT_OF_BILL |
| term | ANNUAL |
| term | DAILY |
| term | WEEKLY |
| term | MONTHLY |
| term | BIANNUAL |
| term | VARIABLE |
EnergyPlanSolarFeedInTariffV3
[
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeVariations": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
]
}
]
}
]
Array of feed in tariffs for solar power
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| displayName | string | mandatory | The name of the tariff |
| description | string | optional | A description of the tariff |
| startDate | DateString | optional | The start date of the application of the feed in tariff |
| endDate | DateString | optional | The end date of the application of the feed in tariff |
| scheme | Enum | mandatory | The applicable scheme |
| payerType | Enum | mandatory | The type of the payer |
| tariffUType | Enum | mandatory | Reference to the applicable tariff structure |
| singleTariff | object | conditional | Represents a constant tariff. Mandatory if tariffUType is set to singleTariff |
| » rates | [object] | mandatory | Array of feed in rates |
| »» unitPrice | AmountString | mandatory | Unit price of usage per measure unit (exclusive of GST) |
| »» measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| »» volume | number | optional | Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period |
| » period | ExternalRef | optional | Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent |
| timeVaryingTariffs | [object] | conditional | Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs |
| » type | Enum | optional | The type of the charging time period. If absent applies to all periods |
| » displayName | string | mandatory | Display name of the tariff |
| » rates | [object] | optional | Array of feed in rates |
| »» unitPrice | AmountString | mandatory | Unit price of usage per measure unit (exclusive of GST) |
| »» measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| »» volume | number | optional | Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period |
| » period | ExternalRef | optional | Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent |
| » timeVariations | [object] | mandatory | Array of time periods for which this tariff is applicable |
| »» days | [Enum] | mandatory | The days that the tariff applies to. At least one entry required |
| »» startTime | ExternalRef | optional | The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight). Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» endTime | ExternalRef | optional | The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight). Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
Enumerated Values
| Property | Value |
|---|---|
| scheme | PREMIUM |
| scheme | CURRENT |
| scheme | VARIABLE |
| scheme | OTHER |
| payerType | GOVERNMENT |
| payerType | RETAILER |
| tariffUType | singleTariff |
| tariffUType | timeVaryingTariffs |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| type | PEAK |
| type | OFF_PEAK |
| type | SHOULDER |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| days | SUN |
| days | MON |
| days | TUE |
| days | WED |
| days | THU |
| days | FRI |
| days | SAT |
| days | PUBLIC_HOLIDAYS |
EnergyPlanTariffPeriodV2
[
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string",
"timeOfUse": [
{
"days": [
"SUN"
],
"startTime": "string",
"endTime": "string"
}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
Array of tariff periods
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type | Enum | optional | Type of charge. Assumed to be other if absent |
| displayName | string | mandatory | The name of the tariff period |
| startDate | string | mandatory | The start date of the tariff period in a calendar year. Formatted in mm-dd format |
| endDate | string | mandatory | The end date of the tariff period in a calendar year. Formatted in mm-dd format |
| dailySupplyChargeType | Enum | optional | Specifies if daily supply charge is single or banded. |
| dailySupplyCharge | AmountString | conditional | The amount of access charge for the tariff period, in dollars per day exclusive of GST. Mandatory if dailySupplyChargeType is SINGLE |
| bandedDailySupplyCharges | [object] | conditional | Array representing banded daily supply charge rates. Mandatory if dailySupplyChargeType is BAND |
| » unitPrice | AmountString | mandatory | The amount of daily supply charge for the band, in dollars per day exclusive of GST |
| » measureUnit | Enum | optional | The measurement unit of rate. Assumed to be DAYS if absent |
| » volume | number | optional | Volume the charge applies to |
| timeZone | Enum | optional | Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed. |
| rateBlockUType | Enum | mandatory | Specifies the type of rate applicable to this tariff period |
| singleRate | object | conditional | Object representing a single rate. Required if rateBlockUType is singleRate |
| » displayName | string | mandatory | Display name of the rate |
| » description | string | optional | Description of the rate |
| » generalUnitPrice | AmountString | conditional | The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST. Only required if pricingModel field is ‘QUOTA’ |
| » rates | [object] | mandatory | Array of controlled load rates in order of usage volume |
| »» unitPrice | AmountString | mandatory | Unit price of usage per measure unit (exclusive of GST) |
| »» measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| »» volume | number | optional | Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period |
| » period | ExternalRef | optional | Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| timeOfUseRates | [object] | conditional | Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates |
| » displayName | string | mandatory | Display name of the rate |
| » description | string | optional | Description of the rate |
| » rates | [object] | mandatory | Array of controlled load rates in order of usage volume |
| »» unitPrice | AmountString | mandatory | Unit price of usage per measure unit (exclusive of GST) |
| »» measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| »» volume | number | optional | Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period |
| » period | ExternalRef | optional | Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax). Defaults to P1Y if absent |
| » timeOfUse | [object] | mandatory | Array of times of use |
| »» days | [Enum] | mandatory | The days that the rate applies to |
| »» startTime | ExternalRef | mandatory | Start of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| »» endTime | ExternalRef | mandatory | End of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| » type | Enum | mandatory | The type of usage that the rate applies to |
| demandCharges | [object] | conditional | Array of demand charges. Required if rateBlockUType is demandCharges |
| » displayName | string | mandatory | Display name of the charge |
| » description | string | optional | Description of the charge |
| » amount | AmountString | mandatory | The charge amount per measure unit exclusive of GST |
| » measureUnit | Enum | optional | The measurement unit of charge amount. Assumed to be KWH if absent |
| » startTime | ExternalRef | mandatory | Start of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| » endTime | ExternalRef | mandatory | End of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. |
| » days | [Enum] | optional | The days that the demand tariff applies to |
| » minDemand | AmountString | optional | Minimum demand for this demand tariff in kW. If absent then 0 is assumed |
| » maxDemand | AmountString | optional | Maximum demand for this demand tariff in kW. If present, must be higher than the value of the minDemand field |
| » measurementPeriod | Enum | mandatory | Application period for the demand tariff |
| » chargePeriod | Enum | mandatory | Charge period for the demand tariff |
Enumerated Values
| Property | Value |
|---|---|
| type | ENVIRONMENTAL |
| type | REGULATED |
| type | NETWORK |
| type | METERING |
| type | RETAIL_SERVICE |
| type | RCTI |
| type | OTHER |
| dailySupplyChargeType | SINGLE |
| dailySupplyChargeType | BAND |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| timeZone | LOCAL |
| timeZone | AEST |
| rateBlockUType | singleRate |
| rateBlockUType | timeOfUseRates |
| rateBlockUType | demandCharges |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| days | SUN |
| days | MON |
| days | TUE |
| days | WED |
| days | THU |
| days | FRI |
| days | SAT |
| days | PUBLIC_HOLIDAYS |
| type | PEAK |
| type | OFF_PEAK |
| type | SHOULDER |
| type | SHOULDER1 |
| type | SHOULDER2 |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| days | SUN |
| days | MON |
| days | TUE |
| days | WED |
| days | THU |
| days | FRI |
| days | SAT |
| days | PUBLIC_HOLIDAYS |
| measurementPeriod | DAY |
| measurementPeriod | MONTH |
| measurementPeriod | TARIFF_PERIOD |
| chargePeriod | DAY |
| chargePeriod | MONTH |
| chargePeriod | TARIFF_PERIOD |
EnergyServicePoint
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | Tokenised ID of the service point to be used for referring to the service point in the CDR API suite. To be created in accordance with CDR ID permanence requirements |
| nationalMeteringId | string | mandatory | The independent ID of the service point, known in the industry as the NMI |
| servicePointClassification | Enum | mandatory | The classification of the service point as defined in MSATS procedures |
| servicePointStatus | Enum | mandatory | Code used to indicate the status of the service point. Note the details for the enumeration values below:
|
| jurisdictionCode | Enum | mandatory | Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
|
| isGenerator | boolean | optional | This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit(this may include generator auxiliary loads). If absent defaults to false. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer |
| validFromDate | DateString | mandatory | The latest start date from which the constituent data sets of this service point became valid |
| lastUpdateDateTime | DateTimeString | mandatory | The date and time that the information for this service point was modified |
| consumerProfile | object | optional | none |
| » classification | Enum | optional | A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments |
| » threshold | Enum | optional | A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
|
Enumerated Values
| Property | Value |
|---|---|
| servicePointClassification | EXTERNAL_PROFILE |
| servicePointClassification | GENERATOR |
| servicePointClassification | LARGE |
| servicePointClassification | SMALL |
| servicePointClassification | WHOLESALE |
| servicePointClassification | NON_CONTEST_UNMETERED_LOAD |
| servicePointClassification | NON_REGISTERED_EMBEDDED_GENERATOR |
| servicePointClassification | DISTRIBUTION_WHOLESALE |
| servicePointStatus | ACTIVE |
| servicePointStatus | DE_ENERGISED |
| servicePointStatus | EXTINCT |
| servicePointStatus | GREENFIELD |
| servicePointStatus | OFF_MARKET |
| jurisdictionCode | ALL |
| jurisdictionCode | ACT |
| jurisdictionCode | NEM |
| jurisdictionCode | NSW |
| jurisdictionCode | QLD |
| jurisdictionCode | SA |
| jurisdictionCode | TAS |
| jurisdictionCode | VIC |
| classification | BUSINESS |
| classification | RESIDENTIAL |
| threshold | LOW |
| threshold | MEDIUM |
| threshold | HIGH |
EnergyServicePointDetail
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | The tokenised ID of the service point for use in the CDR APIs. Created according to the CDR rules for ID permanence |
| nationalMeteringId | string | mandatory | The independent ID of the service point, known in the industry as the NMI |
| servicePointClassification | Enum | mandatory | The classification of the service point as defined in MSATS procedures |
| servicePointStatus | Enum | mandatory | Code used to indicate the status of the service point. Note the details for the enumeration values below:
|
| jurisdictionCode | Enum | mandatory | Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
|
| isGenerator | boolean | optional | This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit(this may include generator auxiliary loads). If absent defaults to false. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer |
| validFromDate | DateString | mandatory | The latest start date from which the constituent data sets of this service point became valid |
| lastUpdateDateTime | DateTimeString | mandatory | The date and time that the information for this service point was modified |
| consumerProfile | object | optional | none |
| » classification | Enum | optional | A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments |
| » threshold | Enum | optional | A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
|
| distributionLossFactor | object | mandatory | none |
| » code | string | mandatory | A code used to identify data loss factor for the service point values. Refer to AEMO distribution loss factor documents for each financial year to interpret |
| » description | string | mandatory | Description of the data loss factor code and value |
| » lossValue | string | mandatory | The value associated with the loss factor code |
| relatedParticipants | [object] | mandatory | none |
| » party | string | mandatory | The name of the party/organisation related to this service point |
| » role | Enum | mandatory | The role performed by this participant in relation to the service point. Note the details of enumeration values below:
|
| location | CommonPhysicalAddress | mandatory | Location of the servicepoint |
| meters | [object] | optional | The meters associated with the service point. This may be empty where there are no meters physically installed at the service point |
| » meterId | string | mandatory | The meter ID uniquely identifies a meter for a given service point. It is unique in the context of the service point. It is not globally unique |
| » specifications | object | mandatory | Technical characteristics of the meter |
| »» status | Enum | mandatory | A code to denote the status of the meter. Note the details of enumeration values below:
|
| »» installationType | Enum | mandatory | The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
|
| »» manufacturer | string | optional | Free text field to identify the manufacturer of the installed meter |
| »» model | string | optional | Free text field to identify the meter manufacturer’s designation for the meter model |
| »» readType | string | optional | Code to denote the method and frequency of Meter Reading. The value is formatted as follows:
|
| »» nextScheduledReadDate | DateString | optional | This date is the next scheduled meter read date (NSRD) if a manual Meter Reading is required |
| » registers | [object] | optional | Usage data registers available from the meter. This may be empty where there are no meters physically installed at the service point |
| »» registerId | string | mandatory | Unique identifier of the register within this service point. Is not globally unique |
| »» registerSuffix | string | optional | Register suffix of the meter register where the meter reads are obtained |
| »» averagedDailyLoad | number | optional | The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh). This value is calculated annually. |
| »» registerConsumptionType | Enum | mandatory | Indicates the consumption type of register |
| »» networkTariffCode | string | optional | The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider |
| »» unitOfMeasure | string | optional | The unit of measure for data held in this register |
| »» timeOfDay | Enum | optional | Code to identify the time validity of register contents |
| »» multiplier | number | optional | Multiplier required to take a register value and turn it into a value representing billable energy |
| »» controlledLoad | boolean | optional | Indicates whether the energy recorded by this register is created under a Controlled Load regime |
| »» consumptionType | Enum | optional | Actual/Subtractive Indicator. Note the details of enumeration values below:
|
Enumerated Values
| Property | Value |
|---|---|
| servicePointClassification | EXTERNAL_PROFILE |
| servicePointClassification | GENERATOR |
| servicePointClassification | LARGE |
| servicePointClassification | SMALL |
| servicePointClassification | WHOLESALE |
| servicePointClassification | NON_CONTEST_UNMETERED_LOAD |
| servicePointClassification | NON_REGISTERED_EMBEDDED_GENERATOR |
| servicePointClassification | DISTRIBUTION_WHOLESALE |
| servicePointStatus | ACTIVE |
| servicePointStatus | DE_ENERGISED |
| servicePointStatus | EXTINCT |
| servicePointStatus | GREENFIELD |
| servicePointStatus | OFF_MARKET |
| jurisdictionCode | ALL |
| jurisdictionCode | ACT |
| jurisdictionCode | NEM |
| jurisdictionCode | NSW |
| jurisdictionCode | QLD |
| jurisdictionCode | SA |
| jurisdictionCode | TAS |
| jurisdictionCode | VIC |
| classification | BUSINESS |
| classification | RESIDENTIAL |
| threshold | LOW |
| threshold | MEDIUM |
| threshold | HIGH |
| role | FRMP |
| role | LNSP |
| role | DRSP |
| status | CURRENT |
| status | DISCONNECTED |
| installationType | BASIC |
| installationType | COMMS1 |
| installationType | COMMS2 |
| installationType | COMMS3 |
| installationType | COMMS4 |
| installationType | COMMS4C |
| installationType | COMMS4D |
| installationType | MRAM |
| installationType | MRIM |
| installationType | PROF |
| installationType | SAMPLE |
| installationType | UMCP |
| installationType | VICAMI |
| installationType | NCOLNUML |
| registerConsumptionType | INTERVAL |
| registerConsumptionType | BASIC |
| registerConsumptionType | PROFILE_DATA |
| registerConsumptionType | ACTIVE_IMPORT |
| registerConsumptionType | ACTIVE |
| registerConsumptionType | REACTIVE_IMPORT |
| registerConsumptionType | REACTIVE |
| timeOfDay | ALLDAY |
| timeOfDay | INTERVAL |
| timeOfDay | PEAK |
| timeOfDay | BUSINESS |
| timeOfDay | SHOULDER |
| timeOfDay | EVENING |
| timeOfDay | OFFPEAK |
| timeOfDay | CONTROLLED |
| timeOfDay | DEMAND |
| consumptionType | ACTUAL |
| consumptionType | CUMULATIVE |
EnergyUsageRead
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | Tokenised ID of the service point to be used for referring to the service point in the CDR API suite. To be created in accordance with CDR ID permanence requirements |
| registerId | string | optional | Register ID of the meter register where the meter reads are obtained |
| registerSuffix | string | mandatory | Register suffix of the meter register where the meter reads are obtained |
| meterId | string | optional | Meter id/serial number as it appears in customer’s bill. ID permanence rules do not apply. |
| controlledLoad | boolean | optional | Indicates whether the energy recorded by this register is created under a Controlled Load regime |
| readStartDate | DateString | mandatory | Date when the meter reads start in AEST and assumed to start from 12:00 am AEST. |
| readEndDate | DateString | optional | Date when the meter reads end in AEST. If absent then assumed to be equal to readStartDate. In this case the entry represents data for a single date specified by readStartDate. |
| unitOfMeasure | ExternalRef | optional | Unit of measure of the meter reads. Refer to Appendix B of MDFF Specification NEM12 NEM13 v2.1 for a list of possible values. |
| readUType | Enum | mandatory | Specify the type of the meter read data |
| basicRead | object | conditional | Mandatory if readUType is set to basicRead |
| » quality | Enum | optional | The quality of the read taken. If absent then assumed to be ACTUAL |
| » value | number | mandatory | Meter read value. If positive then it means consumption, if negative it means export |
| intervalRead | object | conditional | Mandatory if readUType is set to intervalRead |
| » readIntervalLength | PositiveInteger | conditional | Read interval length in minutes. Required when interval-reads query parameter equals FULL or MIN_30 |
| » aggregateValue | number | mandatory | The aggregate sum of the interval read values. If positive then it means net consumption, if negative it means net export |
| » intervalReads | [number] | conditional | Array of Interval read values. If positive then it means consumption, if negative it means export. Required when interval-reads query parameter equals FULL or MIN_30. Each read value indicates the read for the interval specified by readIntervalLength beginning at midnight of readStartDate (for example 00:00 to 00:30 would be the first reading in a 30 minute Interval) |
| » readQualities | [object] | conditional | Specifies quality of reads that are not ACTUAL. For read indices that are not specified, quality is assumed to be ACTUAL. If not present, all quality of all reads are assumed to be actual. Required when interval-reads query parameter equals FULL or MIN_30 |
| »» startInterval | PositiveInteger | mandatory | Start interval for read quality flag. First read begins at 1 |
| »» endInterval | PositiveInteger | mandatory | End interval for read quality flag |
| »» quality | Enum | mandatory | The quality of the read taken |
Enumerated Values
| Property | Value |
|---|---|
| readUType | basicRead |
| readUType | intervalRead |
| quality | ACTUAL |
| quality | SUBSTITUTE |
| quality | FINAL_SUBSTITUTE |
| quality | SUBSTITUTE |
| quality | FINAL_SUBSTITUTE |
EnergyDerRecord
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | Tokenised ID of the service point to be used for referring to the service point in the CDR API suite. To be created in accordance with CDR ID permanence requirements |
| approvedCapacity | number | mandatory | Approved small generating unit capacity as agreed with NSP in the connection agreement, expressed in kVA. Value of 0 indicates no DER record exists for the given servicePointId |
| availablePhasesCount | NaturalNumber | mandatory | The number of phases available for the installation of DER. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId |
| installedPhasesCount | NaturalNumber | mandatory | The number of phases that DER is connected to. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId |
| islandableInstallation | Boolean | mandatory | For identification of small generating units designed with the ability to operate in an islanded mode |
| hasCentralProtectionControl | boolean | optional | For DER installations where NSPs specify the need for additional forms of protection above those inbuilt in an inverter. If absent then assumed to be false |
| protectionMode | object | conditional | Required only when the hasCentralProtectionAndControl flag is set to true. One or more of the object fields will be provided to describe the protection modes in place |
| » exportLimitKva | number | optional | Maximum amount of power (kVA) that may be exported from a connection point to the grid, as monitored by a control / relay function. An absent value indicates no limit |
| » underFrequencyProtection | number | optional | Protective function limit in Hz. |
| » underFrequencyProtectionDelay | number | optional | Trip delay time in seconds. |
| » overFrequencyProtection | number | optional | Protective function limit in Hz. |
| » overFrequencyProtectionDelay | number | optional | Trip delay time in seconds. |
| » underVoltageProtection | number | optional | Protective function limit in V. |
| » underVoltageProtectionDelay | number | optional | Trip delay time in seconds. |
| » overVoltageProtection | number | optional | Protective function limit in V. |
| » overVoltageProtectionDelay | number | optional | Trip delay time in seconds. |
| » sustainedOverVoltage | number | optional | Sustained over voltage. |
| » sustainedOverVoltageDelay | number | optional | Sustained Over voltage protection delay in seconds. |
| » frequencyRateOfChange | number | optional | Rate of change of frequency trip point (Hz/s). |
| » voltageVectorShift | number | optional | Trip angle in degrees. |
| » interTripScheme | string | optional | Description of the form of inter-trip (e.g. 'from local substation'). |
| » neutralVoltageDisplacement | number | optional | Trip voltage. |
| acConnections | [object] | mandatory | none |
| » connectionIdentifier | number | mandatory | AC Connection ID as defined in the DER register. Does not align with CDR ID permanence standards |
| » count | PositiveInteger | mandatory | Number of AC Connections in the group. For the suite of AC Connections to be considered as a group, all of the AC Connections included must have the same attributes |
| » equipmentType | Enum | optional | Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g. rotating machine). If absent, assume equipment type to be “OTHER”. |
| » manufacturerName | string | conditional | The name of the inverter manufacturer. Mandatory if equipmentType is INVERTER |
| » inverterSeries | string | conditional | The inverter series. Mandatory if equipmentType is INVERTER |
| » inverterModelNumber | string | conditional | The inverter model number. Mandatory if equipmentType is INVERTER |
| » commissioningDate | DateString | mandatory | The date that the DER installation is commissioned |
| » status | Enum | mandatory | Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned |
| » inverterDeviceCapacity | number | conditional | The rated AC output power that is listed in the product specified by the manufacturer. Mandatory if equipmentType is INVERTER. Default is 0 if value not known |
| » derDevices | [object] | mandatory | none |
| »» deviceIdentifier | number | mandatory | Unique identifier for a single DER device or a group of DER devices with the same attributes. Does not align with CDR ID permanence standards |
| »» count | PositiveInteger | mandatory | Number of devices in the group of DER devices |
| »» manufacturer | string | optional | The name of the device manufacturer. If absent then assumed to be “unknown” |
| »» modelNumber | string | optional | The model number of the device. If absent then assumed to be “unknown” |
| »» status | Enum | optional | Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned |
| »» type | Enum | mandatory | Used to indicate the primary technology used in the DER device |
| »» subtype | string | optional | Used to indicate the primary technology used in the DER device. This field is also used to record for example the battery chemistry, or the type of PV panel. It is also used to record if a battery is contained in an electric vehicle connected in a vehicle-to-grid arrangement. If absent then assumed to be “other” |
| »» nominalRatedCapacity | number | mandatory | Maximum output in kVA that is listed in the product specification by the manufacturer. This refers to the capacity of each unit within the device group. Default is 0 if value not known |
| »» nominalStorageCapacity | number | conditional | Maximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to “STORAGE”. Default is 0 if value not known |
Enumerated Values
| Property | Value |
|---|---|
| equipmentType | INVERTER |
| equipmentType | OTHER |
| status | ACTIVE |
| status | INACTIVE |
| status | DECOMMISSIONED |
| status | ACTIVE |
| status | INACTIVE |
| status | DECOMMISSIONED |
| type | FOSSIL |
| type | HYDRO |
| type | WIND |
| type | SOLAR_PV |
| type | RENEWABLE |
| type | GEOTHERMAL |
| type | STORAGE |
| type | OTHER |
EnergyAccountBaseV2
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | string | mandatory | The ID of the account. To be created in accordance with CDR ID permanence requirements |
| accountNumber | string | optional | Optional identifier of the account as defined by the data holder. This must be the value presented on physical statements (if it exists) and must not be used for the value of accountId |
| displayName | string | optional | An optional display name for the account if one exists or can be derived. The content of this field is at the discretion of the data holder |
| openStatus | Enum | optional | Open or closed status for the account. If not present then OPEN is assumed |
| creationDate | DateString | conditional | The date that the account was created or opened. Mandatory if openStatus is OPEN |
Enumerated Values
| Property | Value |
|---|---|
| openStatus | CLOSED |
| openStatus | OPEN |
EnergyAccountV2
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
}
}
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | EnergyAccountBaseV2 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | The array of plans containing service points and associated plan details |
| » plans | [object] | mandatory | The array of plans containing service points and associated plan details |
| »» nickname | string | optional | Optional display name for the plan provided by the customer to help differentiate multiple plans |
| »» servicePointIds | [string] | mandatory | An array of servicePointIds, representing NMIs, that this plan is linked to. If there are no service points allocated to this plan then an empty array would be expected |
| »» planOverview | object | conditional | Mandatory if openStatus is OPEN |
| »»» displayName | string | optional | The name of the plan if one exists |
| »»» startDate | DateString | mandatory | The start date of the applicability of this plan |
| »»» endDate | DateString | optional | The end date of the applicability of this plan |
EnergyAccountDetailV4
{
"accountId": "string",
"accountNumber": "string",
"displayName": "string",
"openStatus": "CLOSED",
"creationDate": "string",
"plans": [
{
"nickname": "string",
"servicePointIds": [
"string"
],
"planOverview": {
"displayName": "string",
"startDate": "string",
"endDate": "string"
},
"planDetail": {
"fuelType": "ELECTRICITY",
"isContingentPlan": false,
"meteringCharges": [
{
"displayName": "string",
"description": "string",
"minimumValue": "string",
"maximumValue": "string",
"period": "string"
}
],
"gasContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "string",
"timeOfUse": [
{}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{}
],
"period": "string",
"timeVariations": [
{}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{}
],
"period": "string",
"timeOfUse": [
{}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
},
"electricityContract": {
"additionalFeeInformation": "string",
"pricingModel": "SINGLE_RATE",
"timeZone": "LOCAL",
"isFixed": true,
"variation": "string",
"onExpiryDescription": "string",
"paymentOption": [
"PAPER_BILL"
],
"intrinsicGreenPower": {
"greenPercentage": "string"
},
"controlledLoad": [
{
"displayName": "string",
"rateBlockUType": "singleRate",
"startDate": "string",
"endDate": "string",
"singleRate": {
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"dailySupplyCharge": "string",
"rates": [
{}
],
"period": "string",
"timeOfUse": [
{}
],
"type": "PEAK"
}
]
}
],
"incentives": [
{
"displayName": "string",
"description": "string",
"category": "GIFT",
"eligibility": "string"
}
],
"discounts": [
{
"displayName": "string",
"description": "string",
"type": "CONDITIONAL",
"category": "PAY_ON_TIME",
"endDate": "string",
"methodUType": "percentOfBill",
"percentOfBill": {
"rate": "string"
},
"percentOfUse": {
"rate": "string"
},
"fixedAmount": {
"amount": "string"
},
"percentOverThreshold": {
"rate": "string",
"usageAmount": "string"
}
}
],
"greenPowerCharges": [
{
"displayName": "string",
"description": "string",
"scheme": "GREENPOWER",
"type": "FIXED_PER_DAY",
"tiers": [
{
"percentGreen": "string",
"rate": "string",
"amount": "string"
}
]
}
],
"eligibility": [
{
"type": "EXISTING_CUST",
"information": "string",
"description": "string"
}
],
"fees": [
{
"type": "EXIT",
"term": "FIXED",
"amount": "string",
"rate": "string",
"description": "string"
}
],
"solarFeedInTariff": [
{
"displayName": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"scheme": "PREMIUM",
"payerType": "GOVERNMENT",
"tariffUType": "singleTariff",
"singleTariff": {
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeVaryingTariffs": [
{
"type": "PEAK",
"displayName": "string",
"rates": [
{}
],
"period": "string",
"timeVariations": [
{}
]
}
]
}
],
"tariffPeriod": [
{
"type": "ENVIRONMENTAL",
"displayName": "string",
"startDate": "string",
"endDate": "string",
"dailySupplyChargeType": "SINGLE",
"dailySupplyCharge": "string",
"bandedDailySupplyCharges": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"timeZone": "LOCAL",
"rateBlockUType": "singleRate",
"singleRate": {
"displayName": "string",
"description": "string",
"generalUnitPrice": "string",
"rates": [
{
"unitPrice": "string",
"measureUnit": "KWH",
"volume": 0
}
],
"period": "string"
},
"timeOfUseRates": [
{
"displayName": "string",
"description": "string",
"rates": [
{}
],
"period": "string",
"timeOfUse": [
{}
],
"type": "PEAK"
}
],
"demandCharges": [
{
"displayName": "string",
"description": "string",
"amount": "string",
"measureUnit": "KWH",
"startTime": "string",
"endTime": "string",
"days": [
"SUN"
],
"minDemand": "string",
"maxDemand": "string",
"measurementPeriod": "DAY",
"chargePeriod": "DAY"
}
]
}
]
}
},
"authorisedContacts": [
{
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string"
}
]
}
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | EnergyAccountBaseV2 | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | The array of plans containing service points and associated plan details |
| » plans | [object] | mandatory | The array of plans containing service points and associated plan details |
| »» nickname | string | optional | Optional display name for the plan provided by the customer to help differentiate multiple plans |
| »» servicePointIds | [string] | mandatory | An array of servicePointIds, representing NMIs, that this account is linked to |
| »» planOverview | object | conditional | Mandatory if openStatus is OPEN |
| »»» displayName | string | optional | The name of the plan if one exists |
| »»» startDate | DateString | mandatory | The start date of the applicability of this plan |
| »»» endDate | DateString | optional | The end date of the applicability of this plan |
| »» planDetail | object | conditional | Detail on the plan applicable to this account. Mandatory if openStatus is OPEN |
| »»» fuelType | Enum | mandatory | The fuel types covered by the plan |
| »»» isContingentPlan | boolean | optional | Flag that indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up). Has no meaning if the plan has a fuelType of DUAL. If absent the value is assumed to be false |
| »»» meteringCharges | [object] | optional | Charges for metering included in the plan |
| »»»» displayName | string | mandatory | Display name of the charge |
| »»»» description | string | optional | Description of the charge |
| »»»» minimumValue | AmountString | mandatory | Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified |
| »»»» maximumValue | AmountString | optional | The upper limit of the charge if the charge could occur in a range |
| »»»» period | ExternalRef | optional | The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| »»» gasContract | EnergyPlanContractV3 | conditional | The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL |
| »»» electricityContract | EnergyPlanContractV3 | conditional | The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL |
| »» authorisedContacts | [object] | optional | An array of additional contacts that are authorised to act on this account |
| »»» firstName | string | optional | For people with single names this field need not be present. The single name should be in the lastName field |
| »»» lastName | string | mandatory | For people with single names the single name should be in this field |
| »»» middleNames | [string] | optional | Field is mandatory but array may be empty |
| »»» prefix | string | optional | Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc) |
| »»» suffix | string | optional | Used for a trailing suffix to the name (e.g. Jr) |
Enumerated Values
| Property | Value |
|---|---|
| fuelType | ELECTRICITY |
| fuelType | GAS |
| fuelType | DUAL |
EnergyPaymentSchedule
{
"amount": "string",
"paymentScheduleUType": "cardDebit",
"cardDebit": {
"cardScheme": "VISA",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"directDebit": {
"isTokenised": true,
"bsb": "string",
"accountNumber": "string",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"digitalWallet": {
"name": "string",
"identifier": "string",
"type": "EMAIL",
"provider": "PAYPAL_AU",
"paymentFrequency": "string",
"calculationType": "STATIC"
},
"manualPayment": {
"billFrequency": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | AmountString | optional | Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios) |
| paymentScheduleUType | Enum | mandatory | The type of object present in this response |
| cardDebit | object | conditional | Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit |
| » cardScheme | Enum | mandatory | The type of credit card held on file |
| » paymentFrequency | ExternalRef | mandatory | The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| » calculationType | Enum | mandatory | The mechanism by which the payment amount is calculated. Explanation of values are as follows:
|
| directDebit | object | conditional | Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit |
| » isTokenised | boolean | optional | Flag indicating that the account details are tokenised, or held in a closed system, and is not accessible through any other channels. False if absent |
| » bsb | string | conditional | The unmasked BSB for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false |
| » accountNumber | string | conditional | The unmasked account number for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false |
| » paymentFrequency | ExternalRef | mandatory | The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| » calculationType | Enum | mandatory | The mechanism by which the payment amount is calculated. Explanation of values are as follows:
|
| digitalWallet | object | conditional | Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet |
| » name | string | mandatory | The display name of the wallet as given by the customer, else a default value defined by the data holder |
| » identifier | string | mandatory | The identifier of the digital wallet (dependent on type) |
| » type | Enum | mandatory | The type of the digital wallet identifier |
| » provider | Enum | mandatory | The provider of the digital wallet |
| » paymentFrequency | ExternalRef | mandatory | The frequency that payments will occur. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| » calculationType | Enum | mandatory | The mechanism by which the payment amount is calculated. Explanation of values are as follows:
|
| manualPayment | object | conditional | Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment |
| » billFrequency | ExternalRef | mandatory | The frequency with which a bill will be issued. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
Enumerated Values
| Property | Value |
|---|---|
| paymentScheduleUType | cardDebit |
| paymentScheduleUType | directDebit |
| paymentScheduleUType | manualPayment |
| paymentScheduleUType | digitalWallet |
| cardScheme | VISA |
| cardScheme | MASTERCARD |
| cardScheme | AMEX |
| cardScheme | DINERS |
| cardScheme | OTHER |
| cardScheme | UNKNOWN |
| calculationType | STATIC |
| calculationType | BALANCE |
| calculationType | CALCULATED |
| calculationType | STATIC |
| calculationType | BALANCE |
| calculationType | CALCULATED |
| type | |
| type | CONTACT_NAME |
| type | TELEPHONE |
| provider | PAYPAL_AU |
| provider | OTHER |
| calculationType | STATIC |
| calculationType | BALANCE |
| calculationType | CALCULATED |
EnergyConcession
{
"type": "FIXED_AMOUNT",
"displayName": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"startDate": "string",
"endDate": "string",
"discountFrequency": "string",
"amount": "string",
"percentage": "string",
"appliedTo": [
"INVOICE"
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type | Enum | mandatory | Indicator of the method of concession calculation |
| displayName | string | mandatory | The display name of the concession |
| additionalInfo | string | conditional | Display text providing more information on the concession. Mandatory if type is VARIABLE |
| additionalInfoUri | URIString | optional | Optional link to additional information regarding the concession |
| startDate | DateString | optional | Optional start date for the application of the concession |
| endDate | DateString | optional | Optional end date for the application of the concession |
| discountFrequency | ExternalRef | conditional | Conditional attribute for frequency at which a concession is applied. Required if type is FIXED_AMOUNT or FIXED_PERCENTAGE. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| amount | AmountString | conditional | Conditional attribute for the amount of discount for the concession- required if type is FIXED_AMOUNT |
| percentage | RateString | conditional | Conditional attribute for the percentage of discount of concession - required if type is FIXED_PERCENTAGE |
| appliedTo | [Enum] | optional | Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed |
Enumerated Values
| Property | Value |
|---|---|
| type | FIXED_AMOUNT |
| type | FIXED_PERCENTAGE |
| type | VARIABLE |
| appliedTo | INVOICE |
| appliedTo | USAGE |
| appliedTo | SERVICE_CHARGE |
| appliedTo | CONTROLLED_LOAD |
EnergyInvoice
{
"accountId": "string",
"invoiceNumber": "string",
"issueDate": "string",
"dueDate": "string",
"period": {
"startDate": "string",
"endDate": "string"
},
"invoiceAmount": "string",
"gstAmount": "string",
"payOnTimeDiscount": {
"discountAmount": "string",
"gstAmount": "string",
"date": "string"
},
"balanceAtIssue": "string",
"servicePoints": [
"string"
],
"gas": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"electricity": {
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
},
"accountCharges": {
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "string"
},
"paymentStatus": "PAID"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | string | mandatory | The ID of the account for which the invoice was issued |
| invoiceNumber | string | mandatory | The number assigned to this invoice by the energy Retailer |
| issueDate | DateString | mandatory | The date that the invoice was actually issued (as opposed to generated or calculated) |
| dueDate | DateString | optional | The date that the invoice is due to be paid |
| period | object | conditional | Object containing the start and end date for the period covered by the invoice. Mandatory if any usage or demand based charges are included in the invoice |
| » startDate | DateString | mandatory | The start date of the period covered by this invoice |
| » endDate | DateString | mandatory | The end date of the period covered by this invoice |
| invoiceAmount | AmountString | optional | The net amount due for this invoice regardless of previous balance |
| gstAmount | AmountString | optional | The total GST amount for this invoice. If absent then zero is assumed |
| payOnTimeDiscount | object | optional | A discount for on time payment |
| » discountAmount | AmountString | mandatory | The amount that will be discounted if the invoice is paid by the date specified |
| » gstAmount | AmountString | optional | The GST amount that will be discounted if the invoice is paid by the date specified. If absent then zero is assumed |
| » date | DateString | mandatory | The date by which the invoice must be paid to receive the pay on time discount |
| balanceAtIssue | AmountString | mandatory | The account balance at the time the invoice was issued |
| servicePoints | [string] | mandatory | Array of service point IDs to which this invoice applies. May be empty if the invoice contains no electricity usage related charges |
| gas | EnergyInvoiceGasUsageCharges | optional | Object containing charges and credits related to gas usage |
| electricity | EnergyInvoiceElectricityUsageCharges | optional | Object containing charges and credits related to electricity usage |
| accountCharges | EnergyInvoiceAccountCharges | optional | Object contains account level charges and credits related to electricity usage |
| paymentStatus | Enum | mandatory | Indicator of the payment status for the invoice |
Enumerated Values
| Property | Value |
|---|---|
| paymentStatus | PAID |
| paymentStatus | PARTIALLY_PAID |
| paymentStatus | NOT_PAID |
EnergyInvoiceGasUsageCharges
{
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalUsageCharges | AmountString | mandatory | The aggregate total of usage charges for the period covered by the invoice (exclusive of GST) |
| totalGenerationCredits | AmountString | mandatory | The aggregate total of generation credits for the period covered by the invoice (exclusive of GST) |
| totalOnceOffCharges | AmountString | mandatory | The aggregate total of any once off charges arising from gas usage for the period covered by the invoice (exclusive of GST) |
| totalOnceOffDiscounts | AmountString | mandatory | The aggregate total of any once off discounts or credits arising from gas usage for the period covered by the invoice (exclusive of GST) |
| otherCharges | [object] | optional | Optional array of charges that may be part of the invoice (for e.g. environmental charges for C&I consumers) (exclusive of GST) |
| » type | Enum | optional | Type of charge. Assumed to be other if absent |
| » amount | AmountString | mandatory | The aggregate total of charges for this item (exclusive of GST) |
| » description | string | mandatory | A free text description of the type of charge |
| totalGst | AmountString | optional | The total GST for all gas usage charges. If absent then zero is assumed |
Enumerated Values
| Property | Value |
|---|---|
| type | ENVIRONMENTAL |
| type | REGULATED |
| type | NETWORK |
| type | METERING |
| type | RETAIL_SERVICE |
| type | RCTI |
| type | OTHER |
EnergyInvoiceElectricityUsageCharges
{
"totalUsageCharges": "string",
"totalGenerationCredits": "string",
"totalOnceOffCharges": "string",
"totalOnceOffDiscounts": "string",
"otherCharges": [
{
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string"
}
],
"totalGst": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalUsageCharges | AmountString | mandatory | The aggregate total of usage charges for the period covered by the invoice (exclusive of GST) |
| totalGenerationCredits | AmountString | mandatory | The aggregate total of generation credits for the period covered by the invoice (exclusive of GST) |
| totalOnceOffCharges | AmountString | mandatory | The aggregate total of any once off charges arising from electricity usage for the period covered by the invoice (exclusive of GST) |
| totalOnceOffDiscounts | AmountString | mandatory | The aggregate total of any once off discounts or credits arising from electricity usage for the period covered by the invoice (exclusive of GST) |
| otherCharges | [object] | optional | Optional array of charges that may be part of the invoice (for e.g. environmental charges for C&I consumers) (exclusive of GST) |
| » type | Enum | optional | Type of charge. Assumed to be other if absent |
| » amount | AmountString | mandatory | The aggregate total of charges for this item (exclusive of GST) |
| » description | string | mandatory | A free text description of the type of charge |
| totalGst | AmountString | optional | The total GST for all electricity usage charges. If absent then zero is assumed |
Enumerated Values
| Property | Value |
|---|---|
| type | ENVIRONMENTAL |
| type | REGULATED |
| type | NETWORK |
| type | METERING |
| type | RETAIL_SERVICE |
| type | RCTI |
| type | OTHER |
EnergyInvoiceAccountCharges
{
"totalCharges": "string",
"totalDiscounts": "string",
"totalGst": "string"
}
Object contains account level charges and credits related to electricity usage
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalCharges | AmountString | mandatory | The aggregate total of account level charges for the period covered by the invoice |
| totalDiscounts | AmountString | mandatory | The aggregate total of account level discounts or credits for the period covered by the invoice |
| totalGst | AmountString | optional | The total GST for all account level charges. If absent then zero is assumed |
EnergyBillingTransactionV3
{
"accountId": "string",
"executionDateTime": "string",
"gst": "string",
"transactionUType": "usage",
"usage": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"demand": {
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"onceOff": {
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
},
"otherCharges": {
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
},
"payment": {
"amount": "string",
"method": "DIRECT_DEBIT"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | string | mandatory | The ID of the account for which transaction applies |
| executionDateTime | DateTimeString | mandatory | The date and time that the transaction occurred |
| gst | AmountString | optional | The GST incurred in the transaction. Should not be included for credits or payments. If absent zero is assumed |
| transactionUType | Enum | mandatory | Indicator of the type of transaction object present in this record |
| usage | EnergyBillingUsageTransactionV2 | conditional | Represents a usage charge or generation credit. Mandatory if transactionUType is equal to usage |
| demand | EnergyBillingDemandTransactionV3 | optional | Represents a demand charge or generation credit. Mandatory if transactionUType is equal to demand |
| onceOff | EnergyBillingOnceOffTransaction | conditional | Represents a once off charge or credit. Mandatory if transactionUType is equal to onceOff |
| otherCharges | EnergyBillingOtherTransaction | optional | Represents charge other than usage and once off. Mandatory if transactionUType is equal to otherCharge |
| payment | EnergyBillingPaymentTransaction | conditional | Represents a payment to the account. Mandatory if transactionUType is equal to payment |
Enumerated Values
| Property | Value |
|---|---|
| transactionUType | usage |
| transactionUType | demand |
| transactionUType | onceOff |
| transactionUType | otherCharges |
| transactionUType | payment |
EnergyBillingUsageTransactionV2
{
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"usage": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | optional | The ID of the service point to which this transaction applies if any |
| invoiceNumber | string | optional | The number of the invoice in which this transaction is included if it has been issued |
| timeOfUseType | Enum | mandatory | The time of use type that the transaction applies to |
| description | string | optional | Optional description of the transaction that can be used for display purposes |
| isEstimate | boolean | optional | Flag indicating if the usage is estimated or actual. True indicates estimate. False or absent indicates actual |
| startDate | DateTimeString | mandatory | Date and time when the usage period starts |
| endDate | DateTimeString | mandatory | Date and time when the usage period ends |
| measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KWH if absent |
| usage | number | mandatory | The usage for the period in measure unit. A negative value indicates power generated |
| amount | AmountString | mandatory | The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit |
| calculationFactors | [object] | optional | Additional calculation factors that inform the transaction |
| » value | number | mandatory | The value of the calculation factor |
| » type | Enum | mandatory | The type of the calculation factor |
| adjustments | [object] | optional | Optional array of adjustments arising for this transaction |
| » amount | AmountString | mandatory | The amount of the adjustment |
| » description | string | mandatory | A free text description of the adjustment |
Enumerated Values
| Property | Value |
|---|---|
| timeOfUseType | PEAK |
| timeOfUseType | OFF_PEAK |
| timeOfUseType | OFF_PEAK_DEMAND_CHARGE |
| timeOfUseType | SHOULDER |
| timeOfUseType | SHOULDER1 |
| timeOfUseType | SHOULDER2 |
| timeOfUseType | CONTROLLED_LOAD |
| timeOfUseType | SOLAR |
| timeOfUseType | AGGREGATE |
| timeOfUseType | ALL_DAY |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| type | DLF |
| type | MLF |
EnergyBillingDemandTransactionV3
{
"servicePointId": "string",
"invoiceNumber": "string",
"timeOfUseType": "PEAK",
"description": "string",
"isEstimate": true,
"startDate": "string",
"endDate": "string",
"measureUnit": "KWH",
"rate": 0,
"amount": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | optional | The ID of the service point to which this transaction applies if any |
| invoiceNumber | string | optional | The number of the invoice in which this transaction is included if it has been issued |
| timeOfUseType | Enum | mandatory | The time of use type that the transaction applies to |
| description | string | optional | Optional description of the transaction that can be used for display purposes |
| isEstimate | boolean | optional | Flag indicating if the usage is estimated or actual. True indicates estimate. False or absent indicates actual |
| startDate | DateTimeString | mandatory | Date and time when the demand period starts |
| endDate | DateTimeString | mandatory | Date and time when the demand period ends |
| measureUnit | Enum | optional | The measurement unit of rate. Assumed to be KVA if absent |
| rate | number | mandatory | The rate for the demand charge in measureUnit. Assumed to be KVA if measureUnit not provided. A negative value indicates power generated |
| amount | AmountString | mandatory | The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit |
| calculationFactors | [object] | optional | Additional calculation factors that inform the transaction |
| » value | number | mandatory | The value of the calculation factor |
| » type | Enum | mandatory | The type of the calculation factor |
| adjustments | [object] | optional | Optional array of adjustments arising for this transaction |
| » amount | AmountString | mandatory | The amount of the adjustment |
| » description | string | mandatory | A free text description of the adjustment |
Enumerated Values
| Property | Value |
|---|---|
| timeOfUseType | PEAK |
| timeOfUseType | OFF_PEAK |
| timeOfUseType | OFF_PEAK_DEMAND_CHARGE |
| timeOfUseType | SHOULDER |
| timeOfUseType | SHOULDER1 |
| timeOfUseType | SHOULDER2 |
| timeOfUseType | CONTROLLED_LOAD |
| timeOfUseType | SOLAR |
| timeOfUseType | AGGREGATE |
| timeOfUseType | ALL_DAY |
| timeOfUseType | EXCESS |
| measureUnit | KWH |
| measureUnit | KVA |
| measureUnit | KVAR |
| measureUnit | KVARH |
| measureUnit | KW |
| measureUnit | DAYS |
| measureUnit | METER |
| measureUnit | MONTH |
| type | DLF |
| type | MLF |
EnergyBillingOnceOffTransaction
{
"servicePointId": "string",
"invoiceNumber": "string",
"amount": "string",
"description": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | optional | The ID of the service point to which this transaction applies if any |
| invoiceNumber | string | optional | The number of the invoice in which this transaction is included if it has been issued |
| amount | AmountString | mandatory | The amount of the charge or credit. A positive value indicates a charge and a negative value indicates a credit |
| description | string | mandatory | A free text description of the item |
EnergyBillingOtherTransaction
{
"servicePointId": "string",
"invoiceNumber": "string",
"startDate": "string",
"endDate": "string",
"type": "ENVIRONMENTAL",
"amount": "string",
"description": "string",
"calculationFactors": [
{
"value": 0,
"type": "DLF"
}
],
"adjustments": [
{
"amount": "string",
"description": "string"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | optional | The ID of the service point to which this transaction applies if any |
| invoiceNumber | string | optional | The number of the invoice in which this transaction is included if it has been issued |
| startDate | DateString | optional | Optional start date for the application of the charge |
| endDate | DateString | optional | Optional end date for the application of the charge |
| type | Enum | optional | Type of charge. Assumed to be other if absent |
| amount | AmountString | mandatory | The amount of the charge |
| description | string | mandatory | A free text description of the item |
| calculationFactors | [object] | optional | Additional calculation factors that inform the transaction |
| » value | number | mandatory | The value of the calculation factor |
| » type | Enum | mandatory | The type of the calculation factor |
| adjustments | [object] | optional | Optional array of adjustments arising for this transaction |
| » amount | AmountString | mandatory | The amount of the adjustment |
| » description | string | mandatory | A free text description of the adjustment |
Enumerated Values
| Property | Value |
|---|---|
| type | ENVIRONMENTAL |
| type | REGULATED |
| type | NETWORK |
| type | METERING |
| type | RETAIL_SERVICE |
| type | RCTI |
| type | OTHER |
| type | DLF |
| type | MLF |
EnergyBillingPaymentTransaction
{
"amount": "string",
"method": "DIRECT_DEBIT"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | AmountString | mandatory | The amount paid |
| method | Enum | mandatory | The method of payment |
Enumerated Values
| Property | Value |
|---|---|
| method | DIRECT_DEBIT |
| method | CARD |
| method | TRANSFER |
| method | BPAY |
| method | CASH |
| method | CHEQUE |
| method | OTHER |
CommonPhysicalAddress
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| addressUType | Enum | mandatory | The type of address object present |
| simple | CommonSimpleAddress | conditional | Required if addressUType is set to simple |
| paf | CommonPAFAddress | conditional | Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf |
Enumerated Values
| Property | Value |
|---|---|
| addressUType | paf |
| addressUType | simple |
CommonSimpleAddress
{
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
}
Required if addressUType is set to simple
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| mailingName | string | optional | Name of the individual or business formatted for inclusion in an address used for physical mail |
| addressLine1 | string | mandatory | First line of the standard address object |
| addressLine2 | string | optional | Second line of the standard address object |
| addressLine3 | string | optional | Third line of the standard address object |
| postcode | string | conditional | Mandatory for Australian addresses |
| city | string | mandatory | Name of the city or locality |
| state | string | mandatory | Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT |
| country | ExternalRef | optional | A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present. |
CommonPAFAddress
{
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dpid | string | optional | Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier |
| thoroughfareNumber1 | PositiveInteger | optional | Thoroughfare number for a property (first number in a property ranged address) |
| thoroughfareNumber1Suffix | string | optional | Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated |
| thoroughfareNumber2 | PositiveInteger | optional | Second thoroughfare number (only used if the property has a ranged address eg 23-25) |
| thoroughfareNumber2Suffix | string | optional | Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated |
| flatUnitType | string | optional | Type of flat or unit for the address |
| flatUnitNumber | string | optional | Unit number (including suffix, if applicable) |
| floorLevelType | string | optional | Type of floor or level for the address |
| floorLevelNumber | string | optional | Floor or level number (including alpha characters) |
| lotNumber | string | optional | Allotment number for the address |
| buildingName1 | string | optional | Building/Property name 1 |
| buildingName2 | string | optional | Building/Property name 2 |
| streetName | string | optional | The name of the street |
| streetType | string | optional | The street type. Valid enumeration defined by Australia Post PAF code file |
| streetSuffix | string | optional | The street type suffix. Valid enumeration defined by Australia Post PAF code file |
| postalDeliveryType | string | optional | Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file |
| postalDeliveryNumber | PositiveInteger | optional | Postal delivery number if the address is a postal delivery type |
| postalDeliveryNumberPrefix | string | optional | Postal delivery number prefix related to the postal delivery number |
| postalDeliveryNumberSuffix | string | optional | Postal delivery number suffix related to the postal delivery number |
| localityName | string | mandatory | Full name of locality |
| postcode | string | mandatory | Postcode for the locality |
| state | string | mandatory | State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT |
RequestServicePointIdList
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » servicePointIds | [string] | mandatory | Array of specific servicePointIds to obtain data for |
| meta | Meta | optional | none |
RequestAccountIdList
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » accountIds | [string] | mandatory | Array of specific accountIds to obtain data for |
| meta | Meta | optional | none |
Links
{
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document |
Meta
{}
Properties
None
LinksPaginated
{
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document |
| first | URIString | conditional | URI to the first page of this set. Mandatory if this response is not the first page |
| prev | URIString | conditional | URI to the previous page of this set. Mandatory if this response is not the first page |
| next | URIString | conditional | URI to the next page of this set. Mandatory if this response is not the last page |
| last | URIString | conditional | URI to the last page of this set. Mandatory if this response is not the last page |
MetaPaginated
{
"totalRecords": 0,
"totalPages": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalRecords | NaturalNumber | mandatory | The total number of records in the full set. See pagination. |
| totalPages | NaturalNumber | mandatory | The total number of pages in the full set. See pagination. |
Common APIs
This specification defines the Common APIs that apply to Data Holders in all sectors.
Updated the description of the Common APIs section
- This specification defines the Common APIs that apply to Data Holders multiple sectors.
+ This specification defines the Common APIs that apply to Data Holders in all sectors.
| Common OpenAPI Specification (JSON) |
| Common OpenAPI Specification (YAML) |
Get Customer
Code samples
GET https://data.holder.com.au/cds-au/v1/common/customer HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/common/customer', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /common/customer
Obtain basic information on the customer that has authorised the current session
Conventions
In the customer payloads relevant conventions are explained here, in one place.
Given Names
firstName represents the first of a person's given names.
middleNames represents a collection of given names if the person has more than one given name.
Where a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the firstName field to return the single string of given names and an empty middleNames array.
For example, a person whose given names are "John Paul Winston" but the data holder cannot determine what is the first name, can return "firstName": "John Paul Winston".
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"customerUType": "organisation",
"person": {
"lastUpdateTime": "string",
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string",
"occupationCode": "string",
"occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0"
},
"organisation": {
"lastUpdateTime": "string",
"agentFirstName": "string",
"agentLastName": "string",
"agentRole": "string",
"businessName": "string",
"legalName": "string",
"shortName": "string",
"abn": "string",
"acn": "string",
"isACNCRegistered": true,
"industryCode": "string",
"industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
"organisationType": "COMPANY",
"registeredCountry": "string",
"establishmentDate": "string"
}
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseCommonCustomer |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Customer Detail
Code samples
GET https://data.holder.com.au/cds-au/v1/common/customer/detail HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/common/customer/detail', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /common/customer/detail
Obtain detailed information on the authorised customer within the current session.
Obsolete versions: v1
Endpoint Version
| Version | 2 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | optional | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date | header | string | conditional | The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address | header | string | optional | The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers | header | Base64 | conditional | The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"customerUType": "organisation",
"person": {
"lastUpdateTime": "string",
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string",
"occupationCode": "string",
"occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0",
"phoneNumbers": [
{
"isPreferred": true,
"purpose": "HOME",
"countryCode": "string",
"areaCode": "string",
"number": "string",
"extension": "string",
"fullNumber": "string"
}
],
"emailAddresses": [
{
"isPreferred": true,
"purpose": "HOME",
"address": "string"
}
],
"physicalAddresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
]
},
"organisation": {
"lastUpdateTime": "string",
"agentFirstName": "string",
"agentLastName": "string",
"agentRole": "string",
"businessName": "string",
"legalName": "string",
"shortName": "string",
"abn": "string",
"acn": "string",
"isACNCRegistered": true,
"industryCode": "string",
"industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
"organisationType": "COMPANY",
"registeredCountry": "string",
"establishmentDate": "string",
"physicalAddresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
]
}
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseCommonCustomerDetailV2 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Status
Code samples
GET https://data.holder.com.au/cds-au/v1/discovery/status HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/discovery/status', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /discovery/status
Obtain a health check status for the implementation
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Example responses
200 Response
{
"data": {
"status": "OK",
"explanation": "string",
"detectionTime": "string",
"expectedResolutionTime": "string",
"updateTime": "string"
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseCommonDiscoveryStatus |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Get Outages
Code samples
GET https://data.holder.com.au/cds-au/v1/discovery/outages HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/discovery/outages', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /discovery/outages
Obtain a list of scheduled outages for the implementation
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Example responses
200 Response
{
"data": {
"outages": [
{
"outageTime": "string",
"duration": "string",
"isPartial": true,
"explanation": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseDiscoveryOutagesList |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Schemas
ResponseCommonDiscoveryStatus
{
"data": {
"status": "OK",
"explanation": "string",
"detectionTime": "string",
"expectedResolutionTime": "string",
"updateTime": "string"
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » status | Enum | mandatory | Enumeration with values. OK (implementation is fully functional). PARTIAL_FAILURE (one or more endpoints are unexpectedly unavailable). UNAVAILABLE (the full implementation is unexpectedly unavailable). SCHEDULED_OUTAGE (an advertised outage is in effect) |
| » explanation | string | conditional | Provides an explanation of the current outage that can be displayed to an end customer. Mandatory if the status property is any value other than OK |
| » detectionTime | DateTimeString | optional | The date and time that the current outage was detected. Should only be present if the status property is PARTIAL_FAILURE or UNAVAILABLE |
| » expectedResolutionTime | DateTimeString | optional | The date and time that full service is expected to resume (if known). Should not be present if the status property has a value of OK. |
| » updateTime | DateTimeString | mandatory | The date and time that this status was last updated by the Data Holder. |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
Enumerated Values
| Property | Value |
|---|---|
| status | OK |
| status | PARTIAL_FAILURE |
| status | SCHEDULED_OUTAGE |
| status | UNAVAILABLE |
ResponseDiscoveryOutagesList
{
"data": {
"outages": [
{
"outageTime": "string",
"duration": "string",
"isPartial": true,
"explanation": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » outages | [DiscoveryOutage] | mandatory | List of scheduled outages. Property is mandatory but may contain and empty list if no outages are scheduled |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
DiscoveryOutage
{
"outageTime": "string",
"duration": "string",
"isPartial": true,
"explanation": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| outageTime | DateTimeString | mandatory | Date and time that the outage is scheduled to begin |
| duration | ExternalRef | mandatory | Planned duration of the outage. Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
| isPartial | Boolean | optional | Flag that indicates, if present and set to true, that the outage is only partial meaning that only a subset of normally available endpoints will be affected by the outage |
| explanation | string | mandatory | Provides an explanation of the current outage that can be displayed to an end customer |
ResponseCommonCustomer
{
"data": {
"customerUType": "organisation",
"person": {
"lastUpdateTime": "string",
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string",
"occupationCode": "string",
"occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0"
},
"organisation": {
"lastUpdateTime": "string",
"agentFirstName": "string",
"agentLastName": "string",
"agentRole": "string",
"businessName": "string",
"legalName": "string",
"shortName": "string",
"abn": "string",
"acn": "string",
"isACNCRegistered": true,
"industryCode": "string",
"industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
"organisationType": "COMPANY",
"registeredCountry": "string",
"establishmentDate": "string"
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » customerUType | Enum | mandatory | The type of customer object that is present |
| » person | CommonPerson | conditional | none |
| » organisation | CommonOrganisation | conditional | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
Enumerated Values
| Property | Value |
|---|---|
| customerUType | organisation |
| customerUType | person |
ResponseCommonCustomerDetailV2
{
"data": {
"customerUType": "organisation",
"person": {
"lastUpdateTime": "string",
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string",
"occupationCode": "string",
"occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0",
"phoneNumbers": [
{
"isPreferred": true,
"purpose": "HOME",
"countryCode": "string",
"areaCode": "string",
"number": "string",
"extension": "string",
"fullNumber": "string"
}
],
"emailAddresses": [
{
"isPreferred": true,
"purpose": "HOME",
"address": "string"
}
],
"physicalAddresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
]
},
"organisation": {
"lastUpdateTime": "string",
"agentFirstName": "string",
"agentLastName": "string",
"agentRole": "string",
"businessName": "string",
"legalName": "string",
"shortName": "string",
"abn": "string",
"acn": "string",
"isACNCRegistered": true,
"industryCode": "string",
"industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
"organisationType": "COMPANY",
"registeredCountry": "string",
"establishmentDate": "string",
"physicalAddresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
]
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » customerUType | Enum | mandatory | The type of customer object that is present |
| » person | CommonPersonDetailV2 | conditional | none |
| » organisation | CommonOrganisationDetailV2 | conditional | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
Enumerated Values
| Property | Value |
|---|---|
| customerUType | organisation |
| customerUType | person |
CommonPerson
{
"lastUpdateTime": "string",
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string",
"occupationCode": "string",
"occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| lastUpdateTime | DateTimeString | optional | The date and time that this record was last updated by the customer. If no update has occurred then this date should reflect the initial creation date for the data |
| firstName | string | optional | For people with single names this field need not be present. The single name should be in the lastName field. Where a data holder cannot determine first and middle names from a collection of given names, a single string representing all given names MAY be provided. |
| lastName | string | mandatory | For people with single names the single name should be in this field |
| middleNames | [string] | mandatory | Field is mandatory but array may be empty |
| prefix | string | optional | Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc) |
| suffix | string | optional | Used for a trailing suffix to the name (e.g. Jr) |
| occupationCode | ExternalRef | optional | Value is a valid [ANZSCO] Standard Occupation classification code. If the occupation code held by the data holder is not one of the supported [ANZSCO] versions, then it must not be supplied. |
| occupationCodeVersion | Enum | conditional | The applicable [ANZSCO] release version of the occupation code provided. Mandatory if an occupationCode is supplied. If occupationCode is supplied but occupationCodeVersion is absent, default is ANZSCO_1220.0_2013_V1.2 |
Enumerated Values
| Property | Value |
|---|---|
| occupationCodeVersion | ANZSCO_1220.0_2006_V1.0 |
| occupationCodeVersion | ANZSCO_1220.0_2006_V1.1 |
| occupationCodeVersion | ANZSCO_1220.0_2013_V1.2 |
| occupationCodeVersion | ANZSCO_1220.0_2013_V1.3 |
CommonPersonDetailV2
{
"lastUpdateTime": "string",
"firstName": "string",
"lastName": "string",
"middleNames": [
"string"
],
"prefix": "string",
"suffix": "string",
"occupationCode": "string",
"occupationCodeVersion": "ANZSCO_1220.0_2006_V1.0",
"phoneNumbers": [
{
"isPreferred": true,
"purpose": "HOME",
"countryCode": "string",
"areaCode": "string",
"number": "string",
"extension": "string",
"fullNumber": "string"
}
],
"emailAddresses": [
{
"isPreferred": true,
"purpose": "HOME",
"address": "string"
}
],
"physicalAddresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | CommonPerson | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » phoneNumbers | [CommonPhoneNumber] | mandatory | Array is mandatory but may be empty if no phone numbers are held |
| » emailAddresses | [CommonEmailAddress] | mandatory | May be empty |
| » physicalAddresses | [CommonPhysicalAddressWithPurpose] | mandatory | Array is mandatory but may be empty if no valid addresses are held. One and only one address may have the purpose of REGISTERED. Zero or one, and no more than one, record may have the purpose of MAIL. If zero then the REGISTERED address is to be used for mail |
CommonOrganisation
{
"lastUpdateTime": "string",
"agentFirstName": "string",
"agentLastName": "string",
"agentRole": "string",
"businessName": "string",
"legalName": "string",
"shortName": "string",
"abn": "string",
"acn": "string",
"isACNCRegistered": true,
"industryCode": "string",
"industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
"organisationType": "COMPANY",
"registeredCountry": "string",
"establishmentDate": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| lastUpdateTime | DateTimeString | optional | The date and time that this record was last updated by the customer. If no update has occurred then this date should reflect the initial creation date for the data |
| agentFirstName | string | optional | The first name of the individual providing access on behalf of the organisation. For people with single names this field need not be present. The single name should be in the lastName field |
| agentLastName | string | mandatory | The last name of the individual providing access on behalf of the organisation. For people with single names the single name should be in this field |
| agentRole | string | mandatory | The role of the individual identified as the agent who is providing authorisation. Expected to be used for display. Default to Unspecified if the role is not known |
| businessName | string | mandatory | Name of the organisation |
| legalName | string | optional | Legal name, if different to the business name |
| shortName | string | optional | Short name used for communication, if different to the business name |
| abn | string | optional | Australian Business Number for the organisation |
| acn | string | optional | Australian Company Number for the organisation. Required only if an ACN is applicable for the organisation type |
| isACNCRegistered | Boolean | optional | True if registered with the ACNC. False if not. Absent or null if not confirmed. |
| industryCode | ExternalRef | optional | A valid ANZSIC code for the organisation. If the industry code held by the data holder is not one of the supported ANZSIC versions, then it must not be supplied. |
| industryCodeVersion | Enum | conditional | The applicable ANZSIC release version of the industry code provided. Should only be supplied if industryCode is also supplied. If industryCode is supplied but industryCodeVersion is absent, default is ANZSIC_1292.0_2006_V2.0 |
| organisationType | Enum | mandatory | Legal organisation type |
| registeredCountry | ExternalRef | optional | Enumeration with values from ISO 3166 Alpha-3 country codes. Assumed to be AUS if absent |
| establishmentDate | DateString | optional | The date the organisation described was established |
Enumerated Values
| Property | Value |
|---|---|
| industryCodeVersion | ANZSIC_1292.0_2006_V1.0 |
| industryCodeVersion | ANZSIC_1292.0_2006_V2.0 |
| organisationType | COMPANY |
| organisationType | GOVERNMENT_ENTITY |
| organisationType | OTHER |
| organisationType | PARTNERSHIP |
| organisationType | SOLE_TRADER |
| organisationType | TRUST |
CommonOrganisationDetailV2
{
"lastUpdateTime": "string",
"agentFirstName": "string",
"agentLastName": "string",
"agentRole": "string",
"businessName": "string",
"legalName": "string",
"shortName": "string",
"abn": "string",
"acn": "string",
"isACNCRegistered": true,
"industryCode": "string",
"industryCodeVersion": "ANZSIC_1292.0_2006_V1.0",
"organisationType": "COMPANY",
"registeredCountry": "string",
"establishmentDate": "string",
"physicalAddresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
]
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | CommonOrganisation | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » physicalAddresses | [CommonPhysicalAddressWithPurpose] | mandatory | Array is mandatory but may be empty if no valid addresses are held. One and only one address may have the purpose of REGISTERED. Zero or one, and no more than one, record may have the purpose of MAIL. If zero then the REGISTERED address is to be used for mail |
CommonPhoneNumber
{
"isPreferred": true,
"purpose": "HOME",
"countryCode": "string",
"areaCode": "string",
"number": "string",
"extension": "string",
"fullNumber": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| isPreferred | Boolean | optional | May be true for one and only one entry to indicate the preferred phone number. Assumed to be 'false' if not present |
| purpose | Enum | mandatory | The purpose of the number as specified by the customer |
| countryCode | string | optional | If absent, assumed to be Australia (+61). The + should be included |
| areaCode | string | conditional | Required for non Mobile Phones, if field is present and refers to Australian code - the leading 0 should be omitted. |
| number | string | mandatory | The actual phone number, with leading zeros as appropriate |
| extension | string | optional | An extension number (if applicable) |
| fullNumber | ExternalRef | mandatory | Fully formatted phone number with country code, area code, number and extension incorporated. Formatted according to section 5.1.4. of [RFC3966] |
Enumerated Values
| Property | Value |
|---|---|
| purpose | HOME |
| purpose | INTERNATIONAL |
| purpose | MOBILE |
| purpose | OTHER |
| purpose | UNSPECIFIED |
| purpose | WORK |
CommonEmailAddress
{
"isPreferred": true,
"purpose": "HOME",
"address": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| isPreferred | Boolean | optional | May be true for one and only one email record in the collection. Denotes the default email address |
| purpose | Enum | mandatory | The purpose for the email, as specified by the customer (Enumeration) |
| address | ExternalRef | mandatory | A correctly formatted email address, as defined by the addr-spec format in [RFC5322] |
Enumerated Values
| Property | Value |
|---|---|
| purpose | HOME |
| purpose | OTHER |
| purpose | UNSPECIFIED |
| purpose | WORK |
CommonPhysicalAddressWithPurpose
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
},
"purpose": "MAIL"
}
Properties
allOf
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | CommonPhysicalAddress | mandatory | none |
and
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | object | mandatory | none |
| » purpose | Enum | mandatory | Enumeration of values indicating the purpose of the physical address |
Enumerated Values
| Property | Value |
|---|---|
| purpose | |
| purpose | OTHER |
| purpose | PHYSICAL |
| purpose | REGISTERED |
| purpose | WORK |
CommonPhysicalAddress
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| addressUType | Enum | mandatory | The type of address object present |
| simple | CommonSimpleAddress | conditional | none |
| paf | CommonPAFAddress | conditional | Australian address formatted according to the file format defined by the PAF file format |
Enumerated Values
| Property | Value |
|---|---|
| addressUType | paf |
| addressUType | simple |
CommonSimpleAddress
{
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| mailingName | string | optional | Name of the individual or business formatted for inclusion in an address used for physical mail |
| addressLine1 | string | mandatory | First line of the standard address object |
| addressLine2 | string | optional | Second line of the standard address object |
| addressLine3 | string | optional | Third line of the standard address object |
| postcode | string | conditional | Mandatory for Australian addresses |
| city | string | mandatory | Name of the city or locality |
| state | string | mandatory | Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT |
| country | ExternalRef | optional | A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present. |
CommonPAFAddress
{
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
Australian address formatted according to the file format defined by the PAF file format
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dpid | string | optional | Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier |
| thoroughfareNumber1 | PositiveInteger | optional | Thoroughfare number for a property (first number in a property ranged address) |
| thoroughfareNumber1Suffix | string | optional | Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated |
| thoroughfareNumber2 | PositiveInteger | optional | Second thoroughfare number (only used if the property has a ranged address eg 23-25) |
| thoroughfareNumber2Suffix | string | optional | Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated |
| flatUnitType | string | optional | Type of flat or unit for the address |
| flatUnitNumber | string | optional | Unit number (including suffix, if applicable) |
| floorLevelType | string | optional | Type of floor or level for the address |
| floorLevelNumber | string | optional | Floor or level number (including alpha characters) |
| lotNumber | string | optional | Allotment number for the address |
| buildingName1 | string | optional | Building/Property name 1 |
| buildingName2 | string | optional | Building/Property name 2 |
| streetName | string | optional | The name of the street |
| streetType | string | optional | The street type. Valid enumeration defined by Australia Post PAF code file |
| streetSuffix | string | optional | The street type suffix. Valid enumeration defined by Australia Post PAF code file |
| postalDeliveryType | string | optional | Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file |
| postalDeliveryNumber | PositiveInteger | optional | Postal delivery number if the address is a postal delivery type |
| postalDeliveryNumberPrefix | string | optional | Postal delivery number prefix related to the postal delivery number |
| postalDeliveryNumberSuffix | string | optional | Postal delivery number suffix related to the postal delivery number |
| localityName | string | mandatory | Full name of locality |
| postcode | string | mandatory | Postcode for the locality |
| state | string | mandatory | State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT |
Links
{
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document |
Meta
{}
Properties
None
MetaError
{
"urn": "string"
}
Additional data for customised error codes
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| urn | string | conditional | The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [object] | mandatory | none |
| » code | string | mandatory | The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| » title | string | mandatory | A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| » detail | string | mandatory | A human-readable explanation specific to this occurrence of the problem. |
| » meta | MetaError | optional | Additional data for customised error codes |
Admin APIs
This specification defines the Admin APIs that apply to Data Holders.
Updated the description of the Admin APIs section
- This provides an overview of CDS Administration Endpoints. Please note this API is intended for Data Holders/ Recipients only.
+ This specification defines the Admin APIs that apply to Data Holders.
| Admin OpenAPI Specification (JSON) |
| Admin OpenAPI Specification (YAML) |
Metadata Update
Code samples
POST https://data.holder.com.au/cds-au/v1/admin/register/metadata HTTP/1.1
Host: data.holder.com.au
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"action": "REFRESH"
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/admin/register/metadata', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /admin/register/metadata
Indicate that a critical update to the metadata for Accredited Data Recipients has been made and should be obtained
Body parameter
{
"data": {
"action": "REFRESH"
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. |
| body | body | RequestMetaDataUpdate | mandatory | none |
Example responses
200 Response
null
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Schema
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Get Metrics
Code samples
GET https://data.holder.com.au/cds-au/v1/admin/metrics HTTP/1.1
Host: data.holder.com.au
Accept: application/json
x-v: string
x-min-v: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string'
};
fetch('https://data.holder.com.au/cds-au/v1/admin/metrics', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /admin/metrics
This endpoint allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this endpoint are determined by the non-functional requirements for the CDR regime.
This endpoint is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
NOTE: This version MUST be implemented by May 13th 2024
Deprecated versions:
- v3 - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders MAY retire this version from the earlier of 13th May 2024 or from the time the ACCC announce that they no longer call this version
- v4 - This version, or v5, MUST be implemented by November 1st 2023
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
Endpoint Version
| Version | 5 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| period | query | Enum | optional | The period of metrics to be requested. Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL. If absent the default is ALL. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. |
Enumerated Values
| Parameter | Value |
|---|---|
| period | CURRENT |
| period | HISTORIC |
| period | ALL |
Example responses
200 Response
{
"data": {
"requestTime": "string",
"availability": {
"aggregate": {
"currentMonth": "string",
"previousMonths": [
"string"
]
},
"unauthenticated": {
"currentMonth": "string",
"previousMonths": [
"string"
]
},
"authenticated": {
"currentMonth": "string",
"previousMonths": [
"string"
]
}
},
"performance": {
"aggregate": {
"currentDay": "string",
"previousDays": [
"string"
]
},
"highPriority": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"largePayload": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"lowPriority": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"unattended": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"unauthenticated": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"primary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
}
},
"largeSecondary": {
"primary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
}
}
},
"invocations": {
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"highPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"lowPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"unattended": {
"currentDay": 0,
"previousDays": [
0
]
},
"largePayload": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
},
"largeSecondary": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"averageResponse": {
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"highPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"lowPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"unattended": {
"currentDay": 0,
"previousDays": [
0
]
},
"largePayload": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"primary": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"largeSecondary": {
"primary": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
}
}
},
"sessionCount": {
"currentDay": 0,
"previousDays": [
0
]
},
"averageTps": {
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"peakTps": {
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"errors": {
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": {
"500": 0,
"property1": 0,
"property2": 0
},
"previousDays": [
{
"500": 0,
"property1": 0,
"property2": 0
}
]
},
"authenticated": {
"currentDay": {
"500": 0,
"property1": 0,
"property2": 0
},
"previousDays": [
{
"500": 0,
"property1": 0,
"property2": 0
}
]
}
},
"rejections": {
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"customerCount": 0,
"recipientCount": 0,
"secondaryHolder": {
"errors": {
"currentDay": 0,
"previousDays": [
0
]
},
"rejections": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"authorisations": {
"activeAuthorisationCount": {
"individual": 0,
"nonIndividual": 0
},
"newAuthorisationCount": {
"currentDay": {
"onceOff": {
"individual": 0,
"nonIndividual": 0
},
"ongoing": {
"individual": 0,
"nonIndividual": 0
}
},
"previousDays": [
{
"onceOff": {
"individual": 0,
"nonIndividual": 0
},
"ongoing": {
"individual": 0,
"nonIndividual": 0
}
}
]
},
"revokedAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"amendedAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"expiredAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"abandonedConsentFlowCount": {
"currentDay": 0,
"previousDays": [
0
]
},
"abandonmentsByStage": {
"preIdentification": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAuthentication": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAccountSelection": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAuthorisation": {
"currentDay": 0,
"previousDays": [
0
]
},
"rejected": {
"currentDay": 0,
"previousDays": [
0
]
},
"failedTokenExchange": {
"currentDay": 0,
"previousDays": [
0
]
}
}
}
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ResponseMetricsListV5 |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
Schemas
RequestMetaDataUpdate
{
"data": {
"action": "REFRESH"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » action | Enum | mandatory | The action to take for the meta data. At the moment the only option is REFRESH which requires the data holder to call the ACCC to refresh meta data as soon as practicable |
| meta | Meta | optional | none |
Enumerated Values
| Property | Value |
|---|---|
| action | REFRESH |
ResponseMetricsListV5
{
"data": {
"requestTime": "string",
"availability": {
"aggregate": {
"currentMonth": "string",
"previousMonths": [
"string"
]
},
"unauthenticated": {
"currentMonth": "string",
"previousMonths": [
"string"
]
},
"authenticated": {
"currentMonth": "string",
"previousMonths": [
"string"
]
}
},
"performance": {
"aggregate": {
"currentDay": "string",
"previousDays": [
"string"
]
},
"highPriority": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"largePayload": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"lowPriority": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"unattended": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"unauthenticated": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"primary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
}
},
"largeSecondary": {
"primary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
}
}
},
"invocations": {
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"highPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"lowPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"unattended": {
"currentDay": 0,
"previousDays": [
0
]
},
"largePayload": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
},
"largeSecondary": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"averageResponse": {
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"highPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"lowPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"unattended": {
"currentDay": 0,
"previousDays": [
0
]
},
"largePayload": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"primary": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"largeSecondary": {
"primary": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
}
}
},
"sessionCount": {
"currentDay": 0,
"previousDays": [
0
]
},
"averageTps": {
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"peakTps": {
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"errors": {
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": {
"500": 0,
"property1": 0,
"property2": 0
},
"previousDays": [
{
"500": 0,
"property1": 0,
"property2": 0
}
]
},
"authenticated": {
"currentDay": {
"500": 0,
"property1": 0,
"property2": 0
},
"previousDays": [
{
"500": 0,
"property1": 0,
"property2": 0
}
]
}
},
"rejections": {
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"customerCount": 0,
"recipientCount": 0,
"secondaryHolder": {
"errors": {
"currentDay": 0,
"previousDays": [
0
]
},
"rejections": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"authorisations": {
"activeAuthorisationCount": {
"individual": 0,
"nonIndividual": 0
},
"newAuthorisationCount": {
"currentDay": {
"onceOff": {
"individual": 0,
"nonIndividual": 0
},
"ongoing": {
"individual": 0,
"nonIndividual": 0
}
},
"previousDays": [
{
"onceOff": {
"individual": 0,
"nonIndividual": 0
},
"ongoing": {
"individual": 0,
"nonIndividual": 0
}
}
]
},
"revokedAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"amendedAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"expiredAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"abandonedConsentFlowCount": {
"currentDay": 0,
"previousDays": [
0
]
},
"abandonmentsByStage": {
"preIdentification": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAuthentication": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAccountSelection": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAuthorisation": {
"currentDay": 0,
"previousDays": [
0
]
},
"rejected": {
"currentDay": 0,
"previousDays": [
0
]
},
"failedTokenExchange": {
"currentDay": 0,
"previousDays": [
0
]
}
}
}
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » requestTime | DateTimeString | mandatory | The date and time that the metrics in this payload were requested. |
| » availability | AvailabilityMetricsV2 | mandatory | Availability metrics |
| » performance | PerformanceMetricsV3 | mandatory | Percentage of calls within the performance thresholds in each performance tier over time |
| » invocations | InvocationMetricsV3 | mandatory | Number of API calls in each performance tier over time |
| » averageResponse | AverageResponseMetricsV2 | mandatory | Average response time in seconds, at millisecond resolution, within each performance tier |
| » sessionCount | SessionCountMetricsV2 | mandatory | Session counts over time. Note that a session is defined as the provisioning of an Access Token. |
| » averageTps | AverageTPSMetricsV2 | mandatory | Average transactions per second over time |
| » peakTps | PeakTPSMetricsV2 | mandatory | Peak transactions per second over time |
| » errors | ErrorMetricsV2 | mandatory | Number of calls resulting in error, over time |
| » rejections | RejectionMetricsV3 | mandatory | Number of calls rejected due to traffic thresholds over time |
| » customerCount | NaturalNumber | mandatory | Number of customers with active authorisations at the time of the call |
| » recipientCount | NaturalNumber | mandatory | Number of Data Recipient Software Products with active authorisations at the time of the call |
| » secondaryHolder | SecondaryHolderMetricsV2 | conditional | Errors and rejections received by the primary data holder from the secondary data holder. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » authorisations | AuthorisationMetricsV2 | mandatory | Authorisation counts for the data holder |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
AvailabilityMetricsV2
{
"aggregate": {
"currentMonth": "string",
"previousMonths": [
"string"
]
},
"unauthenticated": {
"currentMonth": "string",
"previousMonths": [
"string"
]
},
"authenticated": {
"currentMonth": "string",
"previousMonths": [
"string"
]
}
}
Availability metrics
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| aggregate | object | mandatory | Aggregated availability metrics |
| » currentMonth | RateString | conditional | Percentage availability of the CDR platform so far for the current calendar month. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero |
| » previousMonths | [RateString] | conditional | Percentage availability of the CDR platform for previous calendar months. The first element indicates the last month and so on. A maximum of twelve entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| unauthenticated | object | mandatory | Availability metrics for the unauthenticated aspects of the CDR regime |
| » currentMonth | RateString | conditional | Percentage availability of the CDR platform so far for the current calendar month. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero |
| » previousMonths | [RateString] | conditional | Percentage availability of the CDR platform for previous calendar months. The first element indicates the last month and so on. A maximum of twelve entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| authenticated | object | mandatory | Availability metrics for the authenticated aspects of the CDR regime |
| » currentMonth | RateString | conditional | Percentage availability of the CDR platform so far for the current calendar month. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero |
| » previousMonths | [RateString] | conditional | Percentage availability of the CDR platform for previous calendar months. The first element indicates the last month and so on. A maximum of twelve entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
PerformanceMetricsV3
{
"aggregate": {
"currentDay": "string",
"previousDays": [
"string"
]
},
"highPriority": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"largePayload": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"lowPriority": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"unattended": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"unauthenticated": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"primary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
}
},
"largeSecondary": {
"primary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
},
"secondary": {
"currentDay": [
"string"
],
"previousDays": [
[
"string"
]
]
}
}
}
Percentage of calls within the performance thresholds in each performance tier over time
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| aggregate | object | optional | Percentage of calls within Primary Data Holder performance thresholds. Note that Secondary Data Holder performance MUST be excluded from this metric. |
| » currentDay | RateString | conditional | Percentage of calls within the performance threshold for the current day. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero |
| » previousDays | [RateString] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| highPriority | object | mandatory | Percentage of high priority calls within the performance thresholds |
| » currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| » previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| largePayload | object | mandatory | Percentage of large payload calls within the performance thresholds |
| » currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| » previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| lowPriority | object | mandatory | Percentage of low priority calls within the performance thresholds |
| » currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| » previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| unattended | object | mandatory | Percentage of unattended calls within the performance thresholds |
| » currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| » previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| unauthenticated | object | mandatory | Percentage of unauthenticated calls within the performance thresholds |
| » currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| » previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| secondary | object | conditional | Percentage of Shared Responsibility calls within the performance thresholds. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » primary | object | mandatory | Percentage of Shared Responsibility calls within the performance thresholds for the primary data holder |
| »» currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| »» previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| » secondary | object | mandatory | Percentage of Shared Responsibility calls within the performance thresholds for the secondary data holder |
| »» currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| »» previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| largeSecondary | object | conditional | Percentage of large Shared Responsibility calls within the performance thresholds. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » primary | object | mandatory | Percentage of large Shared Responsibility calls within the performance thresholds for the secondary data holder |
| »» currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| »» previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
| » secondary | object | mandatory | Percentage of large Shared Responsibility calls within the performance thresholds for the secondary data holder |
| »» currentDay | [PerformanceHours] | conditional | Array of contiguous hourly metrics for the current day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
| »» previousDays | [PerformancePreviousDays] | conditional | Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero |
PerformancePreviousDays
[
"string"
]
Array of contiguous hourly metrics for the specified day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | [PerformanceHours] | mandatory | Array of contiguous hourly metrics for the specified day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder |
PerformanceHours
"string"
Percentage of calls within the performance threshold for the specified hour. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | RateString | mandatory | Percentage of calls within the performance threshold for the specified hour. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero |
InvocationMetricsV3
{
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"highPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"lowPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"unattended": {
"currentDay": 0,
"previousDays": [
0
]
},
"largePayload": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
},
"largeSecondary": {
"currentDay": 0,
"previousDays": [
0
]
}
}
Number of API calls in each performance tier over time
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| unauthenticated | object | mandatory | API call counts for the unauthenticated tier |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| highPriority | object | mandatory | API call counts for the high priority tier |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| lowPriority | object | mandatory | API call counts for the low priority tier |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| unattended | object | mandatory | API call counts for the unattended tier |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| largePayload | object | mandatory | API call counts for the large payload tier |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| secondary | object | conditional | API call counts for the Shared Responsibility Data Requests tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| largeSecondary | object | conditional | API call counts for the large Shared Responsibility Data Requests tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » currentDay | NaturalNumber | conditional | API call counts for current day |
| » previousDays | [NaturalNumber] | conditional | API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
AverageResponseMetricsV2
{
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"highPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"lowPriority": {
"currentDay": 0,
"previousDays": [
0
]
},
"unattended": {
"currentDay": 0,
"previousDays": [
0
]
},
"largePayload": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"primary": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
}
},
"largeSecondary": {
"primary": {
"currentDay": 0,
"previousDays": [
0
]
},
"secondary": {
"currentDay": 0,
"previousDays": [
0
]
}
}
}
Average response time in seconds, at millisecond resolution, within each performance tier
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| unauthenticated | object | mandatory | Average response time for the unauthenticated tier |
| » currentDay | number | conditional | Average response time for current day |
| » previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| highPriority | object | mandatory | Average response time for the high priority tier |
| » currentDay | number | conditional | Average response time for current day |
| » previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| lowPriority | object | mandatory | Average response time for the low priority tier |
| » currentDay | number | conditional | Average response time for current day |
| » previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| unattended | object | mandatory | Average response time for the unattended tier |
| » currentDay | number | conditional | Average response time for current day |
| » previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| largePayload | object | mandatory | Average response time for the large payload tier |
| » currentDay | number | conditional | Average response time for current day |
| » previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| secondary | object | conditional | Average response time for the secondary tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » primary | object | mandatory | Average response time as measured for the primary data holder |
| »» currentDay | number | conditional | Average response time for current day |
| »» previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| » secondary | object | mandatory | Average response time as measured for the secondary data holder |
| »» currentDay | number | conditional | Average response time for current day |
| »» previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| largeSecondary | object | conditional | Average response time for the large payload tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster |
| » primary | object | mandatory | Average response time as measured for the primary data holder |
| »» currentDay | number | conditional | Average response time for current day |
| »» previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| » secondary | object | mandatory | Average response time as measured for the secondary data holder |
| »» currentDay | number | conditional | Average response time for current day |
| »» previousDays | [number] | conditional | Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
SessionCountMetricsV2
{
"currentDay": 0,
"previousDays": [
0
]
}
Session counts over time. Note that a session is defined as the provisioning of an Access Token.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| currentDay | NaturalNumber | conditional | Session count for current day |
| previousDays | [NaturalNumber] | conditional | Session count for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
AverageTPSMetricsV2
{
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
}
Average transactions per second over time
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| aggregate | object | mandatory | Aggregate average transactions per second over time for all endpoints |
| » currentDay | number | conditional | Average TPS for current day. Must be a positive value or zero |
| » previousDays | [number] | conditional | Average TPS for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. Values must be a positive or zero |
| unauthenticated | object | mandatory | Average transactions per second over time for unauthenticated endpoints |
| » currentDay | number | conditional | Average TPS for current day. Must be a positive value or zero |
| » previousDays | [number] | conditional | Average TPS for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. Values must be a positive or zero |
| authenticated | object | mandatory | Average transactions per second over time for authenticated endpoints |
| » currentDay | number | conditional | Average TPS for current day. Must be a positive value or zero |
| » previousDays | [number] | conditional | Average TPS for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. Values must be a positive or zero |
PeakTPSMetricsV2
{
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
}
Peak transactions per second over time
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| aggregate | object | mandatory | Aggregate peak transactions per second over time for all endpoints |
| » currentDay | number | conditional | Peak TPS for current day. Must be a positive value or zero |
| » previousDays | [number] | conditional | Peak TPS for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. Values must be a positive or zero |
| unauthenticated | object | mandatory | Peak transactions per second over time for unauthenticated endpoints |
| » currentDay | number | conditional | Peak TPS for current day. Must be a positive value or zero |
| » previousDays | [number] | conditional | Peak TPS for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. Values must be a positive or zero |
| authenticated | object | mandatory | Peak transactions per second over time for authenticated endpoints |
| » currentDay | number | conditional | Peak TPS for current day. Must be a positive value or zero |
| » previousDays | [number] | conditional | Peak TPS for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. Values must be a positive or zero |
ErrorMetricsV2
{
"aggregate": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": {
"500": 0,
"property1": 0,
"property2": 0
},
"previousDays": [
{
"500": 0,
"property1": 0,
"property2": 0
}
]
},
"authenticated": {
"currentDay": {
"500": 0,
"property1": 0,
"property2": 0
},
"previousDays": [
{
"500": 0,
"property1": 0,
"property2": 0
}
]
}
}
Number of calls resulting in error, over time
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| aggregate | object | mandatory | Aggregate number of calls resulting in error due to server execution over time for all endpoints |
| » currentDay | NaturalNumber | conditional | Error counts for current day |
| » previousDays | [NaturalNumber] | conditional | Error counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| unauthenticated | object | mandatory | Number of calls resulting in error for unauthenticated endpoints |
| » currentDay | object | conditional | Error counts, by HTTP error code, for current day |
| »» additionalProperties | NaturalNumber | optional | Number of errors for a specific HTTP error code. Note that the property name must be 3 digits represent the HTTP error code the error is for |
| »» 500 | NaturalNumber | optional | Number of errors for HTTP error code 500. Note that this field is an example of a single entry due to the lack of OAS support for the JSON Schema patternProperties syntax. See the additionalProperties field in this schema for the generic property structure for error code counts |
| » previousDays | [object] | conditional | Error counts, by HTTP error code, for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| »» additionalProperties | NaturalNumber | optional | Number of errors for a specific HTTP error code. Note that the property name must be 3 digits represent the HTTP error code the error is for |
| »» 500 | NaturalNumber | optional | Number of errors for HTTP error code 500. Note that this field is an example of a single entry due to the lack of OAS support JSON Schema patternProperties syntax. See the additionalProperties field in this schema for the generic property structure for error code counts |
| authenticated | object | mandatory | Number of calls resulting in error for authenticated endpoints |
| » currentDay | object | conditional | Error counts, by HTTP error code, for current day |
| »» additionalProperties | NaturalNumber | optional | Number of errors for a specific HTTP error code. Note that the property name must be 3 digits represent the HTTP error code the error is for |
| »» 500 | NaturalNumber | optional | Number of errors for HTTP error code 500. Note that this field is an example of a single entry due to the lack of OAS support for the JSON Schema patternProperties syntax. See the additionalProperties field in this schema for the generic property structure for error code counts |
| » previousDays | [object] | conditional | Error counts, by HTTP error code, for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| »» additionalProperties | NaturalNumber | optional | Number of errors for a specific HTTP error code. Note that the property name must be 3 digits represent the HTTP error code the error is for |
| »» 500 | NaturalNumber | optional | Number of errors for HTTP error code 500. Note that this field is an example of a single entry due to the lack of OAS support JSON Schema patternProperties syntax. See the additionalProperties field in this schema for the generic property structure for error code counts |
RejectionMetricsV3
{
"authenticated": {
"currentDay": 0,
"previousDays": [
0
]
},
"unauthenticated": {
"currentDay": 0,
"previousDays": [
0
]
}
}
Number of calls rejected due to traffic thresholds over time
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| authenticated | object | mandatory | Rejection counts for all authenticated endpoints |
| » currentDay | NaturalNumber | conditional | Number of calls rejected for current day |
| » previousDays | [NaturalNumber] | conditional | Number of calls rejected for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
| unauthenticated | object | mandatory | Rejection counts for all unauthenticated endpoints |
| » currentDay | NaturalNumber | conditional | Number of calls rejected for current day |
| » previousDays | [NaturalNumber] | conditional | Number of calls rejected for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. |
SecondaryHolderMetricsV2
{
"errors": {
"currentDay": 0,
"previousDays": [
0
]
},
"rejections": {
"currentDay": 0,
"previousDays": [
0
]
}
}
Errors and rejections received by the primary data holder from the secondary data holder. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | object | mandatory | Number of calls resulting in error due to server execution over time |
| » currentDay | NaturalNumber | conditional | Number of errors for current day |
| » previousDays | [NaturalNumber] | conditional | Number of errors for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| rejections | object | mandatory | Number of calls rejected due to traffic thresholds over time |
| » currentDay | NaturalNumber | conditional | Number of rejections for current day |
| » previousDays | [NaturalNumber] | conditional | Number of rejections for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
AuthorisationMetricsV2
{
"activeAuthorisationCount": {
"individual": 0,
"nonIndividual": 0
},
"newAuthorisationCount": {
"currentDay": {
"onceOff": {
"individual": 0,
"nonIndividual": 0
},
"ongoing": {
"individual": 0,
"nonIndividual": 0
}
},
"previousDays": [
{
"onceOff": {
"individual": 0,
"nonIndividual": 0
},
"ongoing": {
"individual": 0,
"nonIndividual": 0
}
}
]
},
"revokedAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"amendedAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"expiredAuthorisationCount": {
"currentDay": {
"individual": 0,
"nonIndividual": 0
},
"previousDays": [
{
"individual": 0,
"nonIndividual": 0
}
]
},
"abandonedConsentFlowCount": {
"currentDay": 0,
"previousDays": [
0
]
},
"abandonmentsByStage": {
"preIdentification": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAuthentication": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAccountSelection": {
"currentDay": 0,
"previousDays": [
0
]
},
"preAuthorisation": {
"currentDay": 0,
"previousDays": [
0
]
},
"rejected": {
"currentDay": 0,
"previousDays": [
0
]
},
"failedTokenExchange": {
"currentDay": 0,
"previousDays": [
0
]
}
}
}
Authorisation counts for the data holder
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| activeAuthorisationCount | object | mandatory | The number of active ongoing authorisations |
| » individual | NaturalNumber | mandatory | Active ongoing authorisation count for individual customers |
| » nonIndividual | NaturalNumber | mandatory | Active ongoing authorisation count for non-individual customers |
| newAuthorisationCount | object | mandatory | The number of new authorisations |
| » currentDay | object | conditional | Number of new authorisations for the current day |
| »» onceOff | object | mandatory | New authorisation count for once-off authorisations |
| »»» individual | NaturalNumber | mandatory | New authorisation count for individual customers |
| »»» nonIndividual | NaturalNumber | mandatory | New authorisation count for non-individual customers |
| »» ongoing | object | mandatory | New authorisation count for ongoing authorisations |
| »»» individual | NaturalNumber | mandatory | New authorisation count for individual customers |
| »»» nonIndividual | NaturalNumber | mandatory | New authorisation count for non-individual customers |
| » previousDays | [object] | conditional | Number of new authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| »» onceOff | object | mandatory | New authorisation count for once-off authorisations |
| »»» individual | NaturalNumber | mandatory | New authorisation count for individual customers |
| »»» nonIndividual | NaturalNumber | mandatory | New authorisation count for non-individual customers |
| »» ongoing | object | mandatory | New authorisation count for ongoing authorisations |
| »»» individual | NaturalNumber | mandatory | New authorisation count for individual customers |
| »»» nonIndividual | NaturalNumber | mandatory | New authorisation count for non-individual customers |
| revokedAuthorisationCount | object | mandatory | The number of revoked authorisations |
| » currentDay | object | conditional | Number of revoked authorisations for the current day |
| »» individual | NaturalNumber | mandatory | Revoked authorisation count for individual customers |
| »» nonIndividual | NaturalNumber | mandatory | Revoked authorisation count for non-individual customers |
| » previousDays | [object] | conditional | Number of revoked authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| »» individual | NaturalNumber | mandatory | Revoked authorisation count for individual customers |
| »» nonIndividual | NaturalNumber | mandatory | Revoked authorisation count for non-individual customers |
| amendedAuthorisationCount | object | mandatory | The number of amended ongoing authorisations |
| » currentDay | object | conditional | Number of amended authorisations for the current day |
| »» individual | NaturalNumber | mandatory | Amended authorisation count for individual customers |
| »» nonIndividual | NaturalNumber | mandatory | Amended authorisation count for non-individual customers |
| » previousDays | [object] | conditional | Number of amended authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| »» individual | NaturalNumber | mandatory | Amended authorisation count for individual customers |
| »» nonIndividual | NaturalNumber | mandatory | Amended authorisation count for non-individual customers |
| expiredAuthorisationCount | object | mandatory | The number of expired ongoing authorisations |
| » currentDay | object | conditional | Number of expired authorisations for the current day |
| »» individual | NaturalNumber | mandatory | Expired authorisation count for individual customers |
| »» nonIndividual | NaturalNumber | mandatory | Expired authorisation count for non-individual customers |
| » previousDays | [object] | conditional | Number of expired authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| »» individual | NaturalNumber | mandatory | Expired authorisation count for individual customers |
| »» nonIndividual | NaturalNumber | mandatory | Expired authorisation count for non-individual customers |
| abandonedConsentFlowCount | object | mandatory | The number of consents flows that were not successfully authorised |
| » currentDay | NaturalNumber | conditional | Number of consents flows that were not successfully authorised for the current day |
| » previousDays | [NaturalNumber] | conditional | Number of consents flows that were not successfully authorised for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| abandonmentsByStage | object | mandatory | Customer abandonment count per stage of the consent flow. Note that the aggregated abandonment count for all stages for a period should equal the count in abandonedConsentFlowCount for the same period (ie. each abandoned consent should assigned to one, and only one, stage) |
| » preIdentification | object | mandatory | The number of authorisations that commenced with the data holder but the customer did not successfully identify their profile or user ID |
| »» currentDay | NaturalNumber | conditional | Number of abandoned consent flows for this stage for the current day |
| »» previousDays | [NaturalNumber] | conditional | Number of abandoned consent flows for this stage for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| » preAuthentication | object | mandatory | The number of authorisations where the customer identified themselves (ie. they successfully identify the customer profile to use for the authorisation) but failed to provide a valid OTP or equivalent |
| »» currentDay | NaturalNumber | conditional | Number of abandoned consent flows for this stage for the current day |
| »» previousDays | [NaturalNumber] | conditional | Number of abandoned consent flows for this stage for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| » preAccountSelection | object | mandatory | The number of authorisations where the customer successfully authenticated with a valid OTP or equivalent but abandoned the process before selecting accounts |
| »» currentDay | NaturalNumber | conditional | Number of abandoned consent flows for this stage for the current day |
| »» previousDays | [NaturalNumber] | conditional | Number of abandoned consent flows for this stage for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| » preAuthorisation | object | mandatory | The number of authorisations where the customer has passed the account selection step but abandoned the process before approving or rejecting the consent being requested |
| »» currentDay | NaturalNumber | conditional | Number of abandoned consent flows for this stage for the current day |
| »» previousDays | [NaturalNumber] | conditional | Number of abandoned consent flows for this stage for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| » rejected | object | mandatory | The number of authorisations where the customer actively rejected the authorisation rather than abandoning the process |
| »» currentDay | NaturalNumber | conditional | Number of abandoned consent flows for this stage for the current day |
| »» previousDays | [NaturalNumber] | conditional | Number of abandoned consent flows for this stage for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
| » failedTokenExchange | object | mandatory | The number of authorisations that completed the interactive flow with the consumer authorising the consent, but the ADR failed to - or was unable to - obtain a refresh or access token using the authorisation code |
| »» currentDay | NaturalNumber | conditional | Number of abandoned consent flows for this stage for the current day |
| »» previousDays | [NaturalNumber] | conditional | Number of abandoned consent flows for this stage for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available |
Links
{
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link to this API call |
Meta
{}
Properties
None
MetaError
{
"urn": "string"
}
Additional data for customised error codes
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| urn | string | conditional | The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [object] | mandatory | none |
| » code | string | mandatory | The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| » title | string | mandatory | A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| » detail | string | mandatory | A human-readable explanation specific to this occurrence of the problem. |
| » meta | MetaError | optional | Additional data for customised error codes |
Shared Responsibility
This section outlines standards related to Shared Responsibility Data Requests. These standards are applicable to CDR data clusters that are designated to be provided by a Secondary Data Holder via a CDR request to a Data Holder.
These standards define the information security mechanisms by which a Data Holder will connect with a Secondary Data Holder to fulfil a valid CDR request and the endpoints that the Secondary Data Holder will expose to fulfil such a request.
Energy
For the energy sector requests for the following data clusters are Shared Responsibility Data Requests for which the Australian Energy Market Operator (AEMO) is the single designated secondary data holder:
- NMI Standard Data
- Energy Usage
- Distributed Energy Resources
CDR requests for these data clusters to a Data Holder MUST be fulfilled by a request to AEMO.
Security Profile
In its function as market operator of the National Energy Market, AEMO already maintains a registration process for industry participants and shares data with participants using real time, RESTful APIs. This is done via the platform known as the e-Hub.
These processes currently include support processes for registration, maintenance of certificates, and the management of change. Documentation includes a developer portal, API documentation and a security profile. More information is published by AEMO.
The e-Hub platform and associated mechanisms ([EHUB]) will be considered a normative standard for the requesting of data from AEMO to fulfil Shared Responsibility Data Requests.
Normative References
| Reference | Description | Version |
|---|---|---|
| [EHUB] | AEMO e-Hub business to business procedures | Standards dated 9/4/2021 |
AEMO Endpoints
AEMO will expose the following end points, to retailers only, to service Shared Responsibility Data Requests:
- Get Service Points: Obtain high level details for a list of service points
- Get Service Point Detail: Obtain the detail for a specific service point
- Get Usage For Service Point: Obtain a list of electricity usage data from a particular service point
- Get Usage For Specific Service Points: Obtain the electricity usage data for a specific set of service points
- Get DER For Service Point: Obtain a list of DER data for a particular service point
- Get DER For Specific Service Points: Obtain DER data for a specific set of service points
The endpoints above MUST be implemented by AEMO exactly as they would be by Data Holders designated for the energy sector unless explicitly indicated otherwise in the following sections.
Secondary Base Path
The term secondary will be added to the URI path for these the AEMO versions of the
endpoints to create a clear separation between the secondary data holder version of the
endpoints and the primary data holder version of the endpoints.
For instance, the primary endpoint:
GET <base>/energy/electricity/servicepoints
would become the secondary endpoint:
GET <base>/secondary/energy/electricity/servicepoints
Endpoint Variations
The following variations to the endpoints published by AEMO from the energy sector endpoints apply:
- The
x-fapi-auth-dateheader MUST NOT be passed to AEMO and AEMO MUST NOT require this header - The
x-fapi-customer-ip-addressheader MUST NOT be passed to AEMO and AEMO MUST NOT require this header - The
x-cds-client-headersheader MUST NOT be passed to AEMO and AEMO MUST NOT require this header - A new header named
x-cds-arrangementmust be passed to AEMO for every invocation. This header should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement - All occurrences of the
servicePointIdfield, whether in a request, a response, or as an input parameter (such as path parameter or query parameter) should be populated with the equivalentNationalMeteringIdin plain text - Fields in the links object for all responses MUST be translated by the Data Holder into values that are valid for a Data Recipient to be able to call back to the Data Holder
- The Get Service Points end point MUST be changed from a GET to a POST and will have the same request payload as the Get Usage For Specific Service Points endpoint
Additional Requirements
The following statements also apply to the endpoints published by AEMO:
- General headers should be provided as if the request were coming from the primary Data Holder and not propagated from the call made by the Data Recipient
- The
x-fapi-interaction-idheader must be propagated from the Data Recipient call to AEMO to allow for end to end tracing. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique value for thex-fapi-interaction-idheader before calling AEMO - Endpoints that require knowledge of the NMIs that belong to the CDR Consumer have been excluded from the AEMO endpoint set. This includes Get Bulk Usage and Get Bulk DER. When a primary Data Holder is required to respond to these endpoints they should call the equivalent endpoint for specific service points and provide the specific list of NMIs to AEMO
- Some primary Data Holders may interact with AEMO using multiple participant IDs. For these Data Holders it is possible that a single request from a CDR Consumer covering multiple NMIs would require multiple calls to AEMO if the NMIs were associated with multiple participant IDs owned by the Data Holder. In this scenario the retailer MUST call AEMO multiple times and aggregate the results before responding to the Data Recipient
- If a request for usage data spans a time period when AEMO cannot definitively determine that the primary Data Holder was not in control of the NMI then:
- AEMO MUST NOT respond with an error
- AEMO MUST respond with the usage for the period that the primary Data Holder can be definitively determined to be in control of the NMI
- AEMO MUST NOT share data outside the period of control of the primary Data Holder
- The primary Data Holder MUST ensure that the data requested and then shared with the Data Recipient is not outside the bounds of control of the specific CDR Consumer
Energy Secondary DH APIs
This specification defines the APIs for Data Holders exposing Energy Secondary Data Holder endpoints.
| Energy Secondary Data Holder OpenAPI Specification (JSON) |
| Energy Secondary Data Holder OpenAPI Specification (YAML) |
Get Service Points (SR)
Code samples
POST /secondary/energy/electricity/servicepoints HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-cds-arrangement: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-cds-arrangement':'string'
};
fetch('/secondary/energy/electricity/servicepoints', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /secondary/energy/electricity/servicepoints
Obtain a list of service points owned by the customer that has authorised the current session
Body parameter
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | mandatory | The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header. |
| x-cds-arrangement | header | string | mandatory | A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement |
| body | body | RequestServicePointIdList | mandatory | Request payload containing list of specific Service Points to obtain data for |
Example responses
200 Response
{
"data": {
"servicePoints": [
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyServicePointListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Service Point Detail (SR)
Code samples
GET /secondary/energy/electricity/servicepoints/{servicePointId} HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-cds-arrangement: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-cds-arrangement':'string'
};
fetch('/secondary/energy/electricity/servicepoints/{servicePointId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /secondary/energy/electricity/servicepoints/{servicePointId}
Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| servicePointId | path | string | mandatory | The independent ID of the service point, known in the industry as the NMI. The servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | mandatory | The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header. |
| x-cds-arrangement | header | string | mandatory | A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement |
Example responses
200 Response
{
"data": {
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyServicePointDetailResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Usage For Service Point (SR)
Code samples
GET /secondary/energy/electricity/servicepoints/{servicePointId}/usage HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-cds-arrangement: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-cds-arrangement':'string'
};
fetch('/secondary/energy/electricity/servicepoints/{servicePointId}/usage', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /secondary/energy/electricity/servicepoints/{servicePointId}/usage
Obtain a list of electricity usage data from a particular service point
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| servicePointId | path | string | mandatory | The independent ID of the service point, known in the industry as the NMI. The servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| oldest-date | query | DateString | optional | Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| newest-date | query | DateString | optional | Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| interval-reads | query | Enum | optional | Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | mandatory | The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header. |
| x-cds-arrangement | header | string | mandatory | A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement |
Enumerated Values
| Parameter | Value |
|---|---|
| interval-reads | NONE |
| interval-reads | MIN_30 |
| interval-reads | FULL |
Example responses
200 Response
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyUsageListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get Usage For Specific Service Points (SR)
Code samples
POST /secondary/energy/electricity/servicepoints/usage HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-cds-arrangement: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-cds-arrangement':'string'
};
fetch('/secondary/energy/electricity/servicepoints/usage', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /secondary/energy/electricity/servicepoints/usage
Obtain the electricity usage data for a specific set of service points
Body parameter
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| oldest-date | query | DateString | optional | Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type |
| newest-date | query | DateString | optional | Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type |
| interval-reads | query | Enum | optional | Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | mandatory | The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header. |
| x-cds-arrangement | header | string | mandatory | A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement |
| body | body | RequestServicePointIdList | mandatory | Request payload containing list of specific Service Points to obtain data for |
Enumerated Values
| Parameter | Value |
|---|---|
| interval-reads | NONE |
| interval-reads | MIN_30 |
| interval-reads | FULL |
Example responses
200 Response
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyUsageListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get DER For Service Point (SR)
Code samples
GET /secondary/energy/electricity/servicepoints/{servicePointId}/der HTTP/1.1
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-cds-arrangement: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-cds-arrangement':'string'
};
fetch('/secondary/energy/electricity/servicepoints/{servicePointId}/der', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /secondary/energy/electricity/servicepoints/{servicePointId}/der
Obtain a list of DER data from a particular service point
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| servicePointId | path | string | mandatory | The independent ID of the service point, known in the industry as the NMI. The servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | mandatory | The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header. |
| x-cds-arrangement | header | string | mandatory | A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement |
Example responses
200 Response
{
"data": {
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyDerDetailResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 404 | Not Found | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Get DER For Specific Service Points (SR)
Code samples
POST /secondary/energy/electricity/servicepoints/der HTTP/1.1
Content-Type: application/json
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-cds-arrangement: string
const fetch = require('node-fetch');
const inputBody = '{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-cds-arrangement':'string'
};
fetch('/secondary/energy/electricity/servicepoints/der', {
method: 'POST',
body: inputBody,
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /secondary/energy/electricity/servicepoints/der
Obtain DER data for a specific set of service points
Body parameter
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Endpoint Version
| Version | 1 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | PositiveInteger | optional | Page of results to request (standard pagination) |
| page-size | query | PositiveInteger | optional | Page size to request. Default is 25 (standard pagination) |
| x-v | header | string | mandatory | Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | header | string | optional | Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
| x-fapi-interaction-id | header | string | mandatory | The x-fapi-interaction-id header value provided by the Data Recipient. If not supplied by the Data Recipient, the primary Data Holder MUST create a unique [RFC4122] UUID value for the x-fapi-interaction-id header. |
| x-cds-arrangement | header | string | mandatory | A unique string representing a consent arrangement between a Data Recipient Software Product and Data Holder for a given consumer. The identifier MUST be unique per customer according to the definition of customer in the CDR Federation section of this profile. The x-cds-arrangement should contain the arrangement ID for the consent that the request is being made under and will be used for tracing and audit purposes. This field MUST be populated but AEMO MUST NOT seek to validate the consent associated with the arrangement |
| body | body | RequestServicePointIdList | mandatory | Request payload containing list of specific Service Points to obtain data for |
Example responses
200 Response
{
"data": {
"derRecords": [
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | EnergyDerListResponse |
| 400 | Bad Request | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 406 | Not Acceptable | The following error codes MUST be supported: |
ResponseErrorListV2 |
| 422 | Unprocessable Entity | The following error codes MUST be supported: |
ResponseErrorListV2 |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | x-v | string | The version of the API endpoint that the data holder has responded with. |
| 200 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 422 | x-fapi-interaction-id | string | An [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Schemas
EnergyServicePointListResponse
{
"data": {
"servicePoints": [
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » servicePoints | [EnergyServicePoint] | mandatory | none |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyServicePointDetailResponse
{
"data": {
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | EnergyServicePointDetail | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
EnergyUsageListResponse
{
"data": {
"reads": [
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » reads | [EnergyUsageRead] | mandatory | Array of meter reads sorted by NMI in ascending order followed by readStartDate in descending order |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyDerListResponse
{
"data": {
"derRecords": [
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » derRecords | [EnergyDerRecord] | mandatory | Array of meter reads |
| links | LinksPaginated | mandatory | none |
| meta | MetaPaginated | mandatory | none |
EnergyDerDetailResponse
{
"data": {
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | EnergyDerRecord | mandatory | none |
| links | Links | mandatory | none |
| meta | Meta | optional | none |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [object] | mandatory | none |
| » code | string | mandatory | The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| » title | string | mandatory | A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| » detail | string | mandatory | A human-readable explanation specific to this occurrence of the problem. |
| » meta | object | optional | Additional data for customised error codes |
| »» urn | string | conditional | The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
EnergyServicePoint
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| nationalMeteringId | string | mandatory | The independent ID of the service point, known in the industry as the NMI |
| servicePointClassification | Enum | mandatory | The classification of the service point as defined in MSATS procedures |
| servicePointStatus | Enum | mandatory | Code used to indicate the status of the service point. Note the details for the enumeration values below:
|
| jurisdictionCode | Enum | mandatory | Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
|
| isGenerator | boolean | optional | This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit(this may include generator auxiliary loads). If absent defaults to false. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer |
| validFromDate | DateString | mandatory | The latest start date from which the constituent data sets of this service point became valid |
| lastUpdateDateTime | DateTimeString | mandatory | The date and time that the information for this service point was modified |
| consumerProfile | object | optional | none |
| » classification | Enum | optional | A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments |
| » threshold | Enum | optional | A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
|
Enumerated Values
| Property | Value |
|---|---|
| servicePointClassification | EXTERNAL_PROFILE |
| servicePointClassification | GENERATOR |
| servicePointClassification | LARGE |
| servicePointClassification | SMALL |
| servicePointClassification | WHOLESALE |
| servicePointClassification | NON_CONTEST_UNMETERED_LOAD |
| servicePointClassification | NON_REGISTERED_EMBEDDED_GENERATOR |
| servicePointClassification | DISTRIBUTION_WHOLESALE |
| servicePointStatus | ACTIVE |
| servicePointStatus | DE_ENERGISED |
| servicePointStatus | EXTINCT |
| servicePointStatus | GREENFIELD |
| servicePointStatus | OFF_MARKET |
| jurisdictionCode | ALL |
| jurisdictionCode | ACT |
| jurisdictionCode | NEM |
| jurisdictionCode | NSW |
| jurisdictionCode | QLD |
| jurisdictionCode | SA |
| jurisdictionCode | TAS |
| jurisdictionCode | VIC |
| classification | BUSINESS |
| classification | RESIDENTIAL |
| threshold | LOW |
| threshold | MEDIUM |
| threshold | HIGH |
EnergyServicePointDetail
{
"servicePointId": "string",
"nationalMeteringId": "string",
"servicePointClassification": "EXTERNAL_PROFILE",
"servicePointStatus": "ACTIVE",
"jurisdictionCode": "ALL",
"isGenerator": true,
"validFromDate": "string",
"lastUpdateDateTime": "string",
"consumerProfile": {
"classification": "BUSINESS",
"threshold": "LOW"
},
"distributionLossFactor": {
"code": "string",
"description": "string",
"lossValue": "string"
},
"relatedParticipants": [
{
"party": "string",
"role": "FRMP"
}
],
"location": {
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
},
"meters": [
{
"meterId": "string",
"specifications": {
"status": "CURRENT",
"installationType": "BASIC",
"manufacturer": "string",
"model": "string",
"readType": "string",
"nextScheduledReadDate": "string"
},
"registers": [
{
"registerId": "string",
"registerSuffix": "string",
"averagedDailyLoad": 0,
"registerConsumptionType": "INTERVAL",
"networkTariffCode": "string",
"unitOfMeasure": "string",
"timeOfDay": "ALLDAY",
"multiplier": 0,
"controlledLoad": true,
"consumptionType": "ACTUAL"
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| nationalMeteringId | string | mandatory | The independent ID of the service point, known in the industry as the NMI |
| servicePointClassification | Enum | mandatory | The classification of the service point as defined in MSATS procedures |
| servicePointStatus | Enum | mandatory | Code used to indicate the status of the service point. Note the details for the enumeration values below:
|
| jurisdictionCode | Enum | mandatory | Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
|
| isGenerator | boolean | optional | This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit(this may include generator auxiliary loads). If absent defaults to false. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer |
| validFromDate | DateString | mandatory | The latest start date from which the constituent data sets of this service point became valid |
| lastUpdateDateTime | DateTimeString | mandatory | The date and time that the information for this service point was modified |
| consumerProfile | object | optional | none |
| » classification | Enum | optional | A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments |
| » threshold | Enum | optional | A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
|
| distributionLossFactor | object | mandatory | none |
| » code | string | mandatory | A code used to identify data loss factor for the service point values. Refer to AEMO distribution loss factor documents for each financial year to interpret |
| » description | string | mandatory | Description of the data loss factor code and value |
| » lossValue | string | mandatory | The value associated with the loss factor code |
| relatedParticipants | [object] | mandatory | none |
| » party | string | mandatory | The name of the party/organisation related to this service point |
| » role | Enum | mandatory | The role performed by this participant in relation to the service point. Note the details of enumeration values below:
|
| location | CommonPhysicalAddress | mandatory | Location of the servicepoint |
| meters | [object] | optional | The meters associated with the service point. This may be empty where there are no meters physically installed at the service point |
| » meterId | string | mandatory | The meter ID uniquely identifies a meter for a given service point. It is unique in the context of the service point. It is not globally unique |
| » specifications | object | mandatory | Technical characteristics of the meter |
| »» status | Enum | mandatory | A code to denote the status of the meter. Note the details of enumeration values below:
|
| »» installationType | Enum | mandatory | The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
|
| »» manufacturer | string | optional | Free text field to identify the manufacturer of the installed meter |
| »» model | string | optional | Free text field to identify the meter manufacturer’s designation for the meter model |
| »» readType | string | optional | Code to denote the method and frequency of Meter Reading. The value is formatted as follows:
|
| »» nextScheduledReadDate | DateString | optional | This date is the next scheduled meter read date (NSRD) if a manual Meter Reading is required |
| » registers | [object] | optional | Usage data registers available from the meter. This may be empty where there are no meters physically installed at the service point |
| »» registerId | string | mandatory | Unique identifier of the register within this service point. Is not globally unique |
| »» registerSuffix | string | optional | Register suffix of the meter register where the meter reads are obtained |
| »» averagedDailyLoad | number | optional | The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh). This value is calculated annually. |
| »» registerConsumptionType | Enum | mandatory | Indicates the consumption type of register |
| »» networkTariffCode | string | optional | The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider |
| »» unitOfMeasure | string | optional | The unit of measure for data held in this register |
| »» timeOfDay | Enum | optional | Code to identify the time validity of register contents |
| »» multiplier | number | optional | Multiplier required to take a register value and turn it into a value representing billable energy |
| »» controlledLoad | boolean | optional | Indicates whether the energy recorded by this register is created under a Controlled Load regime |
| »» consumptionType | Enum | optional | Actual/Subtractive Indicator. Note the details of enumeration values below:
|
Enumerated Values
| Property | Value |
|---|---|
| servicePointClassification | EXTERNAL_PROFILE |
| servicePointClassification | GENERATOR |
| servicePointClassification | LARGE |
| servicePointClassification | SMALL |
| servicePointClassification | WHOLESALE |
| servicePointClassification | NON_CONTEST_UNMETERED_LOAD |
| servicePointClassification | NON_REGISTERED_EMBEDDED_GENERATOR |
| servicePointClassification | DISTRIBUTION_WHOLESALE |
| servicePointStatus | ACTIVE |
| servicePointStatus | DE_ENERGISED |
| servicePointStatus | EXTINCT |
| servicePointStatus | GREENFIELD |
| servicePointStatus | OFF_MARKET |
| jurisdictionCode | ALL |
| jurisdictionCode | ACT |
| jurisdictionCode | NEM |
| jurisdictionCode | NSW |
| jurisdictionCode | QLD |
| jurisdictionCode | SA |
| jurisdictionCode | TAS |
| jurisdictionCode | VIC |
| classification | BUSINESS |
| classification | RESIDENTIAL |
| threshold | LOW |
| threshold | MEDIUM |
| threshold | HIGH |
| role | FRMP |
| role | LNSP |
| role | DRSP |
| status | CURRENT |
| status | DISCONNECTED |
| installationType | BASIC |
| installationType | COMMS1 |
| installationType | COMMS2 |
| installationType | COMMS3 |
| installationType | COMMS4 |
| installationType | COMMS4C |
| installationType | COMMS4D |
| installationType | MRAM |
| installationType | MRIM |
| installationType | PROF |
| installationType | SAMPLE |
| installationType | UMCP |
| installationType | VICAMI |
| installationType | NCOLNUML |
| registerConsumptionType | INTERVAL |
| registerConsumptionType | BASIC |
| registerConsumptionType | PROFILE_DATA |
| registerConsumptionType | ACTIVE_IMPORT |
| registerConsumptionType | ACTIVE |
| registerConsumptionType | REACTIVE_IMPORT |
| registerConsumptionType | REACTIVE |
| timeOfDay | ALLDAY |
| timeOfDay | INTERVAL |
| timeOfDay | PEAK |
| timeOfDay | BUSINESS |
| timeOfDay | SHOULDER |
| timeOfDay | EVENING |
| timeOfDay | OFFPEAK |
| timeOfDay | CONTROLLED |
| timeOfDay | DEMAND |
| consumptionType | ACTUAL |
| consumptionType | CUMULATIVE |
EnergyUsageRead
{
"servicePointId": "string",
"registerId": "string",
"registerSuffix": "string",
"meterId": "string",
"controlledLoad": true,
"readStartDate": "string",
"readEndDate": "string",
"unitOfMeasure": "string",
"readUType": "basicRead",
"basicRead": {
"quality": "ACTUAL",
"value": 0
},
"intervalRead": {
"readIntervalLength": 0,
"aggregateValue": 0,
"intervalReads": [
0
],
"readQualities": [
{
"startInterval": 0,
"endInterval": 0,
"quality": "SUBSTITUTE"
}
]
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| registerId | string | optional | Register ID of the meter register where the meter reads are obtained |
| registerSuffix | string | mandatory | Register suffix of the meter register where the meter reads are obtained |
| meterId | string | optional | Meter id/serial number as it appears in customer’s bill. ID permanence rules do not apply. |
| controlledLoad | boolean | optional | Indicates whether the energy recorded by this register is created under a Controlled Load regime |
| readStartDate | DateString | mandatory | Date when the meter reads start in AEST and assumed to start from 12:00 am AEST. |
| readEndDate | DateString | optional | Date when the meter reads end in AEST. If absent then assumed to be equal to readStartDate. In this case the entry represents data for a single date specified by readStartDate. |
| unitOfMeasure | ExternalRef | optional | Unit of measure of the meter reads. Refer to Appendix B of MDFF Specification NEM12 NEM13 v2.1 for a list of possible values |
| readUType | Enum | mandatory | Specify the type of the meter read data |
| basicRead | object | conditional | Mandatory if readUType is set to basicRead |
| » quality | Enum | optional | The quality of the read taken. If absent then assumed to be ACTUAL |
| » value | number | mandatory | Meter read value. If positive then it means consumption, if negative it means export |
| intervalRead | object | conditional | Mandatory if readUType is set to intervalRead |
| » readIntervalLength | PositiveInteger | conditional | Read interval length in minutes. Required when interval-reads query parameter equals FULL or MIN_30 |
| » aggregateValue | number | mandatory | The aggregate sum of the interval read values. If positive then it means net consumption, if negative it means net export |
| » intervalReads | [number] | conditional | Array of Interval read values. If positive then it means consumption, if negative it means export. Required when interval-reads query parameter equals FULL or MIN_30. Each read value indicates the read for the interval specified by readIntervalLength beginning at midnight of readStartDate (for example 00:00 to 00:30 would be the first reading in a 30 minute Interval) |
| » readQualities | [object] | conditional | Specifies quality of reads that are not ACTUAL. For read indices that are not specified, quality is assumed to be ACTUAL. If not present, all quality of all reads are assumed to be actual. Required when interval-reads query parameter equals FULL or MIN_30 |
| »» startInterval | PositiveInteger | mandatory | Start interval for read quality flag. First read begins at 1 |
| »» endInterval | PositiveInteger | mandatory | End interval for read quality flag |
| »» quality | Enum | mandatory | The quality of the read taken |
Enumerated Values
| Property | Value |
|---|---|
| readUType | basicRead |
| readUType | intervalRead |
| quality | ACTUAL |
| quality | SUBSTITUTE |
| quality | FINAL_SUBSTITUTE |
| quality | SUBSTITUTE |
| quality | FINAL_SUBSTITUTE |
EnergyDerRecord
{
"servicePointId": "string",
"approvedCapacity": 0,
"availablePhasesCount": 3,
"installedPhasesCount": 3,
"islandableInstallation": true,
"hasCentralProtectionControl": false,
"protectionMode": {
"exportLimitKva": 0,
"underFrequencyProtection": 0,
"underFrequencyProtectionDelay": 0,
"overFrequencyProtection": 0,
"overFrequencyProtectionDelay": 0,
"underVoltageProtection": 0,
"underVoltageProtectionDelay": 0,
"overVoltageProtection": 0,
"overVoltageProtectionDelay": 0,
"sustainedOverVoltage": 0,
"sustainedOverVoltageDelay": 0,
"frequencyRateOfChange": 0,
"voltageVectorShift": 0,
"interTripScheme": "string",
"neutralVoltageDisplacement": 0
},
"acConnections": [
{
"connectionIdentifier": 0,
"count": 0,
"equipmentType": "INVERTER",
"manufacturerName": "string",
"inverterSeries": "string",
"inverterModelNumber": "string",
"commissioningDate": "string",
"status": "ACTIVE",
"inverterDeviceCapacity": 0,
"derDevices": [
{
"deviceIdentifier": 0,
"count": 0,
"manufacturer": "string",
"modelNumber": "string",
"status": "ACTIVE",
"type": "FOSSIL",
"subtype": "string",
"nominalRatedCapacity": 0,
"nominalStorageCapacity": 0
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| servicePointId | string | mandatory | The independent ID of the service point, known in the industry as the National Meter Identifier (NMI). Note that the servicePointId will be replaced with NMI for all interactions between Data Holder and AEMO. |
| approvedCapacity | number | mandatory | Approved small generating unit capacity as agreed with NSP in the connection agreement, expressed in kVA. Value of 0 indicates no DER record exists for the given servicePointId |
| availablePhasesCount | NaturalNumber | mandatory | The number of phases available for the installation of DER. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId |
| installedPhasesCount | NaturalNumber | mandatory | The number of phases that DER is connected to. Acceptable values are 0, 1, 2 or 3. Value of 0 indicates no DER record exists for the given servicePointId |
| islandableInstallation | Boolean | mandatory | For identification of small generating units designed with the ability to operate in an islanded mode |
| hasCentralProtectionControl | boolean | optional | For DER installations where NSPs specify the need for additional forms of protection above those inbuilt in an inverter. If absent then assumed to be false |
| protectionMode | object | conditional | Required only when the hasCentralProtectionAndControl flag is set to true. One or more of the object fields will be provided to describe the protection modes in place |
| » exportLimitKva | number | optional | Maximum amount of power (kVA) that may be exported from a connection point to the grid, as monitored by a control / relay function. An absent value indicates no limit |
| » underFrequencyProtection | number | optional | Protective function limit in Hz. |
| » underFrequencyProtectionDelay | number | optional | Trip delay time in seconds. |
| » overFrequencyProtection | number | optional | Protective function limit in Hz. |
| » overFrequencyProtectionDelay | number | optional | Trip delay time in seconds. |
| » underVoltageProtection | number | optional | Protective function limit in V. |
| » underVoltageProtectionDelay | number | optional | Trip delay time in seconds. |
| » overVoltageProtection | number | optional | Protective function limit in V. |
| » overVoltageProtectionDelay | number | optional | Trip delay time in seconds. |
| » sustainedOverVoltage | number | optional | Sustained over voltage. |
| » sustainedOverVoltageDelay | number | optional | Sustained Over voltage protection delay in seconds. |
| » frequencyRateOfChange | number | optional | Rate of change of frequency trip point (Hz/s). |
| » voltageVectorShift | number | optional | Trip angle in degrees. |
| » interTripScheme | string | optional | Description of the form of inter-trip (e.g. 'from local substation'). |
| » neutralVoltageDisplacement | number | optional | Trip voltage. |
| acConnections | [object] | mandatory | none |
| » connectionIdentifier | number | mandatory | AC Connection ID as defined in the DER register. Does not align with CDR ID permanence standards |
| » count | PositiveInteger | mandatory | Number of AC Connections in the group. For the suite of AC Connections to be considered as a group, all of the AC Connections included must have the same attributes |
| » equipmentType | Enum | optional | Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g. rotating machine). If absent, assume equipment type to be “OTHER”. |
| » manufacturerName | string | conditional | The name of the inverter manufacturer. Mandatory if equipmentType is INVERTER |
| » inverterSeries | string | conditional | The inverter series. Mandatory if equipmentType is INVERTER |
| » inverterModelNumber | string | conditional | The inverter model number. Mandatory if equipmentType is INVERTER |
| » commissioningDate | DateString | mandatory | The date that the DER installation is commissioned |
| » status | Enum | mandatory | Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned |
| » inverterDeviceCapacity | number | conditional | The rated AC output power that is listed in the product specified by the manufacturer. Mandatory if equipmentType is INVERTER. Default is 0 if value not known |
| » derDevices | [object] | mandatory | none |
| »» deviceIdentifier | number | mandatory | Unique identifier for a single DER device or a group of DER devices with the same attributes. Does not align with CDR ID permanence standards |
| »» count | PositiveInteger | mandatory | Number of devices in the group of DER devices |
| »» manufacturer | string | optional | The name of the device manufacturer. If absent then assumed to be “unknown” |
| »» modelNumber | string | optional | The model number of the device. If absent then assumed to be “unknown” |
| »» status | Enum | optional | Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned |
| »» type | Enum | mandatory | Used to indicate the primary technology used in the DER device |
| »» subtype | string | optional | Used to indicate the primary technology used in the DER device. This field is also used to record for example the battery chemistry, or the type of PV panel. It is also used to record if a battery is contained in an electric vehicle connected in a vehicle-to-grid arrangement. If absent then assumed to be “other” |
| »» nominalRatedCapacity | number | mandatory | Maximum output in kVA that is listed in the product specification by the manufacturer. This refers to the capacity of each unit within the device group. Default is 0 if value not known |
| »» nominalStorageCapacity | number | conditional | Maximum storage capacity in kVAh. This refers to the capacity of each storage module within the device group. Mandatory if type is equal to “STORAGE”. Default is 0 if value not known |
Enumerated Values
| Property | Value |
|---|---|
| equipmentType | INVERTER |
| equipmentType | OTHER |
| status | ACTIVE |
| status | INACTIVE |
| status | DECOMMISSIONED |
| status | ACTIVE |
| status | INACTIVE |
| status | DECOMMISSIONED |
| type | FOSSIL |
| type | HYDRO |
| type | WIND |
| type | SOLAR_PV |
| type | RENEWABLE |
| type | GEOTHERMAL |
| type | STORAGE |
| type | OTHER |
CommonPhysicalAddress
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| addressUType | Enum | mandatory | The type of address object present |
| simple | CommonSimpleAddress | conditional | Required if addressUType is set to simple |
| paf | CommonPAFAddress | conditional | Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf |
Enumerated Values
| Property | Value |
|---|---|
| addressUType | paf |
| addressUType | simple |
CommonSimpleAddress
{
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
}
Required if addressUType is set to simple
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| mailingName | string | optional | Name of the individual or business formatted for inclusion in an address used for physical mail |
| addressLine1 | string | mandatory | First line of the standard address object |
| addressLine2 | string | optional | Second line of the standard address object |
| addressLine3 | string | optional | Third line of the standard address object |
| postcode | string | conditional | Mandatory for Australian addresses |
| city | string | mandatory | Name of the city or locality |
| state | string | mandatory | Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT |
| country | ExternalRef | optional | A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present. |
CommonPAFAddress
{
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dpid | string | optional | Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier |
| thoroughfareNumber1 | PositiveInteger | optional | Thoroughfare number for a property (first number in a property ranged address) |
| thoroughfareNumber1Suffix | string | optional | Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated |
| thoroughfareNumber2 | PositiveInteger | optional | Second thoroughfare number (only used if the property has a ranged address eg 23-25) |
| thoroughfareNumber2Suffix | string | optional | Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated |
| flatUnitType | string | optional | Type of flat or unit for the address |
| flatUnitNumber | string | optional | Unit number (including suffix, if applicable) |
| floorLevelType | string | optional | Type of floor or level for the address |
| floorLevelNumber | string | optional | Floor or level number (including alpha characters) |
| lotNumber | string | optional | Allotment number for the address |
| buildingName1 | string | optional | Building/Property name 1 |
| buildingName2 | string | optional | Building/Property name 2 |
| streetName | string | optional | The name of the street |
| streetType | string | optional | The street type. Valid enumeration defined by Australia Post PAF code file |
| streetSuffix | string | optional | The street type suffix. Valid enumeration defined by Australia Post PAF code file |
| postalDeliveryType | string | optional | Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file |
| postalDeliveryNumber | PositiveInteger | optional | Postal delivery number if the address is a postal delivery type |
| postalDeliveryNumberPrefix | string | optional | Postal delivery number prefix related to the postal delivery number |
| postalDeliveryNumberSuffix | string | optional | Postal delivery number suffix related to the postal delivery number |
| localityName | string | mandatory | Full name of locality |
| postcode | string | mandatory | Postcode for the locality |
| state | string | mandatory | State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT |
RequestServicePointIdList
{
"data": {
"servicePointIds": [
"string"
]
},
"meta": {}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | mandatory | none |
| » servicePointIds | [string] | mandatory | Array of specific servicePointIds to obtain data for |
| meta | Meta | optional | none |
Links
{
"self": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document |
Meta
{}
Properties
None
LinksPaginated
{
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| self | URIString | mandatory | Fully qualified link that generated the current response document |
| first | URIString | conditional | URI to the first page of this set. Mandatory if this response is not the first page |
| prev | URIString | conditional | URI to the previous page of this set. Mandatory if this response is not the first page |
| next | URIString | conditional | URI to the next page of this set. Mandatory if this response is not the last page |
| last | URIString | conditional | URI to the last page of this set. Mandatory if this response is not the last page |
MetaPaginated
{
"totalRecords": 0,
"totalPages": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| totalRecords | NaturalNumber | mandatory | The total number of records in the full set. See pagination. |
| totalPages | NaturalNumber | mandatory | The total number of pages in the full set. See pagination. |
Additional Standards
The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations.
These standards fall into three categories:
Candidatestandards that are non-binding and stableDraftstandards that are non-binding but volatile as they are under developmentExperimentalstandards that are transient and created to test concepts
Candidate Standards
Updated Telco specification to ensure response header details are displayed correctly
The Consumer Data Standards currently include the following Candidate Standards:
- Candidate Standards for the Telecommunications sector
- Candidate Standards for Banking Decision Proposal 306
- Candidate Standards for the Banking and Non-Bank Lending sector
Draft Standards
The Consumer Data Standards do not currently include any Draft Standards.
Experimental Standards
The experimental standards developed by the Data Standards Body are developed in this GitHub repository and are published here.
Known Issues
There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.
Removed three known issues related to Register endpoint specfications that are resolved
| Issue | Description |
|---|---|
| None | N/A |
Future improvements
The following improvements will be incorporated into future versions of the Standards
Standardise Register API Error Codes
Future versions of the CDR Register API error codes are to be aligned to the Standards high-level error codes as follows:
| API | Updated Error Codes | New Error Codes |
|---|---|---|
| Get Data Holder Brands | 400: Missing Required Header / Invalid Header / Invalid Version / Invalid Field |
404: Invalid Industry |
| Get Software Statement Assertion (SSA) | 400: Missing Required Header / Invalid Header / Invalid Version / Invalid Field 403: The ADR or the ADR's Software Product is not active 404: Invalid Industry / Invalid Brand Id / Invalid Software Product Id |
|
| Get Data Holder Statuses | 400: Missing Required Header / Invalid Header / Invalid Version / Invalid Field |
404: Invalid Industry |
| Get Software Products Statuses | 400: Missing Required Header / Invalid Header / Invalid Version / Invalid Field |
404: Invalid Industry |
| Get Data Recipients Statuses | 400: Missing Required Header / Invalid Header / Invalid Version / Invalid Field |
404: Invalid Industry |
| Get Data Recipients | 400: Missing Required Header / Invalid Header / Invalid Version / Invalid Field |
404: Invalid Industry |
Changelog and archives
Merged the Change Log and Archives sections. Archived versions are available through the links in the Version column.
The following table lists the changes made to these standards in reverse date order (most recent change and current version is at the top). Archived versions are prior versions of the standards that are available for reference only and not considered binding.
| Date | Version | Description | Detail of change |
|---|---|---|---|
| 21/10/2024 | 1.32.0 | Changes from Maintenance Iteration 20. | See release notes and Decision 353 for details. |
| 03/07/2024 | 1.31.0 | Changes from Maintenance Iteration 19 | See release notes and Decision 347 for details. |
| 24/04/2024 | 1.30.0 | Changes from maintenance iteration 18 | See release notes and Decision 340 for details. |
| 28/02/2024 | 1.29.1 | Patch release fixing minor issues | See release notes for details. |
| 21/12/2023 | 1.29.0 | Changes from maintenance iteration 17. Also includes CX Standards changes to uplift Data Holder Dashboards and accommodate Business Consumers | See release notes, Decision 318, Decision 328, Decision 333 and Decision 334 for details. |
| 10/11/2023 | 1.28.0 | Candidate standards arising from Decision 306 and updated draft non-bank lending standards | See release notes and Decision 306 for details. |
| 10/10/2023 | 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | See release notes and Decision 313 for details. |
| 24/08/2023 | 1.26.0 | Changes to obligations for the implementation of Get Metrics | See release notes and Decision 322 for details. |
| 08/07/2023 | 1.25.0 | Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs) | See release notes, Decision 303 and Decision 288 for details. |
| 07/05/2023 | 1.24.0 | Changes arising from Decision 281 (Maintenance iteration 14) | See release notes and Decision 281 for details. |
| 14/04/2023 | 1.23.0 | Changes arising from Decision Proposal 298 | See release notes and Decision 298 for details. |
| 22/03/2023 | 1.22.1 | Patch release including updates to draft Telco standards | See release notes for details. |
| 22/12/2022 | 1.22.0 | Changes arising from Decision 271 (Maintenance iteration 13) | See release notes and Decision 272 for details. |
| 16/12/2022 | 1.21.0 | Changes arising from Decision 282 | See release notes and Decision 282 for details. |
| 03/11/2022 | 1.20.0 | Changes arising from Decision 259 (Maintenance iteration 12) | See release notes and Decision 259 for details. Also includes first draft of Telco standards |
| 13/09/2022 | 1.19.0 | Changes arising from Decision 260 (Energy Closed Accounts) | See release notes and Decision 260 for details |
| 11/08/2022 | 1.18.0 | Changes arising from Decision 249 (Maintenance iteration 11) | See release notes and Decision 249 for details |
| 23/05/2022 | 1.17.0 | Changes arising from Decision 237 (Maintenance Iteration 10) | See release notes and Decision 237 for details |
| 22/03/2022 | 1.16.1 | Minor errata and documentation fixes. Update of swagger files to OAS3 | See release notes for details |
| 04/02/2022 | 1.16.0 | Changes arising from Decision 222 (Insights and Trusted Adviser Disclosure Consents CX Standards) | See release notes, Decision 222 for details |
| 23/12/2021 | 1.15.0 | Changes arising from Decision 199 (Binding Energy Standards), Decision 162 (Joint Account CX standards), Decision 209 (FAPI 1.0 migration), Decision 216 (OIDC Profile Scope) and Decision 212 (Maintenance Iteration 9 change requests) | See release notes, Decision 199, Decision 162, Decision 209, Decision 212, and Decision 216 for details |
| 29/10/2021 | 1.14.0 | Inclusion of full candidate level standards for the energy sector | See release notes for details |
| 22/10/2021 | 1.13.0 | Changes arising from Decisions 206 (Register Standards), 191 and 192 | See release notes, Decision 206, Decision 191 and Decision 192 for details |
| 14/10/2021 | 1.12.0 | Inclusion of a series of decisions related to energy and non-functional requirements. Changes arising from Decision Proposals 193 and 208. | See release notes for details |
| 05/10/2021 | 1.11.1 | Minor errata and documentation fixes | See release notes for details |
| 30/06/2021 | 1.11.0 | Changes arising from Decision Proposals 160, 187 and maintenance iteration 7 Decision Proposal 178 | See release notes, Decision 160, Decision 187 and Decision 178 for details |
| 01/06/2021 | 1.10.0 | Changes arising from Enhanced Error Handling decision proposals | See release notes and Decision 154 for details |
| 29/04/2021 | 1.9.0 | Changes arising from the sixth Data Standards Maintenance Iteration | See release notes and Decision 161 for details |
| 16/04/2021 | 1.8.0 | CX Standards for Amending Consent | See release notes and Decision 144 for details |
| 10/03/2021 | 1.7.0 | Changes arising from the fifth Banking Maintenance Iteration | See release notes and Decision 159 for details |
| 23/12/2020 | 1.6.0 | DP325 to address urgent community request regarding audience claim for client authentication for data recipients calling data holders | See release notes for details |
| 25/09/2020 | 1.5.1 | Revert 1.5.0 CRN update | See release notes for details |
| 16/09/2020 | 1.5.0 | Second Banking Maintenance Iteration 4 Release (Banking Maintenance Iteration 4 Release) | See release notes for details |
| 12/08/2020 | 1.4.0 | Banking Maintenance Iteration 4 Release (Banking Maintenance Iteration 3 Release) | See release notes for details |
| 22/05/2020 | 1.3.1 | Maintenance updates (May Banking Maintenance Iteration 2 Release) | Error Fixes See release notes for detail |
| 17/04/2020 | 1.3.0 | Minor Update Release (April 1.3.0 Release) | Incorporates maintenance iteration 2 changes along with a number other CX and technical changes See release notes for detail |
| 31/01/2020 | 1.2.0 | Phase 2 Baseline (January 1.2.0 Release) | Baseline version for the Phase 2 implementation of the CDR regime See release notes for detail |
| 20/01/2020 | 1.1.1 | Maintenance updates | Error Fixes See release notes for detail |
| 10/12/2019 | 1.1.0 | Banking Maintenance Iteration 1 Changes | Changes arising from iteration 1 of the banking maintenance cadence. See release notes for detail |
| 12/11/2019 | 1.0.1 | Patch update | Minor defect changes and clarifications. See release notes for detail |
| 30/09/2019 | 1.0.0 | Baseline version 1 (September 1.0.0 Release) | This release is the baseline release for the standards that are intended for implementation February 2020 and contains minor updates as well as changes to align to the locked down CDR Rules and the updated CDR Register design |
| 04/09/2019 | 0.9.6 | Defect fix release (September fixes update) | This release addresses a series of documentation issues and other clarifications as identified via GitHub feedback |
| 15/07/2019 | 0.9.5 | Incorporated May 2019 Feedback (July 2019 Working Draft) | This version incorporates the decisions arising from the consultation feedback obtained on the May 2019 draft of the standards (v0.9.3) |
| 27/06/2019 | 0.9.4 | Documentation and error fixes from May draft |
|
| 29/05/2019 | 0.9.3 | Final updates for May Draft (May 2019 Working Draft) | Addition of Discoverability, InfoSec Profile and minor corrections |
| 28/05/2019 | 0.9.2 | Admin End Points | Added separate swagger/yaml as well as documentation for admin end points |
| 28/05/2019 | 0.9.1 | Modified BankingProductRateTier.maximumValue to optional | Rebuild of docs |
| 28/05/2019 | 0.9.0 | Incorporated Scheduled Payments Decision proposal 51 | Swagger updates and Documentation changes |
| 13/05/2019 | 0.8.4 | InfoSec Update | Imported the InfoSec content without update for recent proposals |
| 12/05/2019 | 0.8.3 | Optionality Update | Clarified the meaning of a field declaration of optional |
| 07/05/2019 | 0.8.2 | Minor fixes | Minor fixes for product category enum |
| 06/04/2019 | 0.8.1 | Negative Rates | Modified RateString to allow for negative rates and not just positive or zero rates |
| 03/04/2019 | 0.8.0 | Accounts and Balances v1 final | Applied changes to prepare for v1 version of Accounts and Balances end points and payloads documentation |
| 27/04/2019 | 0.7.0 | April Feedback | Incorporated feedback from v1 draft decisions and feedback cycle 5 |
| 23/04/2019 | 0.6.0 | Payees & Customer v1 draft | Applied changes to prepare for v1 version of Payees & Customer end points and payloads documentation |
| 16/04/2019 | 0.5.0 | Transaction v1 draft | Applied changes to prepare for v1 version of Transaction end points and payloads documentation |
| 16/04/2019 | 0.4.0 | Direct Debit Auth v1 draft | Applied changes to prepare for v1 version of Direct Debit Authorisations end points and payloads documentation |
| 09/04/2019 | 0.3.0 | Product Reference v1 final | Synchronised standards documentation and swagger with final Decision 054 - Product Reference v1 |
| 11/03/2019 | 0.2.0 | Product Reference v1 draft | Applied changes to prepare for v1 version of Product Reference end points and payloads |
| 22/02/2019 | 0.2.0 | Rate tier name | Addition of a name field for rate tiers |
| 21/02/2019 | 0.2.0 | Rate tiering | Added rate tiering and additional rate types based on community feedback |
| 19/02/2019 | 0.2.0 | Fees and Discounts | Updated product and account fees, discounts and elibilities based on community feedback |
| 19/02/2019 | 0.2.0 | Doc Sync | Synchronised the API documentation with the swagger files |
| 11/02/2019 | 0.2.0 | Consistency Fixes | Fixes to end points for consistency across the standard. Changes as follows:
|
| 04/02/2019 | 0.2.0 | Object Model Names | Updated the swagger json and yaml files to make the object model names consistent |
| 21/12/2018 | 0.2.0 | Transaction payloads | Removed incorrect inclusion of accountId, displayName and nickname for transaction response payloads |
| 20/12/2018 | 0.1.0 | Infosec version 0.1 (Christmas 2018 Working Draft - InfoSec Profile) | Infosec version 0.1 |
| 20/12/2018 | 0.2.0 | Version 0.20 (Christmas 2018 Working Draft - Standards) | Version updated formally to version 0.20 for Christmas Draft |
| 20/12/2018 | 0.1.0 | Updated documentation | Documentation has been automatically generated from the swagger for consistency |
| 20/12/2018 | 0.1.0 | Known issues | Added a section identifying known issues with the standards that are under review |
| 20/12/2018 | 0.1.0 | Cursor based pagination | Added commentary in pagination section on the potential use of cursors |
| 20/12/2018 | 0.1.0 | Minor amendments to response codes | Additional wording to support caching and inserted a cross reference to the error payload section |
| 20/12/2018 | 0.1.0 | Minor amendments to extensibility | Minor wording changes for clarity and included reference to addition of new query parameters |
| 20/12/2018 | 0.1.0 | Unauthenticated end points | Modified URI structure commentary to allow for a different provider path for unauthenticated end points |
| 20/12/2018 | 0.1.0 | Festive spirit | Critical update - added a Santa hat to the logo |
| 20/12/2018 | 0.1.0 | FAPI Headers | Added FAPI specific headers arising from the InfoSec work |
| 19/12/2018 | 0.1.0 | PAFAddress | Added detail for the PAFAddress model based on the Australia Post PAF file format definition |
| 19/12/2018 | 0.1.0 | RateString common type | Changed the RateString type to represent rates such that 100% is represented by the value 1.0 |
| 19/12/2018 | 0.1.0 | URIString common type | Corrected the name of the URIString common type |
| 19/12/2018 | 0.1.0 | Updated swagger files | Swagger files were updated to address feedback. Documentation has not been changed to reflect these changes unless stated. Changes are as follows:
|
| 19/12/2018 | 0.1.0 | Masking rules | Added specificity to the masking guidance for the masked string primitives |
| 18/12/2018 | 0.1.0 | Updated swagger files | Swagger files were updated to address feedback. Documentation has not been changed to reflect these changes unless stated. Changes are as follows:
|
| 18/12/2018 | 0.1.0 | Addition of change log | This change log was added to the standards documentation |
| 02/11/2018 | 0.1.0 | (November 2018 Working Draft) | November 2018 Working Draft |