Open Gateway API
- 2.1.0
- 2.0.1
- 1.36.0
Biza OG API (OpenAPI Client) (2.1.0)
Download OpenAPI specification:Download
This is the OpenAPI specification for the Open Gateway
List Agreements
Retrieve a list of agreements
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
query Parameters
| agreementStatus | Array of strings (EnumAgreementCDRSharingStatusV1) Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED" Example: agreementStatus=ACTIVE Filter the agreements by these statuses |
| revision | string (EnumRevisionTypeV1) Enum: "LATEST" "ACTIVATED" Example: revision=LATEST When there are multiple revisions, only return the most current |
| CDRArrangementId | string Unique identifier, shared amongst all revisions of a CDR Sharing arrangement |
| 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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "agreements": [
- {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
]
}
}Get Agreement Detail
Obtain information about a specific agreement
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Terminate an Agreement
Initiates an agreement termination. As agreements can be many different types this has various meanings. For CDR Sharing Arrangements this triggers the revocation action from the Data Recipient to the Data Holder.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
Responses
Response samples
- 200
- 400
- 403
- 500
{- "version": "V1",
- "data": {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Get Agreement History
Obtain historical information about a specific agreement
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| agreementStatus | Array of strings (EnumAgreementCDRSharingStatusV1) Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED" Example: agreementStatus=ACTIVE Filter the agreements by these statuses |
| revision | string (EnumRevisionTypeV1) Enum: "LATEST" "ACTIVATED" Example: revision=LATEST When there are multiple revisions, only return the most current |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "agreements": [
- {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
]
}
}List Agreement Templates
Retrieve a list of agreement templates
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "templates": [
- {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "description": "Template for basic data sharing",
- "collection_scopes": [
- "bank:accounts.basic:read",
- "bank:accounts.basic:read"
], - "require_all_scopes": true,
- "collection_durations": [
- "P1D"
], - "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
- "use_durations": [
- "P1D"
], - "use_purpose": "To allow for the testing of data holder CDR sharing API's",
- "direct_marketing_shown": true,
- "data_handling_default": "DEIDENTIFY",
- "active": true,
- "data_holder_industry": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}
]
}
}Create an Agreement Template
Create a new Agreement Template
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 |
Request Body schema: application/jsonrequired
Request payload for creating a new agreement template
| version required | string Payload Version |
| description required | string Meaningful agreement template description that explains the purpose of the template, but not shown to consumers. |
| collection_scopes required | Array of strings Mandatory scopes you required from a consumer. |
| collection_durations required | Array of strings (EnumAgreementTemplateDuration) Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M" |
| collection_purpose required | string Describes the purpose behind collection. |
| use_durations required | Array of strings (EnumAgreementTemplateDuration) Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M" |
| use_purpose required | string Describes how/for what the data collected will be used. |
| direct_marketing_shown | boolean Default: true Should the marketing consent be asked for. |
| allowed_redirect_uris required | Array of strings List of valid software product hosts. |
| data_handling_default required | string Enum: "DEIDENTIFY" "DELETE" A default option for how this software product handles redundant data. This still allows for the user to change how they want the software product to handle redundant data. |
| agreementEndCallbackUrl required | string Default: "" The POST URL webhook that will be called to post data deletion request with a jwt payload |
| data_holder_industry | Array of strings (EnumParticipantCapabilityV1) Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" |
Responses
Request samples
- Payload
{- "version": "V1",
- "description": "Template for basic data sharing",
- "collection_scopes": [
- "bank:accounts.basic:read",
- "bank:accounts.basic:read"
], - "collection_durations": [
- "P1D"
], - "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
- "use_durations": [
- "P1D"
], - "use_purpose": "To allow for the testing of data holder CDR sharing API's",
- "direct_marketing_shown": true,
- "data_handling_default": "DEIDENTIFY",
- "data_holder_industry": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}Response samples
- 200
- 400
- 500
- 503
{- "id": "53e14d6c-1af4-4dc3-bd7a-18e7cccc5034"
}Delete an Agreement Template
Deletes an agreement template with a given id
Authorizations:
path Parameters
| id required | string <uuid> Unique Agreement Template Identifier |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Responses
Response samples
- 400
- 500
- 503
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Field/Invalid",
- "title": "Invalid Field",
- "detail": "Invalid format supplied for fieldName",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Field/Invalid"
}
}
]
}Prime a CDR Sharing Arrangement (V1)
Prime a CDR Sharing Agreement
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
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 |
Request Body schema: application/json
Request payload for a priming a CDR Sharing agreement
| version required | string Payload Version |
required | object (AgreementPrimeCDRSharingRequestV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "userId": "8c63744e-6507-477c-8002-ae1fb9a190de",
- "name": "Joe Blogs",
- "email": "joeblogs@gmail.com",
- "principalId": "4a28de94-52e9-4a5d-ad91-ae93916cadfb",
- "agreementId": "d5a4a443-cae7-4319-97ed-dc92bc20c66d",
- "templateId": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "state": "string",
- "participantIds": [
- "string"
]
}
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V1",
- "data": {
- "agreementId": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
}
}Get Accounts
Obtain a list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V2",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accounts": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "creationDate": "2020-03-01",
- "displayName": "ACME Savings Account",
- "isOwned": true,
- "accountOwnership": "UNKNOWN",
- "maskedNumber": "XXXX-XXXX-XXXX-1234",
- "nickname": "Holiday Fund",
- "openStatus": "OPEN",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productName": "ACME Savings Maximiser"
}
]
}
}Get Account Detail
Obtain detailed information on a single account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V3",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "creationDate": "2020-03-01",
- "displayName": "ACME Savings Account",
- "isOwned": true,
- "accountOwnership": "UNKNOWN",
- "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"
}
]
}
}Get Account Balance
Obtain the balance for a single specified account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
}Get Scheduled Payments for Account
Obtain scheduled, outgoing payments for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Direct Debits For Account
Obtain direct debit authorisations for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Transactions For Account
Obtain transactions for a specific account. Some general notes that apply to all end points 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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 10,
- "isQueryParamUnsupported": true
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Transaction Detail
Obtain detailed information on a transaction for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
}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.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
}Get Payees
Obtain a list of pre-registered payees
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "payees": [
- {
- "creationDate": "2007-05-01",
- "description": "Joe's Flowers",
- "nickname": "Friendly Joe",
- "payeeId": "abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz",
- "type": "BILLER"
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}, - "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"
}
}Get Scheduled Payments Bulk
Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Scheduled Payments For Specific Accounts
Obtain scheduled payments for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Direct Debits
Obtain direct debit authorisations for multiple, filtered accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Direct Debits For Specific Accounts
Obtain direct debit authorisations for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Balances
Obtain balances for multiple, filtered accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}
}Get Balances For Specific Banking Accounts
Obtain balances for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}
}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:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
}Get Customer Detail
Obtain detailed information on the authorised customer within the current session.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
}Get Energy Accounts
Obtain the list of energy accounts available under the authorised consent
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V2",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
]
}
}Get Energy Account Detail
Obtain detailed information for a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V2",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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."
}
]
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Energy Account Concessions
Obtain the details of any concessions or arrangements applied to a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
]
}
]
}
}Get Balance For Energy Account
Obtain the current balance for a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balance": "11.55"
}
}Get Billing for Energy Account
Obtain the billing transactions for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Energy Account Invoices
Obtain the invoices for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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 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
- 404
- 406
- 422
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Invoices
Obtain the invoices for all accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Invoices For Specific Energy Accounts
Obtain invoices for a specified set of energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Billing
Obtain billing transactions for all accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Billing for Specific Energy Accounts
Obtain billing for a specified set of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Bulk Balances for Energy
Obtain the current balance for all energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}Get Balances For Specific Energy Accounts
Obtain the current balances for a specified list of energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}Get Electricity Service Points
Obtain a list of service points owned by the customer that has authorised the current session
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Bulk DER
Obtain DER data for all service points associated with the customer
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
]
}
}Get DER For Specific Service Points
Obtain DER data for a specific set of service points
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
]
}
}Get Bulk Service Point Usage
Obtain usage data for all service points associated with the customer
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}Get Usage For Specific Service Points
Obtain the electricity usage data for a specific set of service points
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
]
}
}Get DER For Electricity Service Point
Obtain a list of DER data from a particular service point
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
}Get Usage For Electricity Service Point
Obtain a list of electricity usage data from a particular service point
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}Get Banking Products
Obtain a list of products that are currently openly offered to the market Will be implemented in a future release. See Biza Developer guides for future plans.
Note that the results returned by this end point 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 name 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_CARDS feature 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 difference 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 actual 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 long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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. |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V3",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "products": [
- {
- "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",
}
]
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f"
}
]
}
}Get Banking Product Detail
Obtain detailed information on a single product offered openly to the market. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| 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
{- "version": "V3",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "additionalInformation": {
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f",
- "bundles": [
- {
- "additionalInfo": "A great bundle with all the extras",
- "description": "Provides a savings account and loan",
- "name": "ACME Super Bundle",
- "productIds": [
- "string"
]
}
], - "constraints": [
- {
- "additionalInfo": "Some information about the constraint",
- "additionalValue": "Type specific value, see documentation",
- "constraintType": "MIN_BALANCE"
}
], - "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"
}
]
}
], - "eligibility": [
- {
- "additionalInfo": "Eligibility Criteria",
- "additionalValue": "Type dependent value, see docs",
- "eligibilityType": "MIN_TURNOVER"
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS"
}
], - "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"
}
], - "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"
}
]
}
]
}
}Get Outages
Obtain a list of scheduled outages for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "outages": [
- {
- "duration": "PT2H30M",
- "explanation": "There is an ongoing outage",
- "isPartial": true,
- "outageTime": "2022-08-20T01:55:05Z"
}
]
}
}Get Status
Obtain a health check status for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}Dynamic Client Registration
Perform a Dynamic Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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 |
Request Body schema: application/json
Request payload for a Dynamic Client Registration
| version required | string Payload Version |
required | object (ActionCDRRegistrationV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "redirectUris": [
- "string"
]
}
}Response samples
- 201
- 400
- 500
{- "version": "V1",
- "data": {
- "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 a Client Registration
Get a Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Responses
Response samples
- 200
- 403
- 500
{- "version": "V1",
- "data": {
- "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 a Client Registration
Update a Dynamic Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Request Body schema: application/json
Request payload for a Dynamic Client Registration
| version required | string Payload Version |
required | object (ActionCDRRegistrationV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "redirectUris": [
- "string"
]
}
}Response samples
- 200
- 403
- 500
{- "version": "V1",
- "data": {
- "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"
}
}Delete a Client Registration
Delete a Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Responses
Response samples
- 403
- 500
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive",
- "title": "ADR Status Is Not Active",
- "detail": "The ADR requesting this information is not Active",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive"
}
}
]
}List Directories
Retrieve a list of directories available
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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "directories": [
- {
- "directoryId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "directoryName": "Biza Test Register"
}
]
}
}List Participants
Obtain a collated list of participants available
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
query Parameters
| capabilities | Array of strings (EnumParticipantCapabilityV2) Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" "CDS_AU_DATA_SHARING_NON_BANK_LENDING" "CDS_AU_PRD_NON_BANK_LENDING" Example: capabilities=CDS_AU_DATA_SHARING_BANKING Filter the participants by these capabilities |
| 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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "participants": [
- {
- "participantId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "directoryId": "5f2cc672-88be-4cd8-bbe7-3fb6981b6234",
- "participantName": "ACME Bank",
- "legalEntity": {
- "legalEntityName": "ACME Bank Ltd",
- "legalEntityId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "registrationNumber": "string",
- "registrationDate": "2019-08-24",
- "registeredCountry": "string",
- "abn": "string",
- "acn": "string",
- "arbn": "string",
- "anzsicDivision": "string",
- "organisationType": "OTHER"
}, - "lastUpdated": "2022-08-20T03:01:42+00:00",
- "status": "ACTIVE",
- "capabilities": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}
]
}
}Get Energy Switch Status
Retrieve the status of an Energy Account Switch
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| switchId required | string Global unique identifier of an energy switch |
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 |
Responses
Response samples
- 200
- 403
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "switchId": "7a20c06e-17d6-4eb0-852b-6afea5e44eb2",
- "creationDateTime": "2023-09-21T14:44:16+10:00",
- "msatsChangeRequest": {
- "status": "REQ"
}, - "lastUpdated": "2023-09-23T11:44:16+10:00"
},
}List Energy Switches
Endpoint to list energy account switch actions
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
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 |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "actions": [
- {
- "actionId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958"
}
]
}
}Get Energy Switch Request
Retrieve an Energy Account Switch request
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| actionId required | string Global unique identifier of an action |
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 |
Responses
Response samples
- 200
- 403
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "switchId": "7a20c06e-17d6-4eb0-852b-6afea5e44eb2",
- "actionStatus": "SUCCESS",
- "actionStatusDescription": "Energy Account Switch successfully initiated, refer to Switch Status for more information"
}
}Initiate Energy Switch
Endpoint to initiate an energy account opening via the DataRight+ framework
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
header Parameters
| x-v required | string (EnumRequestInitiateEnergySwitchV1) Value: "V1" Example: V1 Supported Request Version |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Request Body schema: application/jsonrequired
Initiate Energy Account Switch
| version required | string Payload Version |
required | object (RequestInitiateEnergySwitchDataV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}
}Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "actionStatus": "IN_PROGRESS",
- "actionStatusDescription": "Energy Account Switch is currently in progress",
- "authStatus": "COMPLETE",
- "authStatusDescription": "Authorisation for action has been completed"
}
}Get Sharing Request
Retrieve the status of Arrangement V2
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
- 403
- 404
- 500
- 503
{- "version": "V2",
- "data": {
- "sharingDuration": 31536000,
- "dataClusters": [
- "BANK_ACCOUNTS_BASIC_READ"
]
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "agreementId": "e1529071-601f-46ff-a097-97cdaba84065",
- "actionStatus": "SUCCESS",
- "actionStatusDescription": "Sharing Arrangement Established",
- "authStatus": "COMPLETE",
- "authStatusDescription": "Authorisation for sharing has been completed"
}
}List Credit Reports
List Illion credit report(s) for a given principal.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reports": [
- {
- "reportId": "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "status": "COMPLETED",
- "resource": {
}
}
]
}
}Create Credit Report
Creates an Illion credit report for a given principal.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Request Body schema: application/json
Request payload for Create Credit report
| version required | string Payload Version |
required | object (CreateIllionCreditReportV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "agreementIds": [
- "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "56g4b801-97b2-4a07-a92e-f76e0331c952"
]
}
}Response samples
- 201
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reportId": "99e4b801-97b2-4a07-a92e-f76e0331c959"
}
}Get Credit Report By Id
Get an Illion credit report by id, for a given principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| reportId required | string <uuid> Unique Credit Report Identifier |
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reportId": "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "status": "COMPLETED",
- "resource": {
}
}
}List Principals
Retrieve a list of principals
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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "principals": [
- {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "principalId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
]
}
}Get Principal Detail
Obtain information about a specific principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "principalId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
}List Principal Users
Obtain a list of users for a specific principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "users": [
- {
- "userId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
]
}
}CDR end of life
CDR end of life callback. This is the endpoint OG calls to let the software product do any CDR end of life activities. Example - data deletion.
Software product MUST verify the JWT signature before using it.
OG's JWKS URL - https://<OG_PUBLIC_URI>/<Software Product id>/jwks
Request Body schema: application/jwtrequired
JWT signed by OG with claims required to complete any CDR arrangement end of life activities. Claims include
- iss - Issuer
- aud - Audience - Software product
- nbf - Token activation time
- iat - Token issued time
- exp - Token expiry - 60 seconds from the issued time
- cdrArrangementId - arrangement id recognised in the CDR eco-system
- interactionId - unique id sent by OG, which can be used by the software products to dedupe requests from OG
- principalId - Principal Id of the User/Client
- softwareProductId - Unique Id of the Software product
Responses
Biza OG API (OpenAPI Client) (2.0.1)
Download OpenAPI specification:Download
This is the OpenAPI specification for the Open Gateway
List Agreements
Retrieve a list of agreements
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
query Parameters
| agreementStatus | Array of strings (EnumAgreementCDRSharingStatusV1) Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED" Example: agreementStatus=ACTIVE Filter the agreements by these statuses |
| revision | string (EnumRevisionTypeV1) Enum: "LATEST" "ACTIVATED" Example: revision=LATEST When there are multiple revisions, only return the most current |
| CDRArrangementId | string Unique identifier, shared amongst all revisions of a CDR Sharing arrangement |
| 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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "agreements": [
- {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
]
}
}Get Agreement Detail
Obtain information about a specific agreement
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Terminate an Agreement
Initiates an agreement termination. As agreements can be many different types this has various meanings. For CDR Sharing Arrangements this triggers the revocation action from the Data Recipient to the Data Holder.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
Responses
Response samples
- 200
- 400
- 403
- 500
{- "version": "V1",
- "data": {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Get Agreement History
Obtain historical information about a specific agreement
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| agreementStatus | Array of strings (EnumAgreementCDRSharingStatusV1) Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED" Example: agreementStatus=ACTIVE Filter the agreements by these statuses |
| revision | string (EnumRevisionTypeV1) Enum: "LATEST" "ACTIVATED" Example: revision=LATEST When there are multiple revisions, only return the most current |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "agreements": [
- {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
]
}
}List Agreement Templates
Retrieve a list of agreement templates
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "templates": [
- {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "description": "Template for basic data sharing",
- "collection_scopes": [
- "bank:accounts.basic:read",
- "bank:accounts.basic:read"
], - "require_all_scopes": true,
- "collection_durations": [
- "P1D"
], - "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
- "use_durations": [
- "P1D"
], - "use_purpose": "To allow for the testing of data holder CDR sharing API's",
- "direct_marketing_shown": true,
- "data_handling_default": "DEIDENTIFY",
- "active": true,
- "data_holder_industry": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}
]
}
}Create an Agreement Template
Create a new Agreement Template
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 |
Request Body schema: application/jsonrequired
Request payload for creating a new agreement template
| version required | string Payload Version |
| description required | string Meaningful agreement template description that explains the purpose of the template, but not shown to consumers. |
| collection_scopes required | Array of strings Mandatory scopes you required from a consumer. |
| collection_durations required | Array of strings (EnumAgreementTemplateDuration) Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M" |
| collection_purpose required | string Describes the purpose behind collection. |
| use_durations required | Array of strings (EnumAgreementTemplateDuration) Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M" |
| use_purpose required | string Describes how/for what the data collected will be used. |
| direct_marketing_shown | boolean Default: true Should the marketing consent be asked for. |
| allowed_redirect_uris required | Array of strings List of valid software product hosts. |
| data_handling_default required | string Enum: "DEIDENTIFY" "DELETE" A default option for how this software product handles redundant data. This still allows for the user to change how they want the software product to handle redundant data. |
| agreementEndCallbackUrl required | string Default: "" The POST URL webhook that will be called to post data deletion request with a jwt payload |
| data_holder_industry | Array of strings (EnumParticipantCapabilityV1) Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" |
Responses
Request samples
- Payload
{- "version": "V1",
- "description": "Template for basic data sharing",
- "collection_scopes": [
- "bank:accounts.basic:read",
- "bank:accounts.basic:read"
], - "collection_durations": [
- "P1D"
], - "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
- "use_durations": [
- "P1D"
], - "use_purpose": "To allow for the testing of data holder CDR sharing API's",
- "direct_marketing_shown": true,
- "data_handling_default": "DEIDENTIFY",
- "data_holder_industry": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}Response samples
- 200
- 400
- 500
- 503
{- "id": "53e14d6c-1af4-4dc3-bd7a-18e7cccc5034"
}Delete an Agreement Template
Deletes an agreement template with a given id
Authorizations:
path Parameters
| id required | string <uuid> Unique Agreement Template Identifier |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Responses
Response samples
- 400
- 500
- 503
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Field/Invalid",
- "title": "Invalid Field",
- "detail": "Invalid format supplied for fieldName",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Field/Invalid"
}
}
]
}Prime a CDR Sharing Arrangement (V1)
Prime a CDR Sharing Agreement
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
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 |
Request Body schema: application/json
Request payload for a priming a CDR Sharing agreement
| version required | string Payload Version |
required | object (AgreementPrimeCDRSharingRequestV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "userId": "8c63744e-6507-477c-8002-ae1fb9a190de",
- "name": "Joe Blogs",
- "email": "joeblogs@gmail.com",
- "principalId": "4a28de94-52e9-4a5d-ad91-ae93916cadfb",
- "agreementId": "d5a4a443-cae7-4319-97ed-dc92bc20c66d",
- "templateId": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "state": "string",
- "participantIds": [
- "string"
]
}
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V1",
- "data": {
- "agreementId": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
}
}Get Accounts
Obtain a list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V2",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accounts": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "creationDate": "2020-03-01",
- "displayName": "ACME Savings Account",
- "isOwned": true,
- "accountOwnership": "UNKNOWN",
- "maskedNumber": "XXXX-XXXX-XXXX-1234",
- "nickname": "Holiday Fund",
- "openStatus": "OPEN",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productName": "ACME Savings Maximiser"
}
]
}
}Get Account Detail
Obtain detailed information on a single account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V3",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "creationDate": "2020-03-01",
- "displayName": "ACME Savings Account",
- "isOwned": true,
- "accountOwnership": "UNKNOWN",
- "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"
}
]
}
}Get Account Balance
Obtain the balance for a single specified account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
}Get Scheduled Payments for Account
Obtain scheduled, outgoing payments for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Direct Debits For Account
Obtain direct debit authorisations for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Transactions For Account
Obtain transactions for a specific account. Some general notes that apply to all end points 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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 10,
- "isQueryParamUnsupported": true
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Transaction Detail
Obtain detailed information on a transaction for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
}
}Get Payees
Obtain a list of pre-registered payees
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "payees": [
- {
- "creationDate": "2007-05-01",
- "description": "Joe's Flowers",
- "nickname": "Friendly Joe",
- "payeeId": "abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz",
- "type": "BILLER"
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}, - "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"
}
}Get Scheduled Payments Bulk
Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Scheduled Payments For Specific Accounts
Obtain scheduled payments for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Direct Debits
Obtain direct debit authorisations for multiple, filtered accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Direct Debits For Specific Accounts
Obtain direct debit authorisations for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Balances
Obtain balances for multiple, filtered accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}
}Get Balances For Specific Banking Accounts
Obtain balances for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}
}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:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
}Get Customer Detail
Obtain detailed information on the authorised customer within the current session.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
}Get Energy Accounts
Obtain the list of energy accounts available under the authorised consent
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V2",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
]
}
}Get Energy Account Detail
Obtain detailed information for a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V2",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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."
}
]
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Energy Account Concessions
Obtain the details of any concessions or arrangements applied to a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
]
}
]
}
}Get Balance For Energy Account
Obtain the current balance for a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balance": "11.55"
}
}Get Billing for Energy Account
Obtain the billing transactions for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Energy Account Invoices
Obtain the invoices for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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 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
- 404
- 406
- 422
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Invoices
Obtain the invoices for all accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Invoices For Specific Energy Accounts
Obtain invoices for a specified set of energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Billing
Obtain billing transactions for all accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Billing for Specific Energy Accounts
Obtain billing for a specified set of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Bulk Balances for Energy
Obtain the current balance for all energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}Get Balances For Specific Energy Accounts
Obtain the current balances for a specified list of energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}Get Electricity Service Points
Obtain a list of service points owned by the customer that has authorised the current session
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Bulk DER
Obtain DER data for all service points associated with the customer
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
]
}
}Get DER For Specific Service Points
Obtain DER data for a specific set of service points
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
]
}
}Get Bulk Service Point Usage
Obtain usage data for all service points associated with the customer
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}Get Usage For Specific Service Points
Obtain the electricity usage data for a specific set of service points
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
]
}
}Get DER For Electricity Service Point
Obtain a list of DER data from a particular service point
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
}Get Usage For Electricity Service Point
Obtain a list of electricity usage data from a particular service point
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}Get Banking Products
Obtain a list of products that are currently openly offered to the market Will be implemented in a future release. See Biza Developer guides for future plans.
Note that the results returned by this end point 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 name 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_CARDS feature 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 difference 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 actual 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 long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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. |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V3",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "products": [
- {
- "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",
}
]
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f"
}
]
}
}Get Banking Product Detail
Obtain detailed information on a single product offered openly to the market. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| 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
{- "version": "V3",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "additionalInformation": {
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f",
- "bundles": [
- {
- "additionalInfo": "A great bundle with all the extras",
- "description": "Provides a savings account and loan",
- "name": "ACME Super Bundle",
- "productIds": [
- "string"
]
}
], - "constraints": [
- {
- "additionalInfo": "Some information about the constraint",
- "additionalValue": "Type specific value, see documentation",
- "constraintType": "MIN_BALANCE"
}
], - "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"
}
]
}
], - "eligibility": [
- {
- "additionalInfo": "Eligibility Criteria",
- "additionalValue": "Type dependent value, see docs",
- "eligibilityType": "MIN_TURNOVER"
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS"
}
], - "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"
}
], - "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"
}
]
}
]
}
}Get Outages
Obtain a list of scheduled outages for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "outages": [
- {
- "duration": "PT2H30M",
- "explanation": "There is an ongoing outage",
- "isPartial": true,
- "outageTime": "2022-08-20T01:55:05Z"
}
]
}
}Get Status
Obtain a health check status for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}Dynamic Client Registration
Perform a Dynamic Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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 |
Request Body schema: application/json
Request payload for a Dynamic Client Registration
| version required | string Payload Version |
required | object (ActionCDRRegistrationV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "redirectUris": [
- "string"
]
}
}Response samples
- 201
- 400
- 500
{- "version": "V1",
- "data": {
- "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 a Client Registration
Get a Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Responses
Response samples
- 200
- 403
- 500
{- "version": "V1",
- "data": {
- "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 a Client Registration
Update a Dynamic Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Request Body schema: application/json
Request payload for a Dynamic Client Registration
| version required | string Payload Version |
required | object (ActionCDRRegistrationV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "redirectUris": [
- "string"
]
}
}Response samples
- 200
- 403
- 500
{- "version": "V1",
- "data": {
- "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"
}
}Delete a Client Registration
Delete a Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Responses
Response samples
- 403
- 500
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive",
- "title": "ADR Status Is Not Active",
- "detail": "The ADR requesting this information is not Active",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive"
}
}
]
}List Directories
Retrieve a list of directories available
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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "directories": [
- {
- "directoryId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "directoryName": "Biza Test Register"
}
]
}
}List Participants
Obtain a collated list of participants available
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
query Parameters
| capabilities | Array of strings (EnumParticipantCapabilityV2) Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" "CDS_AU_DATA_SHARING_NON_BANK_LENDING" Example: capabilities=CDS_AU_DATA_SHARING_BANKING Filter the participants by these capabilities |
| 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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "participants": [
- {
- "participantId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "directoryId": "5f2cc672-88be-4cd8-bbe7-3fb6981b6234",
- "participantName": "ACME Bank",
- "legalEntity": {
- "legalEntityName": "ACME Bank Ltd",
- "legalEntityId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "registrationNumber": "string",
- "registrationDate": "2019-08-24",
- "registeredCountry": "string",
- "abn": "string",
- "acn": "string",
- "arbn": "string",
- "anzsicDivision": "string",
- "organisationType": "OTHER"
}, - "lastUpdated": "2022-08-20T03:01:42+00:00",
- "status": "ACTIVE",
- "capabilities": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}
]
}
}Get Energy Switch Status
Retrieve the status of an Energy Account Switch
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| switchId required | string Global unique identifier of an energy switch |
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 |
Responses
Response samples
- 200
- 403
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "switchId": "7a20c06e-17d6-4eb0-852b-6afea5e44eb2",
- "creationDateTime": "2023-09-21T14:44:16+10:00",
- "msatsChangeRequest": {
- "status": "REQ"
}, - "lastUpdated": "2023-09-23T11:44:16+10:00"
},
}List Energy Switches
Endpoint to list energy account switch actions
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
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 |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "actions": [
- {
- "actionId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958"
}
]
}
}Get Energy Switch Request
Retrieve an Energy Account Switch request
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| actionId required | string Global unique identifier of an action |
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 |
Responses
Response samples
- 200
- 403
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "switchId": "7a20c06e-17d6-4eb0-852b-6afea5e44eb2",
- "actionStatus": "SUCCESS",
- "actionStatusDescription": "Energy Account Switch successfully initiated, refer to Switch Status for more information"
}
}Initiate Energy Switch
Endpoint to initiate an energy account opening via the DataRight+ framework
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
header Parameters
| x-v required | string (EnumRequestInitiateEnergySwitchV1) Value: "V1" Example: V1 Supported Request Version |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Request Body schema: application/jsonrequired
Initiate Energy Account Switch
| version required | string Payload Version |
required | object (RequestInitiateEnergySwitchDataV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}
}Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "actionStatus": "IN_PROGRESS",
- "actionStatusDescription": "Energy Account Switch is currently in progress",
- "authStatus": "COMPLETE",
- "authStatusDescription": "Authorisation for action has been completed"
}
}Get Sharing Request
Retrieve the status of Arrangement V2
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
- 403
- 404
- 500
- 503
{- "version": "V2",
- "data": {
- "sharingDuration": 31536000,
- "dataClusters": [
- "BANK_ACCOUNTS_BASIC_READ"
]
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "agreementId": "e1529071-601f-46ff-a097-97cdaba84065",
- "actionStatus": "SUCCESS",
- "actionStatusDescription": "Sharing Arrangement Established",
- "authStatus": "COMPLETE",
- "authStatusDescription": "Authorisation for sharing has been completed"
}
}List Credit Reports
List Illion credit report(s) for a given principal.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reports": [
- {
- "reportId": "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "status": "COMPLETED",
- "resource": {
}
}
]
}
}Create Credit Report
Creates an Illion credit report for a given principal.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Request Body schema: application/json
Request payload for Create Credit report
| version required | string Payload Version |
required | object (CreateIllionCreditReportV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "agreementIds": [
- "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "56g4b801-97b2-4a07-a92e-f76e0331c952"
]
}
}Response samples
- 201
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reportId": "99e4b801-97b2-4a07-a92e-f76e0331c959"
}
}Get Credit Report By Id
Get an Illion credit report by id, for a given principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| reportId required | string <uuid> Unique Credit Report Identifier |
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reportId": "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "status": "COMPLETED",
- "resource": {
}
}
}List Principals
Retrieve a list of principals
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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "principals": [
- {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "principalId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
]
}
}Get Principal Detail
Obtain information about a specific principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "principalId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
}List Principal Users
Obtain a list of users for a specific principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "users": [
- {
- "userId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
]
}
}CDR end of life
CDR end of life callback. This is the endpoint OG calls to let the software product do any CDR end of life activities. Example - data deletion.
Software product MUST verify the JWT signature before using it.
OG's JWKS URL - https://<OG_PUBLIC_URI>/<Software Product id>/jwks
Request Body schema: application/jwtrequired
JWT signed by OG with claims required to complete any CDR arrangement end of life activities. Claims include
- iss - Issuer
- aud - Audience - Software product
- nbf - Token activation time
- iat - Token issued time
- exp - Token expiry - 60 seconds from the issued time
- cdrArrangementId - arrangement id recognised in the CDR eco-system
- interactionId - unique id sent by OG, which can be used by the software products to dedupe requests from OG
- principalId - Principal Id of the User/Client
- softwareProductId - Unique Id of the Software product
Responses
Biza OG API (OpenAPI Client) (1.36.0)
Download OpenAPI specification:Download
This is the OpenAPI specification for the Open Gateway
List Agreements
Retrieve a list of agreements
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
query Parameters
| agreementStatus | Array of strings (EnumAgreementCDRSharingStatusV1) Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED" Example: agreementStatus=ACTIVE Filter the agreements by these statuses |
| revision | string (EnumRevisionTypeV1) Enum: "LATEST" "ACTIVATED" Example: revision=LATEST When there are multiple revisions, only return the most current |
| CDRArrangementId | string Unique identifier, shared amongst all revisions of a CDR Sharing arrangement |
| 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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "agreements": [
- {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
]
}
}Get Agreement Detail
Obtain information about a specific agreement
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Terminate an Agreement
Initiates an agreement termination. As agreements can be many different types this has various meanings. For CDR Sharing Arrangements this triggers the revocation action from the Data Recipient to the Data Holder.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
Responses
Response samples
- 200
- 400
- 403
- 500
{- "version": "V1",
- "data": {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
}Get Agreement History
Obtain historical information about a specific agreement
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| agreementStatus | Array of strings (EnumAgreementCDRSharingStatusV1) Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED" Example: agreementStatus=ACTIVE Filter the agreements by these statuses |
| revision | string (EnumRevisionTypeV1) Enum: "LATEST" "ACTIVATED" Example: revision=LATEST When there are multiple revisions, only return the most current |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "agreements": [
- {
- "id": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "agreementType": "CDR_SHARING_ARRANGEMENT_V1"
}
]
}
}List Agreement Templates
Retrieve a list of agreement templates
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "templates": [
- {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "description": "Template for basic data sharing",
- "collection_scopes": [
- "bank:accounts.basic:read",
- "bank:accounts.basic:read"
], - "require_all_scopes": true,
- "collection_durations": [
- "P1D"
], - "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
- "use_durations": [
- "P1D"
], - "use_purpose": "To allow for the testing of data holder CDR sharing API's",
- "direct_marketing_shown": true,
- "data_handling_default": "DEIDENTIFY",
- "active": true,
- "data_holder_industry": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}
]
}
}Create an Agreement Template
Create a new Agreement Template
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 |
Request Body schema: application/jsonrequired
Request payload for creating a new agreement template
| version required | string Payload Version |
| description required | string Meaningful agreement template description that explains the purpose of the template, but not shown to consumers. |
| collection_scopes required | Array of strings Mandatory scopes you required from a consumer. |
| collection_durations required | Array of strings (EnumAgreementTemplateDuration) Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M" |
| collection_purpose required | string Describes the purpose behind collection. |
| use_durations required | Array of strings (EnumAgreementTemplateDuration) Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M" |
| use_purpose required | string Describes how/for what the data collected will be used. |
| direct_marketing_shown | boolean Default: true Should the marketing consent be asked for. |
| allowed_redirect_uris required | Array of strings List of valid software product hosts. |
| data_handling_default required | string Enum: "DEIDENTIFY" "DELETE" A default option for how this software product handles redundant data. This still allows for the user to change how they want the software product to handle redundant data. |
| agreementEndCallbackUrl required | string Default: "" The POST URL webhook that will be called to post data deletion request with a jwt payload |
| data_holder_industry | Array of strings (EnumParticipantCapabilityV1) Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" |
Responses
Request samples
- Payload
{- "version": "V1",
- "description": "Template for basic data sharing",
- "collection_scopes": [
- "bank:accounts.basic:read",
- "bank:accounts.basic:read"
], - "collection_durations": [
- "P1D"
], - "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
- "use_durations": [
- "P1D"
], - "use_purpose": "To allow for the testing of data holder CDR sharing API's",
- "direct_marketing_shown": true,
- "data_handling_default": "DEIDENTIFY",
- "data_holder_industry": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}Response samples
- 200
- 400
- 500
- 503
{- "id": "53e14d6c-1af4-4dc3-bd7a-18e7cccc5034"
}Delete an Agreement Template
Deletes an agreement template with a given id
Authorizations:
path Parameters
| id required | string <uuid> Unique Agreement Template Identifier |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Responses
Response samples
- 400
- 500
- 503
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Field/Invalid",
- "title": "Invalid Field",
- "detail": "Invalid format supplied for fieldName",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Field/Invalid"
}
}
]
}Prime a CDR Sharing Arrangement (V1)
Prime a CDR Sharing Agreement
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
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 |
Request Body schema: application/json
Request payload for a priming a CDR Sharing agreement
| version required | string Payload Version |
required | object (AgreementPrimeCDRSharingRequestV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "userId": "8c63744e-6507-477c-8002-ae1fb9a190de",
- "name": "Joe Blogs",
- "email": "joeblogs@gmail.com",
- "principalId": "4a28de94-52e9-4a5d-ad91-ae93916cadfb",
- "agreementId": "d5a4a443-cae7-4319-97ed-dc92bc20c66d",
- "templateId": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
- "state": "string",
- "participantIds": [
- "string"
]
}
}Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V1",
- "data": {
- "agreementId": "27a0d944-4eb7-452e-a63c-dc14d8f92428",
}
}Get Accounts
Obtain a list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| product-category | string (EnumBankingProductCategoryV1) Enum: "BUSINESS_LOANS" "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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Account Detail
Obtain detailed information on a single account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Account Balance
Obtain the balance for a single specified account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
}Get Scheduled Payments for Account
Obtain scheduled, outgoing payments for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Direct Debits For Account
Obtain direct debit authorisations for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Transactions For Account
Obtain transactions for a specific account. Some general notes that apply to all end points 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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 10,
- "isQueryParamUnsupported": true
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Transaction Detail
Obtain detailed information on a transaction for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
}
}Get Payees
Obtain a list of pre-registered payees
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "payees": [
- {
- "creationDate": "2007-05-01",
- "description": "Joe's Flowers",
- "nickname": "Friendly Joe",
- "payeeId": "abwvgooyreohudvlszokbadxgozfhibifwmarjxmbpogdazskkimxucqjkzvvmfz",
- "type": "BILLER"
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}, - "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"
}
}Get Scheduled Payments Bulk
Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| product-category | string (EnumBankingProductCategoryV1) Enum: "BUSINESS_LOANS" "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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Scheduled Payments For Specific Accounts
Obtain scheduled payments for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Direct Debits
Obtain direct debit authorisations for multiple, filtered accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| product-category | string (EnumBankingProductCategoryV1) Enum: "BUSINESS_LOANS" "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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Direct Debits For Specific Accounts
Obtain direct debit authorisations for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Balances
Obtain balances for multiple, filtered accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
query Parameters
| product-category | string (EnumBankingProductCategoryV1) Enum: "BUSINESS_LOANS" "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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}
}Get Balances For Specific Banking Accounts
Obtain balances for a specified list of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "string",
- "amortisedLimit": "10.00",
- "availableBalance": "10.00",
- "creditLimit": "10.00",
- "currency": "AUD",
- "currentBalance": "10.00",
- "purses": [
- {
- "amount": "10.00",
- "currency": "AUD"
}
]
}
]
}
}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:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
}Get Customer Detail
Obtain detailed information on the authorised customer within the current session.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
}Get Energy Accounts
Obtain the list of energy accounts available under the authorised consent
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V2",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
]
}
}Get Energy Account Detail
Obtain detailed information for a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V2",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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."
}
]
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Energy Account Concessions
Obtain the details of any concessions or arrangements applied to a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
]
}
]
}
}Get Balance For Energy Account
Obtain the current balance for a specific energy account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balance": "11.55"
}
}Get Billing for Energy Account
Obtain the billing transactions for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Energy Account Invoices
Obtain the invoices for a specific account
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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 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
- 404
- 406
- 422
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Invoices
Obtain the invoices for all accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Invoices For Specific Energy Accounts
Obtain invoices for a specified set of energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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 |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}Get Bulk Billing
Obtain billing transactions for all accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Billing for Specific Energy Accounts
Obtain billing for a specified set of accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Bulk Balances for Energy
Obtain the current balance for all energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}Get Balances For Specific Energy Accounts
Obtain the current balances for a specified list of energy accounts
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}Get Electricity Service Points
Obtain a list of service points owned by the customer that has authorised the current session
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}
]
}
}Get Bulk DER
Obtain DER data for all service points associated with the customer
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
]
}
}Get DER For Specific Service Points
Obtain DER data for a specific set of service points
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
]
}
}Get Bulk Service Point Usage
Obtain usage data for all service points associated with the customer
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}Get Usage For Specific Service Points
Obtain the electricity usage data for a specific set of service points
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}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
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
]
}
}Get DER For Electricity Service Point
Obtain a list of DER data from a particular service point
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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
}
]
}
]
}
}Get Usage For Electricity Service Point
Obtain a list of electricity usage data from a particular service point
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
| 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
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
]
}
}
]
}
}Get Banking Products
Obtain a list of products that are currently openly offered to the market Will be implemented in a future release. See Biza Developer guides for future plans.
Note that the results returned by this end point 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 name 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_CARDS feature 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 difference 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 actual 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 long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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 (EnumBankingProductCategoryV1) Enum: "BUSINESS_LOANS" "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. |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V3",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "products": [
- {
- "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",
}
]
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f"
}
]
}
}Get Banking Product Detail
Obtain detailed information on a single product offered openly to the market. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| 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
{- "version": "V3",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "additionalInformation": {
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f",
- "bundles": [
- {
- "additionalInfo": "A great bundle with all the extras",
- "description": "Provides a savings account and loan",
- "name": "ACME Super Bundle",
- "productIds": [
- "string"
]
}
], - "constraints": [
- {
- "additionalInfo": "Some information about the constraint",
- "additionalValue": "Type specific value, see documentation",
- "constraintType": "MIN_BALANCE"
}
], - "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"
}
]
}
], - "eligibility": [
- {
- "additionalInfo": "Eligibility Criteria",
- "additionalValue": "Type dependent value, see docs",
- "eligibilityType": "MIN_TURNOVER"
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS"
}
], - "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"
}
], - "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"
}
]
}
]
}
}Get Outages
Obtain a list of scheduled outages for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "outages": [
- {
- "duration": "PT2H30M",
- "explanation": "There is an ongoing outage",
- "isPartial": true,
- "outageTime": "2022-08-20T01:55:05Z"
}
]
}
}Get Status
Obtain a health check status for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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
{- "version": "V1",
- "meta": { },
- "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "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"
}
}Dynamic Client Registration
Perform a Dynamic Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
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 |
Request Body schema: application/json
Request payload for a Dynamic Client Registration
| version required | string Payload Version |
required | object (ActionCDRRegistrationV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "redirectUris": [
- "string"
]
}
}Response samples
- 201
- 400
- 500
{- "version": "V1",
- "data": {
- "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 a Client Registration
Get a Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Responses
Response samples
- 200
- 403
- 500
{- "version": "V1",
- "data": {
- "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 a Client Registration
Update a Dynamic Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Request Body schema: application/json
Request payload for a Dynamic Client Registration
| version required | string Payload Version |
required | object (ActionCDRRegistrationV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "redirectUris": [
- "string"
]
}
}Response samples
- 200
- 403
- 500
{- "version": "V1",
- "data": {
- "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"
}
}Delete a Client Registration
Delete a Client Registration for a specified participant contained within a specified directory
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
| clientId required | string Unique Client Identifier |
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 |
Responses
Response samples
- 403
- 500
{- "errors": [
- {
- "code": "urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive",
- "title": "ADR Status Is Not Active",
- "detail": "The ADR requesting this information is not Active",
- "meta": {
- "urn": "urn:au-cds:error:cds-all:Authorisation/AdrStatusNotActive"
}
}
]
}List Directories
Retrieve a list of directories available
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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "directories": [
- {
- "directoryId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "directoryName": "Biza Test Register"
}
]
}
}List Participants
Obtain a collated list of participants available
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
query Parameters
| capabilities | Array of strings (EnumParticipantCapabilityV1) Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" Example: capabilities=CDS_AU_DATA_SHARING_BANKING Filter the participants by these capabilities |
| 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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "participants": [
- {
- "participantId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "directoryId": "5f2cc672-88be-4cd8-bbe7-3fb6981b6234",
- "participantName": "ACME Bank",
- "legalEntity": {
- "legalEntityName": "ACME Bank Ltd",
- "legalEntityId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "registrationNumber": "string",
- "registrationDate": "2019-08-24",
- "registeredCountry": "string",
- "abn": "string",
- "acn": "string",
- "arbn": "string",
- "anzsicDivision": "string",
- "organisationType": "OTHER"
}, - "lastUpdated": "2022-08-20T03:01:42+00:00",
- "status": "ACTIVE",
- "capabilities": [
- "CDS_AU_DATA_SHARING_BANKING"
]
}
]
}
}Get Energy Switch Status
Retrieve the status of an Energy Account Switch
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| switchId required | string Global unique identifier of an energy switch |
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 |
Responses
Response samples
- 200
- 403
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "switchId": "7a20c06e-17d6-4eb0-852b-6afea5e44eb2",
- "creationDateTime": "2023-09-21T14:44:16+10:00",
- "msatsChangeRequest": {
- "status": "REQ"
}, - "lastUpdated": "2023-09-23T11:44:16+10:00"
},
}List Energy Switches
Endpoint to list energy account switch actions
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
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 |
Responses
Response samples
- 200
- 400
- 406
- 422
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "validationErrors": [
- {
- "type": "ATTRIBUTE_INVALID",
- "fields": [
- "data.availableBalance"
], - "message": "Must be specified and not an empty string",
- "severity": "ERROR"
}
], - "data": {
- "actions": [
- {
- "actionId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958"
}
]
}
}Get Energy Switch Request
Retrieve an Energy Account Switch request
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| actionId required | string Global unique identifier of an action |
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 |
Responses
Response samples
- 200
- 403
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "switchId": "7a20c06e-17d6-4eb0-852b-6afea5e44eb2",
- "actionStatus": "SUCCESS",
- "actionStatusDescription": "Energy Account Switch successfully initiated, refer to Switch Status for more information"
}
}Initiate Energy Switch
Endpoint to initiate an energy account opening via the DataRight+ framework
Authorizations:
path Parameters
| directoryId required | string <uuid> Unique Directory Identifier |
| participantId required | string <uuid> Unique Participant Identifier |
header Parameters
| x-v required | string (EnumRequestInitiateEnergySwitchV1) Value: "V1" Example: V1 Supported Request Version |
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
Request Body schema: application/jsonrequired
Initiate Energy Account Switch
| version required | string Payload Version |
required | object (RequestInitiateEnergySwitchDataV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}
}Response samples
- 200
- 400
- 403
- 404
- 406
- 422
- 500
- 503
{- "version": "V1",
- "data": {
- "connectionDetail": {
- "planId": "ENERGY_SAVER_PLAN",
- "nationalMeteringId": 6987332211,
- "lifeSupportRequired": false,
- "concessionEligible": false,
- "electronicBills": true
}, - "customerDetail": {
- "customerUType": "person",
- "person": {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [ ],
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "purpose": "HOME"
}
], - "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "purpose": "MOBILE"
}
], - "physicalAddresses": [
- {
- "addressUType": "simple",
- "purpose": "MAIL",
- "simple": {
- "addressLine1": "55 McDonald Avenue",
- "city": "Maryville",
- "postcode": "2293",
- "state": "NSW"
}
}
]
}
}
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "actionStatus": "IN_PROGRESS",
- "actionStatusDescription": "Energy Account Switch is currently in progress",
- "authStatus": "COMPLETE",
- "authStatusDescription": "Authorisation for action has been completed"
}
}Get Sharing Request
Retrieve the status of Arrangement V2
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| agreementId required | string <uuid> Unique Agreement Identifier |
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
- 403
- 404
- 500
- 503
{- "version": "V2",
- "data": {
- "sharingDuration": 31536000,
- "dataClusters": [
- "BANK_ACCOUNTS_BASIC_READ"
]
}, - "meta": {
- "actionId": "8ba3f97e-c22c-4516-b6ed-05c0486db195",
- "agreementId": "e1529071-601f-46ff-a097-97cdaba84065",
- "actionStatus": "SUCCESS",
- "actionStatusDescription": "Sharing Arrangement Established",
- "authStatus": "COMPLETE",
- "authStatusDescription": "Authorisation for sharing has been completed"
}
}List Credit Reports
List Illion credit report(s) for a given principal.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reports": [
- {
- "reportId": "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "status": "COMPLETED",
- "resource": {
}
}
]
}
}Create Credit Report
Creates an Illion credit report for a given principal.
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Request Body schema: application/json
Request payload for Create Credit report
| version required | string Payload Version |
required | object (CreateIllionCreditReportV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "agreementIds": [
- "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "56g4b801-97b2-4a07-a92e-f76e0331c952"
]
}
}Response samples
- 201
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reportId": "99e4b801-97b2-4a07-a92e-f76e0331c959"
}
}Get Credit Report By Id
Get an Illion credit report by id, for a given principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
| reportId required | string <uuid> Unique Credit Report Identifier |
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 |
Responses
Response samples
- 200
- 400
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "reportId": "77g4b801-97b2-4a07-a92e-f76e0331c959",
- "status": "COMPLETED",
- "resource": {
}
}
}List Principals
Retrieve a list of principals
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 |
Responses
Response samples
- 200
- 400
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "principals": [
- {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "principalId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
]
}
}Get Principal Detail
Obtain information about a specific principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "data": {
- "id": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "principalId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
}List Principal Users
Obtain a list of users for a specific principal
Authorizations:
path Parameters
| principalId required | string Unique Principal Identifier |
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 |
Responses
Response samples
- 200
- 404
- 500
- 503
{- "version": "V1",
- "links": {
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}, - "data": {
- "users": [
- {
- "userId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "displayName": "John Doe"
}
]
}
}CDR end of life
CDR end of life callback. This is the endpoint OG calls to let the software product do any CDR end of life activities. Example - data deletion.
Software product MUST verify the JWT signature before using it.
OG's JWKS URL - https://<OG_PUBLIC_URI>/<Software Product id>/jwks
Request Body schema: application/jwtrequired
JWT signed by OG with claims required to complete any CDR arrangement end of life activities. Claims include
- iss - Issuer
- aud - Audience - Software product
- nbf - Token activation time
- iat - Token issued time
- exp - Token expiry - 60 seconds from the issued time
- cdrArrangementId - arrangement id recognised in the CDR eco-system
- interactionId - unique id sent by OG, which can be used by the software products to dedupe requests from OG
- principalId - Principal Id of the User/Client
- softwareProductId - Unique Id of the Software product