Consumer Data Standards (Biza.io Edition)
Consumer Data Standards (Biza.io Edition) (1.36.3)
Download OpenAPI specification:Download
This specification mirrors the definitions of the Australian Consumer Data Standards and is intended to deliver the Standards in OpenAPI 3 format with additional data specifications.
Register Data Recipient oAuth Client
Register a client using a CDR Register issued Software Statement Assertion. This endpoint does not require CORS.
Request Body schema: application/jwtrequired
Client Registration Request
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 the CDS (but not this DSB Standards)
Responses
Response samples
- 201
- 400
{- "client_id": "35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a",
- "client_id_issued_at": 1571808167,
- "client_name": "Mock Software",
- "client_description": "A mock software product",
- "legal_entity_id": "344F0E809-BDBE-4F8E-BD30-5E6C3CB78D7B",
- "legal_entity_name": "Mock Company Pty Ltd.",
- "org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
- "org_name": "Mock Company Brand",
- "redirect_uris": [
], - "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": "Software Statement Content",
- "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"
}Get oAuth Client Registration
Get a Client Registration for a given Client ID.
Authorizations:
path Parameters
| clientId required | string The client ID issued by the target Data Holder |
Responses
Response samples
- 200
{- "client_id": "35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a",
- "client_id_issued_at": 1571808167,
- "client_name": "Mock Software",
- "client_description": "A mock software product",
- "legal_entity_id": "344F0E809-BDBE-4F8E-BD30-5E6C3CB78D7B",
- "legal_entity_name": "Mock Company Pty Ltd.",
- "org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
- "org_name": "Mock Company Brand",
- "redirect_uris": [
], - "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": "Software Statement Content",
- "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"
}Update Data Recipient Registration
Update a Client Registration for a given Client ID.
Authorizations:
path Parameters
| clientId required | string The client ID issued by the target Data Holder |
Request Body schema: application/jwtrequired
Client Registration Request
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 the CDS (but not this DSB Standards)
Responses
Response samples
- 200
- 400
{- "client_id": "35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a",
- "client_id_issued_at": 1571808167,
- "client_name": "Mock Software",
- "client_description": "A mock software product",
- "legal_entity_id": "344F0E809-BDBE-4F8E-BD30-5E6C3CB78D7B",
- "legal_entity_name": "Mock Company Pty Ltd.",
- "org_id": "3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8",
- "org_name": "Mock Company Brand",
- "redirect_uris": [
], - "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": "Software Statement Content",
- "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"
}Get 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.
Authorizations:
query Parameters
| period | string Default: "ALL" Enum: "ALL" "CURRENT" "HISTORIC" 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. |
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 406
- 500
- 503
{- "data": {
- "availability": {
- "currentMonth": 1,
- "previousMonths": [
- 1,
- 1,
- 1,
- 0.99,
- 1,
- 1,
- 0.989,
- 0.956,
- 1,
- 1,
- 1,
- 0.99,
- 1,
- 1,
- 1,
- 0.99
]
}, - "averageResponse": {
- "highPriority": {
- "currentDay": 55,
- "previousDays": [
- 55,
- 10.12,
- 40.22,
- 66,
- 22,
- 11,
- 10
]
}, - "largePayload": {
- "currentDay": 55,
- "previousDays": [
- 55,
- 10.12,
- 40.22,
- 66,
- 22,
- 11,
- 10
]
}, - "lowPriority": {
- "currentDay": 55,
- "previousDays": [
- 55,
- 10.12,
- 40.22,
- 66,
- 22,
- 11,
- 10
]
}, - "unattended": {
- "currentDay": 55,
- "previousDays": [
- 55,
- 10.12,
- 40.22,
- 66,
- 22,
- 11,
- 10
]
}, - "unauthenticated": {
- "currentDay": 55,
- "previousDays": [
- 55,
- 10.12,
- 40.22,
- 66,
- 22,
- 11,
- 10
]
}
}, - "averageTps": {
- "currentDay": 5.22,
- "previousDays": [
- 1.22,
- 1.22,
- 0.22,
- 2.22,
- 3.66,
- 4.22,
- 9.22
]
}, - "customerCount": 5,
- "errors": {
- "currentDay": 0,
- "previousDays": [
- 1,
- 4,
- 8,
- 0,
- 0,
- 22,
- 0
]
}, - "invocations": {
- "highPriority": {
- "currentDay": 18833,
- "previousDays": [
- 15293,
- 12834,
- 28218,
- 18234,
- 18293,
- 26534,
- 15367
]
}, - "largePayload": {
- "currentDay": 18833,
- "previousDays": [
- 15293,
- 12834,
- 28218,
- 18234,
- 18293,
- 26534,
- 15367
]
}, - "lowPriority": {
- "currentDay": 18833,
- "previousDays": [
- 15293,
- 12834,
- 28218,
- 18234,
- 18293,
- 26534,
- 15367
]
}, - "unattended": {
- "currentDay": 18833,
- "previousDays": [
- 15293,
- 12834,
- 28218,
- 18234,
- 18293,
- 26534,
- 15367
]
}, - "unauthenticated": {
- "currentDay": 18833,
- "previousDays": [
- 15293,
- 12834,
- 28218,
- 18234,
- 18293,
- 26534,
- 15367
]
}
}, - "peakTps": {
- "currentDay": 11.22,
- "previousDays": [
- 11.22,
- 14.22,
- 8.22,
- 4.22,
- 5.66,
- 9.22,
- 19.22
]
}, - "performance": {
- "currentDay": 1,
- "previousDays": [
- 1,
- 1,
- 0.998,
- 0.99,
- 1,
- 1,
- 0.95
]
}, - "recipientCount": 11,
- "rejections": {
- "currentDay": 235,
- "previousDays": [
- 288,
- 212,
- 145,
- 183,
- 104,
- 234,
- 291
]
}, - "requestTime": "2022-08-20T03:01:42+00:00",
- "sessionCount": {
- "currentDay": 134,
- "previousDays": [
- 123,
- 111,
- 110,
- 100,
- 88,
- 55,
- 33
]
}
}, - "meta": { }
}Metadata Update
Indicate that a critical update to the metadata for Accredited Data Recipients has been made and should be obtained
Authorizations:
header Parameters
| x-v required | string 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 | string 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. |
Request Body schema: application/jsonrequired
Register triggered action to perform
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "action": "REFRESH"
}, - "meta": { }
}Response samples
- 400
- 406
- 500
- 503
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Field/Missing",
- "title": "Missing Required Field",
- "detail": "fieldName missing",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Field/Missing"
}
}
]
}Get Data Holder Brands Summary
Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
header Parameters
| x-v required | string 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 | string 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. |
| If-None-Match | string 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. |
Responses
Response samples
- 200
- 400
- 404
- 406
{- "data": [
- {
- "dataHolderBrandId": "7f72c074-ac4a-4bad-87f7-bd654f89b031",
- "interimId": "2b91c9a4-aa0e-4393-a17f-fe3755828c5c",
- "brandName": "ACME Bank",
- "industries": [
- "banking"
], - "lastUpdated": "2022-08-20T03:01:42+00:00",
- "abn": "string",
- "acn": "string",
- "arbn": "string"
}
], - "meta": { }
}Get Data Holder Statuses
Endpoint used by participants to discover the statuses for Data Holders from the CDR Register
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
header Parameters
| x-v | string Default: 1 The version of the API endpoint requested by the client. Must be set to a positive integer. For backwards compatibility 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 | string 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. |
| If-None-Match | string 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. |
Responses
Response samples
- 200
- 400
- 406
{- "data": [
- {
- "legalEntityId": "533bdca3-a733-4949-abda-f8c5317b7516",
- "status": "ACTIVE"
}
], - "meta": { }
}Get Software Products Statuses
Get Data Recipient Software Products Statuses
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
header Parameters
| x-v required | string 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 | string |
| If-None-Match | string 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. |
Responses
Response samples
- 200
- 400
- 406
{- "softwareProducts": [
- {
- "softwareProductId": "038b1ecc-d645-4d8b-9442-4afe952940e0",
- "softwareProductStatus": "ACTIVE"
}
]
}Get Data Recipients Statuses
Endpoint used by participants to discover the statuses for Data Recipients from the CDR Register.
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
header Parameters
| x-v required | string 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 | string |
| If-None-Match | string 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. |
Responses
Response samples
- 200
- 400
- 406
{- "dataRecipients": [
- {
- "dataRecipientId": "038b1ecc-d645-4d8b-9442-4afe952940e0",
- "dataRecipientStatus": "ACTIVE"
}
]
}Get Data Recipients
Endpoint used by participants to discover data recipients and associated brands and software products, available in the CDR ecosystem.
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
header Parameters
| x-v required | string 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 | string |
| If-None-Match | string 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. |
Responses
Response samples
- 200
- 400
- 406
{- "data": [
- {
- "legalEntityId": "038b1ecc-d645-4d8b-9442-4afe952940e0",
- "legalEntityName": "ACME Recipient",
- "accreditationNumber": "BNK00000102",
- "accreditationLevel": "UNRESTRICTED",
- "dataRecipientBrands": [
- {
- "dataRecipientBrandId": "7f72c074-ac4a-4bad-87f7-bd654f89b031",
- "brandName": "ACME Bank",
- "softwareProducts": [
- {
- "softwareProductId": "038b1ecc-d645-4d8b-9442-4afe952940e0",
- "softwareProductName": "ACME Software Product",
- "softwareProductDescription": "ACME Software Product Description",
- "status": "ACTIVE"
}
], - "status": "ACTIVE"
}
], - "status": "ACTIVE",
- "lastUpdated": "2022-08-20T03:01:42+00:00"
}
], - "meta": { }
}Get Data Holder Brands
Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem.
Authorizations:
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
query Parameters
| updated-since | string <date-time> Only include items that have been updated after the specified date and time. If absent defaults to include all items. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string |
Responses
Response samples
- 200
- 400
- 406
{- "data": [
- {
- "dataHolderBrandId": "7f72c074-ac4a-4bad-87f7-bd654f89b031",
- "brandName": "ACME Bank",
- "industry": "banking",
- "legalEntity": {
- "legalEntityId": "533bdca3-a733-4949-abda-f8c5317b7516",
- "legalEntityName": "ACME Bank Ltd",
- "registrationNumber": "string",
- "registrationDate": "2019-08-24",
- "registeredCountry": "string",
- "abn": "string",
- "acn": "string",
- "arbn": "string",
- "industryCode": "string",
- "organisationType": "SOLE_TRADER"
}, - "status": "ACTIVE",
- "endpointDetail": {
- "version": "1",
}, - "lastUpdated": "2022-08-20T03:01:42+00:00"
}
], - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Software Statement Assertion (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.
Authorizations:
path Parameters
| industry required | string Enum: "banking" "energy" "telco" "all" The industry the participant is retrieving for:
|
| dataRecipientBrandId required | string Unique id for the Accredited Data Recipient Brand that the Software Product is associated with in the CDR Register |
| softwareProductId required | string Unique id for the Accredited Data Recipient Software Product in the CDR Register |
header Parameters
| x-v required | string 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 | string |
Responses
Response samples
- 400
- 403
- 404
- 406
- 422
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:GeneralError/Expected",
- "title": "Expected Error Encountered",
- "detail": "General Expected error occurred",
- "meta": {
- "urn": "string"
}
}
]
}Get 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".
Authorizations:
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 500
- 503
{- "data": {
- "customerUType": "person",
- "organisation": {
- "abn": "string",
- "acn": "string",
- "agentFirstName": "string",
- "agentLastName": "Doe",
- "agentRole": "Unspecified",
- "businessName": "ACME",
- "establishmentDate": "2019-08-24",
- "industryCode": "string",
- "industryCodeVersion": "ANZSIC_1292.0_2006_V2.0",
- "isACNCRegistered": true,
- "lastUpdateTime": "2019-08-24T14:15:22Z",
- "legalName": "string",
- "organisationType": "COMPANY",
- "registeredCountry": "string",
- "shortName": "string"
}, - "person": {
- "firstName": "string",
- "lastName": "Doe",
- "lastUpdateTime": "2019-08-24T14:15:22Z",
- "middleNames": [
- "string"
], - "occupationCode": "string",
- "occupationCodeVersion": "ANZSCO_1220.0_2013_V1.2",
- "prefix": "string",
- "suffix": "string"
}
}, - "meta": { }
}Get Customer Detail
Obtain detailed information on the authorised customer within the current session.
Authorizations:
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 500
- 503
{- "data": {
- "customerUType": "person",
- "organisation": {
- "abn": "string",
- "acn": "string",
- "agentFirstName": "string",
- "agentLastName": "Doe",
- "agentRole": "Unspecified",
- "businessName": "ACME",
- "establishmentDate": "2019-08-24",
- "industryCode": "string",
- "industryCodeVersion": "ANZSIC_1292.0_2006_V2.0",
- "isACNCRegistered": true,
- "lastUpdateTime": "2019-08-24T14:15:22Z",
- "legalName": "string",
- "organisationType": "COMPANY",
- "registeredCountry": "string",
- "shortName": "string",
- "physicalAddresses": [
- {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}, - "purpose": "MAIL"
}
]
}, - "person": {
- "firstName": "string",
- "lastName": "Doe",
- "lastUpdateTime": "2019-08-24T14:15:22Z",
- "middleNames": [
- "string"
], - "occupationCode": "string",
- "occupationCodeVersion": "ANZSCO_1220.0_2013_V1.2",
- "prefix": "string",
- "suffix": "string",
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "isPreferred": true,
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "areaCode": "string",
- "countryCode": "string",
- "extension": "string",
- "fullNumber": "+61439123123",
- "isPreferred": true,
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}, - "purpose": "MAIL"
}
]
}
}, - "meta": { }
}Get Outages
Obtain a list of scheduled outages for the implementation
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 406
- 500
- 503
{- "data": {
- "outages": [
- {
- "duration": "PT2H30M",
- "explanation": "There is an ongoing outage",
- "isPartial": true,
- "outageTime": "2022-08-20T01:55:05Z"
}
]
}, - "meta": { }
}Get Status
Obtain a health check status for the implementation
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 406
- 500
- 503
{- "data": {
- "detectionTime": "2022-08-20T02:23:25Z",
- "expectedResolutionTime": "2022-08-21T02:23:25Z",
- "explanation": "There is an outage we are looking into",
- "status": "OK",
- "updateTime": "2022-08-20T12:23:25Z"
}, - "meta": { }
}Get Accounts
Obtain a list of accounts
Authorizations:
query Parameters
| product-category | string (EnumBankingProductCategoryV2) Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS" Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS 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 | string (EnumAccountOpenStatusWithAllV1) Default: "ALL" Enum: "ALL" "CLOSED" "OPEN" Used to filter results according to open/closed status. Values can be |
| is-owned | boolean Filters accounts based on whether they are owned by the authorised customer. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "accounts": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "creationDate": "2020-03-01",
- "displayName": "ACME Savings Account",
- "isOwned": true,
- "maskedNumber": "XXXX-XXXX-XXXX-1234",
- "nickname": "Holiday Fund",
- "openStatus": "OPEN",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productName": "ACME Savings Maximiser"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Account Detail
Obtain detailed information on a single account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "creationDate": "2020-03-01",
- "displayName": "ACME Savings Account",
- "isOwned": true,
- "maskedNumber": "XXXX-XXXX-XXXX-1234",
- "nickname": "Holiday Fund",
- "openStatus": "OPEN",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productName": "ACME Savings Maximiser",
- "accountNumber": "01231234",
- "addresses": [
- {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}
}
], - "bsb": "999999",
- "bundleName": "Great Bundle Savings",
- "creditCard": {
- "minPaymentAmount": "10.00",
- "paymentCurrency": "AUD",
- "paymentDueAmount": "10.00",
- "paymentDueDate": "2022-05-01"
}, - "depositRate": "0.02",
- "depositRates": [
- {
- "additionalInfo": "A great deposit rate",
- "additionalValue": "Type specific value, see docs",
- "applicationFrequency": "P30D",
- "calculationFrequency": "P1D",
- "depositRateType": "FIXED",
- "rate": "0.011",
- "tiers": [
- {
- "additionalInfo": "string",
- "applicabilityConditions": {
- "additionalInfo": "Package discount is assessed on the package lending balance when you apply for a package.",
}, - "maximumValue": 0,
- "minimumValue": 0.05,
- "name": "Example Rate Tier",
- "rateApplicationMethod": "WHOLE_BALANCE",
- "unitOfMeasure": "DOLLAR"
}
]
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS",
- "isActivated": true
}
], - "fees": [
- {
- "accrualFrequency": "P1D",
- "accruedRate": "0.002",
- "additionalInfo": "Additional Fee Information",
- "additionalValue": "Type specific value, see docs",
- "amount": "10.01",
- "balanceRate": "0.0023",
- "currency": "AUD",
- "discounts": [
- {
- "accruedRate": "0.012",
- "additionalInfo": "Discount Information",
- "additionalValue": "Type specific value, see docs",
- "amount": "11.00",
- "balanceRate": "0.0103",
- "description": "A great discount offer for having multiple accounts with us.",
- "discountType": "BALANCE",
- "eligibility": [
- {
- "additionalInfo": "Eligibility criteria explanation",
- "additionalValue": "Type specific value, see docs",
- "discountEligibilityType": "BUSINESS"
}
], - "feeRate": "0.0124",
- "transactionRate": "0.00234"
}
], - "feeType": "EXIT",
- "name": "Fee Name",
- "transactionRate": "0.0023"
}
], - "lendingRate": "0.02",
- "lendingRates": [
- {
- "additionalInfo": "Owner Occupied with Principal and Interest repayment type",
- "additionalInfoUri": "https://www.bank.com.au/personal/apply-online/download-printed-forms/home-loan-update-002842.pdf",
- "additionalValue": "P1Y",
- "applicationFrequency": "P1M",
- "calculationFrequency": "P1D",
- "comparisonRate": "0.0456",
- "interestPaymentDue": "IN_ARREARS",
- "lendingRateType": "FIXED",
- "loanPurpose": "OWNER_OCCUPIED",
- "rate": "0.0456",
- "repaymentType": "PRINCIPAL_AND_INTEREST",
- "tiers": [
- {
- "additionalInfo": "string",
- "applicabilityConditions": {
- "additionalInfo": "Package discount is assessed on the package lending balance when you apply for a package.",
}, - "maximumValue": 0,
- "minimumValue": 0.05,
- "name": "Example Rate Tier",
- "rateApplicationMethod": "WHOLE_BALANCE",
- "unitOfMeasure": "DOLLAR"
}
]
}
], - "loan": {
- "loanEndDate": "2035-06-01",
- "maxRedraw": "1000.00",
- "maxRedrawCurrency": "AUD",
- "minInstalmentAmount": "122.22",
- "minInstalmentCurrency": "AUD",
- "minRedraw": "500.00",
- "minRedrawCurrency": "AUD",
- "nextInstalmentDate": "2022-10-02",
- "offsetAccountEnabled": false,
- "offsetAccountIds": [
- "string"
], - "originalLoanAmount": "526000.00",
- "originalLoanCurrency": "AUD",
- "originalStartDate": "2021-06-01",
- "repaymentFrequency": "P1M",
- "repaymentType": "PRINCIPAL_AND_INTEREST"
}, - "specificAccountUType": "loan",
- "termDeposit": [
- {
- "lodgementDate": "2022-01-01",
- "maturityAmount": "string",
- "maturityCurrency": "string",
- "maturityDate": "2024-01-01",
- "maturityInstructions": "PAID_OUT_AT_MATURITY"
}
]
}, - "meta": { }
}Get Bulk Balances
Obtain balances for multiple, filtered accounts
Authorizations:
query Parameters
| product-category | string (EnumBankingProductCategoryV2) Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS" Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS 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 | string (EnumAccountOpenStatusWithAllV1) Default: "ALL" Enum: "ALL" "CLOSED" "OPEN" Used to filter results according to open/closed status. Values can be |
| is-owned | boolean Filters accounts based on whether they are owned by the authorised customer. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Balances For Specific Banking Accounts
Obtain balances for a specified list of accounts.
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Accounts to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "accountIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Account Balance
Obtain the balance for a single specified account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}, - "meta": { }
}Get Bulk Direct Debits
Obtain direct debit authorisations for multiple, filtered accounts
Authorizations:
query Parameters
| product-category | string (EnumBankingProductCategoryV2) Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS" Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS 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 | string (EnumAccountOpenStatusWithAllV1) Default: "ALL" Enum: "ALL" "CLOSED" "OPEN" Used to filter results according to open/closed status. Values can be |
| is-owned | boolean Filters accounts based on whether they are owned by the authorised customer. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "directDebitAuthorisations": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "authorisedEntity": {
- "abn": "54 624 797 655",
- "acn": "624 797 655",
- "arbn": "000 000 123",
- "description": "Biza Pty Ltd",
- "financialInstitution": "ACME Bank"
}, - "lastDebitAmount": "10.00",
- "lastDebitDateTime": "2007-05-01T15:43:00.12345Z"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Direct Debits For Specific Accounts
Obtain direct debit authorisations for a specified list of accounts
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Accounts to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "accountIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "directDebitAuthorisations": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "authorisedEntity": {
- "abn": "54 624 797 655",
- "acn": "624 797 655",
- "arbn": "000 000 123",
- "description": "Biza Pty Ltd",
- "financialInstitution": "ACME Bank"
}, - "lastDebitAmount": "10.00",
- "lastDebitDateTime": "2007-05-01T15:43:00.12345Z"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Direct Debits For Account
Obtain direct debit authorisations for a specific account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "directDebitAuthorisations": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "authorisedEntity": {
- "abn": "54 624 797 655",
- "acn": "624 797 655",
- "arbn": "000 000 123",
- "description": "Biza Pty Ltd",
- "financialInstitution": "ACME Bank"
}, - "lastDebitAmount": "10.00",
- "lastDebitDateTime": "2007-05-01T15:43:00.12345Z"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Instalment Plans Bulk
Obtain the active and/or inactive instalment plans across all accounts the customer has authorised access to. The plans returned MUST be ordered according to plan creationDate in descending order.
Data Holders MAY respond with 404 Resource Not Implemented if instalment plans are not applicable to any account types they support.
Authorizations:
query Parameters
| plan-status | string (EnumBankingInstalmentPlanStatusV1) Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" "ALL" Used to filter results on the status field. Values can be |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "plans": [
- {
- "accountId": "string",
- "planId": "5ce4408d-3a6c-4d2c-b51a-cebde6b21e4e",
- "planReference": "ORD-998832",
- "merchantName": "ACME Retail",
- "merchantCategoryCode": "5311",
- "planNickname": "New TV",
- "creationDate": "2026-11-15",
- "amount": "100.00",
- "planCurrency": "AUD",
- "planCharge": "5.00",
- "planRate": "0.10",
- "duration": "P6W",
- "instalmentInterval": "P2W",
- "schedule": [
- {
- "amountDue": "25.00",
- "dueDate": "2026-12-15",
- "isPaid": false
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Instalment Plans for Account
Obtain the active and/or inactive instalment plans for a specific account. The plans returned MUST be ordered according to plan creationDate in descending order.
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
query Parameters
| plan-status | string (EnumBankingInstalmentPlanStatusV1) Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" "ALL" Used to filter results on the status field. Values can be |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "plans": [
- {
- "accountId": "string",
- "planId": "5ce4408d-3a6c-4d2c-b51a-cebde6b21e4e",
- "planReference": "ORD-998832",
- "merchantName": "ACME Retail",
- "merchantCategoryCode": "5311",
- "planNickname": "New TV",
- "creationDate": "2026-11-15",
- "amount": "100.00",
- "planCurrency": "AUD",
- "planCharge": "5.00",
- "planRate": "0.10",
- "duration": "P6W",
- "instalmentInterval": "P2W",
- "schedule": [
- {
- "amountDue": "25.00",
- "dueDate": "2026-12-15",
- "isPaid": false
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Payees
Obtain a list of pre-registered payees
Authorizations:
query Parameters
| type | string Default: "ALL" Enum: "ALL" "BILLER" "DIGITAL_WALLET" "DOMESTIC" "INTERNATIONAL" Filter on the payee type field. In addition to normal type field values, |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "payees": [
- {
- "creationDate": "2007-05-01",
- "description": "Joe's Flowers",
- "nickname": "Friendly Joe",
- "payeeId": "abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz",
- "type": "BILLER"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Payee Detail
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
Authorizations:
path Parameters
| payeeId required | string The ID used to locate the details of a particular payee. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "creationDate": "2007-05-01",
- "description": "Joe's Flowers",
- "nickname": "Friendly Joe",
- "payeeId": "abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz",
- "type": "BILLER",
- "biller": {
- "billerCode": "12345",
- "billerName": "BPAY Electricity Co",
- "crn": "XXXXXXXXXXXX1234"
}, - "digitalWallet": {
- "name": "My Digital Wallet",
- "identifier": "user@digital.wallet.com",
- "type": "EMAIL",
- "provider": "OTHER"
}, - "domestic": {
- "account": {
- "accountName": "Woolie Jumpers Shop",
- "accountNumber": "1234123423",
- "bsb": "123-123"
}, - "card": {
- "cardNumber": "XXXX-XXXX-XXXX-1234"
}, - "payId": {
- "identifier": "hello@biza.io",
- "name": "Biza Pty Ltd",
- "type": "EMAIL"
}, - "payeeAccountUType": "payId"
}, - "international": {
- "bankDetails": {
- "accountNumber": "12341234",
- "bankAddress": {
- "address": "100 Wiltock Place, London, GB",
- "name": "ACME Bank"
}, - "beneficiaryBankBIC": "ACMEAUSYHOM",
- "chipNumber": "12341234",
- "country": "AUS",
- "fedWireNumber": "12939281",
- "legalEntityIdentifier": "549300TGFLH2QZV80T70",
- "routingNumber": "18281828",
- "sortCode": "01"
}, - "beneficiaryDetails": {
- "country": "AUS",
- "message": "Payment Received",
- "name": "Woolie Jumpers International"
}
}, - "payeeUType": "biller"
}, - "meta": { }
}Get 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 the MAX_LIMIT constraint 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.
query Parameters
| effective | string (EnumEffectiveWithAllV1) Default: "CURRENT" Enum: "ALL" "CURRENT" "FUTURE" Example: effective=CURRENT Allows for the filtering of results 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 | string <date-time> Only include items that have been updated after the specified date and time. If absent defaults to include all items. |
| brand | string Filter results based on a specific brand. If absent defaults to include all plans. |
| product-category | string (EnumBankingProductCategoryV2) Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS" Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS 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 | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "products": [
- {
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "name": "Example Product",
- "description": "An amazing example product",
- "brand": "ACME",
- "brandName": "string",
- "isTailored": true,
- "additionalInformation": {
- "additionalOverviewUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalTermsUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalEligibilityUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalFeesAndPricingUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalBundleUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
]
}, - "cardArt": [
- {
- "cardScheme": "OTHER",
- "cardType": "DEBIT",
- "title": "string",
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Product Detail
Obtain detailed information on a single product offered openly to the market.
path Parameters
| productId required | string ID of the specific product requested |
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 404
- 406
- 500
- 503
{- "data": {
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "name": "Example Product",
- "description": "An amazing example product",
- "brand": "ACME",
- "brandName": "string",
- "brandGroup": "string",
- "isTailored": true,
- "additionalInformation": {
- "additionalOverviewUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalTermsUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalEligibilityUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalFeesAndPricingUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
], - "additionalBundleUris": [
- {
- "description": "Additional Product Information can be found at ACME Bank website",
}
]
}, - "cardArt": [
- {
- "cardScheme": "OTHER",
- "cardType": "DEBIT",
- "title": "string",
}
], - "bundles": [
- {
- "additionalInfo": "A great bundle with all the extras",
- "description": "Provides a savings account and loan",
- "name": "ACME Super Bundle",
- "productIds": [
- "string"
]
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS"
}
], - "constraints": [
- {
- "additionalInfo": "Some information about the constraint",
- "additionalValue": "Type specific value, see documentation",
- "constraintType": "MIN_BALANCE"
}
], - "eligibility": [
- {
- "additionalInfo": "Eligibility Criteria",
- "additionalValue": "Type dependent value, see docs",
- "eligibilityType": "MIN_TURNOVER"
}
], - "fees": [
- {
- "name": "Special fee",
- "feeType": "CASH_ADVANCE",
- "feeMethodUType": "rateBased",
- "fixedAmount": {
- "amount": "10.00"
}, - "rateBased": {
- "rateType": "BALANCE",
- "rate": "0.05",
- "accrualFrequency": "string",
- "amountRange": {
- "feeMinimum": "string",
- "feeMaximum": "string"
}
}, - "variable": {
- "feeMinimum": "string",
- "feeMaximum": "string"
}, - "feeCap": "string",
- "feeCapPeriod": "string",
- "currency": "AUD",
- "additionalValue": "string",
- "additionalInfo": "string",
- "discounts": [
- {
- "description": "Christmas special discount",
- "discountType": "PAYMENTS",
- "discountMethodUType": "fixedAmount",
- "fixedAmount": {
- "amount": "10.00"
}, - "rateBased": {
- "rateType": "FEE",
- "rate": "0.05",
- "amountRange": {
- "discountMinimum": "string",
- "discountMaximum": "string"
}
}, - "additionalValue": "string",
- "additionalInfo": "string",
- "eligibility": [
- {
- "additionalInfo": "Eligibility criteria explanation",
- "additionalValue": "Type specific value, see docs",
- "discountEligibilityType": "BUSINESS"
}
]
}
]
}
], - "depositRates": [
- {
- "depositRateType": "FIXED",
- "rate": "0.05",
- "calculationFrequency": "string",
- "applicationType": "PERIODIC",
- "applicationFrequency": "string",
- "tiers": [
- {
- "name": "Sample display name",
- "unitOfMeasure": "DAY",
- "minimumValue": "10",
- "maximumValue": "string",
- "rateApplicationMethod": "PER_TIER",
- "applicabilityConditions": [
- {
- "rateApplicabilityType": "NEW_CUSTOMER",
- "additionalValue": "string",
- "additionalInfo": "string",
}
], - "additionalInfo": "string",
}
], - "applicabilityConditions": [
- {
- "rateApplicabilityType": "NEW_CUSTOMER",
- "additionalValue": "string",
- "additionalInfo": "string",
}
], - "additionalValue": "string",
- "additionalInfo": "string",
}
], - "lendingRates": [
- {
- "lendingRateType": "FIXED",
- "rate": "0.05",
- "comparisonRate": "string",
- "calculationFrequency": "string",
- "applicationType": "PERIODIC",
- "applicationFrequency": "string",
- "interestPaymentDue": "IN_ADVANCE",
- "repaymentType": "INTEREST_ONLY",
- "loanPurpose": "INVESTMENT",
- "tiers": [
- {
- "name": "Sample display name",
- "unitOfMeasure": "DAY",
- "minimumValue": "10",
- "maximumValue": "string",
- "rateApplicationMethod": "PER_TIER",
- "applicabilityConditions": [
- {
- "rateApplicabilityType": "NEW_CUSTOMER",
- "additionalValue": "string",
- "additionalInfo": "string",
}
], - "additionalInfo": "string",
}
], - "applicabilityConditions": [
- {
- "rateApplicabilityType": "NEW_CUSTOMER",
- "additionalValue": "string",
- "additionalInfo": "string",
}
], - "additionalValue": "string",
- "additionalInfo": "string",
}
], - "instalments": {
- "maximumConcurrentPlans": 0,
- "instalmentsLimit": "string",
- "minimumPlanValue": "string",
- "maximumPlanValue": "string",
- "minimumSplit": 4,
- "maximumSplit": 4
}
}, - "meta": { }
}Get Scheduled Payments for Account
Obtain scheduled, outgoing payments for a specific account.
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "scheduledPayments": [
- {
- "from": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay"
}, - "nickname": "string",
- "payeeReference": "string",
- "payerReference": "Football Membership Fees",
- "paymentSet": [
- {
- "amount": "151.33",
- "currency": "string",
- "isAmountCalculated": true,
- "to": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "biller": {
- "billerCode": "12345",
- "billerName": "BPAY Electricity Co",
- "crn": "XXXXXXXXXXXX1234"
}, - "domestic": {
- "account": {
- "accountName": "Woolie Jumpers Shop",
- "accountNumber": "1234123423",
- "bsb": "123-123"
}, - "card": {
- "cardNumber": "XXXX-XXXX-XXXX-1234"
}, - "payId": {
- "identifier": "hello@biza.io",
- "name": "Biza Pty Ltd",
- "type": "EMAIL"
}, - "payeeAccountUType": "payId"
}, - "international": {
- "bankDetails": {
- "accountNumber": "12341234",
- "bankAddress": {
- "address": null,
- "name": null
}, - "beneficiaryBankBIC": "ACMEAUSYHOM",
- "chipNumber": "12341234",
- "country": "AUS",
- "fedWireNumber": "12939281",
- "legalEntityIdentifier": "549300TGFLH2QZV80T70",
- "routingNumber": "18281828",
- "sortCode": "01"
}, - "beneficiaryDetails": {
- "country": "AUS",
- "message": "Payment Received",
- "name": "Woolie Jumpers International"
}
}, - "payeeId": "8a0e108e03d1b05f049d4bd4f612e314517bb967fa907b76029e17b6f42d2131",
- "nickname": "John Doe",
- "payeeReference": "Dinner Payback",
- "toUType": "domestic"
}
}
], - "recurrence": {
- "eventBased": {
- "description": "Overdraw Charge"
}, - "intervalSchedule": {
- "finalPaymentDate": "2023-05-01",
- "intervals": [
- {
- "dayInInterval": "P1D",
- "interval": "P5D"
}
], - "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "lastWeekDay": {
- "finalPaymentDate": "2023-05-01",
- "interval": "P1D",
- "lastWeekDay": "MON",
- "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "nextPaymentDate": "2022-09-13",
- "onceOff": {
- "paymentDate": "2022-08-11"
}, - "recurrenceUType": "intervalSchedule"
}, - "scheduledPaymentId": "50accd7daeeccf2e8245dc46b549aa68def146049c82c17bc4ab53f74d5586b1",
- "status": "ACTIVE"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Scheduled Payments Bulk
Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
Authorizations:
query Parameters
| product-category | string (EnumBankingProductCategoryV2) Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS" Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS 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 | string (EnumAccountOpenStatusWithAllV1) Default: "ALL" Enum: "ALL" "CLOSED" "OPEN" Used to filter results according to open/closed status. Values can be |
| is-owned | boolean Filters accounts based on whether they are owned by the authorised customer. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "scheduledPayments": [
- {
- "from": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay"
}, - "nickname": "string",
- "payeeReference": "string",
- "payerReference": "Football Membership Fees",
- "paymentSet": [
- {
- "amount": "151.33",
- "currency": "string",
- "isAmountCalculated": true,
- "to": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "biller": {
- "billerCode": "12345",
- "billerName": "BPAY Electricity Co",
- "crn": "XXXXXXXXXXXX1234"
}, - "domestic": {
- "account": {
- "accountName": "Woolie Jumpers Shop",
- "accountNumber": "1234123423",
- "bsb": "123-123"
}, - "card": {
- "cardNumber": "XXXX-XXXX-XXXX-1234"
}, - "payId": {
- "identifier": "hello@biza.io",
- "name": "Biza Pty Ltd",
- "type": "EMAIL"
}, - "payeeAccountUType": "payId"
}, - "international": {
- "bankDetails": {
- "accountNumber": "12341234",
- "bankAddress": {
- "address": null,
- "name": null
}, - "beneficiaryBankBIC": "ACMEAUSYHOM",
- "chipNumber": "12341234",
- "country": "AUS",
- "fedWireNumber": "12939281",
- "legalEntityIdentifier": "549300TGFLH2QZV80T70",
- "routingNumber": "18281828",
- "sortCode": "01"
}, - "beneficiaryDetails": {
- "country": "AUS",
- "message": "Payment Received",
- "name": "Woolie Jumpers International"
}
}, - "payeeId": "8a0e108e03d1b05f049d4bd4f612e314517bb967fa907b76029e17b6f42d2131",
- "nickname": "John Doe",
- "payeeReference": "Dinner Payback",
- "toUType": "domestic"
}
}
], - "recurrence": {
- "eventBased": {
- "description": "Overdraw Charge"
}, - "intervalSchedule": {
- "finalPaymentDate": "2023-05-01",
- "intervals": [
- {
- "dayInInterval": "P1D",
- "interval": "P5D"
}
], - "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "lastWeekDay": {
- "finalPaymentDate": "2023-05-01",
- "interval": "P1D",
- "lastWeekDay": "MON",
- "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "nextPaymentDate": "2022-09-13",
- "onceOff": {
- "paymentDate": "2022-08-11"
}, - "recurrenceUType": "intervalSchedule"
}, - "scheduledPaymentId": "50accd7daeeccf2e8245dc46b549aa68def146049c82c17bc4ab53f74d5586b1",
- "status": "ACTIVE"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Scheduled Payments For Specific Accounts
Obtain scheduled payments for a specified list of accounts.
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Accounts to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "accountIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "scheduledPayments": [
- {
- "from": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay"
}, - "nickname": "string",
- "payeeReference": "string",
- "payerReference": "Football Membership Fees",
- "paymentSet": [
- {
- "amount": "151.33",
- "currency": "string",
- "isAmountCalculated": true,
- "to": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "biller": {
- "billerCode": "12345",
- "billerName": "BPAY Electricity Co",
- "crn": "XXXXXXXXXXXX1234"
}, - "domestic": {
- "account": {
- "accountName": "Woolie Jumpers Shop",
- "accountNumber": "1234123423",
- "bsb": "123-123"
}, - "card": {
- "cardNumber": "XXXX-XXXX-XXXX-1234"
}, - "payId": {
- "identifier": "hello@biza.io",
- "name": "Biza Pty Ltd",
- "type": "EMAIL"
}, - "payeeAccountUType": "payId"
}, - "international": {
- "bankDetails": {
- "accountNumber": "12341234",
- "bankAddress": {
- "address": null,
- "name": null
}, - "beneficiaryBankBIC": "ACMEAUSYHOM",
- "chipNumber": "12341234",
- "country": "AUS",
- "fedWireNumber": "12939281",
- "legalEntityIdentifier": "549300TGFLH2QZV80T70",
- "routingNumber": "18281828",
- "sortCode": "01"
}, - "beneficiaryDetails": {
- "country": "AUS",
- "message": "Payment Received",
- "name": "Woolie Jumpers International"
}
}, - "payeeId": "8a0e108e03d1b05f049d4bd4f612e314517bb967fa907b76029e17b6f42d2131",
- "nickname": "John Doe",
- "payeeReference": "Dinner Payback",
- "toUType": "domestic"
}
}
], - "recurrence": {
- "eventBased": {
- "description": "Overdraw Charge"
}, - "intervalSchedule": {
- "finalPaymentDate": "2023-05-01",
- "intervals": [
- {
- "dayInInterval": "P1D",
- "interval": "P5D"
}
], - "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "lastWeekDay": {
- "finalPaymentDate": "2023-05-01",
- "interval": "P1D",
- "lastWeekDay": "MON",
- "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "nextPaymentDate": "2022-09-13",
- "onceOff": {
- "paymentDate": "2022-08-11"
}, - "recurrenceUType": "intervalSchedule"
}, - "scheduledPaymentId": "50accd7daeeccf2e8245dc46b549aa68def146049c82c17bc4ab53f74d5586b1",
- "status": "ACTIVE"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Transactions For Account
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 (ie. 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
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
query Parameters
| oldest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type. If absent defaults to the following dependent on call:
|
| newest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type. |
| min-amount | string Filter transactions to only transactions with amounts higher than or equal to this amount. |
| max-amount | string Filter transactions to only transactions with amounts less than or equal to this amount. |
| text | string 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 |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "transactions": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "amount": "133.55",
- "apcaNumber": "484799",
- "billerCode": "75556",
- "billerName": "TAX OFFICE PAYMENTS",
- "crn": "1234123412341",
- "currency": "AUD",
- "description": "Outbound payment to ATO",
- "executionDateTime": "2022-03-03T03:03:03.3Z",
- "isDetailAvailable": true,
- "merchantCategoryCode": "5200",
- "merchantName": "Freedom Furniture",
- "postingDateTime": "2022-03-03T03:03:03.3Z",
- "reference": "Payment for Services",
- "status": "POSTED",
- "transactionId": "8cce04fbcc0fe8307e8c221b5ae497691935a368e98f5478610c60ca4ef81caf",
- "type": "PAYMENT",
- "valueDateTime": "2022-03-13T03:03:03.3Z"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 10,
- "isQueryParamUnsupported": true
}
}Get Transaction Detail
Obtain detailed information on a transaction for a specific account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
| transactionId required | string ID of the transaction obtained from a previous call to one of the other transaction endpoints. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "amount": "133.55",
- "apcaNumber": "484799",
- "billerCode": "75556",
- "billerName": "TAX OFFICE PAYMENTS",
- "crn": "1234123412341",
- "currency": "AUD",
- "description": "Outbound payment to ATO",
- "executionDateTime": "2022-03-03T03:03:03.3Z",
- "isDetailAvailable": true,
- "merchantCategoryCode": "5200",
- "merchantName": "Freedom Furniture",
- "postingDateTime": "2022-03-03T03:03:03.3Z",
- "reference": "Payment for Services",
- "status": "POSTED",
- "transactionId": "8cce04fbcc0fe8307e8c221b5ae497691935a368e98f5478610c60ca4ef81caf",
- "type": "PAYMENT",
- "valueDateTime": "2022-03-13T03:03:03.3Z",
- "extendedData": {
- "extensionUType": "x2p101Payload",
- "payee": "string",
- "payer": "string",
- "service": "X2P1.01",
- "x2p101Payload": {
- "endToEndId": "string",
- "extendedDescription": "An extended string description.",
- "purposeCode": "string"
}
}
}, - "meta": { }
}Get Energy Accounts
Obtain the list of energy accounts available under the authorised consent
Authorizations:
query Parameters
| open-status | string (EnumAccountOpenStatusWithAllV1) Default: "ALL" Enum: "ALL" "CLOSED" "OPEN" Used to filter results according to open/closed status. Values can be |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "accounts": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "accountNumber": "28326662",
- "displayName": "My Home Energy",
- "openStatus": "OPEN",
- "creationDate": "2021-08-03",
- "plans": [
- {
- "nickname": "Solar Saver Plan",
- "servicePointIds": [
- "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa"
], - "planOverview": {
- "displayName": "Solar Saver",
- "startDate": "2021-01-01",
- "endDate": "2023-07-01"
}
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Energy Account Detail
Obtain detailed information for a specific energy account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "accountNumber": "28326662",
- "displayName": "My Home Energy",
- "openStatus": "OPEN",
- "creationDate": "2021-08-03",
- "plans": [
- {
- "nickname": "Solar Saver",
- "servicePointIds": [
- "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa"
], - "planOverview": {
- "displayName": "Solar Saver",
- "startDate": "2021-01-01",
- "endDate": "2023-07-01"
}, - "planDetail": {
- "fuelType": "ELECTRICITY",
- "isContingentPlan": false,
- "meteringCharges": [
- {
- "displayName": "Base Metering Charge",
- "description": "A metering charge applied to all bills",
- "minimumValue": "1.00",
- "maximumValue": "15.00",
- "period": "P1M"
}
], - "gasContract": {
- "additionalFeeInformation": "Additional Solar Feed In Fee",
- "pricingModel": "SINGLE_RATE",
- "timeZone": "AEST",
- "isFixed": true,
- "variation": "Price Variations possible by calling support center",
- "onExpiryDescription": "On expiry of the contract the price will revert to the spot price at any given time",
- "paymentOption": [
- "CREDIT_CARD"
], - "intrinsicGreenPower": {
- "greenPercentage": "0.95"
}, - "controlledLoad": [
- {
- "displayName": "Electric hot water system",
- "rateBlockUType": "singleRate",
- "startDate": "2021-10-23",
- "endDate": "2022-04-30",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "string",
- "dailySupplyCharge": "string",
- "rates": [
- null
]
}, - "timeOfUseRates": [
- {
- "displayName": null,
- "description": null,
- "dailySupplyCharge": null,
- "rates": [ ],
- "timeOfUse": [ ],
- "type": null
}
]
}
], - "incentives": [
- {
- "displayName": "Pay Early Discount",
- "description": "Pay Early and Receive a 5% Discount",
- "category": "ACCOUNT_CREDIT",
- "eligibility": "Pay by the due date and you will be credited 5% off your next bill"
}
], - "discounts": [
- {
- "displayName": "Pensioner Discount",
- "description": "Provide Pensioner card and you will receive a 15% discount",
- "type": "CONDITIONAL",
- "category": "GUARANTEED_DISCOUNT",
- "endDate": "2023-01-01",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": "0.05"
}, - "percentOfUse": {
- "rate": "0.05"
}, - "fixedAmount": {
- "amount": "15.00"
}, - "percentOverThreshold": {
- "rate": "0.05",
- "usageAmount": "1.15"
}
}
], - "greenPowerCharges": [
- {
- "displayName": "Green Power Surcharge",
- "description": "A surcharge applied for saving the planet",
- "scheme": "GREENPOWER",
- "type": "FIXED_PER_DAY",
- "tiers": [
- {
- "percentGreen": null,
- "rate": null,
- "amount": null
}
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "Eligibility restrictions apply for this restriction",
- "description": "Must be a remote property"
}
], - "fees": [
- {
- "type": "ESTABLISHMENT",
- "term": "FIXED",
- "amount": "1.55",
- "rate": "0.10",
- "description": "Initial Setup Charge"
}
], - "solarFeedInTariff": [
- {
- "displayName": "Solar Feed In Tariff",
- "description": "A base charge for feeding back into the grid",
- "scheme": "PREMIUM",
- "payerType": "RETAILER",
- "tariffUType": "singleTariff",
- "singleTariff": {
- "amount": "0.05"
}, - "timeVaryingTariffs": {
- "type": "PEAK",
- "amount": "0.13",
- "timeVariations": [
- { }
]
}
}
], - "tariffPeriod": [
- {
- "type": "OTHER",
- "displayName": "Plan Tariff",
- "startDate": "08-01",
- "endDate": "12-01",
- "dailySupplyCharges": "1.00",
- "timeZone": "AEST",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "A single universal rate",
- "generalUnitPrice": "0.12",
- "rates": [
- null
], - "period": "PT2H30M"
}, - "timeOfUseRates": [
- {
- "displayName": null,
- "description": null,
- "rates": [ ],
- "timeOfUse": [ ],
- "type": null
}
], - "demandCharges": [
- {
- "displayName": null,
- "description": null,
- "amount": null,
- "measureUnit": null,
- "startTime": null,
- "endTime": null,
- "days": [ ],
- "minDemand": null,
- "maxDemand": null,
- "measurementPeriod": null,
- "chargePeriod": null
}
]
}
]
}, - "electricityContract": {
- "additionalFeeInformation": "Additional Solar Feed In Fee",
- "pricingModel": "SINGLE_RATE",
- "timeZone": "AEST",
- "isFixed": true,
- "variation": "Price Variations possible by calling support center",
- "onExpiryDescription": "On expiry of the contract the price will revert to the spot price at any given time",
- "paymentOption": [
- "CREDIT_CARD"
], - "intrinsicGreenPower": {
- "greenPercentage": "0.95"
}, - "controlledLoad": [
- {
- "displayName": "Electric hot water system",
- "rateBlockUType": "singleRate",
- "startDate": "2021-10-23",
- "endDate": "2022-04-30",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "string",
- "dailySupplyCharge": "string",
- "rates": [
- null
]
}, - "timeOfUseRates": [
- {
- "displayName": null,
- "description": null,
- "dailySupplyCharge": null,
- "rates": [ ],
- "timeOfUse": [ ],
- "type": null
}
]
}
], - "incentives": [
- {
- "displayName": "Pay Early Discount",
- "description": "Pay Early and Receive a 5% Discount",
- "category": "ACCOUNT_CREDIT",
- "eligibility": "Pay by the due date and you will be credited 5% off your next bill"
}
], - "discounts": [
- {
- "displayName": "Pensioner Discount",
- "description": "Provide Pensioner card and you will receive a 15% discount",
- "type": "CONDITIONAL",
- "category": "GUARANTEED_DISCOUNT",
- "endDate": "2023-01-01",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": "0.05"
}, - "percentOfUse": {
- "rate": "0.05"
}, - "fixedAmount": {
- "amount": "15.00"
}, - "percentOverThreshold": {
- "rate": "0.05",
- "usageAmount": "1.15"
}
}
], - "greenPowerCharges": [
- {
- "displayName": "Green Power Surcharge",
- "description": "A surcharge applied for saving the planet",
- "scheme": "GREENPOWER",
- "type": "FIXED_PER_DAY",
- "tiers": [
- {
- "percentGreen": null,
- "rate": null,
- "amount": null
}
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "Eligibility restrictions apply for this restriction",
- "description": "Must be a remote property"
}
], - "fees": [
- {
- "type": "ESTABLISHMENT",
- "term": "FIXED",
- "amount": "1.55",
- "rate": "0.10",
- "description": "Initial Setup Charge"
}
], - "solarFeedInTariff": [
- {
- "displayName": "Solar Feed In Tariff",
- "description": "A base charge for feeding back into the grid",
- "scheme": "PREMIUM",
- "payerType": "RETAILER",
- "tariffUType": "singleTariff",
- "singleTariff": {
- "amount": "0.05"
}, - "timeVaryingTariffs": {
- "type": "PEAK",
- "amount": "0.13",
- "timeVariations": [
- { }
]
}
}
], - "tariffPeriod": [
- {
- "type": "OTHER",
- "displayName": "Plan Tariff",
- "startDate": "08-01",
- "endDate": "12-01",
- "dailySupplyCharges": "1.00",
- "timeZone": "AEST",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "A single universal rate",
- "generalUnitPrice": "0.12",
- "rates": [
- null
], - "period": "PT2H30M"
}, - "timeOfUseRates": [
- {
- "displayName": null,
- "description": null,
- "rates": [ ],
- "timeOfUse": [ ],
- "type": null
}
], - "demandCharges": [
- {
- "displayName": null,
- "description": null,
- "amount": null,
- "measureUnit": null,
- "startTime": null,
- "endTime": null,
- "days": [ ],
- "minDemand": null,
- "maxDemand": null,
- "measurementPeriod": null,
- "chargePeriod": null
}
]
}
]
}
}, - "authorisedContacts": [
- {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [
- "Jefferey"
], - "prefix": "Mr.",
- "suffix": "Sr."
}
]
}
]
}, - "meta": { }
}Get Energy Account Concessions
Obtain the details of any concessions or arrangements applied to a specific energy account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "concessions": [
- {
- "type": "FIXED_AMOUNT",
- "displayName": "Pensioner Discount",
- "additionalInfo": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "discountFrequency": "string",
- "amount": "67.39",
- "percentage": "0.05",
- "appliedTo": [
- "INVOICE"
]
}
]
}, - "meta": { }
}Get Balance For Energy Account
Obtain the current balance for a specific energy account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "balance": "11.55"
}, - "meta": { }
}Get Bulk Balances for Energy
Obtain the current balance for all energy accounts
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Balances For Specific Energy Accounts
Obtain the current balances for a specified list of energy accounts
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Accounts to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "accountIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get DER For Electricity Service Point
Obtain a list of DER data from a particular service point
Authorizations:
path Parameters
| servicePointId required | string 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. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "approvedCapacity": 100,
- "availablePhasesCount": 3,
- "installedPhasesCount": 3,
- "islandableInstallation": true,
- "hasCentralProtectionControl": true,
- "protectionMode": {
- "exportLimitKva": 50,
- "underFrequencyProtection": 65,
- "underFrequencyProtectionDelay": 0.05,
- "overFrequencyProtection": 70,
- "overFrequencyProtectionDelay": 3,
- "underVoltageProtection": 210,
- "underVoltageProtectionDelay": 0.23,
- "overVoltageProtection": 260,
- "overVoltageProtectionDelay": 0.22,
- "sustainedOverVoltage": 255,
- "sustainedOverVoltageDelay": 1.55,
- "frequencyRateOfChange": 5,
- "voltageVectorShift": 90,
- "interTripScheme": "From local subscription",
- "neutralVoltageDisplacement": 105
}, - "acConnections": [
- {
- "connectionIdentifier": 19283,
- "count": 3,
- "equipmentType": "INVERTER",
- "manufacturerName": "APC Power Inverter",
- "inverterSeries": "INV3000",
- "inverterModelNumber": "3000",
- "commissioningDate": "2022-08-01",
- "status": "ACTIVE",
- "inverterDeviceCapacity": 100,
- "derDevices": [
- {
- "deviceIdentifier": 2927816,
- "count": 3,
- "manufacturer": "APC",
- "modelNumber": "3000",
- "status": "ACTIVE",
- "type": "RENEWABLE",
- "subtype": "OTHER",
- "nominalRatedCapacity": 50,
- "nominalStorageCapacity": 25
}
]
}
]
}, - "meta": { }
}Get Bulk DER
Obtain DER data for all service points associated with the customer
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "derRecords": [
- {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "approvedCapacity": 100,
- "availablePhasesCount": 3,
- "installedPhasesCount": 3,
- "islandableInstallation": true,
- "hasCentralProtectionControl": true,
- "protectionMode": {
- "exportLimitKva": 50,
- "underFrequencyProtection": 65,
- "underFrequencyProtectionDelay": 0.05,
- "overFrequencyProtection": 70,
- "overFrequencyProtectionDelay": 3,
- "underVoltageProtection": 210,
- "underVoltageProtectionDelay": 0.23,
- "overVoltageProtection": 260,
- "overVoltageProtectionDelay": 0.22,
- "sustainedOverVoltage": 255,
- "sustainedOverVoltageDelay": 1.55,
- "frequencyRateOfChange": 5,
- "voltageVectorShift": 90,
- "interTripScheme": "From local subscription",
- "neutralVoltageDisplacement": 105
}, - "acConnections": [
- {
- "connectionIdentifier": 19283,
- "count": 3,
- "equipmentType": "INVERTER",
- "manufacturerName": "APC Power Inverter",
- "inverterSeries": "INV3000",
- "inverterModelNumber": "3000",
- "commissioningDate": "2022-08-01",
- "status": "ACTIVE",
- "inverterDeviceCapacity": 100,
- "derDevices": [
- {
- "deviceIdentifier": 2927816,
- "count": 3,
- "manufacturer": "APC",
- "modelNumber": "3000",
- "status": "ACTIVE",
- "type": "RENEWABLE",
- "subtype": "OTHER",
- "nominalRatedCapacity": 50,
- "nominalStorageCapacity": 25
}
]
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get DER For Specific Service Points
Obtain DER data for a specific set of service points
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Service Points to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "servicePointIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "derRecords": [
- {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "approvedCapacity": 100,
- "availablePhasesCount": 3,
- "installedPhasesCount": 3,
- "islandableInstallation": true,
- "hasCentralProtectionControl": true,
- "protectionMode": {
- "exportLimitKva": 50,
- "underFrequencyProtection": 65,
- "underFrequencyProtectionDelay": 0.05,
- "overFrequencyProtection": 70,
- "overFrequencyProtectionDelay": 3,
- "underVoltageProtection": 210,
- "underVoltageProtectionDelay": 0.23,
- "overVoltageProtection": 260,
- "overVoltageProtectionDelay": 0.22,
- "sustainedOverVoltage": 255,
- "sustainedOverVoltageDelay": 1.55,
- "frequencyRateOfChange": 5,
- "voltageVectorShift": 90,
- "interTripScheme": "From local subscription",
- "neutralVoltageDisplacement": 105
}, - "acConnections": [
- {
- "connectionIdentifier": 19283,
- "count": 3,
- "equipmentType": "INVERTER",
- "manufacturerName": "APC Power Inverter",
- "inverterSeries": "INV3000",
- "inverterModelNumber": "3000",
- "commissioningDate": "2022-08-01",
- "status": "ACTIVE",
- "inverterDeviceCapacity": 100,
- "derDevices": [
- {
- "deviceIdentifier": 2927816,
- "count": 3,
- "manufacturer": "APC",
- "modelNumber": "3000",
- "status": "ACTIVE",
- "type": "RENEWABLE",
- "subtype": "OTHER",
- "nominalRatedCapacity": 50,
- "nominalStorageCapacity": 25
}
]
}
]
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Energy Account 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
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "paymentSchedules": [
- {
- "amount": "string",
- "paymentScheduleUType": "manualPayment",
- "cardDebit": {
- "cardScheme": "VISA",
- "paymentFrequency": "P3M",
- "calculationType": "CALCULATED"
}, - "directDebit": {
- "isTokenised": true,
- "bsb": "string",
- "accountNumber": "string",
- "paymentFrequency": "P3M",
- "calculationType": "CALCULATED"
}, - "digitalWallet": {
- "name": "My Digital Wallet",
- "identifier": "user@digital.wallet.com",
- "type": "EMAIL",
- "provider": "OTHER",
- "paymentFrequency": "P3M",
- "calculationType": "CALCULATED"
}, - "manualPayment": {
- "billFrequency": "P3M"
}
}
]
}, - "meta": { }
}Get Energy Account Invoices
Obtain the invoices for a specific account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
query Parameters
| oldest-date | string <date> 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 |
| newest-date | string <date> 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 |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "invoices": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "invoiceNumber": "109818233",
- "issueDate": "2022-08-01",
- "dueDate": "2022-09-01",
- "period": {
- "startDate": "2022-01-01",
- "endDate": "2022-06-30"
}, - "invoiceAmount": "22.00",
- "gstAmount": "20.00",
- "payOnTimeDiscount": {
- "discountAmount": "5.00",
- "gstAmount": "0.50",
- "date": "2022-07-15"
}, - "balanceAtIssue": "10.00",
- "servicePoints": [
- "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa"
], - "gas": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "electricity": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "accountCharges": {
- "totalCharges": "15.00",
- "totalDiscounts": "10.00",
- "totalGst": "1.36"
}, - "paymentStatus": "NOT_PAID"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Bulk Invoices
Obtain the invoices for all accounts
Authorizations:
query Parameters
| oldest-date | string <date> 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 |
| newest-date | string <date> 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 |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "invoices": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "invoiceNumber": "109818233",
- "issueDate": "2022-08-01",
- "dueDate": "2022-09-01",
- "period": {
- "startDate": "2022-01-01",
- "endDate": "2022-06-30"
}, - "invoiceAmount": "22.00",
- "gstAmount": "20.00",
- "payOnTimeDiscount": {
- "discountAmount": "5.00",
- "gstAmount": "0.50",
- "date": "2022-07-15"
}, - "balanceAtIssue": "10.00",
- "servicePoints": [
- "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa"
], - "gas": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "electricity": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "accountCharges": {
- "totalCharges": "15.00",
- "totalDiscounts": "10.00",
- "totalGst": "1.36"
}, - "paymentStatus": "NOT_PAID"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Invoices For Specific Energy Accounts
Obtain invoices for a specified set of energy accounts
Authorizations:
query Parameters
| oldest-date | string <date> 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 |
| newest-date | string <date> 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 |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Accounts to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "accountIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "invoices": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "invoiceNumber": "109818233",
- "issueDate": "2022-08-01",
- "dueDate": "2022-09-01",
- "period": {
- "startDate": "2022-01-01",
- "endDate": "2022-06-30"
}, - "invoiceAmount": "22.00",
- "gstAmount": "20.00",
- "payOnTimeDiscount": {
- "discountAmount": "5.00",
- "gstAmount": "0.50",
- "date": "2022-07-15"
}, - "balanceAtIssue": "10.00",
- "servicePoints": [
- "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa"
], - "gas": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "electricity": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "accountCharges": {
- "totalCharges": "15.00",
- "totalDiscounts": "10.00",
- "totalGst": "1.36"
}, - "paymentStatus": "NOT_PAID"
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Billing for Energy Account
Obtain the billing transactions for a specific account
Authorizations:
path Parameters
| accountId required | string ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint. |
query Parameters
| oldest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type. If absent defaults to the following dependent on call:
|
| newest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "transactions": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "executionDateTime": "2022-08-20T03:01:42+00:00",
- "gst": "string",
- "transactionUType": "onceOff",
- "usage": {
- "servicePointId": "string",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": false,
- "startDate": "2022-08-20T03:01:42+00:00",
- "endDate": "2022-09-20T03:01:42+00:00",
- "measureUnit": "KWH",
- "usage": 1.55,
- "amount": "1.56",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "demand": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": true,
- "startDate": "2022-07-20T03:01:42+00:00",
- "endDate": "2022-08-20T03:01:42+00:00",
- "rate": 0.044,
- "amount": "10.00",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "onceOff": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "amount": "10.00",
- "description": "Once Off Setup Charge"
}, - "otherCharges": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "type": "OTHER",
- "amount": "14.55",
- "description": "Miscellaneous Supply Charge",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "payment": {
- "amount": "1.00",
- "method": "CARD"
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Bulk Billing
Obtain billing transactions for all accounts
Authorizations:
query Parameters
| oldest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type. If absent defaults to the following dependent on call:
|
| newest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "transactions": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "executionDateTime": "2022-08-20T03:01:42+00:00",
- "gst": "string",
- "transactionUType": "onceOff",
- "usage": {
- "servicePointId": "string",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": false,
- "startDate": "2022-08-20T03:01:42+00:00",
- "endDate": "2022-09-20T03:01:42+00:00",
- "measureUnit": "KWH",
- "usage": 1.55,
- "amount": "1.56",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "demand": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": true,
- "startDate": "2022-07-20T03:01:42+00:00",
- "endDate": "2022-08-20T03:01:42+00:00",
- "rate": 0.044,
- "amount": "10.00",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "onceOff": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "amount": "10.00",
- "description": "Once Off Setup Charge"
}, - "otherCharges": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "type": "OTHER",
- "amount": "14.55",
- "description": "Miscellaneous Supply Charge",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "payment": {
- "amount": "1.00",
- "method": "CARD"
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Billing for Specific Energy Accounts
Obtain billing for a specified set of accounts
Authorizations:
query Parameters
| oldest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type. If absent defaults to the following dependent on call:
|
| newest-time | string <date-time> Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Accounts to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "accountIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "transactions": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "executionDateTime": "2022-08-20T03:01:42+00:00",
- "gst": "string",
- "transactionUType": "onceOff",
- "usage": {
- "servicePointId": "string",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": false,
- "startDate": "2022-08-20T03:01:42+00:00",
- "endDate": "2022-09-20T03:01:42+00:00",
- "measureUnit": "KWH",
- "usage": 1.55,
- "amount": "1.56",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "demand": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": true,
- "startDate": "2022-07-20T03:01:42+00:00",
- "endDate": "2022-08-20T03:01:42+00:00",
- "rate": 0.044,
- "amount": "10.00",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "onceOff": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "amount": "10.00",
- "description": "Once Off Setup Charge"
}, - "otherCharges": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "type": "OTHER",
- "amount": "14.55",
- "description": "Miscellaneous Supply Charge",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "payment": {
- "amount": "1.00",
- "method": "CARD"
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}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.
query Parameters
| type | string (EnumEnergyPlanTypeWithAllV1) Default: "ALL" Enum: "STANDING" "MARKET" "REGULATED" "ALL" Example: type=ALL 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 | string (EnumEnergyFuelTypeWithAllV1) Default: "ALL" Enum: "ELECTRICITY" "GAS" "DUAL" "ALL" Example: fuelType=ALL 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 | string (EnumEffectiveWithAllV1) Default: "CURRENT" Enum: "ALL" "CURRENT" "FUTURE" Example: effective=CURRENT Allows for the filtering of results 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 | string <date-time> Only include items that have been updated after the specified date and time. If absent defaults to include all items. |
| brand | string Filter results based on a specific brand. If absent defaults to include all plans. |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "plans": [
- {
- "planId": "69ee7c8ed6ffc658c84cfe84ac4780795a8c76fed8d166e4385636649035512e",
- "effectiveFrom": "2021-08-20T01:55:05Z",
- "effectiveTo": "2022-08-20T01:55:05Z",
- "lastUpdated": "2022-05-20T01:55:05.12Z",
- "displayName": "Solar Saver",
- "description": "An Energy Plan for those using solar panels",
- "type": "STANDING",
- "fuelType": "ELECTRICITY",
- "brand": "ACME",
- "brandName": "ACME Energy",
- "additionalInformation": {
}, - "customerType": "RESIDENTIAL",
- "geography": {
- "excludedPostcodes": [
- "string"
], - "includedPostcodes": [
- "string"
], - "distributors": [
- "string"
]
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Energy Plan detail
Obtain detailed information on a single energy plan offered openly to the market
path Parameters
| planId required | string ID of the specific plan requested |
header Parameters
| x-v required | string 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 | string 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. |
Responses
Response samples
- 200
- 400
- 404
- 406
- 500
- 503
{- "data": {
- "planId": "69ee7c8ed6ffc658c84cfe84ac4780795a8c76fed8d166e4385636649035512e",
- "effectiveFrom": "2021-08-20T01:55:05Z",
- "effectiveTo": "2022-08-20T01:55:05Z",
- "lastUpdated": "2022-05-20T01:55:05.12Z",
- "displayName": "Solar Saver",
- "description": "An Energy Plan for those using solar panels",
- "type": "STANDING",
- "fuelType": "ELECTRICITY",
- "brand": "ACME",
- "brandName": "ACME Energy",
- "additionalInformation": {
}, - "customerType": "RESIDENTIAL",
- "geography": {
- "excludedPostcodes": [
- "string"
], - "includedPostcodes": [
- "string"
], - "distributors": [
- "string"
]
}, - "meteringCharges": [
- {
- "displayName": "Base Metering Charge",
- "description": "A metering charge applied to all bills",
- "minimumValue": "1.00",
- "maximumValue": "15.00",
- "period": "P1M"
}
], - "gasContract": {
- "additionalFeeInformation": "Additional Solar Feed In Fee",
- "pricingModel": "SINGLE_RATE",
- "timeZone": "AEST",
- "isFixed": true,
- "variation": "Price Variations possible by calling support center",
- "onExpiryDescription": "On expiry of the contract the price will revert to the spot price at any given time",
- "paymentOption": [
- "CREDIT_CARD"
], - "intrinsicGreenPower": {
- "greenPercentage": "0.95"
}, - "controlledLoad": [
- {
- "displayName": "Electric hot water system",
- "rateBlockUType": "singleRate",
- "startDate": "2021-10-23",
- "endDate": "2022-04-30",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "string",
- "dailySupplyCharge": "string",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
]
}, - "timeOfUseRates": [
- {
- "displayName": "Time of use charge applied",
- "description": "string",
- "dailySupplyCharge": "string",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
], - "timeOfUse": [
- {
- "days": [
- "PUBLIC_HOLIDAYS"
], - "startTime": "17:00:00.000+10:00",
- "endTime": "20:59:59.999+10:00",
- "additionalInfo": "string",
}
], - "type": "PEAK"
}
]
}
], - "incentives": [
- {
- "displayName": "Pay Early Discount",
- "description": "Pay Early and Receive a 5% Discount",
- "category": "ACCOUNT_CREDIT",
- "eligibility": "Pay by the due date and you will be credited 5% off your next bill"
}
], - "discounts": [
- {
- "displayName": "Pensioner Discount",
- "description": "Provide Pensioner card and you will receive a 15% discount",
- "type": "CONDITIONAL",
- "category": "GUARANTEED_DISCOUNT",
- "endDate": "2023-01-01",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": "0.05"
}, - "percentOfUse": {
- "rate": "0.05"
}, - "fixedAmount": {
- "amount": "15.00"
}, - "percentOverThreshold": {
- "rate": "0.05",
- "usageAmount": "1.15"
}
}
], - "greenPowerCharges": [
- {
- "displayName": "Green Power Surcharge",
- "description": "A surcharge applied for saving the planet",
- "scheme": "GREENPOWER",
- "type": "FIXED_PER_DAY",
- "tiers": [
- {
- "percentGreen": "0.90",
- "rate": "0.345",
- "amount": "10.00"
}
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "Eligibility restrictions apply for this restriction",
- "description": "Must be a remote property"
}
], - "fees": [
- {
- "type": "ESTABLISHMENT",
- "term": "FIXED",
- "amount": "1.55",
- "rate": "0.10",
- "description": "Initial Setup Charge"
}
], - "solarFeedInTariff": [
- {
- "displayName": "Solar Feed In Tariff",
- "description": "A base charge for feeding back into the grid",
- "scheme": "PREMIUM",
- "payerType": "RETAILER",
- "tariffUType": "singleTariff",
- "singleTariff": {
- "amount": "0.05"
}, - "timeVaryingTariffs": {
- "type": "PEAK",
- "amount": "0.13",
- "timeVariations": [
- {
- "days": [
- "MON"
], - "startTime": "12:00",
- "endTime": "23:00"
}
]
}
}
], - "tariffPeriod": [
- {
- "type": "OTHER",
- "displayName": "Plan Tariff",
- "startDate": "08-01",
- "endDate": "12-01",
- "dailySupplyCharges": "1.00",
- "timeZone": "AEST",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "A single universal rate",
- "generalUnitPrice": "0.12",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
], - "period": "PT2H30M"
}, - "timeOfUseRates": [
- {
- "displayName": "Time of use charge applied",
- "description": "Rate applied based on the time the energy is used",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
], - "timeOfUse": [
- {
- "days": [
- "MON",
- "TUE",
- "WED",
- "THU",
- "FRI"
], - "startTime": "17:00:00.000+10:00",
- "endTime": "20:59:59.999+10:00"
}
], - "type": "PEAK"
}
], - "demandCharges": [
- {
- "displayName": "Demand Charge",
- "description": "A tariff applied based on the level of demand",
- "amount": "0.2444",
- "measureUnit": "KWH",
- "startTime": "06:45:00Z",
- "endTime": "21:45:00Z",
- "days": [
- "MON"
], - "minDemand": "0.00",
- "maxDemand": "15.00",
- "measurementPeriod": "DAY",
- "chargePeriod": "DAY"
}
]
}
], - "termType": "ONGOING",
- "benefitPeriod": "10% Discount for ongoing contract",
- "terms": "12 Month Initial Contract",
- "meterTypes": [
- "string"
], - "coolingOffDays": 14,
- "billFrequency": [
- "P1M",
- "P3M"
]
}, - "electricityContract": {
- "additionalFeeInformation": "Additional Solar Feed In Fee",
- "pricingModel": "SINGLE_RATE",
- "timeZone": "AEST",
- "isFixed": true,
- "variation": "Price Variations possible by calling support center",
- "onExpiryDescription": "On expiry of the contract the price will revert to the spot price at any given time",
- "paymentOption": [
- "CREDIT_CARD"
], - "intrinsicGreenPower": {
- "greenPercentage": "0.95"
}, - "controlledLoad": [
- {
- "displayName": "Electric hot water system",
- "rateBlockUType": "singleRate",
- "startDate": "2021-10-23",
- "endDate": "2022-04-30",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "string",
- "dailySupplyCharge": "string",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
]
}, - "timeOfUseRates": [
- {
- "displayName": "Time of use charge applied",
- "description": "string",
- "dailySupplyCharge": "string",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
], - "timeOfUse": [
- {
- "days": [
- "PUBLIC_HOLIDAYS"
], - "startTime": "17:00:00.000+10:00",
- "endTime": "20:59:59.999+10:00",
- "additionalInfo": "string",
}
], - "type": "PEAK"
}
]
}
], - "incentives": [
- {
- "displayName": "Pay Early Discount",
- "description": "Pay Early and Receive a 5% Discount",
- "category": "ACCOUNT_CREDIT",
- "eligibility": "Pay by the due date and you will be credited 5% off your next bill"
}
], - "discounts": [
- {
- "displayName": "Pensioner Discount",
- "description": "Provide Pensioner card and you will receive a 15% discount",
- "type": "CONDITIONAL",
- "category": "GUARANTEED_DISCOUNT",
- "endDate": "2023-01-01",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": "0.05"
}, - "percentOfUse": {
- "rate": "0.05"
}, - "fixedAmount": {
- "amount": "15.00"
}, - "percentOverThreshold": {
- "rate": "0.05",
- "usageAmount": "1.15"
}
}
], - "greenPowerCharges": [
- {
- "displayName": "Green Power Surcharge",
- "description": "A surcharge applied for saving the planet",
- "scheme": "GREENPOWER",
- "type": "FIXED_PER_DAY",
- "tiers": [
- {
- "percentGreen": "0.90",
- "rate": "0.345",
- "amount": "10.00"
}
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "Eligibility restrictions apply for this restriction",
- "description": "Must be a remote property"
}
], - "fees": [
- {
- "type": "ESTABLISHMENT",
- "term": "FIXED",
- "amount": "1.55",
- "rate": "0.10",
- "description": "Initial Setup Charge"
}
], - "solarFeedInTariff": [
- {
- "displayName": "Solar Feed In Tariff",
- "description": "A base charge for feeding back into the grid",
- "scheme": "PREMIUM",
- "payerType": "RETAILER",
- "tariffUType": "singleTariff",
- "singleTariff": {
- "amount": "0.05"
}, - "timeVaryingTariffs": {
- "type": "PEAK",
- "amount": "0.13",
- "timeVariations": [
- {
- "days": [
- "MON"
], - "startTime": "12:00",
- "endTime": "23:00"
}
]
}
}
], - "tariffPeriod": [
- {
- "type": "OTHER",
- "displayName": "Plan Tariff",
- "startDate": "08-01",
- "endDate": "12-01",
- "dailySupplyCharges": "1.00",
- "timeZone": "AEST",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": "Single Rate Charge",
- "description": "A single universal rate",
- "generalUnitPrice": "0.12",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
], - "period": "PT2H30M"
}, - "timeOfUseRates": [
- {
- "displayName": "Time of use charge applied",
- "description": "Rate applied based on the time the energy is used",
- "rates": [
- {
- "unitPrice": "0.044",
- "measureUnit": "KWH",
- "volume": 145
}
], - "timeOfUse": [
- {
- "days": [
- "MON",
- "TUE",
- "WED",
- "THU",
- "FRI"
], - "startTime": "17:00:00.000+10:00",
- "endTime": "20:59:59.999+10:00"
}
], - "type": "PEAK"
}
], - "demandCharges": [
- {
- "displayName": "Demand Charge",
- "description": "A tariff applied based on the level of demand",
- "amount": "0.2444",
- "measureUnit": "KWH",
- "startTime": "06:45:00Z",
- "endTime": "21:45:00Z",
- "days": [
- "MON"
], - "minDemand": "0.00",
- "maxDemand": "15.00",
- "measurementPeriod": "DAY",
- "chargePeriod": "DAY"
}
]
}
], - "termType": "ONGOING",
- "benefitPeriod": "10% Discount for ongoing contract",
- "terms": "12 Month Initial Contract",
- "meterTypes": [
- "string"
], - "coolingOffDays": 14,
- "billFrequency": [
- "P1M",
- "P3M"
]
}
}, - "meta": { }
}Get Electricity Service Points
Obtain a list of service points owned by the customer that has authorised the current session
Authorizations:
query Parameters
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "servicePoints": [
- {
- "servicePointId": "217c06338290152ff6b1fb2bbafea8e02cc8ac2e0e2807c5d3200222e24230e3",
- "nationalMeteringId": "4567123487",
- "servicePointClassification": "GENERATOR",
- "servicePointStatus": "ACTIVE",
- "jurisdictionCode": "QLD",
- "isGenerator": false,
- "validFromDate": "2022-08-01",
- "lastUpdateDateTime": "2022-05-20T02:23:25Z",
- "consumerProfile": {
- "classification": "RESIDENTIAL",
- "threshold": "LOW"
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Electricity Service Point Detail
Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session
Authorizations:
path Parameters
| servicePointId required | string 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. |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 500
- 503
{- "data": {
- "servicePointId": "217c06338290152ff6b1fb2bbafea8e02cc8ac2e0e2807c5d3200222e24230e3",
- "nationalMeteringId": "4567123487",
- "servicePointClassification": "GENERATOR",
- "servicePointStatus": "ACTIVE",
- "jurisdictionCode": "QLD",
- "isGenerator": false,
- "validFromDate": "2022-08-01",
- "lastUpdateDateTime": "2022-05-20T02:23:25Z",
- "consumerProfile": {
- "classification": "RESIDENTIAL",
- "threshold": "LOW"
}, - "distributionLossFactor": {
- "code": "A",
- "description": "Distribution Loss Factor A",
- "lossValue": "1.23"
}, - "relatedParticipants": [
- {
- "party": "Origin Energy",
- "role": "FRMP"
}
], - "location": {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}
}, - "meters": [
- {
- "meterId": "4b5e3fc483dc79ca7b831a8ebaa10c4a6abc761d0417ed2fbda5c1cf936d82da",
- "specifications": {
- "status": "CURRENT",
- "installationType": "BASIC",
- "manufacturer": "APC",
- "model": "APC Metering Device",
- "readType": "string",
- "nextScheduledReadDate": "2023-01-04"
}, - "registers": [
- {
- "registerId": "0100",
- "registerSuffix": "A",
- "averagedDailyLoad": 23.23,
- "registerConsumptionType": "INTERVAL",
- "networkTariffCode": "P",
- "unitOfMeasure": "KWH",
- "timeOfDay": "ALLDAY",
- "multiplier": 1,
- "controlledLoad": true,
- "consumptionType": "ACTUAL"
}
]
}
]
}, - "meta": { }
}Get Usage For Electricity Service Point
Obtain a list of electricity usage data from a particular service point
Authorizations:
path Parameters
| servicePointId required | string 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. |
query Parameters
| oldest-date | string <date> 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 | string <date> 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 | string (EnumElectricityMeterReadIntervalReadTypeV1) Default: "NONE" Enum: "NONE" "MIN_30" "FULL" Example: interval-reads=NONE Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "data": {
- "reads": [
- {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "registerId": "0100",
- "registerSuffix": "P",
- "meterId": "29821234",
- "controlledLoad": true,
- "readStartDate": "2022-06-19",
- "readEndDate": "2022-06-20",
- "unitOfMeasure": "KWH",
- "readUType": "basicRead",
- "basicRead": {
- "quality": "ACTUAL",
- "value": 14.23
}, - "intervalRead": {
- "readIntervalLength": 15,
- "aggregateValue": 150,
- "intervalReads": [
- 0
], - "readQualities": [
- {
- "startInterval": 1,
- "endInterval": 5,
- "quality": "SUBSTITUTE"
}
]
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Bulk Service Point Usage
Obtain usage data for all service points associated with the customer
Authorizations:
query Parameters
| interval-reads | string (EnumElectricityMeterReadIntervalReadTypeV1) Default: "NONE" Enum: "NONE" "MIN_30" "FULL" Example: interval-reads=NONE Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| oldest-date | string <date> 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 | string <date> 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 | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Responses
Response samples
- 200
- 400
- 403
- 406
- 422
- 500
- 503
{- "data": {
- "reads": [
- {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "registerId": "0100",
- "registerSuffix": "P",
- "meterId": "29821234",
- "controlledLoad": true,
- "readStartDate": "2022-06-19",
- "readEndDate": "2022-06-20",
- "unitOfMeasure": "KWH",
- "readUType": "basicRead",
- "basicRead": {
- "quality": "ACTUAL",
- "value": 14.23
}, - "intervalRead": {
- "readIntervalLength": 15,
- "aggregateValue": 150,
- "intervalReads": [
- 0
], - "readQualities": [
- {
- "startInterval": 1,
- "endInterval": 5,
- "quality": "SUBSTITUTE"
}
]
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Get Usage For Specific Service Points
Obtain the electricity usage data for a specific set of service points
Authorizations:
query Parameters
| oldest-date | string <date> 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 | string <date> 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 | string (EnumElectricityMeterReadIntervalReadTypeV1) Default: "NONE" Enum: "NONE" "MIN_30" "FULL" Example: interval-reads=NONE Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE |
| page | integer >= 1 Default: 1 Page of results to request (standard pagination). |
| page-size | integer >= 1 Default: 25 Page size to request. Default is 25 (standard pagination). |
header Parameters
| x-v required | string 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 | string 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 | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-fapi-auth-date | string Example: Thu, 16 Jan 2020 16:50:15 GMT 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 | string Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 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 | string Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY= 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. |
Request Body schema: application/jsonrequired
Request payload containing list of specific Service Points to obtain data for
required | object |
| meta | object |
Responses
Request samples
- Payload
{- "data": {
- "servicePointIds": [
- "string"
]
}, - "meta": { }
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "data": {
- "reads": [
- {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "registerId": "0100",
- "registerSuffix": "P",
- "meterId": "29821234",
- "controlledLoad": true,
- "readStartDate": "2022-06-19",
- "readEndDate": "2022-06-20",
- "unitOfMeasure": "KWH",
- "readUType": "basicRead",
- "basicRead": {
- "quality": "ACTUAL",
- "value": 14.23
}, - "intervalRead": {
- "readIntervalLength": 15,
- "aggregateValue": 150,
- "intervalReads": [
- 0
], - "readQualities": [
- {
- "startInterval": 1,
- "endInterval": 5,
- "quality": "SUBSTITUTE"
}
]
}
}
]
}, - "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}