From e50413d8ad1587038ee9aafaf11aa03182b1996e Mon Sep 17 00:00:00 2001 From: James Bligh <40985476+JamesMBligh@users.noreply.github.com> Date: Fri, 10 Nov 2023 15:23:15 +1100 Subject: [PATCH] Release/1.28.0 (#336) * Create clean version of release 1.28.0 * Removed last remaining diffs * Updates to NBL Draft Standards To reflect details and feedback from https://github.com/ConsumerDataStandardsAustralia/standards/issues/317, and to support https://github.com/ConsumerDataStandardsAustralia/standards/issues/318. * Decision Proposal 306 Candidate Standards Reflects proposed changes to the Banking Standards as a result of consultation and feedback to https://github.com/ConsumerDataStandardsAustralia/standards/issues/306 * Rebuild * Rebuild * Version delta for Enum type fix * Rebuild * Add CX section with Banking Language to NBL Draft * Version Delta for updates to Additional Standards * Rebuild * Rebuild * Rebuild --------- Co-authored-by: James Bligh Co-authored-by: Nils Berge <60594671+nils-work@users.noreply.github.com> --- ...u8e1h => additional20231110-66305-183zxnd} | 8 +- .../candidates/dp306/banking-dp306.html | 16704 ++++++++++++++++ .../candidates/dp306/banking-dp306_apis | 76 + .../includes/additional/candidates/telco.html | 49 +- .../banking-non-bank-lending.html | 1748 +- .../banking-non-bank-lending_apis | 23 + .../additional/drafts/non-bank-lending/cx_nbl | 3 + docs/includes/archives | 5 + docs/includes/cds_admin | 2 +- docs/includes/cds_banking | 72 +- docs/includes/cds_banking_dp306 | 15093 ++++++++++++++ docs/includes/cds_banking_non_bank_lending | 809 +- docs/includes/cds_common | 20 +- docs/includes/cds_dcr | 10 +- docs/includes/cds_energy | 172 +- docs/includes/cds_energy_sdh | 48 +- docs/includes/cds_register | 4 +- .../cds_register_banking_non_bank_lending | 16 +- docs/includes/cds_telco | 46 +- docs/includes/changelog | 9 +- .../obsolete/get-account-detail-v3.html | 3295 +++ docs/includes/obsolete/get-accounts-v2.html | 1052 + .../obsolete/get-bulk-balances-v1.html | 1092 + .../obsolete/get-bulk-direct-debits-v1.html | 1033 + .../get-data-holder-brands-summary-v1.html | 800 + .../obsolete/get-data-holder-brands-v2.html | 1234 ++ .../obsolete/get-data-holder-statuses-v1.html | 712 + .../obsolete/get-product-detail-v4.html | 3540 ++++ docs/includes/obsolete/get-products-v3.html | 2177 ++ .../get-scheduled-payments-bulk-v2.html | 2433 +++ .../releasenotes/releasenotes.1.28.0.html | 330 + docs/includes/swagger/cds_admin.json | 2 +- docs/includes/swagger/cds_admin.yaml | 2 +- docs/includes/swagger/cds_banking.json | 2 +- docs/includes/swagger/cds_banking.yaml | 2 +- docs/includes/swagger/cds_banking_dp306.json | 6749 +++++++ docs/includes/swagger/cds_banking_dp306.yaml | 8681 ++++++++ .../swagger/cds_banking_non_bank_lending.json | 410 +- .../swagger/cds_banking_non_bank_lending.yaml | 531 +- docs/includes/swagger/cds_common.json | 2 +- docs/includes/swagger/cds_common.yaml | 2 +- docs/includes/swagger/cds_dcr.json | 2 +- docs/includes/swagger/cds_dcr.yaml | 2 +- docs/includes/swagger/cds_energy.json | 2 +- docs/includes/swagger/cds_energy.yaml | 2 +- docs/includes/swagger/cds_energy_sdh.json | 2 +- docs/includes/swagger/cds_energy_sdh.yaml | 2 +- docs/includes/swagger/cds_register.json | 2 +- docs/includes/swagger/cds_register.yaml | 2 +- ...cds_register_banking_non_bank_lending.json | 14 +- ...cds_register_banking_non_bank_lending.yaml | 22 +- docs/includes/swagger/cds_telco.json | 2 +- docs/includes/swagger/cds_telco.yaml | 2 +- docs/index.html | 406 +- slate/source/includes/_admin.md.erb | 10 - slate/source/includes/_banking_apis.md.erb | 8 - slate/source/includes/_dcr_apis.md.erb | 8 - slate/source/includes/_energy_apis.md.erb | 10 - slate/source/includes/_energy_apis_sdh.md.erb | 6 - slate/source/includes/_register.md.erb | 6 - slate/source/includes/additional.md | 10 +- .../dp306/_product_categories-dp306.md | 28 + .../dp306/_product_components-dp306.md | 292 + .../candidates/dp306/banking-dp306.html.md | 18 + .../dp306/banking-dp306_apis.md.erb | 70 + .../additional/candidates/telco.html.md | 3 - .../non-bank-lending/_cx_standards_nbl.md.erb | 33 + .../_product_categories_nbl.md | 28 + .../_product_components_nbl.md | 220 + .../_register_banking_non_bank_lending.md.erb | 10 + .../banking-non-bank-lending.html.md | 5 + .../banking-non-bank-lending_apis.md.erb | 24 + .../drafts/non-bank-lending/cx_nbl.md | 7 + slate/source/includes/archives.md | 1 + slate/source/includes/cds_admin.md | 2 +- slate/source/includes/cds_banking.md | 72 +- slate/source/includes/cds_banking_dp306.md | 8925 +++++++++ .../includes/cds_banking_non_bank_lending.md | 580 +- slate/source/includes/cds_common.md | 20 +- slate/source/includes/cds_dcr.md | 10 +- slate/source/includes/cds_energy.md | 172 +- slate/source/includes/cds_energy_sdh.md | 48 +- slate/source/includes/cds_register.md | 4 +- .../cds_register_banking_non_bank_lending.md | 16 +- slate/source/includes/cds_telco.md | 46 +- slate/source/includes/changelog.md | 5 +- slate/source/includes/introduction/_fdo.md | 6 - slate/source/includes/introduction/_intro.md | 6 +- .../includes/introduction/_references.md | 4 - .../obsolete/get-account-detail-v3.html.md | 1664 ++ .../includes/obsolete/get-accounts-v2.html.md | 406 + .../obsolete/get-bulk-balances-v1.html.md | 451 + .../get-bulk-direct-debits-v1.html.md | 412 + .../get-data-holder-brands-summary-v1.html.md | 331 + .../get-data-holder-brands-v2.html.md | 568 + .../get-data-holder-statuses-v1.html.md | 291 + .../obsolete/get-product-detail-v4.html.md | 1745 ++ .../includes/obsolete/get-products-v3.html.md | 984 + .../get-scheduled-payments-bulk-v2.html.md | 1265 ++ .../releasenotes/releasenotes.1.28.0.html.md | 75 + .../security/_client_registration.md.erb | 14 - .../endpoints/_oidc_provider_configuration.md | 6 - .../includes/security/endpoints/_register.md | 4 - slate/source/includes/standards/_types.md | 4 + slate/source/includes/swagger/cds_admin.json | 2 +- slate/source/includes/swagger/cds_admin.yaml | 2 +- .../source/includes/swagger/cds_banking.json | 2 +- .../source/includes/swagger/cds_banking.yaml | 2 +- .../includes/swagger/cds_banking_dp306.json | 6749 +++++++ .../includes/swagger/cds_banking_dp306.yaml | 8681 ++++++++ .../swagger/cds_banking_non_bank_lending.json | 410 +- .../swagger/cds_banking_non_bank_lending.yaml | 531 +- slate/source/includes/swagger/cds_common.json | 2 +- slate/source/includes/swagger/cds_common.yaml | 2 +- slate/source/includes/swagger/cds_dcr.json | 2 +- slate/source/includes/swagger/cds_dcr.yaml | 2 +- slate/source/includes/swagger/cds_energy.json | 2 +- slate/source/includes/swagger/cds_energy.yaml | 2 +- .../includes/swagger/cds_energy_sdh.json | 2 +- .../includes/swagger/cds_energy_sdh.yaml | 2 +- .../source/includes/swagger/cds_register.json | 2 +- .../source/includes/swagger/cds_register.yaml | 2 +- ...cds_register_banking_non_bank_lending.json | 14 +- ...cds_register_banking_non_bank_lending.yaml | 22 +- slate/source/includes/swagger/cds_telco.json | 2 +- slate/source/includes/swagger/cds_telco.yaml | 2 +- swagger-gen/api/cds_admin.json | 2 +- swagger-gen/api/cds_banking.json | 2 +- swagger-gen/api/cds_banking_dp306.json | 7186 +++++++ .../api/cds_banking_non_bank_lending.json | 407 +- swagger-gen/api/cds_common.json | 2 +- swagger-gen/api/cds_dcr.json | 2 +- swagger-gen/api/cds_energy.json | 2 +- swagger-gen/api/cds_energy_sdh.json | 2 +- swagger-gen/api/cds_register.json | 2 +- ...cds_register_banking_non_bank_lending.json | 14 +- swagger-gen/api/cds_telco.json | 2 +- swagger-gen/cds_admin.md | 2 +- swagger-gen/cds_banking.md | 72 +- swagger-gen/cds_banking_dp306.md | 8925 +++++++++ swagger-gen/cds_banking_non_bank_lending.md | 580 +- swagger-gen/cds_common.md | 20 +- swagger-gen/cds_dcr.md | 10 +- swagger-gen/cds_energy.md | 172 +- swagger-gen/cds_energy_sdh.md | 48 +- swagger-gen/cds_register.md | 4 +- .../cds_register_banking_non_bank_lending.md | 16 +- swagger-gen/cds_telco.md | 46 +- swagger-gen/create_markdown.sh | 12 + swagger-gen/generate_json.sh | 1 + swagger-gen/generate_yaml.sh | 1 + swagger-gen/package-lock.json | 6 + swagger-gen/publish_markdown.sh | 1 + swagger-gen/widdershins-cdr/common.js | 6 + 154 files changed, 119705 insertions(+), 2672 deletions(-) rename docs/includes/additional/{additional20231010-42976-iu8e1h => additional20231110-66305-183zxnd} (78%) create mode 100644 docs/includes/additional/candidates/dp306/banking-dp306.html create mode 100644 docs/includes/additional/candidates/dp306/banking-dp306_apis create mode 100644 docs/includes/additional/drafts/non-bank-lending/cx_nbl create mode 100644 docs/includes/cds_banking_dp306 create mode 100644 docs/includes/obsolete/get-account-detail-v3.html create mode 100644 docs/includes/obsolete/get-accounts-v2.html create mode 100644 docs/includes/obsolete/get-bulk-balances-v1.html create mode 100644 docs/includes/obsolete/get-bulk-direct-debits-v1.html create mode 100644 docs/includes/obsolete/get-data-holder-brands-summary-v1.html create mode 100644 docs/includes/obsolete/get-data-holder-brands-v2.html create mode 100644 docs/includes/obsolete/get-data-holder-statuses-v1.html create mode 100644 docs/includes/obsolete/get-product-detail-v4.html create mode 100644 docs/includes/obsolete/get-products-v3.html create mode 100644 docs/includes/obsolete/get-scheduled-payments-bulk-v2.html create mode 100644 docs/includes/releasenotes/releasenotes.1.28.0.html create mode 100644 docs/includes/swagger/cds_banking_dp306.json create mode 100644 docs/includes/swagger/cds_banking_dp306.yaml create mode 100644 slate/source/includes/additional/candidates/dp306/_product_categories-dp306.md create mode 100644 slate/source/includes/additional/candidates/dp306/_product_components-dp306.md create mode 100644 slate/source/includes/additional/candidates/dp306/banking-dp306.html.md create mode 100644 slate/source/includes/additional/candidates/dp306/banking-dp306_apis.md.erb create mode 100644 slate/source/includes/additional/drafts/non-bank-lending/_cx_standards_nbl.md.erb create mode 100644 slate/source/includes/additional/drafts/non-bank-lending/_product_categories_nbl.md create mode 100644 slate/source/includes/additional/drafts/non-bank-lending/_product_components_nbl.md create mode 100644 slate/source/includes/additional/drafts/non-bank-lending/cx_nbl.md create mode 100644 slate/source/includes/cds_banking_dp306.md create mode 100644 slate/source/includes/obsolete/get-account-detail-v3.html.md create mode 100644 slate/source/includes/obsolete/get-accounts-v2.html.md create mode 100644 slate/source/includes/obsolete/get-bulk-balances-v1.html.md create mode 100644 slate/source/includes/obsolete/get-bulk-direct-debits-v1.html.md create mode 100644 slate/source/includes/obsolete/get-data-holder-brands-summary-v1.html.md create mode 100644 slate/source/includes/obsolete/get-data-holder-brands-v2.html.md create mode 100644 slate/source/includes/obsolete/get-data-holder-statuses-v1.html.md create mode 100644 slate/source/includes/obsolete/get-product-detail-v4.html.md create mode 100644 slate/source/includes/obsolete/get-products-v3.html.md create mode 100644 slate/source/includes/obsolete/get-scheduled-payments-bulk-v2.html.md create mode 100644 slate/source/includes/releasenotes/releasenotes.1.28.0.html.md create mode 100644 slate/source/includes/swagger/cds_banking_dp306.json create mode 100644 slate/source/includes/swagger/cds_banking_dp306.yaml create mode 100644 swagger-gen/api/cds_banking_dp306.json create mode 100644 swagger-gen/cds_banking_dp306.md create mode 100644 swagger-gen/package-lock.json diff --git a/docs/includes/additional/additional20231010-42976-iu8e1h b/docs/includes/additional/additional20231110-66305-183zxnd similarity index 78% rename from docs/includes/additional/additional20231010-42976-iu8e1h rename to docs/includes/additional/additional20231110-66305-183zxnd index feea6881..1f29fe8b 100644 --- a/docs/includes/additional/additional20231010-42976-iu8e1h +++ b/docs/includes/additional/additional20231110-66305-183zxnd @@ -1,4 +1,6 @@ -

Additional Standards

+

Additional Standards

Added Candidate Standards for Banking Decision Proposal 306
+Updated the Draft Standards for the Banking and Non-Bank Lending sector (related to Decision Proposal 318)
+

The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations.

These standards fall into three categories:

@@ -13,11 +15,11 @@

Draft Standards

The Consumer Data Standards currently include the following Draft Standards:

-
Added Draft Standards for non-bank lending
-
+ diff --git a/docs/includes/additional/candidates/dp306/banking-dp306.html b/docs/includes/additional/candidates/dp306/banking-dp306.html new file mode 100644 index 00000000..fc0bd953 --- /dev/null +++ b/docs/includes/additional/candidates/dp306/banking-dp306.html @@ -0,0 +1,16704 @@ + + + + + + + + DSB Candidate Standard - Banking Decision Proposal 306 + + + + + + + + + + + + NAV + Navbar + + +
+ +
+ Non-normative Examples + Version Delta +
+
+ +
+ + + +
+
+
+
+

Banking APIs

+ + +

This specification defines the APIs for Data Holders exposing Banking endpoints.

+ + + + +
Banking OpenAPI Specification (JSON)
Banking OpenAPI Specification (YAML)
+
Changed the `cardArt` array to a `cardOption` object to provide additional card details in 'Get Products', 'Get Product Detail' and 'Get Account Detail'.
+
+Added the `FEE` `lendingRateType` value to support lending products that have a fee-based rather than rate-based cost. This type may be expected to align to the new `PRINCIPAL_AND_FEE` `repaymentType`.
+
+Added the `BALANCE_TRANSFER` `lendingRateType` value to extend support for credit card plan detail.
+
+Updated the `creditCard` schema in 'Get Account Detail' to allow an array of plan types, each with specific rates, repayments, adjustments and features.
+
+Added `revertRate`, `revertProductId`, `rateStartDate` and `rateEndDate` fields to respective lending rate schemas to support 'revert' rate details.
+
+Added `referenceRate` to multiple lending and deposit rate schemas.
+
+Added `adjustmentToBase` and `adjustmentBundle` fields to the 'BankingProductLendingRate' and 'BankingProductDepositRate' schemas. The `adjustmentToBase` field is provided to allow an adjustment rate type to specify which base rate type the adjustment applies to, where many may be offered for a product.
+
+Updated and added the `applicabilityConditions` field in the 'BankingProductLendingRate', 'BankingProductDepositRate' and 'BankingProductRateTier' schemas.
+
+Added the `applicationType` field to clarify whether an associated `applicationFrequency` value is to be expected.
+
+Updated the description of the `features` property of 'Get Product Detail' and 'Get Account Detail' to clarify that the schema also supports providing details of any key operational product limitations.
+
+Updated the description of the `constraints` property of 'Get Product Detail' to clarify that the schema is only intended to provide details of constraints on application for the product.
+
+Added new `featureType` values to support operational limitations and the `OTHER` `constraintType` to allow additional detail to be provided.
+
+Added new `feeCategory` field and new `feeType` values to improve classification and comparison of fees.
+
+Updated the 'BankingProductFee' schema to separate different fee types by UType and added minimum and maximum fee details and `feeCap` fields.
+
+Incorporated rate detail into the 'Get Account Detail' schemas to provide specific rate fields separated from the generic Product Reference rate objects.
+
+Extended the `termDeposit` schema in 'Get Account Detail' to allow each deposit to be specified with specific rates and terms.
+
+Updated the 'adjustment' rate type values to remove the `INTRODUCTORY`, `BUNDLE_BONUS`, `BUNDLE_DISCOUNT_FIXED`, `BUNDLE_DISCOUNT_VARIABLE` options. Time and bundle-based rate detail will be supported through new fields to capture that detail: `adjustmentBundle`, `adjustmentPeriod` and `adjustmentEndDate`, leaving the `additionalValue` field available for other detail where necessary.
+
+Added a `deposit` schema in 'Get Account Detail' to provide rate detail for general deposit structures without term deposit maturity detail.
+
+Removed the `specificAccountUType` field in 'Get Account Detail' to clarify that multiple types may be present in a single account.
+
+Updated the 'Use of additionalValue Field' descriptions for the `PENSION_RECIPIENT` and `STUDENT` 'Product Eligibility' and 'Product Discount Eligibility' types.
+
+Updated the description of the `comparisonRate` field to clarify how it could be interpreted when associated with an adjustment rate type.
+
+Updated the description of the rate tier `unitOfMeasure` field to clarify the format of the associated values, including specifying `PERCENT` values as a RateString.
+
+This candidate incorporates the latest Non-Bank Lending (NBL) Draft changes including the `BUY_NOW_PAY_LATER` product category value, the `instalments` object, and related feature and fee types. The endpoint versions incremented due to changes related to the NBL Draft only, are: 
+ - Get Accounts (v3)
+ - Get Bulk Balances (v2)
+ - Get Bulk Direct Debits (v2)
+ - Get Scheduled Payments Bulk (v3).
+ - Other NBL changes affecting the Register APIs are only shown in the NBL Draft.
+
+The endpoint versions incremented primarily for Decision Proposal 306, but also including NBL detail are: 
+ - Get Account Detail (v4)
+ - Get Products (v4)
+ - Get Product Detail (v5).
+
+Corrected minor typos and updated documentation formatting.
+

Get Accounts

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts

+ +

Obtain a list of accounts.

+ +

Obsolete versions: v1, v2

+

Endpoint Version

+ + + + + + + + + + +
Version3
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "creationDate": "string",
+        "displayName": "string",
+        "nickname": "string",
+        "openStatus": "CLOSED",
+        "isOwned": true,
+        "accountOwnership": "UNKNOWN",
+        "maskedNumber": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "productName": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountListV3
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Bulk Balances

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/balances

+ +

Obtain balances for multiple, filtered accounts

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Balances For Specific Accounts

+

+ +
+

Code samples

+
+
POST https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+const inputBody = '{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}';
+const headers = {
+  'Content-Type':'application/json',
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

POST /banking/accounts/balances

+ +

Obtain balances for a specified list of accounts

+ +
+

Body parameter

+
+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe 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.
bodybodyRequestAccountIdsmandatoryThe list of account IDs to obtain balances for
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Account Balance

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/balance

+ +

Obtain the balance for a single specified account

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the specific account requested
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accountId": "string",
+    "currentBalance": "string",
+    "availableBalance": "string",
+    "creditLimit": "string",
+    "amortisedLimit": "string",
+    "currency": "string",
+    "purses": [
+      {
+        "amount": "string",
+        "currency": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceById
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Account Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}

+ +

Obtain detailed information on a single account.

+ +

Obsolete versions: v1, v2, v3

+

Endpoint Version

+ + + + + + + + + + +
Version4
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryA tokenised identifier for the account which is unique but not shareable
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accountId": "string",
+    "creationDate": "string",
+    "displayName": "string",
+    "nickname": "string",
+    "openStatus": "CLOSED",
+    "isOwned": true,
+    "accountOwnership": "UNKNOWN",
+    "maskedNumber": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "productName": "string",
+    "bsb": "string",
+    "accountNumber": "string",
+    "bundleName": "string",
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4,
+      "plans": [
+        {
+          "planNickname": "string",
+          "creationDate": "string",
+          "amount": "string",
+          "duration": "string",
+          "instalmentInterval": "string",
+          "schedule": [
+            {
+              "amountDue": "string",
+              "dueDate": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "termDeposit": [
+      {
+        "lodgementDate": "string",
+        "maturityDate": "string",
+        "maturityAmount": "string",
+        "maturityCurrency": "string",
+        "maturityInstructions": "HOLD_ON_MATURITY",
+        "depositRateDetail": {
+          "depositRateType": "FIXED",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "tiers": [
+            {
+              "name": "string",
+              "unitOfMeasure": "DAY",
+              "minimumValue": "string",
+              "maximumValue": "string",
+              "rateApplicationMethod": "PER_TIER",
+              "applicabilityConditions": [
+                {
+                  "rateApplicabilityType": "NEW_CUSTOMER",
+                  "additionalValue": "string",
+                  "additionalInfo": "string",
+                  "additionalInfoUri": "string"
+                }
+              ],
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      }
+    ],
+    "creditCard": {
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string",
+      "cardPlans": [
+        {
+          "nickname": "string",
+          "planType": "PURCHASE_PLAN",
+          "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+          "planCreationDate": "string",
+          "planPeriod": "string",
+          "planEndDate": "string",
+          "planReferenceRate": "string",
+          "planEffectiveRate": "string",
+          "minPaymentAmount": "string",
+          "paymentDueAmount": "string",
+          "paymentCurrency": "string",
+          "paymentDueDate": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "interestFreePeriods": [
+            {
+              "from": "string",
+              "to": "string"
+            }
+          ],
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "planFeatures": [
+            {
+              "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+              "period": "string",
+              "endDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "loan": {
+      "originalStartDate": "string",
+      "originalLoanAmount": "string",
+      "originalLoanCurrency": "string",
+      "loanEndDate": "string",
+      "nextInstalmentDate": "string",
+      "minInstalmentAmount": "string",
+      "minInstalmentCurrency": "string",
+      "maxRedraw": "string",
+      "maxRedrawCurrency": "string",
+      "minRedraw": "string",
+      "minRedrawCurrency": "string",
+      "offsetAccountEnabled": true,
+      "offsetAccountIds": [
+        "string"
+      ],
+      "lendingRateDetail": [
+        {
+          "loanPurpose": "OWNER_OCCUPIED",
+          "repaymentType": "PRINCIPAL_AND_INTEREST",
+          "rateStartDate": "string",
+          "rateEndDate": "string",
+          "revertProductId": "string",
+          "repaymentUType": "fixedRate",
+          "fixedRate": {
+            "fixedPeriod": "string",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "variableRate": {
+            "variableRateType": "FLOATING",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "feeAmount": {
+            "amount": "string",
+            "currency": "string",
+            "repaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "deposit": {
+      "lodgementDate": "string",
+      "nickname": "string",
+      "depositRateDetail": {
+        "depositRateType": "FIXED",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    },
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "isActivated": true
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "addresses": [
+      {
+        "addressUType": "paf",
+        "simple": {
+          "mailingName": "string",
+          "addressLine1": "string",
+          "addressLine2": "string",
+          "addressLine3": "string",
+          "postcode": "string",
+          "city": "string",
+          "state": "string",
+          "country": "AUS"
+        },
+        "paf": {
+          "dpid": "string",
+          "thoroughfareNumber1": 0,
+          "thoroughfareNumber1Suffix": "string",
+          "thoroughfareNumber2": 0,
+          "thoroughfareNumber2Suffix": "string",
+          "flatUnitType": "string",
+          "flatUnitNumber": "string",
+          "floorLevelType": "string",
+          "floorLevelNumber": "string",
+          "lotNumber": "string",
+          "buildingName1": "string",
+          "buildingName2": "string",
+          "streetName": "string",
+          "streetType": "string",
+          "streetSuffix": "string",
+          "postalDeliveryType": "string",
+          "postalDeliveryNumber": 0,
+          "postalDeliveryNumberPrefix": "string",
+          "postalDeliveryNumberSuffix": "string",
+          "localityName": "string",
+          "postcode": "string",
+          "state": "string"
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountByIdV4
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Transactions For Account

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/transactions

+ +

Obtain transactions for a specific account.

+ +

Some general notes that apply to all endpoints that retrieve transactions:

+ +
    +
  • Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
    • +
  • As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as: + +
      +
    • Posted date/time if available, then
      • +
    • Execution date/time if available, then
      • +
    • A reasonable date/time nominated by the data holder using internal data structures
      • +
    • +
  • For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account
    • +
  • For aggregated transactions (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
    • +
+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.
oldest-timequeryDateTimeStringoptionalConstrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type
newest-timequeryDateTimeStringoptionalConstrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type
min-amountqueryAmountStringoptionalFilter transactions to only transactions with amounts higher than or equal to this amount
max-amountqueryAmountStringoptionalFilter transactions to only transactions with amounts less than or equal to this amount
textquerystringoptionalFilter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "transactions": [
+      {
+        "accountId": "string",
+        "transactionId": "string",
+        "isDetailAvailable": true,
+        "type": "DIRECT_DEBIT",
+        "status": "PENDING",
+        "description": "string",
+        "postingDateTime": "string",
+        "valueDateTime": "string",
+        "executionDateTime": "string",
+        "amount": "string",
+        "currency": "string",
+        "reference": "string",
+        "merchantName": "string",
+        "merchantCategoryCode": "string",
+        "billerCode": "string",
+        "billerName": "string",
+        "crn": "string",
+        "apcaNumber": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0,
+    "isQueryParamUnsupported": false
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingTransactionList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Transaction Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/transactions/{transactionId}

+ +

Obtain detailed information on a transaction for a specific account

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get transactions for. Must have previously been returned by one of the account list endpoints
transactionIdpathASCIIStringmandatoryID of the transaction obtained from a previous call to one of the other transaction endpoints
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accountId": "string",
+    "transactionId": "string",
+    "isDetailAvailable": true,
+    "type": "DIRECT_DEBIT",
+    "status": "PENDING",
+    "description": "string",
+    "postingDateTime": "string",
+    "valueDateTime": "string",
+    "executionDateTime": "string",
+    "amount": "string",
+    "currency": "string",
+    "reference": "string",
+    "merchantName": "string",
+    "merchantCategoryCode": "string",
+    "billerCode": "string",
+    "billerName": "string",
+    "crn": "string",
+    "apcaNumber": "string",
+    "extendedData": {
+      "payer": "string",
+      "payee": "string",
+      "extensionUType": "x2p101Payload",
+      "x2p101Payload": {
+        "extendedDescription": "string",
+        "endToEndId": "string",
+        "purposeCode": "string"
+      },
+      "service": "X2P1.01"
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingTransactionById
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Direct Debits For Account

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/direct-debits

+ +

Obtain direct debit authorisations for a specific account

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Bulk Direct Debits

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/direct-debits

+ +

Obtain direct debit authorisations for multiple, filtered accounts

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Direct Debits For Specific Accounts

+

+ +
+

Code samples

+
+
POST https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+const inputBody = '{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}';
+const headers = {
+  'Content-Type':'application/json',
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

POST /banking/accounts/direct-debits

+ +

Obtain direct debit authorisations for a specified list of accounts

+ +
+

Body parameter

+
+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe 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.
bodybodyRequestAccountIdsmandatoryArray of specific accountIds to obtain authorisations for
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Scheduled Payments for Account

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/payments/scheduled

+ +

Obtain scheduled, outgoing payments for a specific account

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Scheduled Payments Bulk

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payments/scheduled

+ +

Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments

+ +

Obsolete versions: v1, v2

+

Endpoint Version

+ + + + + + + + + + +
Version3
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Scheduled Payments For Specific Accounts

+

+ +
+

Code samples

+
+
POST https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+const inputBody = '{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}';
+const headers = {
+  'Content-Type':'application/json',
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

POST /banking/payments/scheduled

+ +

Obtain scheduled payments for a specified list of accounts

+ +

Obsolete versions: v1

+ +
+

Body parameter

+
+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe 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.
bodybodyRequestAccountIdsmandatoryArray of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Payees

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payees HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payees',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payees

+ +

Obtain a list of pre-registered payees.

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
typequerystringoptionalFilter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
typeALL
typeBILLER
typeDIGITAL_WALLET
typeDOMESTIC
typeINTERNATIONAL
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "payees": [
+      {
+        "payeeId": "string",
+        "nickname": "string",
+        "description": "string",
+        "type": "BILLER",
+        "creationDate": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingPayeeListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Payee Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payees/{payeeId}

+ +

Obtain detailed information on a single payee.

+ +

Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient.

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
payeeIdpathASCIIStringmandatoryThe ID used to locate the details of a particular payee
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "payeeId": "string",
+    "nickname": "string",
+    "description": "string",
+    "type": "BILLER",
+    "creationDate": "string",
+    "payeeUType": "biller",
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingPayeeByIdV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Products

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/products HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/products',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/products

+ +

Obtain a list of products that are currently openly offered to the market

+ +

Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.

+

Conventions

+

In the product reference payloads there are a number of recurring conventions that are explained here, in one place.

+

Arrays Of Features

+

In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:

+ +
    +
  • Each element in an array has the same structure so that clients can reliably interpret the payloads
    • +
  • Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.
    • +
  • Each element has a field 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 actually has been instantiated and created along with the associated decisions inherent in that process.

+

Dates

+

It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.

+ +

In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.

+ +

Obsolete versions: v1, v2, v3

+

Endpoint Version

+ + + + + + + + + + +
Version4
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
effectivequerystringoptionalAllows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are CURRENT, FUTURE and ALL. If absent defaults to CURRENT
updated-sincequeryDateTimeStringoptionalOnly include products that have been updated after the specified date and time. If absent defaults to include all products
brandquerystringoptionalFilter results based on a specific brand
product-categoryquerystringoptionalUsed 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.
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
effectiveALL
effectiveCURRENT
effectiveFUTURE
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "products": [
+      {
+        "productId": "string",
+        "effectiveFrom": "string",
+        "effectiveTo": "string",
+        "lastUpdated": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "name": "string",
+        "description": "string",
+        "brand": "string",
+        "brandName": "string",
+        "applicationUri": "string",
+        "isTailored": true,
+        "additionalInformation": {
+          "overviewUri": "string",
+          "termsUri": "string",
+          "eligibilityUri": "string",
+          "feesAndPricingUri": "string",
+          "bundleUri": "string",
+          "additionalOverviewUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalTermsUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalEligibilityUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalFeesAndPricingUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalBundleUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        },
+        "cardOption": {
+          "cardScheme": "AMEX",
+          "cardType": "CHARGE",
+          "cardImages": [
+            {
+              "title": "string",
+              "imageUri": "string"
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingProductListV3
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
+ +

+

Get Product Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/products/{productId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/products/{productId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/products/{productId}

+ +

Obtain detailed information on a single product offered openly to the market.

+ +

Obsolete versions: v1, v2, v3, v4

+

Endpoint Version

+ + + + + + + + + + +
Version5
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
productIdpathASCIIStringmandatoryID of the specific product requested
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "productId": "string",
+    "effectiveFrom": "string",
+    "effectiveTo": "string",
+    "lastUpdated": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "name": "string",
+    "description": "string",
+    "brand": "string",
+    "brandName": "string",
+    "applicationUri": "string",
+    "isTailored": true,
+    "additionalInformation": {
+      "overviewUri": "string",
+      "termsUri": "string",
+      "eligibilityUri": "string",
+      "feesAndPricingUri": "string",
+      "bundleUri": "string",
+      "additionalOverviewUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalTermsUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalEligibilityUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalFeesAndPricingUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalBundleUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    },
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "bundles": [
+      {
+        "name": "string",
+        "description": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "productIds": [
+          "string"
+        ]
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "constraints": [
+      {
+        "constraintType": "MAX_BALANCE",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "eligibility": [
+      {
+        "eligibilityType": "BUSINESS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "depositRates": [
+      {
+        "depositRateType": "VARIABLE",
+        "rate": "string",
+        "adjustmentToBase": "FIXED",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "DISCOUNT",
+        "rate": "string",
+        "referenceRate": "string",
+        "comparisonRate": "string",
+        "revertRate": "string",
+        "revertProductId": "string",
+        "adjustmentToBase": "BALANCE_TRANSFER",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingProductByIdV5
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
+ +

+ +

Schemas

+ +

+ +

RequestAccountIds

+ +

+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» accountIds[string]mandatorynone
metaMetaoptionalnone
+ +

ResponseBankingProductListV3

+ +

+
{
+  "data": {
+    "products": [
+      {
+        "productId": "string",
+        "effectiveFrom": "string",
+        "effectiveTo": "string",
+        "lastUpdated": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "name": "string",
+        "description": "string",
+        "brand": "string",
+        "brandName": "string",
+        "applicationUri": "string",
+        "isTailored": true,
+        "additionalInformation": {
+          "overviewUri": "string",
+          "termsUri": "string",
+          "eligibilityUri": "string",
+          "feesAndPricingUri": "string",
+          "bundleUri": "string",
+          "additionalOverviewUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalTermsUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalEligibilityUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalFeesAndPricingUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalBundleUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        },
+        "cardOption": {
+          "cardScheme": "AMEX",
+          "cardType": "CHARGE",
+          "cardImages": [
+            {
+              "title": "string",
+              "imageUri": "string"
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» products[BankingProductV5]mandatoryThe list of products returned. If the filter results in an empty set then this array may have no records
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingProductV5

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardOption": {
+    "cardScheme": "AMEX",
+    "cardType": "CHARGE",
+    "cardImages": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ]
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
productIdASCIIStringmandatoryA data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
effectiveFromDateTimeStringoptionalThe date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
effectiveToDateTimeStringoptionalThe date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products
lastUpdatedDateTimeStringmandatoryThe last date and time that the information for this product was changed (or the creation date for the product if it has never been altered)
productCategoryBankingProductCategoryV2mandatoryThe category to which a product or account belongs. See here for more details
namestringmandatoryThe display name of the product
descriptionstringmandatoryA description of the product
brandstringmandatoryA label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required
brandNamestringoptionalAn optional display name of the brand
applicationUriURIStringoptionalA link to an application web page where this product can be applied for.
isTailoredBooleanmandatoryIndicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable
additionalInformationBankingProductAdditionalInformationV2optionalObject that contains links to additional information on specific topics
cardOptionBankingProductCardOptionoptionalInformation about the type of card available with the account
+ +

BankingProductCardOption

+ +

+
{
+  "cardScheme": "AMEX",
+  "cardType": "CHARGE",
+  "cardImages": [
+    {
+      "title": "string",
+      "imageUri": "string"
+    }
+  ]
+}
+
+
+

Information about the type of card available with the account

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
cardSchemeEnummandatoryCard scheme available with the account
cardTypeEnummandatoryCard type available with the account
cardImages[BankingProductCardOption_cardImages]optionalAn array of card art images
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
cardSchemeAMEX
cardSchemeDINERS
cardSchemeEFTPOS
cardSchemeMASTERCARD
cardSchemeVISA
cardSchemeOTHER
cardTypeCHARGE
cardTypeCREDIT
cardTypeDEBIT
+ +

BankingProductCardOption_cardImages

+ +

+
{
+  "title": "string",
+  "imageUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
titlestringoptionalDisplay label for the specific image
imageUriURIStringmandatoryURI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]
+ +

BankingProductAdditionalInformationV2

+ +

+
{
+  "overviewUri": "string",
+  "termsUri": "string",
+  "eligibilityUri": "string",
+  "feesAndPricingUri": "string",
+  "bundleUri": "string",
+  "additionalOverviewUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalTermsUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalEligibilityUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalFeesAndPricingUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalBundleUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Object that contains links to additional information on specific topics

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
overviewUriURIStringconditionalGeneral overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents.
termsUriURIStringconditionalTerms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents.
eligibilityUriURIStringconditionalEligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents.
feesAndPricingUriURIStringconditionalDescription of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents.
bundleUriURIStringconditionalDescription of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents.
additionalOverviewUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri.
additionalTermsUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri.
additionalEligibilityUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri.
additionalFeesAndPricingUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri.
additionalBundleUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri.
+ +

BankingProductAdditionalInformationV2_additionalInformationUris

+ +

+
{
+  "description": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDisplay text providing more information about the document URI
additionalInfoUriURIStringmandatoryThe URI describing the additional information
+ +

ResponseBankingProductByIdV5

+ +

+
{
+  "data": {
+    "productId": "string",
+    "effectiveFrom": "string",
+    "effectiveTo": "string",
+    "lastUpdated": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "name": "string",
+    "description": "string",
+    "brand": "string",
+    "brandName": "string",
+    "applicationUri": "string",
+    "isTailored": true,
+    "additionalInformation": {
+      "overviewUri": "string",
+      "termsUri": "string",
+      "eligibilityUri": "string",
+      "feesAndPricingUri": "string",
+      "bundleUri": "string",
+      "additionalOverviewUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalTermsUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalEligibilityUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalFeesAndPricingUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalBundleUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    },
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "bundles": [
+      {
+        "name": "string",
+        "description": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "productIds": [
+          "string"
+        ]
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "constraints": [
+      {
+        "constraintType": "MAX_BALANCE",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "eligibility": [
+      {
+        "eligibilityType": "BUSINESS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "depositRates": [
+      {
+        "depositRateType": "VARIABLE",
+        "rate": "string",
+        "adjustmentToBase": "FIXED",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "DISCOUNT",
+        "rate": "string",
+        "referenceRate": "string",
+        "comparisonRate": "string",
+        "revertRate": "string",
+        "revertProductId": "string",
+        "adjustmentToBase": "BALANCE_TRANSFER",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingProductDetailV5mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingProductDetailV5

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardOption": {
+    "cardScheme": "AMEX",
+    "cardType": "CHARGE",
+    "cardImages": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ]
+  },
+  "bundles": [
+    {
+      "name": "string",
+      "description": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "productIds": [
+        "string"
+      ]
+    }
+  ],
+  "features": [
+    {
+      "featureType": "ADDITIONAL_CARDS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "constraints": [
+    {
+      "constraintType": "MAX_BALANCE",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "eligibility": [
+    {
+      "eligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "fees": [
+    {
+      "name": "string",
+      "feeCategory": "CARD",
+      "feeType": "CASH_ADVANCE",
+      "feeMethodUType": "fixedAmount",
+      "fixedAmount": {
+        "amount": "string"
+      },
+      "rateBased": {
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "amountRange": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        }
+      },
+      "variable": {
+        "feeMinimum": "string",
+        "feeMaximum": "string"
+      },
+      "feeCap": "string",
+      "feeCapPeriod": "string",
+      "currency": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "discounts": [
+        {
+          "description": "string",
+          "discountType": "BALANCE",
+          "amount": "string",
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "feeRate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "eligibility": [
+            {
+              "discountEligibilityType": "BUSINESS",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "depositRates": [
+    {
+      "depositRateType": "VARIABLE",
+      "rate": "string",
+      "adjustmentToBase": "FIXED",
+      "adjustmentBundle": "string",
+      "calculationFrequency": "string",
+      "applicationType": "PERIODIC",
+      "applicationFrequency": "string",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": "string",
+          "maximumValue": "string",
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "lendingRates": [
+    {
+      "lendingRateType": "DISCOUNT",
+      "rate": "string",
+      "referenceRate": "string",
+      "comparisonRate": "string",
+      "revertRate": "string",
+      "revertProductId": "string",
+      "adjustmentToBase": "BALANCE_TRANSFER",
+      "adjustmentBundle": "string",
+      "calculationFrequency": "string",
+      "applicationType": "PERIODIC",
+      "applicationFrequency": "string",
+      "interestPaymentDue": "IN_ADVANCE",
+      "repaymentType": "INTEREST_ONLY",
+      "loanPurpose": "INVESTMENT",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": "string",
+          "maximumValue": "string",
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "instalments": {
+    "maximumPlanCount": 1,
+    "instalmentsLimit": "string",
+    "minimumPlanValue": "string",
+    "maximumPlanValue": "string",
+    "minimumSplit": 4,
+    "maximumSplit": 4
+  }
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingProductV5mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» bundles[BankingProductBundle]optionalAn array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also
» features[BankingProductFeatureV3]optionalArray of features and limitations of the product
» constraints[BankingProductConstraintV2]optionalConstraints on the application for the product such as minimum balances or limit thresholds
» eligibility[BankingProductEligibility]optionalEligibility criteria for the product
» fees[BankingProductFeeV2]optionalFees applicable to the product
» depositRates[BankingProductDepositRateV2]optionalInterest rates available for deposits
» lendingRates[BankingProductLendingRateV3]optionalInterest rates charged against lending balances
» instalmentsBankingProductInstalmentsoptionalDetails of instalment features on the account
+ +

BankingProductBundle

+ +

+
{
+  "name": "string",
+  "description": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "productIds": [
+    "string"
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the bundle
descriptionstringmandatoryDescription of the bundle
additionalInfostringoptionalDisplay text providing more information on the bundle
additionalInfoUriURIStringoptionalLink to a web page with more information on the bundle criteria and benefits
productIds[string]optionalArray of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints
+ +

BankingProductFeatureV3

+ +

+
{
+  "featureType": "ADDITIONAL_CARDS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Array of features and limitations of the product

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
featureTypeEnummandatoryThe type of feature described. For further details, refer to Product Feature Types
additionalValuestringconditionalGeneric field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
additionalInfostringconditionalDisplay text providing more information on the feature. Mandatory if the feature type is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this feature
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
featureTypeADDITIONAL_CARDS
featureTypeBALANCE_TRANSFERS
featureTypeBILL_PAYMENT
featureTypeBONUS_REWARDS
featureTypeCARD_ACCESS
featureTypeCASHBACK_OFFER
featureTypeCOMPLEMENTARY_PRODUCT_DISCOUNTS
featureTypeEXTRA_DOWN_PAYMENT
featureTypeDIGITAL_BANKING
featureTypeDIGITAL_WALLET
featureTypeDONATE_INTEREST
featureTypeEXTRA_REPAYMENTS
featureTypeFRAUD_PROTECTION
featureTypeFREE_TXNS
featureTypeFREE_TXNS_ALLOWANCE
featureTypeFUNDS_AVAILABLE_AFTER
featureTypeGUARANTOR
featureTypeINSTALMENT_PLAN
featureTypeINSURANCE
featureTypeINTEREST_FREE
featureTypeINTEREST_FREE_TRANSFERS
featureTypeLOYALTY_PROGRAM
featureTypeMAX_BALANCE
featureTypeMAX_LIMIT
featureTypeMAX_TXNS
featureTypeMIN_BALANCE
featureTypeMIN_LIMIT
featureTypeNOTIFICATIONS
featureTypeNPP_ENABLED
featureTypeNPP_PAYID
featureTypeOFFSET
featureTypeOTHER
featureTypeOVERDRAFT
featureTypeREDRAW
featureTypeRELATIONSHIP_MANAGEMENT
featureTypeUNLIMITED_TXNS
+ +

BankingProductConstraintV2

+ +

+
{
+  "constraintType": "MAX_BALANCE",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
constraintTypeEnummandatoryThe type of constraint described. For further details, refer to Product Constraint Types
additionalValuestringconditionalGeneric field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
additionalInfostringconditionalDisplay text providing more information on the constraint. Mandatory if the constraint type is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on the constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
constraintTypeMAX_BALANCE
constraintTypeMAX_LIMIT
constraintTypeMIN_BALANCE
constraintTypeMIN_LIMIT
constraintTypeOPENING_BALANCE
constraintTypeOTHER
+ +

BankingProductEligibility

+ +

+
{
+  "eligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
eligibilityTypeEnummandatoryThe type of eligibility criteria described. For further details, refer to Product Eligibility Types
additionalValuestringconditionalGeneric field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
additionalInfostringconditionalDisplay text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility criteria
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
eligibilityTypeBUSINESS
eligibilityTypeEMPLOYMENT_STATUS
eligibilityTypeMAX_AGE
eligibilityTypeMIN_AGE
eligibilityTypeMIN_INCOME
eligibilityTypeMIN_TURNOVER
eligibilityTypeNATURAL_PERSON
eligibilityTypeOTHER
eligibilityTypePENSION_RECIPIENT
eligibilityTypeRESIDENCY_STATUS
eligibilityTypeSTAFF
eligibilityTypeSTUDENT
+ +

BankingProductFeeV2

+ +

+
{
+  "name": "string",
+  "feeCategory": "CARD",
+  "feeType": "CASH_ADVANCE",
+  "feeMethodUType": "fixedAmount",
+  "fixedAmount": {
+    "amount": "string"
+  },
+  "rateBased": {
+    "balanceRate": "string",
+    "transactionRate": "string",
+    "accruedRate": "string",
+    "accrualFrequency": "string",
+    "amountRange": {
+      "feeMinimum": "string",
+      "feeMaximum": "string"
+    }
+  },
+  "variable": {
+    "feeMinimum": "string",
+    "feeMaximum": "string"
+  },
+  "feeCap": "string",
+  "feeCapPeriod": "string",
+  "currency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "discounts": [
+    {
+      "description": "string",
+      "discountType": "BALANCE",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "feeRate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "eligibility": [
+        {
+          "discountEligibilityType": "BUSINESS",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the fee
feeCategoryEnummandatoryThe category of fee, used to group feeType values. For further details, refer to Product Fee Categories.
feeTypeEnummandatoryThe type of fee. For further details, refer to Product Fee Types.
feeMethodUTypeEnummandatoryThe fee charge method
fixedAmountBankingFeeAmountconditionalPresent if feeMethodUType is set to fixedAmount. Where the fee is a specific amount
rateBasedBankingFeeRateconditionalPresent if feeMethodUType is set to rateBased. Where the fee is based on a type of rate
variableBankingFeeRangeconditionalPresent if feeMethodUType is set to variable. Where the amount or rate may not be known until the fee is incurred
feeCapAmountStringoptionalThe cap amount if multiple occurrences of the fee are capped to a limit
feeCapPeriodExternalRefoptionalSpecifies a duration over which multiple occurrences of the fee will be capped. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
currencyCurrencyStringoptionalThe currency the fee will be charged in. Assumes AUD if absent
additionalValuestringconditionalGeneric field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
additionalInfostringconditionalDisplay text providing more information on the fee
additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
discounts[BankingProductDiscount]optionalAn optional list of discounts to this fee that may be available
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
feeCategoryAPPLICATION
feeCategoryATM
feeCategoryBRANCH
feeCategoryBUY_NOW_PAY_LATER
feeCategoryCARD
feeCategoryCHEQUE
feeCategoryCLOSURE
feeCategoryCORRESPONDENCE
feeCategoryFOREIGN_EXCHANGE
feeCategoryOTHER
feeCategoryPOS
feeCategorySERVICE
feeCategoryTELEGRAPHIC_TRANSFER
feeCategoryTELEPHONE_BANKING
feeCategoryTERMS_CONDITIONS
feeCategoryTHIRD_PARTY
feeCategoryTRANSACTION
feeTypeCASH_ADVANCE
feeTypeDEPOSIT
feeTypeDISHONOUR
feeTypeENQUIRY
feeTypeEVENT
feeTypeEXIT
feeTypeOTHER
feeTypePAYMENT
feeTypePAYMENT_LATE
feeTypePERIODIC
feeTypePURCHASE
feeTypeREPLACEMENT
feeTypeTRANSACTION
feeTypeUPFRONT
feeTypeUPFRONT_PER_PLAN
feeTypeVARIATION
feeTypeWITHDRAWAL
feeMethodUTypefixedAmount
feeMethodUTyperateBased
feeMethodUTypevariable
+ +

BankingFeeAmount

+ +

+
{
+  "amount": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryThe specific amount charged for the fee each time it is incurred
+ +

BankingFeeRate

+ +

+
{
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "accrualFrequency": "string",
+  "amountRange": {
+    "feeMinimum": "string",
+    "feeMaximum": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
balanceRateRateStringconditionalA fee rate calculated based on a proportion of the balance. One of balanceRate, transactionRate and accruedRate is mandatory
transactionRateRateStringconditionalA fee rate calculated based on a proportion of a transaction. One of balanceRate, transactionRate and accruedRate is mandatory
accruedRateRateStringconditionalA fee rate calculated based on a proportion of the calculated interest accrued on the account. One of balanceRate, transactionRate and accruedRate is mandatory
accrualFrequencyExternalRefoptionalThe indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
amountRangeBankingFeeRangeoptionalA minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred
+ +

BankingFeeRange

+ +

+
{
+  "feeMinimum": "string",
+  "feeMaximum": "string"
+}
+
+
+

A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred

+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
feeMinimumAmountStringoptionalThe minimum fee that will be charged per occurrence
feeMaximumAmountStringoptionalThe maximum fee that will be charged per occurrence
+ +

BankingProductDiscount

+ +

+
{
+  "description": "string",
+  "discountType": "BALANCE",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "feeRate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "eligibility": [
+    {
+      "discountEligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the discount
discountTypeEnummandatoryThe type of discount. For further details, refer to Product Discount Types
amountAmountStringconditionalDollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
balanceRateRateStringconditionalA discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
transactionRateRateStringconditionalA discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
accruedRateRateStringconditionalA discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
feeRateRateStringconditionalA discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
additionalValuestringconditionalGeneric field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
additionalInfostringoptionalDisplay text providing more information on the discount
additionalInfoUriURIStringoptionalLink to a web page with more information on this discount
eligibility[BankingProductDiscountEligibility]conditionalEligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountTypeBALANCE
discountTypeDEPOSITS
discountTypeELIGIBILITY_ONLY
discountTypeFEE_CAP
discountTypePAYMENTS
+ +

BankingProductDiscountEligibility

+ +

+
{
+  "discountEligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
discountEligibilityTypeEnummandatoryThe type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types
additionalValuestringconditionalGeneric field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfostringconditionalDisplay text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountEligibilityTypeBUSINESS
discountEligibilityTypeEMPLOYMENT_STATUS
discountEligibilityTypeINTRODUCTORY
discountEligibilityTypeMAX_AGE
discountEligibilityTypeMIN_AGE
discountEligibilityTypeMIN_INCOME
discountEligibilityTypeMIN_TURNOVER
discountEligibilityTypeNATURAL_PERSON
discountEligibilityTypeOTHER
discountEligibilityTypePENSION_RECIPIENT
discountEligibilityTypeRESIDENCY_STATUS
discountEligibilityTypeSTAFF
discountEligibilityTypeSTUDENT
+ +

BankingProductDepositRateV2

+ +

+
{
+  "depositRateType": "VARIABLE",
+  "rate": "string",
+  "adjustmentToBase": "FIXED",
+  "adjustmentBundle": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": "string",
+      "maximumValue": "string",
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
depositRateTypeEnummandatoryThe type of rate (FIXED, VARIABLE, BONUS, etc). For further details, refer to Product Deposit Rate Types
rateRateStringmandatoryThe rate to be applied
adjustmentToBaseEnumoptionalFor an adjustment depositRateType, the base rate that the adjustment value will apply to. The value of the additionalValue field may be used to further qualify the corresponding base.
adjustmentBundlestringoptionalThe name of the bundle that makes the adjustment rate applicable
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
tiers[BankingProductRateTierV4]optionalRate tiers applicable for this rate
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a rate
additionalValuestringconditionalGeneric field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
depositRateTypeBONUS
depositRateTypeFIXED
depositRateTypeFLOATING
depositRateTypeMARKET_LINKED
depositRateTypeVARIABLE
adjustmentToBaseFIXED
adjustmentToBaseFLOATING
adjustmentToBaseMARKET_LINKED
adjustmentToBaseVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
+ +

BankingProductLendingRateV3

+ +

+
{
+  "lendingRateType": "DISCOUNT",
+  "rate": "string",
+  "referenceRate": "string",
+  "comparisonRate": "string",
+  "revertRate": "string",
+  "revertProductId": "string",
+  "adjustmentToBase": "BALANCE_TRANSFER",
+  "adjustmentBundle": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentType": "INTEREST_ONLY",
+  "loanPurpose": "INVESTMENT",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": "string",
+      "maximumValue": "string",
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lendingRateTypeEnummandatoryThe type of rate (fixed, variable, etc). For further details, refer to Product Lending Rate Types
rateRateStringconditionalThe rate to be applied. Mandatory unless the lendingRateType FEE is supplied
referenceRateRateStringoptionalThe reference or index rate for this account option, or variant
comparisonRateRateStringoptionalA comparison rate equivalent for this rate. The comparison rate associated with an 'adjustment' lendingRateType is the full comparison rate assuming the adjusted rate is available for origination.
revertRateRateStringoptionalThe revert rate applicable after the respective rate expires. For example, FIXED, or INTEREST_ONLY rates may revert to a different rate when those terms expire. Expected where this product will continue to operate with a new 'revert' rate.
revertProductIdstringoptionalA reference to a productId that the associated product will revert to after the respective rate terms expire. For example, FIXED, or INTEREST_ONLY rates may revert to a different rate when those terms expire. Expected if the product will change when the rate reverts to different terms.
adjustmentToBaseEnumoptionalFor an adjustment lendingRateType, the base rate that the adjustment value will apply to. The values of the repaymentType, loanPurpose and additionalValue fields may be used to further qualify the corresponding base.
adjustmentBundlestringoptionalThe name of the bundle that makes the adjustment rate applicable
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDueEnumoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentTypeEnumoptionalOptions in place for repayments. If absent, the lending rate is applicable to all repayment types
loanPurposeEnumoptionalThe reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
tiers[BankingProductRateTierV4]optionalRate tiers applicable for this rate
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a rate
additionalValuestringconditionalGeneric field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
lendingRateTypeBALANCE_TRANSFER
lendingRateTypeCASH_ADVANCE
lendingRateTypeDISCOUNT
lendingRateTypeFEE
lendingRateTypeFIXED
lendingRateTypeFLOATING
lendingRateTypeMARKET_LINKED
lendingRateTypePENALTY
lendingRateTypePURCHASE
lendingRateTypeVARIABLE
adjustmentToBaseBALANCE_TRANSFER
adjustmentToBaseCASH_ADVANCE
adjustmentToBaseFEE
adjustmentToBaseFIXED
adjustmentToBaseFLOATING
adjustmentToBaseMARKET_LINKED
adjustmentToBasePURCHASE
adjustmentToBaseVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
repaymentTypeINTEREST_ONLY
repaymentTypePRINCIPAL_AND_FEE
repaymentTypePRINCIPAL_AND_INTEREST
loanPurposeINVESTMENT
loanPurposeOWNER_OCCUPIED
+ +

BankingProductRateTierV4

+ +

+
{
+  "name": "string",
+  "unitOfMeasure": "DAY",
+  "minimumValue": "string",
+  "maximumValue": "string",
+  "rateApplicationMethod": "PER_TIER",
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Defines the criteria and conditions for which a rate applies

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryA display name for the tier
unitOfMeasureEnummandatoryThe unit of measure that applies to the minimumValue and maximumValue values, e.g.:
  • DOLLAR for a dollar amount (with values in AmountString format)
  • PERCENT for Loan-to-Value Ratio or LVR (with values in RateString format)
  • MONTH or DAY for a period representing a discrete number of months or days for a fixed-term deposit or loan (with values as a string containing a positive integer)
minimumValuestringmandatoryThe number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
maximumValuestringoptionalThe number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
rateApplicationMethodEnumoptionalThe method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a tier
additionalInfostringoptionalDisplay text providing more information on the rate tier
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate tier
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
unitOfMeasureDAY
unitOfMeasureDOLLAR
unitOfMeasureMONTH
unitOfMeasurePERCENT
rateApplicationMethodPER_TIER
rateApplicationMethodWHOLE_BALANCE
+ +

BankingProductRateConditionV2

+ +

+
{
+  "rateApplicabilityType": "NEW_CUSTOMER",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Defines a condition for the applicability of a tiered rate

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
rateApplicabilityTypeEnumoptionalCategory of applicability condition associated with the rate. For more information refer to Rate and Tier Applicability Types
additionalValuestringconditionalGeneric field containing additional information relevant to the rateApplicabilityType specified. Whether mandatory or not is dependent on the value of rateApplicabilityType
additionalInfostringconditionalDisplay text providing more information on the condition
additionalInfoUriURIStringoptionalLink to a web page with more information on this condition
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
rateApplicabilityTypeDEPOSITS_MIN
rateApplicabilityTypeDEPOSITS_MIN_AMOUNT
rateApplicabilityTypeDEPOSIT_BALANCE_INCREASED
rateApplicabilityTypeEXISTING_CUST
rateApplicabilityTypeNEW_ACCOUNTS
rateApplicabilityTypeNEW_CUSTOMER
rateApplicabilityTypeNEW_CUSTOMER_TO_GROUP
rateApplicabilityTypeONLINE_ONLY
rateApplicabilityTypeOTHER
rateApplicabilityTypePURCHASES_MIN
rateApplicabilityTypeWITHDRAWALS_MAX
rateApplicabilityTypeWITHDRAWALS_MAX_AMOUNT
+ +

BankingProductInstalments

+ +

+
{
+  "maximumPlanCount": 1,
+  "instalmentsLimit": "string",
+  "minimumPlanValue": "string",
+  "maximumPlanValue": "string",
+  "minimumSplit": 4,
+  "maximumSplit": 4
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
maximumPlanCountPositiveIntegermandatoryTotal number of plans that may be created
instalmentsLimitAmountStringmandatoryMaximum combined limit of all instalment plans that may be created
minimumPlanValueAmountStringmandatoryMinimum value that can be opened as an instalment plan
maximumPlanValueAmountStringmandatoryMaximum value that can be opened as an instalment plan
minimumSplitPositiveIntegermandatoryMinimum number of instalment payments a plan can be created with
maximumSplitPositiveIntegermandatoryMaximum number of instalment payments a plan can be created with
+ +

ResponseBankingAccountListV3

+ +

+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "creationDate": "string",
+        "displayName": "string",
+        "nickname": "string",
+        "openStatus": "CLOSED",
+        "isOwned": true,
+        "accountOwnership": "UNKNOWN",
+        "maskedNumber": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "productName": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» accounts[BankingAccountV3]mandatoryThe list of accounts returned. If the filter results in an empty set then this array may have no records
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingAccountV3

+ +

+
{
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
creationDateDateStringoptionalDate that the account was created (if known)
displayNamestringmandatoryThe display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.
nicknamestringoptionalA customer supplied nick name for the account
openStatusEnumoptionalOpen or closed status for the account. If not present then OPEN is assumed
isOwnedBooleanoptionalFlag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then true is assumed
accountOwnershipEnummandatoryValue indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers
maskedNumberMaskedAccountStringmandatoryA masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
productCategoryBankingProductCategoryV2mandatoryThe category to which a product or account belongs. See here for more details
productNamestringmandatoryThe unique identifier of the account as defined by the data holder (akin to model number for the account)
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
openStatusCLOSED
openStatusOPEN
accountOwnershipUNKNOWN
accountOwnershipONE_PARTY
accountOwnershipTWO_PARTY
accountOwnershipMANY_PARTY
accountOwnershipOTHER
+ +

ResponseBankingAccountByIdV4

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "creationDate": "string",
+    "displayName": "string",
+    "nickname": "string",
+    "openStatus": "CLOSED",
+    "isOwned": true,
+    "accountOwnership": "UNKNOWN",
+    "maskedNumber": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "productName": "string",
+    "bsb": "string",
+    "accountNumber": "string",
+    "bundleName": "string",
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4,
+      "plans": [
+        {
+          "planNickname": "string",
+          "creationDate": "string",
+          "amount": "string",
+          "duration": "string",
+          "instalmentInterval": "string",
+          "schedule": [
+            {
+              "amountDue": "string",
+              "dueDate": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "termDeposit": [
+      {
+        "lodgementDate": "string",
+        "maturityDate": "string",
+        "maturityAmount": "string",
+        "maturityCurrency": "string",
+        "maturityInstructions": "HOLD_ON_MATURITY",
+        "depositRateDetail": {
+          "depositRateType": "FIXED",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "tiers": [
+            {
+              "name": "string",
+              "unitOfMeasure": "DAY",
+              "minimumValue": "string",
+              "maximumValue": "string",
+              "rateApplicationMethod": "PER_TIER",
+              "applicabilityConditions": [
+                {
+                  "rateApplicabilityType": "NEW_CUSTOMER",
+                  "additionalValue": "string",
+                  "additionalInfo": "string",
+                  "additionalInfoUri": "string"
+                }
+              ],
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      }
+    ],
+    "creditCard": {
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string",
+      "cardPlans": [
+        {
+          "nickname": "string",
+          "planType": "PURCHASE_PLAN",
+          "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+          "planCreationDate": "string",
+          "planPeriod": "string",
+          "planEndDate": "string",
+          "planReferenceRate": "string",
+          "planEffectiveRate": "string",
+          "minPaymentAmount": "string",
+          "paymentDueAmount": "string",
+          "paymentCurrency": "string",
+          "paymentDueDate": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "interestFreePeriods": [
+            {
+              "from": "string",
+              "to": "string"
+            }
+          ],
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "planFeatures": [
+            {
+              "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+              "period": "string",
+              "endDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "loan": {
+      "originalStartDate": "string",
+      "originalLoanAmount": "string",
+      "originalLoanCurrency": "string",
+      "loanEndDate": "string",
+      "nextInstalmentDate": "string",
+      "minInstalmentAmount": "string",
+      "minInstalmentCurrency": "string",
+      "maxRedraw": "string",
+      "maxRedrawCurrency": "string",
+      "minRedraw": "string",
+      "minRedrawCurrency": "string",
+      "offsetAccountEnabled": true,
+      "offsetAccountIds": [
+        "string"
+      ],
+      "lendingRateDetail": [
+        {
+          "loanPurpose": "OWNER_OCCUPIED",
+          "repaymentType": "PRINCIPAL_AND_INTEREST",
+          "rateStartDate": "string",
+          "rateEndDate": "string",
+          "revertProductId": "string",
+          "repaymentUType": "fixedRate",
+          "fixedRate": {
+            "fixedPeriod": "string",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "variableRate": {
+            "variableRateType": "FLOATING",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "feeAmount": {
+            "amount": "string",
+            "currency": "string",
+            "repaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "deposit": {
+      "lodgementDate": "string",
+      "nickname": "string",
+      "depositRateDetail": {
+        "depositRateType": "FIXED",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    },
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "isActivated": true
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "addresses": [
+      {
+        "addressUType": "paf",
+        "simple": {
+          "mailingName": "string",
+          "addressLine1": "string",
+          "addressLine2": "string",
+          "addressLine3": "string",
+          "postcode": "string",
+          "city": "string",
+          "state": "string",
+          "country": "AUS"
+        },
+        "paf": {
+          "dpid": "string",
+          "thoroughfareNumber1": 0,
+          "thoroughfareNumber1Suffix": "string",
+          "thoroughfareNumber2": 0,
+          "thoroughfareNumber2Suffix": "string",
+          "flatUnitType": "string",
+          "flatUnitNumber": "string",
+          "floorLevelType": "string",
+          "floorLevelNumber": "string",
+          "lotNumber": "string",
+          "buildingName1": "string",
+          "buildingName2": "string",
+          "streetName": "string",
+          "streetType": "string",
+          "streetSuffix": "string",
+          "postalDeliveryType": "string",
+          "postalDeliveryNumber": 0,
+          "postalDeliveryNumberPrefix": "string",
+          "postalDeliveryNumberSuffix": "string",
+          "localityName": "string",
+          "postcode": "string",
+          "state": "string"
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingAccountDetailV4mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingAccountDetailV4

+ +

+
{
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string",
+  "bsb": "string",
+  "accountNumber": "string",
+  "bundleName": "string",
+  "cardOption": {
+    "cardScheme": "AMEX",
+    "cardType": "CHARGE",
+    "cardImages": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ]
+  },
+  "instalments": {
+    "maximumPlanCount": 1,
+    "instalmentsLimit": "string",
+    "minimumPlanValue": "string",
+    "maximumPlanValue": "string",
+    "minimumSplit": 4,
+    "maximumSplit": 4,
+    "plans": [
+      {
+        "planNickname": "string",
+        "creationDate": "string",
+        "amount": "string",
+        "duration": "string",
+        "instalmentInterval": "string",
+        "schedule": [
+          {
+            "amountDue": "string",
+            "dueDate": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "termDeposit": [
+    {
+      "lodgementDate": "string",
+      "maturityDate": "string",
+      "maturityAmount": "string",
+      "maturityCurrency": "string",
+      "maturityInstructions": "HOLD_ON_MATURITY",
+      "depositRateDetail": {
+        "depositRateType": "FIXED",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    }
+  ],
+  "creditCard": {
+    "minPaymentAmount": "string",
+    "paymentDueAmount": "string",
+    "paymentCurrency": "string",
+    "paymentDueDate": "string",
+    "cardPlans": [
+      {
+        "nickname": "string",
+        "planType": "PURCHASE_PLAN",
+        "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+        "planCreationDate": "string",
+        "planPeriod": "string",
+        "planEndDate": "string",
+        "planReferenceRate": "string",
+        "planEffectiveRate": "string",
+        "minPaymentAmount": "string",
+        "paymentDueAmount": "string",
+        "paymentCurrency": "string",
+        "paymentDueDate": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "interestFreePeriods": [
+          {
+            "from": "string",
+            "to": "string"
+          }
+        ],
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "planFeatures": [
+          {
+            "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+            "period": "string",
+            "endDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "loan": {
+    "originalStartDate": "string",
+    "originalLoanAmount": "string",
+    "originalLoanCurrency": "string",
+    "loanEndDate": "string",
+    "nextInstalmentDate": "string",
+    "minInstalmentAmount": "string",
+    "minInstalmentCurrency": "string",
+    "maxRedraw": "string",
+    "maxRedrawCurrency": "string",
+    "minRedraw": "string",
+    "minRedrawCurrency": "string",
+    "offsetAccountEnabled": true,
+    "offsetAccountIds": [
+      "string"
+    ],
+    "lendingRateDetail": [
+      {
+        "loanPurpose": "OWNER_OCCUPIED",
+        "repaymentType": "PRINCIPAL_AND_INTEREST",
+        "rateStartDate": "string",
+        "rateEndDate": "string",
+        "revertProductId": "string",
+        "repaymentUType": "fixedRate",
+        "fixedRate": {
+          "fixedPeriod": "string",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "interestPaymentDue": "IN_ADVANCE",
+          "repaymentFrequency": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        },
+        "variableRate": {
+          "variableRateType": "FLOATING",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "interestPaymentDue": "IN_ADVANCE",
+          "repaymentFrequency": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        },
+        "feeAmount": {
+          "amount": "string",
+          "currency": "string",
+          "repaymentDue": "IN_ADVANCE",
+          "repaymentFrequency": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        },
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "deposit": {
+    "lodgementDate": "string",
+    "nickname": "string",
+    "depositRateDetail": {
+      "depositRateType": "FIXED",
+      "referenceRate": "string",
+      "effectiveRate": "string",
+      "calculationFrequency": "string",
+      "applicationType": "PERIODIC",
+      "applicationFrequency": "string",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": "string",
+          "maximumValue": "string",
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "adjustments": [
+        {
+          "adjustmentType": "BONUS",
+          "amount": "string",
+          "currency": "string",
+          "rate": "string",
+          "adjustmentBundle": "string",
+          "adjustmentPeriod": "string",
+          "adjustmentEndDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  },
+  "features": [
+    {
+      "featureType": "ADDITIONAL_CARDS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "isActivated": true
+    }
+  ],
+  "fees": [
+    {
+      "name": "string",
+      "feeCategory": "CARD",
+      "feeType": "CASH_ADVANCE",
+      "feeMethodUType": "fixedAmount",
+      "fixedAmount": {
+        "amount": "string"
+      },
+      "rateBased": {
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "amountRange": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        }
+      },
+      "variable": {
+        "feeMinimum": "string",
+        "feeMaximum": "string"
+      },
+      "feeCap": "string",
+      "feeCapPeriod": "string",
+      "currency": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "discounts": [
+        {
+          "description": "string",
+          "discountType": "BALANCE",
+          "amount": "string",
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "feeRate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "eligibility": [
+            {
+              "discountEligibilityType": "BUSINESS",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "addresses": [
+    {
+      "addressUType": "paf",
+      "simple": {
+        "mailingName": "string",
+        "addressLine1": "string",
+        "addressLine2": "string",
+        "addressLine3": "string",
+        "postcode": "string",
+        "city": "string",
+        "state": "string",
+        "country": "AUS"
+      },
+      "paf": {
+        "dpid": "string",
+        "thoroughfareNumber1": 0,
+        "thoroughfareNumber1Suffix": "string",
+        "thoroughfareNumber2": 0,
+        "thoroughfareNumber2Suffix": "string",
+        "flatUnitType": "string",
+        "flatUnitNumber": "string",
+        "floorLevelType": "string",
+        "floorLevelNumber": "string",
+        "lotNumber": "string",
+        "buildingName1": "string",
+        "buildingName2": "string",
+        "streetName": "string",
+        "streetType": "string",
+        "streetSuffix": "string",
+        "postalDeliveryType": "string",
+        "postalDeliveryNumber": 0,
+        "postalDeliveryNumberPrefix": "string",
+        "postalDeliveryNumberSuffix": "string",
+        "localityName": "string",
+        "postcode": "string",
+        "state": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingAccountV3mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» bsbstringoptionalThe unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
» accountNumberstringoptionalThe unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
» bundleNamestringoptionalOptional field to indicate if this account is part of a bundle that is providing additional benefit to the customer
» cardOptionBankingProductCardOptionoptionalInformation about the type of card available with the account
» instalmentsBankingAccountInstalmentsoptionalDetails of instalment features on the account
» termDeposit[BankingTermDepositAccountV2]optionalA structure suited to accounts that have term deposit-like features
» creditCardBankingCreditCardAccountV2optionalA structure suited to accounts that have credit card-like features
» loanBankingLoanAccountV3optionalA structure suited to accounts that have loan-like features
» depositBankingDepositAccountoptionalA structure suited to accounts that have deposit-like features without term deposit maturity detail
» features[allOf]optionalArray of features of the account based on the equivalent structure in Product Reference with the following additional field
+ +

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
»» anonymousBankingProductFeatureV3mandatoryArray of features and limitations of the product
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
»» anonymousobjectmandatorynone
»»» isActivatedBooleanoptional
  • true if the feature has been activated by the customer or is a standard feature of the product.
  • false if the feature is not activated but is available for activation.
  • null or absent if the activation state is unknown.
(Note this is an additional field appended to the feature object defined in the Product Reference payload.)
+ +

continued

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
» fees[BankingProductFeeV2]optionalFees and charges applicable to the account based on the equivalent structure in Product Reference
» addresses[CommonPhysicalAddress]optionalThe addresses for the account to be used for correspondence
+ +

BankingAccountInstalments

+ +

+
{
+  "maximumPlanCount": 1,
+  "instalmentsLimit": "string",
+  "minimumPlanValue": "string",
+  "maximumPlanValue": "string",
+  "minimumSplit": 4,
+  "maximumSplit": 4,
+  "plans": [
+    {
+      "planNickname": "string",
+      "creationDate": "string",
+      "amount": "string",
+      "duration": "string",
+      "instalmentInterval": "string",
+      "schedule": [
+        {
+          "amountDue": "string",
+          "dueDate": "string"
+        }
+      ]
+    }
+  ]
+}
+
+
+

Details of instalment features on the account

+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingProductInstalmentsmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» plans[BankingInstalmentPlans]optionalArray of instalment plans
+ +

BankingInstalmentPlans

+ +

+
{
+  "planNickname": "string",
+  "creationDate": "string",
+  "amount": "string",
+  "duration": "string",
+  "instalmentInterval": "string",
+  "schedule": [
+    {
+      "amountDue": "string",
+      "dueDate": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
planNicknamestringmandatoryThe short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels
creationDateDateStringmandatoryThe date the plan was created
amountAmountStringmandatoryThe total amount of the plan
durationExternalRefmandatoryThe original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
instalmentIntervalExternalRefmandatoryThe expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
schedule[BankingInstalmentPlanSchedule]mandatoryArray of expected repayment amounts and dates
+ +

BankingInstalmentPlanSchedule

+ +

+
{
+  "amountDue": "string",
+  "dueDate": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountDueAmountStringmandatoryAmount due with this repayment
dueDateDateStringmandatoryDate this repayment is due
+ +

BankingTermDepositAccountV2

+ +

+
{
+  "lodgementDate": "string",
+  "maturityDate": "string",
+  "maturityAmount": "string",
+  "maturityCurrency": "string",
+  "maturityInstructions": "HOLD_ON_MATURITY",
+  "depositRateDetail": {
+    "depositRateType": "FIXED",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "tiers": [
+      {
+        "name": "string",
+        "unitOfMeasure": "DAY",
+        "minimumValue": "string",
+        "maximumValue": "string",
+        "rateApplicationMethod": "PER_TIER",
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "applicabilityConditions": [
+      {
+        "rateApplicabilityType": "NEW_CUSTOMER",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalValue": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string",
+    "adjustments": [
+      {
+        "adjustmentType": "BONUS",
+        "amount": "string",
+        "currency": "string",
+        "rate": "string",
+        "adjustmentBundle": "string",
+        "adjustmentPeriod": "string",
+        "adjustmentEndDate": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lodgementDateDateStringmandatoryThe lodgement date of the original deposit
maturityDateDateStringmandatoryMaturity date for the term deposit
maturityAmountAmountStringoptionalAmount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated
maturityCurrencyCurrencyStringoptionalIf absent assumes AUD
maturityInstructionsEnummandatoryCurrent instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments
depositRateDetailBankingDepositRateDetailoptionalDetail about deposit rates and adjustments
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
maturityInstructionsHOLD_ON_MATURITY
maturityInstructionsPAID_OUT_AT_MATURITY
maturityInstructionsROLLED_OVER
+ +

BankingDepositRateDetail

+ +

+
{
+  "depositRateType": "FIXED",
+  "referenceRate": "string",
+  "effectiveRate": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": "string",
+      "maximumValue": "string",
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "adjustments": [
+    {
+      "adjustmentType": "BONUS",
+      "amount": "string",
+      "currency": "string",
+      "rate": "string",
+      "adjustmentBundle": "string",
+      "adjustmentPeriod": "string",
+      "adjustmentEndDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Detail about deposit rates and adjustments

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
depositRateTypeEnummandatoryThe type of rate
referenceRateRateStringmandatoryReference rate for this account type and terms
effectiveRateRateStringmandatoryRate being paid for this deposit
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
tiers[BankingProductRateTierV4]optionalRate tiers applicable for this rate
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a rate
additionalValuestringconditionalGeneric field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
adjustments[BankingRateAdjustments]optionalAdjustments applicable to the rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
depositRateTypeFIXED
depositRateTypeFLOATING
depositRateTypeMARKET_LINKED
depositRateTypeVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
+ +

BankingRateAdjustments

+ +

+
{
+  "adjustmentType": "BONUS",
+  "amount": "string",
+  "currency": "string",
+  "rate": "string",
+  "adjustmentBundle": "string",
+  "adjustmentPeriod": "string",
+  "adjustmentEndDate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Information about adjustments to an associated rate

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
adjustmentTypeEnummandatoryThe type of adjustment. For further details, refer to Deposit Adjustment Rate Types and Lending Adjustment Rate Types
amountAmountStringoptionalAdjustment amount if not a rate
currencyCurrencyStringoptionalAdjustment amount currency. If absent assumes AUD
rateRateStringoptionalAdjustment to an associated base rate. The impact to the base rate depends on the type of base (deposit or loan) and the adjustmentType (bonus, discount or penalty)
adjustmentBundlestringoptionalThe name of the bundle that makes the adjustment rate applicable
adjustmentPeriodExternalRefoptionalThe original or standard adjustment period after which the adjustment ends. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
adjustmentEndDateDateStringoptionalDate the adjustment will cease to apply
additionalValuestringconditionalGeneric field containing additional information relevant to the adjustmentType specified. Whether mandatory or not is dependent on the value of adjustmentType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
adjustmentTypeBONUS
adjustmentTypeDISCOUNT
adjustmentTypePENALTY
+ +

BankingCreditCardAccountV2

+ +

+
{
+  "minPaymentAmount": "string",
+  "paymentDueAmount": "string",
+  "paymentCurrency": "string",
+  "paymentDueDate": "string",
+  "cardPlans": [
+    {
+      "nickname": "string",
+      "planType": "PURCHASE_PLAN",
+      "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+      "planCreationDate": "string",
+      "planPeriod": "string",
+      "planEndDate": "string",
+      "planReferenceRate": "string",
+      "planEffectiveRate": "string",
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "interestFreePeriods": [
+        {
+          "from": "string",
+          "to": "string"
+        }
+      ],
+      "adjustments": [
+        {
+          "adjustmentType": "BONUS",
+          "amount": "string",
+          "currency": "string",
+          "rate": "string",
+          "adjustmentBundle": "string",
+          "adjustmentPeriod": "string",
+          "adjustmentEndDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "planFeatures": [
+        {
+          "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+          "period": "string",
+          "endDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
minPaymentAmountAmountStringmandatoryThe minimum payment amount due for the next card payment
paymentDueAmountAmountStringmandatoryThe amount due for the next card payment
paymentCurrencyCurrencyStringoptionalIf absent assumes AUD
paymentDueDateDateStringmandatoryDate that the next payment for the card is due
cardPlans[BankingCreditCardPlan]mandatoryCard plans sorted in order of repayment allocation. Repayments are allocated to the first entry first.
+ +

BankingCreditCardPlan

+ +

+
{
+  "nickname": "string",
+  "planType": "PURCHASE_PLAN",
+  "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+  "planCreationDate": "string",
+  "planPeriod": "string",
+  "planEndDate": "string",
+  "planReferenceRate": "string",
+  "planEffectiveRate": "string",
+  "minPaymentAmount": "string",
+  "paymentDueAmount": "string",
+  "paymentCurrency": "string",
+  "paymentDueDate": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "interestFreePeriods": [
+    {
+      "from": "string",
+      "to": "string"
+    }
+  ],
+  "adjustments": [
+    {
+      "adjustmentType": "BONUS",
+      "amount": "string",
+      "currency": "string",
+      "rate": "string",
+      "adjustmentBundle": "string",
+      "adjustmentPeriod": "string",
+      "adjustmentEndDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "planFeatures": [
+    {
+      "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+      "period": "string",
+      "endDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
nicknamestringoptionalA short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided
planTypeBankingCardPlanTypesmandatoryThe credit card plan type
atExpiryBalanceTransfersToBankingCardPlanTypesoptionalA reference to the plan type that any balance will be transferred to at the expiry of this plan
planCreationDateDateStringoptionalDate this plan was created
planPeriodExternalRefoptionalOriginal duration for this plan. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
planEndDateDateStringoptionalDate this plan is expected to end
planReferenceRateRateStringmandatoryReference rate for this plan type
planEffectiveRateRateStringmandatoryEffective rate for this plan
minPaymentAmountAmountStringoptionalThe minimum payment amount due for this plan
paymentDueAmountAmountStringoptionalThe amount due for this plan
paymentCurrencyCurrencyStringoptionalIf absent assumes AUD
paymentDueDateDateStringoptionalDate that the next payment for this plan is due
additionalInfostringoptionalDisplay text providing more information on the plan
additionalInfoUriURIStringoptionalLink to a web page with more information on this plan
interestFreePeriods[object]optionalDefines when any current or future interest-free periods will be applicable to this plan. The interest-free period itself will be specified through an associated INTEREST_FREE plan feature.
» fromDateStringoptionalThe date any associated interest-free period will be available for the plan
» toDateStringmandatoryThe date any associated interest-free period will no longer be available
adjustments[BankingRateAdjustments]optionalAdjustments applicable to the plan rate
planFeatures[BankingCardPlanFeatures]optionalArray of features available or applicable to this plan
+ +

BankingCardPlanTypes

+ +

+
"PURCHASE_PLAN"
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousEnummandatorynone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBALANCE_TRANSFER_PLAN
anonymousCASH_ADVANCE_PLAN
anonymousINSTALMENT_PLAN
anonymousPURCHASE_PLAN
+ +

BankingCardPlanFeatures

+ +

+
{
+  "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+  "period": "string",
+  "endDate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Features and limitations available or applicable to the associated plan

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
planFeatureTypeEnummandatoryType of feature or limitation. For details refer to Plan Feature Types.
periodExternalRefoptionalOriginal duration of the feature or limitation. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
endDateDateStringoptionalDate that the feature or limitation will cease to apply
additionalValuestringconditionalDetail associated with the planFeatureType. For details refer to Plan Feature Types.
additionalInfostringoptionalDisplay text providing more information on the plan feature
additionalInfoUriURIStringoptionalLink to a web page with more information on this plan feature
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
planFeatureTypeBALANCE_TRANSFER_ENDS_INTEREST_FREE
planFeatureTypeINSTALMENTS
planFeatureTypeINTEREST_FREE
+ +

BankingDepositAccount

+ +

+
{
+  "lodgementDate": "string",
+  "nickname": "string",
+  "depositRateDetail": {
+    "depositRateType": "FIXED",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "tiers": [
+      {
+        "name": "string",
+        "unitOfMeasure": "DAY",
+        "minimumValue": "string",
+        "maximumValue": "string",
+        "rateApplicationMethod": "PER_TIER",
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "applicabilityConditions": [
+      {
+        "rateApplicabilityType": "NEW_CUSTOMER",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalValue": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string",
+    "adjustments": [
+      {
+        "adjustmentType": "BONUS",
+        "amount": "string",
+        "currency": "string",
+        "rate": "string",
+        "adjustmentBundle": "string",
+        "adjustmentPeriod": "string",
+        "adjustmentEndDate": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lodgementDateDateStringoptionalThe lodgement date of the deposit
nicknameDateStringoptionalA short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided
depositRateDetailBankingDepositRateDetailoptionalDetail about deposit rates and adjustments
+ +

BankingLoanAccountV3

+ +

+
{
+  "originalStartDate": "string",
+  "originalLoanAmount": "string",
+  "originalLoanCurrency": "string",
+  "loanEndDate": "string",
+  "nextInstalmentDate": "string",
+  "minInstalmentAmount": "string",
+  "minInstalmentCurrency": "string",
+  "maxRedraw": "string",
+  "maxRedrawCurrency": "string",
+  "minRedraw": "string",
+  "minRedrawCurrency": "string",
+  "offsetAccountEnabled": true,
+  "offsetAccountIds": [
+    "string"
+  ],
+  "lendingRateDetail": [
+    {
+      "loanPurpose": "OWNER_OCCUPIED",
+      "repaymentType": "PRINCIPAL_AND_INTEREST",
+      "rateStartDate": "string",
+      "rateEndDate": "string",
+      "revertProductId": "string",
+      "repaymentUType": "fixedRate",
+      "fixedRate": {
+        "fixedPeriod": "string",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentFrequency": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "variableRate": {
+        "variableRateType": "FLOATING",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentFrequency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "feeAmount": {
+        "amount": "string",
+        "currency": "string",
+        "repaymentDue": "IN_ADVANCE",
+        "repaymentFrequency": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "adjustments": [
+        {
+          "adjustmentType": "BONUS",
+          "amount": "string",
+          "currency": "string",
+          "rate": "string",
+          "adjustmentBundle": "string",
+          "adjustmentPeriod": "string",
+          "adjustmentEndDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
originalStartDateDateStringoptionalOptional original start date for the loan
originalLoanAmountAmountStringoptionalOptional original loan value
originalLoanCurrencyCurrencyStringoptionalIf absent assumes AUD
loanEndDateDateStringoptionalDate that the loan is due to be repaid in full
nextInstalmentDateDateStringoptionalNext date that an instalment is required
minInstalmentAmountAmountStringoptionalMinimum amount of next instalment
minInstalmentCurrencyCurrencyStringoptionalIf absent assumes AUD
maxRedrawAmountStringoptionalMaximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account
maxRedrawCurrencyCurrencyStringoptionalIf absent assumes AUD
minRedrawAmountStringoptionalMinimum redraw amount
minRedrawCurrencyCurrencyStringoptionalIf absent assumes AUD
offsetAccountEnabledBooleanoptionalSet to true if one or more offset accounts are configured for this loan account
offsetAccountIds[string]optionalThe accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation
lendingRateDetail[BankingLendingRateDetail]optionalInformation about lending rates and adjustments
+ +

BankingLendingRateDetail

+ +

+
{
+  "loanPurpose": "OWNER_OCCUPIED",
+  "repaymentType": "PRINCIPAL_AND_INTEREST",
+  "rateStartDate": "string",
+  "rateEndDate": "string",
+  "revertProductId": "string",
+  "repaymentUType": "fixedRate",
+  "fixedRate": {
+    "fixedPeriod": "string",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "interestPaymentDue": "IN_ADVANCE",
+    "repaymentFrequency": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "variableRate": {
+    "variableRateType": "FLOATING",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "interestPaymentDue": "IN_ADVANCE",
+    "repaymentFrequency": "string",
+    "additionalValue": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "feeAmount": {
+    "amount": "string",
+    "currency": "string",
+    "repaymentDue": "IN_ADVANCE",
+    "repaymentFrequency": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "adjustments": [
+    {
+      "adjustmentType": "BONUS",
+      "amount": "string",
+      "currency": "string",
+      "rate": "string",
+      "adjustmentBundle": "string",
+      "adjustmentPeriod": "string",
+      "adjustmentEndDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Information about lending rates and adjustments. Future-dated rates allow scheduled rate changes such as 'revert' rates to be specified.

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
loanPurposeEnumoptionalThe reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
repaymentTypeEnumoptionalOptions in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
rateStartDateDateStringoptionalDate this rate will begin to apply. If not specified, the rate is currently applicable to the account.
rateEndDateDateStringoptionalDate this rate will cease to apply. If not specified, the rate on the account is not scheduled to change or 'revert' to a different rate setting.
revertProductIdstringoptionalThe productId of the product that this account will revert to at the specified rateEndDate
repaymentUTypeEnummandatoryThe type of structure to present account specific fields
fixedRateBankingLendingRateFixedoptionalnone
variableRateBankingLendingRateVariableoptionalnone
feeAmountBankingLendingFeeoptionalnone
adjustments[BankingRateAdjustments]optionalAdjustments applicable to the rate or fee
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
loanPurposeINVESTMENT
loanPurposeOWNER_OCCUPIED
repaymentTypeINTEREST_ONLY
repaymentTypePRINCIPAL_AND_FEE
repaymentTypePRINCIPAL_AND_INTEREST
repaymentUTypefixedRate
repaymentUTypevariableRate
repaymentUTypefeeAmount
+ +

BankingLendingRateFixed

+ +

+
{
+  "fixedPeriod": "string",
+  "referenceRate": "string",
+  "effectiveRate": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentFrequency": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
fixedPeriodExternalRefoptionalThe period of time for the fixed rate. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
referenceRateRateStringmandatoryReference rate for this account type and terms
effectiveRateRateStringmandatoryThe current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDueEnumoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
+ +

BankingLendingRateVariable

+ +

+
{
+  "variableRateType": "FLOATING",
+  "referenceRate": "string",
+  "effectiveRate": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentFrequency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
variableRateTypeEnummandatoryThe type of variable rate
referenceRateRateStringmandatoryReference rate for this account type and terms
effectiveRateRateStringmandatoryThe current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDueEnumoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
additionalValuestringconditionalGeneric field containing additional information relevant to the variableRateType specified. Whether mandatory or not is dependent on the value of variableRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
variableRateTypeFLOATING
variableRateTypeMARKET_LINKED
variableRateTypeVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
+ +

BankingLendingFee

+ +

+
{
+  "amount": "string",
+  "currency": "string",
+  "repaymentDue": "IN_ADVANCE",
+  "repaymentFrequency": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryMinimum payment due at specified repaymentFrequency
currencyCurrencyStringoptionalCurrency of the fee. AUD assumed if not present
repaymentDueEnumoptionalWhen loan payments are due to be paid within each period
repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
additionalInfostringoptionalDisplay text providing more information on the fee
additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
repaymentDueIN_ADVANCE
repaymentDueIN_ARREARS
+ +

ResponseBankingTransactionList

+ +

+
{
+  "data": {
+    "transactions": [
+      {
+        "accountId": "string",
+        "transactionId": "string",
+        "isDetailAvailable": true,
+        "type": "DIRECT_DEBIT",
+        "status": "PENDING",
+        "description": "string",
+        "postingDateTime": "string",
+        "valueDateTime": "string",
+        "executionDateTime": "string",
+        "amount": "string",
+        "currency": "string",
+        "reference": "string",
+        "merchantName": "string",
+        "merchantCategoryCode": "string",
+        "billerCode": "string",
+        "billerName": "string",
+        "crn": "string",
+        "apcaNumber": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0,
+    "isQueryParamUnsupported": false
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» transactions[BankingTransaction]mandatorynone
linksLinksPaginatedmandatorynone
metaMetaPaginatedTransactionmandatorynone
+ +

BankingTransaction

+ +

+
{
+  "accountId": "string",
+  "transactionId": "string",
+  "isDetailAvailable": true,
+  "type": "DIRECT_DEBIT",
+  "status": "PENDING",
+  "description": "string",
+  "postingDateTime": "string",
+  "valueDateTime": "string",
+  "executionDateTime": "string",
+  "amount": "string",
+  "currency": "string",
+  "reference": "string",
+  "merchantName": "string",
+  "merchantCategoryCode": "string",
+  "billerCode": "string",
+  "billerName": "string",
+  "crn": "string",
+  "apcaNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryID of the account for which transactions are provided
transactionIdASCIIStringconditionalA unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if isDetailAvailable is set to true.
isDetailAvailableBooleanmandatorytrue if extended information is available using the transaction detail endpoint. false if extended data is not available
typeEnummandatoryThe type of the transaction
statusEnummandatoryStatus of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction
descriptionstringmandatoryThe transaction description as applied by the financial institution
postingDateTimeDateTimeStringconditionalThe time the transaction was posted. This field is Mandatory if the transaction has status POSTED. This is the time that appears on a standard statement
valueDateTimeDateTimeStringoptionalDate and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry
executionDateTimeDateTimeStringoptionalThe time the transaction was executed by the originating customer, if available
amountAmountStringmandatoryThe value of the transaction. Negative values mean money was outgoing from the account
currencyCurrencyStringoptionalThe currency for the transaction amount. AUD assumed if not present
referencestringmandatoryThe reference for the transaction provided by the originating institution. Empty string if no data provided
merchantNamestringoptionalName of the merchant for an outgoing payment to a merchant
merchantCategoryCodestringoptionalThe merchant category code (or MCC) for an outgoing payment to a merchant
billerCodestringoptionalBPAY Biller Code for the transaction (if available)
billerNamestringoptionalName of the BPAY biller for the transaction (if available)
crnstringconditionalBPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
apcaNumberstringoptional6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeDIRECT_DEBIT
typeFEE
typeINTEREST_CHARGED
typeINTEREST_PAID
typeOTHER
typePAYMENT
typeTRANSFER_INCOMING
typeTRANSFER_OUTGOING
statusPENDING
statusPOSTED
+ +

ResponseBankingTransactionById

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "transactionId": "string",
+    "isDetailAvailable": true,
+    "type": "DIRECT_DEBIT",
+    "status": "PENDING",
+    "description": "string",
+    "postingDateTime": "string",
+    "valueDateTime": "string",
+    "executionDateTime": "string",
+    "amount": "string",
+    "currency": "string",
+    "reference": "string",
+    "merchantName": "string",
+    "merchantCategoryCode": "string",
+    "billerCode": "string",
+    "billerName": "string",
+    "crn": "string",
+    "apcaNumber": "string",
+    "extendedData": {
+      "payer": "string",
+      "payee": "string",
+      "extensionUType": "x2p101Payload",
+      "x2p101Payload": {
+        "extendedDescription": "string",
+        "endToEndId": "string",
+        "purposeCode": "string"
+      },
+      "service": "X2P1.01"
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingTransactionDetailmandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingTransactionDetail

+ +

+
{
+  "accountId": "string",
+  "transactionId": "string",
+  "isDetailAvailable": true,
+  "type": "DIRECT_DEBIT",
+  "status": "PENDING",
+  "description": "string",
+  "postingDateTime": "string",
+  "valueDateTime": "string",
+  "executionDateTime": "string",
+  "amount": "string",
+  "currency": "string",
+  "reference": "string",
+  "merchantName": "string",
+  "merchantCategoryCode": "string",
+  "billerCode": "string",
+  "billerName": "string",
+  "crn": "string",
+  "apcaNumber": "string",
+  "extendedData": {
+    "payer": "string",
+    "payee": "string",
+    "extensionUType": "x2p101Payload",
+    "x2p101Payload": {
+      "extendedDescription": "string",
+      "endToEndId": "string",
+      "purposeCode": "string"
+    },
+    "service": "X2P1.01"
+  }
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingTransactionmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» extendedDataobjectmandatorynone
»» payerstringconditionalLabel of the originating payer. Mandatory for inbound payment
»» payeestringconditionalLabel of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)
»» extensionUTypeEnumoptionalOptional extended data specific to transactions originated via NPP
»» x2p101Payloadobjectconditionalnone
»»» extendedDescriptionstringconditionalAn extended string description. Required if the extensionUType field is x2p101Payload
»»» endToEndIdstringoptionalAn end to end ID for the payment created at initiation
»»» purposeCodestringoptionalPurpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service
»» serviceEnummandatoryIdentifier of the applicable overlay service. Valid values are: X2P1.01
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
extensionUTypex2p101Payload
serviceX2P1.01
+ +

ResponseBankingAccountsBalanceList

+ +

+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» balances[BankingBalance]mandatoryThe list of balances returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

ResponseBankingAccountsBalanceById

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "currentBalance": "string",
+    "availableBalance": "string",
+    "creditLimit": "string",
+    "amortisedLimit": "string",
+    "currency": "string",
+    "purses": [
+      {
+        "amount": "string",
+        "currency": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingBalancemandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingBalance

+ +

+
{
+  "accountId": "string",
+  "currentBalance": "string",
+  "availableBalance": "string",
+  "creditLimit": "string",
+  "amortisedLimit": "string",
+  "currency": "string",
+  "purses": [
+    {
+      "amount": "string",
+      "currency": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
currentBalanceAmountStringmandatoryThe balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing
availableBalanceAmountStringmandatoryBalance representing the amount of funds available for transfer. Assumed to be zero or positive
creditLimitAmountStringoptionalObject representing the maximum amount of credit that is available for this account. Assumed to be zero if absent
amortisedLimitAmountStringoptionalObject representing the available limit amortised according to payment schedule. Assumed to be zero if absent
currencyCurrencyStringoptionalThe currency for the balance amounts. If absent assumed to be AUD
purses[BankingBalancePurse]optionalOptional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards
+ +

BankingBalancePurse

+ +

+
{
+  "amount": "string",
+  "currency": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryThe balance available for this additional currency purse
currencyCurrencyStringoptionalThe currency for the purse
+ +

ResponseBankingPayeeListV2

+ +

+
{
+  "data": {
+    "payees": [
+      {
+        "payeeId": "string",
+        "nickname": "string",
+        "description": "string",
+        "type": "BILLER",
+        "creationDate": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» payees[BankingPayeeV2]mandatoryThe list of payees returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

ResponseBankingPayeeByIdV2

+ +

+
{
+  "data": {
+    "payeeId": "string",
+    "nickname": "string",
+    "description": "string",
+    "type": "BILLER",
+    "creationDate": "string",
+    "payeeUType": "biller",
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingPayeeDetailV2mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingPayeeV2

+ +

+
{
+  "payeeId": "string",
+  "nickname": "string",
+  "description": "string",
+  "type": "BILLER",
+  "creationDate": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
payeeIdASCIIStringmandatoryID of the payee adhering to the rules of ID permanence
nicknamestringmandatoryThe short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels
descriptionstringoptionalA description of the payee provided by the customer
typeEnummandatoryThe type of payee.
  • DOMESTIC means a registered payee for domestic payments including NPP.
  • INTERNATIONAL means a registered payee for international payments.
  • BILLER means a registered payee for BPAY.
  • DIGITAL_WALLET means a registered payee for a bank's digital wallet
creationDateDateStringoptionalThe date the payee was created by the customer
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeBILLER
typeDIGITAL_WALLET
typeDOMESTIC
typeINTERNATIONAL
+ +

BankingPayeeDetailV2

+ +

+
{
+  "payeeId": "string",
+  "nickname": "string",
+  "description": "string",
+  "type": "BILLER",
+  "creationDate": "string",
+  "payeeUType": "biller",
+  "biller": {
+    "billerCode": "string",
+    "crn": "string",
+    "billerName": "string"
+  },
+  "domestic": {
+    "payeeAccountUType": "account",
+    "account": {
+      "accountName": "string",
+      "bsb": "string",
+      "accountNumber": "string"
+    },
+    "card": {
+      "cardNumber": "string"
+    },
+    "payId": {
+      "name": "string",
+      "identifier": "string",
+      "type": "ABN"
+    }
+  },
+  "digitalWallet": {
+    "name": "string",
+    "identifier": "string",
+    "type": "EMAIL",
+    "provider": "PAYPAL_AU"
+  },
+  "international": {
+    "beneficiaryDetails": {
+      "name": "string",
+      "country": "string",
+      "message": "string"
+    },
+    "bankDetails": {
+      "country": "string",
+      "accountNumber": "string",
+      "bankAddress": {
+        "name": "string",
+        "address": "string"
+      },
+      "beneficiaryBankBIC": "string",
+      "fedWireNumber": "string",
+      "sortCode": "string",
+      "chipNumber": "string",
+      "routingNumber": "string",
+      "legalEntityIdentifier": "string"
+    }
+  }
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingPayeeV2mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» payeeUTypeEnummandatoryType of object included that describes the payee in detail
» billerBankingBillerPayeeconditionalnone
» domesticBankingDomesticPayeeconditionalnone
» digitalWalletBankingDigitalWalletPayeeconditionalnone
» internationalBankingInternationalPayeeconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
payeeUTypebiller
payeeUTypedigitalWallet
payeeUTypedomestic
payeeUTypeinternational
+ +

BankingDomesticPayee

+ +

+
{
+  "payeeAccountUType": "account",
+  "account": {
+    "accountName": "string",
+    "bsb": "string",
+    "accountNumber": "string"
+  },
+  "card": {
+    "cardNumber": "string"
+  },
+  "payId": {
+    "name": "string",
+    "identifier": "string",
+    "type": "ABN"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
payeeAccountUTypeEnummandatoryType of account object included. Valid values are:
  • account A standard Australian account defined by BSB/Account Number.
  • card A credit or charge card to pay to (note that PANs are masked).
  • payId A PayID recognised by NPP
accountBankingDomesticPayeeAccountconditionalnone
cardBankingDomesticPayeeCardconditionalnone
payIdBankingDomesticPayeePayIdconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
payeeAccountUTypeaccount
payeeAccountUTypecard
payeeAccountUTypepayId
+ +

BankingDomesticPayeeAccount

+ +

+
{
+  "accountName": "string",
+  "bsb": "string",
+  "accountNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountNamestringoptionalName of the account to pay to
bsbstringmandatoryBSB of the account to pay to
accountNumberstringmandatoryNumber of the account to pay to
+ +

BankingDomesticPayeeCard

+ +

+
{
+  "cardNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
cardNumberMaskedPANStringmandatoryName of the account to pay to
+ +

BankingDomesticPayeePayId

+ +

+
{
+  "name": "string",
+  "identifier": "string",
+  "type": "ABN"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringoptionalThe name assigned to the PayID by the owner of the PayID
identifierstringmandatoryThe identifier of the PayID (dependent on type)
typeEnummandatoryThe type of the PayID
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeABN
typeEMAIL
typeORG_IDENTIFIER
typeTELEPHONE
+ +

BankingBillerPayee

+ +

+
{
+  "billerCode": "string",
+  "crn": "string",
+  "billerName": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
billerCodestringmandatoryBPAY Biller Code of the Biller
crnstringconditionalBPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
billerNamestringmandatoryName of the Biller
+ +

BankingInternationalPayee

+ +

+
{
+  "beneficiaryDetails": {
+    "name": "string",
+    "country": "string",
+    "message": "string"
+  },
+  "bankDetails": {
+    "country": "string",
+    "accountNumber": "string",
+    "bankAddress": {
+      "name": "string",
+      "address": "string"
+    },
+    "beneficiaryBankBIC": "string",
+    "fedWireNumber": "string",
+    "sortCode": "string",
+    "chipNumber": "string",
+    "routingNumber": "string",
+    "legalEntityIdentifier": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
beneficiaryDetailsobjectmandatorynone
» namestringoptionalName of the beneficiary
» countryExternalRefmandatoryCountry where the beneficiary resides. A valid ISO 3166 Alpha-3 country code
» messagestringoptionalResponse message for the payment
bankDetailsobjectmandatorynone
» countryExternalRefmandatoryCountry of the recipient institution. A valid ISO 3166 Alpha-3 country code
» accountNumberstringmandatoryAccount Targeted for payment
» bankAddressobjectoptionalnone
»» namestringmandatoryName of the recipient Bank
»» addressstringmandatoryAddress of the recipient Bank
» beneficiaryBankBICExternalRefoptionalSwift bank code. Aligns with standard ISO 9362
» fedWireNumberstringoptionalNumber for Fedwire payment (Federal Reserve Wire Network)
» sortCodestringoptionalSort code used for account identification in some jurisdictions
» chipNumberstringoptionalNumber for the Clearing House Interbank Payments System
» routingNumberstringoptionalInternational bank routing number
» legalEntityIdentifierExternalRefoptionalThe legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442
+ +

BankingDigitalWalletPayee

+ +

+
{
+  "name": "string",
+  "identifier": "string",
+  "type": "EMAIL",
+  "provider": "PAYPAL_AU"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryThe display name of the wallet as given by the customer, else a default value defined by the data holder
identifierstringmandatoryThe identifier of the digital wallet (dependent on type)
typeEnummandatoryThe type of the digital wallet identifier
providerEnummandatoryThe provider of the digital wallet
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeEMAIL
typeCONTACT_NAME
typeTELEPHONE
providerPAYPAL_AU
providerOTHER
+ +

ResponseBankingDirectDebitAuthorisationList

+ +

+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» directDebitAuthorisations[BankingDirectDebit]mandatoryThe list of authorisations returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingDirectDebit

+ +

+
{
+  "accountId": "string",
+  "authorisedEntity": {
+    "description": "string",
+    "financialInstitution": "string",
+    "abn": "string",
+    "acn": "string",
+    "arbn": "string"
+  },
+  "lastDebitDateTime": "string",
+  "lastDebitAmount": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence.
authorisedEntityBankingAuthorisedEntitymandatorynone
lastDebitDateTimeDateTimeStringoptionalThe date and time of the last debit executed under this authorisation
lastDebitAmountAmountStringoptionalThe amount of the last debit executed under this authorisation
+ +

BankingAuthorisedEntity

+ +

+
{
+  "description": "string",
+  "financialInstitution": "string",
+  "abn": "string",
+  "acn": "string",
+  "arbn": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDescription of the authorised entity derived from previously executed direct debits
financialInstitutionstringconditionalName of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme
abnstringoptionalAustralian Business Number for the authorised entity
acnstringoptionalAustralian Company Number for the authorised entity
arbnstringoptionalAustralian Registered Body Number for the authorised entity
+ +

ResponseBankingScheduledPaymentsListV2

+ +

+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» scheduledPayments[BankingScheduledPaymentV2]mandatoryThe list of scheduled payments to return
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingScheduledPaymentV2

+ +

+
{
+  "scheduledPaymentId": "string",
+  "nickname": "string",
+  "payerReference": "string",
+  "payeeReference": "string",
+  "status": "ACTIVE",
+  "from": {
+    "accountId": "string"
+  },
+  "paymentSet": [
+    {
+      "to": {
+        "toUType": "accountId",
+        "accountId": "string",
+        "payeeId": "string",
+        "nickname": "string",
+        "payeeReference": "string",
+        "digitalWallet": {
+          "name": "string",
+          "identifier": "string",
+          "type": "EMAIL",
+          "provider": "PAYPAL_AU"
+        },
+        "domestic": {
+          "payeeAccountUType": "account",
+          "account": {
+            "accountName": "string",
+            "bsb": "string",
+            "accountNumber": "string"
+          },
+          "card": {
+            "cardNumber": "string"
+          },
+          "payId": {
+            "name": "string",
+            "identifier": "string",
+            "type": "ABN"
+          }
+        },
+        "biller": {
+          "billerCode": "string",
+          "crn": "string",
+          "billerName": "string"
+        },
+        "international": {
+          "beneficiaryDetails": {
+            "name": "string",
+            "country": "string",
+            "message": "string"
+          },
+          "bankDetails": {
+            "country": "string",
+            "accountNumber": "string",
+            "bankAddress": {
+              "name": "string",
+              "address": "string"
+            },
+            "beneficiaryBankBIC": "string",
+            "fedWireNumber": "string",
+            "sortCode": "string",
+            "chipNumber": "string",
+            "routingNumber": "string",
+            "legalEntityIdentifier": "string"
+          }
+        }
+      },
+      "isAmountCalculated": true,
+      "amount": "string",
+      "currency": "string"
+    }
+  ],
+  "recurrence": {
+    "nextPaymentDate": "string",
+    "recurrenceUType": "eventBased",
+    "onceOff": {
+      "paymentDate": "string"
+    },
+    "intervalSchedule": {
+      "finalPaymentDate": "string",
+      "paymentsRemaining": 1,
+      "nonBusinessDayTreatment": "AFTER",
+      "intervals": [
+        {
+          "interval": "string",
+          "dayInInterval": "string"
+        }
+      ]
+    },
+    "lastWeekDay": {
+      "finalPaymentDate": "string",
+      "paymentsRemaining": 1,
+      "interval": "string",
+      "lastWeekDay": "FRI",
+      "nonBusinessDayTreatment": "AFTER"
+    },
+    "eventBased": {
+      "description": "string"
+    }
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
scheduledPaymentIdASCIIStringmandatoryA unique ID of the scheduled payment adhering to the standards for ID permanence
nicknamestringoptionalThe short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels
payerReferencestringmandatoryThe reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided
payeeReferencestringconditionalThe reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided
statusEnummandatoryIndicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
fromBankingScheduledPaymentFrommandatoryObject containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
paymentSet[BankingScheduledPaymentSetV2]mandatory[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]
recurrenceBankingScheduledPaymentRecurrencemandatoryObject containing the detail of the schedule for the payment
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
statusACTIVE
statusINACTIVE
statusSKIP
+ +

BankingScheduledPaymentSetV2

+ +

+
{
+  "to": {
+    "toUType": "accountId",
+    "accountId": "string",
+    "payeeId": "string",
+    "nickname": "string",
+    "payeeReference": "string",
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "isAmountCalculated": true,
+  "amount": "string",
+  "currency": "string"
+}
+
+
+

The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
toBankingScheduledPaymentToV2mandatoryObject containing details of the destination of the payment. Used to specify a variety of payment destination types
isAmountCalculatedBooleanoptionalFlag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed
amountAmountStringconditionalThe amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
currencyCurrencyStringoptionalThe currency for the payment. AUD assumed if not present
+ +

BankingScheduledPaymentToV2

+ +

+
{
+  "toUType": "accountId",
+  "accountId": "string",
+  "payeeId": "string",
+  "nickname": "string",
+  "payeeReference": "string",
+  "digitalWallet": {
+    "name": "string",
+    "identifier": "string",
+    "type": "EMAIL",
+    "provider": "PAYPAL_AU"
+  },
+  "domestic": {
+    "payeeAccountUType": "account",
+    "account": {
+      "accountName": "string",
+      "bsb": "string",
+      "accountNumber": "string"
+    },
+    "card": {
+      "cardNumber": "string"
+    },
+    "payId": {
+      "name": "string",
+      "identifier": "string",
+      "type": "ABN"
+    }
+  },
+  "biller": {
+    "billerCode": "string",
+    "crn": "string",
+    "billerName": "string"
+  },
+  "international": {
+    "beneficiaryDetails": {
+      "name": "string",
+      "country": "string",
+      "message": "string"
+    },
+    "bankDetails": {
+      "country": "string",
+      "accountNumber": "string",
+      "bankAddress": {
+        "name": "string",
+        "address": "string"
+      },
+      "beneficiaryBankBIC": "string",
+      "fedWireNumber": "string",
+      "sortCode": "string",
+      "chipNumber": "string",
+      "routingNumber": "string",
+      "legalEntityIdentifier": "string"
+    }
+  }
+}
+
+
+

Object containing details of the destination of the payment. Used to specify a variety of payment destination types

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
toUTypeEnummandatoryThe type of object provided that specifies the destination of the funds for the payment.
accountIdASCIIStringconditionalPresent if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
payeeIdASCIIStringconditionalPresent if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead
nicknamestringconditionalThe short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels
payeeReferencestringconditionalThe reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.
digitalWalletBankingDigitalWalletPayeeconditionalnone
domesticBankingDomesticPayeeconditionalnone
billerBankingBillerPayeeconditionalnone
internationalBankingInternationalPayeeconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
toUTypeaccountId
toUTypebiller
toUTypedigitalWallet
toUTypedomestic
toUTypeinternational
toUTypepayeeId
+ +

BankingScheduledPaymentFrom

+ +

+
{
+  "accountId": "string"
+}
+
+
+

Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryID of the account that is the source of funds for the payment
+ +

BankingScheduledPaymentRecurrence

+ +

+
{
+  "nextPaymentDate": "string",
+  "recurrenceUType": "eventBased",
+  "onceOff": {
+    "paymentDate": "string"
+  },
+  "intervalSchedule": {
+    "finalPaymentDate": "string",
+    "paymentsRemaining": 1,
+    "nonBusinessDayTreatment": "AFTER",
+    "intervals": [
+      {
+        "interval": "string",
+        "dayInInterval": "string"
+      }
+    ]
+  },
+  "lastWeekDay": {
+    "finalPaymentDate": "string",
+    "paymentsRemaining": 1,
+    "interval": "string",
+    "lastWeekDay": "FRI",
+    "nonBusinessDayTreatment": "AFTER"
+  },
+  "eventBased": {
+    "description": "string"
+  }
+}
+
+
+

Object containing the detail of the schedule for the payment

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
nextPaymentDateDateStringoptionalThe date of the next payment under the recurrence schedule
recurrenceUTypeEnummandatoryThe type of recurrence used to define the schedule
onceOffBankingScheduledPaymentRecurrenceOnceOffconditionalIndicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
intervalScheduleBankingScheduledPaymentRecurrenceIntervalScheduleconditionalIndicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
lastWeekDayBankingScheduledPaymentRecurrenceLastWeekdayconditionalIndicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay
eventBasedBankingScheduledPaymentRecurrenceEventBasedconditionalIndicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
recurrenceUTypeeventBased
recurrenceUTypeintervalSchedule
recurrenceUTypelastWeekDay
recurrenceUTypeonceOff
+ +

BankingScheduledPaymentRecurrenceOnceOff

+ +

+
{
+  "paymentDate": "string"
+}
+
+
+

Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
paymentDateDateStringmandatoryThe scheduled date for the once off payment
+ +

BankingScheduledPaymentRecurrenceIntervalSchedule

+ +

+
{
+  "finalPaymentDate": "string",
+  "paymentsRemaining": 1,
+  "nonBusinessDayTreatment": "AFTER",
+  "intervals": [
+    {
+      "interval": "string",
+      "dayInInterval": "string"
+    }
+  ]
+}
+
+
+

Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
finalPaymentDateDateStringoptionalThe limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
paymentsRemainingPositiveIntegeroptionalIndicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely
nonBusinessDayTreatmentEnumoptionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
intervals[BankingScheduledPaymentInterval]mandatoryAn array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
nonBusinessDayTreatmentAFTER
nonBusinessDayTreatmentBEFORE
nonBusinessDayTreatmentON
nonBusinessDayTreatmentONLY
+ +

BankingScheduledPaymentInterval

+ +

+
{
+  "interval": "string",
+  "dayInInterval": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
intervalExternalRefmandatoryAn interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
dayInIntervalExternalRefoptionalUses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
+ +

BankingScheduledPaymentRecurrenceLastWeekday

+ +

+
{
+  "finalPaymentDate": "string",
+  "paymentsRemaining": 1,
+  "interval": "string",
+  "lastWeekDay": "FRI",
+  "nonBusinessDayTreatment": "AFTER"
+}
+
+
+

Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
finalPaymentDateDateStringoptionalThe limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
paymentsRemainingPositiveIntegeroptionalIndicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
intervalExternalRefmandatoryThe interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
lastWeekDayEnummandatoryThe weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
nonBusinessDayTreatmentEnumoptionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
lastWeekDayFRI
lastWeekDayMON
lastWeekDaySAT
lastWeekDaySUN
lastWeekDayTHU
lastWeekDayTUE
lastWeekDayWED
nonBusinessDayTreatmentAFTER
nonBusinessDayTreatmentBEFORE
nonBusinessDayTreatmentON
nonBusinessDayTreatmentONLY
+ +

BankingScheduledPaymentRecurrenceEventBased

+ +

+
{
+  "description": "string"
+}
+
+
+

Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
+ +

CommonPhysicalAddress

+ +

+
{
+  "addressUType": "paf",
+  "simple": {
+    "mailingName": "string",
+    "addressLine1": "string",
+    "addressLine2": "string",
+    "addressLine3": "string",
+    "postcode": "string",
+    "city": "string",
+    "state": "string",
+    "country": "AUS"
+  },
+  "paf": {
+    "dpid": "string",
+    "thoroughfareNumber1": 0,
+    "thoroughfareNumber1Suffix": "string",
+    "thoroughfareNumber2": 0,
+    "thoroughfareNumber2Suffix": "string",
+    "flatUnitType": "string",
+    "flatUnitNumber": "string",
+    "floorLevelType": "string",
+    "floorLevelNumber": "string",
+    "lotNumber": "string",
+    "buildingName1": "string",
+    "buildingName2": "string",
+    "streetName": "string",
+    "streetType": "string",
+    "streetSuffix": "string",
+    "postalDeliveryType": "string",
+    "postalDeliveryNumber": 0,
+    "postalDeliveryNumberPrefix": "string",
+    "postalDeliveryNumberSuffix": "string",
+    "localityName": "string",
+    "postcode": "string",
+    "state": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
addressUTypeEnummandatoryThe type of address object present
simpleCommonSimpleAddressconditionalnone
pafCommonPAFAddressconditionalAustralian address formatted according to the file format defined by the PAF file format
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
addressUTypepaf
addressUTypesimple
+ +

CommonSimpleAddress

+ +

+
{
+  "mailingName": "string",
+  "addressLine1": "string",
+  "addressLine2": "string",
+  "addressLine3": "string",
+  "postcode": "string",
+  "city": "string",
+  "state": "string",
+  "country": "AUS"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
mailingNamestringoptionalName of the individual or business formatted for inclusion in an address used for physical mail
addressLine1stringmandatoryFirst line of the standard address object
addressLine2stringoptionalSecond line of the standard address object
addressLine3stringoptionalThird line of the standard address object
postcodestringconditionalMandatory for Australian addresses
citystringmandatoryName of the city or locality
statestringmandatoryFree text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
countryExternalRefoptionalA valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
+ +

CommonPAFAddress

+ +

+
{
+  "dpid": "string",
+  "thoroughfareNumber1": 0,
+  "thoroughfareNumber1Suffix": "string",
+  "thoroughfareNumber2": 0,
+  "thoroughfareNumber2Suffix": "string",
+  "flatUnitType": "string",
+  "flatUnitNumber": "string",
+  "floorLevelType": "string",
+  "floorLevelNumber": "string",
+  "lotNumber": "string",
+  "buildingName1": "string",
+  "buildingName2": "string",
+  "streetName": "string",
+  "streetType": "string",
+  "streetSuffix": "string",
+  "postalDeliveryType": "string",
+  "postalDeliveryNumber": 0,
+  "postalDeliveryNumberPrefix": "string",
+  "postalDeliveryNumberSuffix": "string",
+  "localityName": "string",
+  "postcode": "string",
+  "state": "string"
+}
+
+
+

Australian address formatted according to the file format defined by the PAF file format

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dpidstringoptionalUnique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
thoroughfareNumber1PositiveIntegeroptionalThoroughfare number for a property (first number in a property ranged address)
thoroughfareNumber1SuffixstringoptionalSuffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
thoroughfareNumber2PositiveIntegeroptionalSecond thoroughfare number (only used if the property has a ranged address eg 23-25)
thoroughfareNumber2SuffixstringoptionalSuffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
flatUnitTypestringoptionalType of flat or unit for the address
flatUnitNumberstringoptionalUnit number (including suffix, if applicable)
floorLevelTypestringoptionalType of floor or level for the address
floorLevelNumberstringoptionalFloor or level number (including alpha characters)
lotNumberstringoptionalAllotment number for the address
buildingName1stringoptionalBuilding/Property name 1
buildingName2stringoptionalBuilding/Property name 2
streetNamestringoptionalThe name of the street
streetTypestringoptionalThe street type. Valid enumeration defined by Australia Post PAF code file
streetSuffixstringoptionalThe street type suffix. Valid enumeration defined by Australia Post PAF code file
postalDeliveryTypestringoptionalPostal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
postalDeliveryNumberPositiveIntegeroptionalPostal delivery number if the address is a postal delivery type
postalDeliveryNumberPrefixstringoptionalPostal delivery number prefix related to the postal delivery number
postalDeliveryNumberSuffixstringoptionalPostal delivery number suffix related to the postal delivery number
localityNamestringmandatoryFull name of locality
postcodestringmandatoryPostcode for the locality
statestringmandatoryState in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
+ + + +

+
{
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
+ +

Meta

+ +

+
{}
+
+

Properties

+

None

+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaPaginatedTransaction

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0,
+  "isQueryParamUnsupported": false
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousMetaPaginatedmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» isQueryParamUnsupportedBooleanoptionaltrue if "text" query parameter is not supported
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategoryV2

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousEnummandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousBUY_NOW_PAY_LATER
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+

Product Categories

+

The Product Category enumeration lists the available product categories for categorising products and accounts. These are explained in the following tables:

+ +

Deposit Products

+ + + + + + + + + + + + + + + + + + + + + + + +
EnumDescription
REGULATED_TRUST_ACCOUNTSThis grouping of products includes accounts where funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers.
TERM_DEPOSITSThis grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds.
TRANS_AND_SAVINGS_ACCOUNTSThis grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc...
TRAVEL_CARDSThis grouping of products includes prepaid cards with multi-currency capabilities.
+ +

Lending Products

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EnumDescription
BUSINESS_LOANSThis grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease.
BUY_NOW_PAY_LATERThis grouping of products includes 'Buy Now, Pay Later' products that are used to purchase and immediately receive goods or services after an initial down-payment instalment. A predefined or agreed schedule of a number of interest-free instalment payments is made against the remaining balance over time.
CRED_AND_CHRG_CARDSThis grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards.
LEASESThis grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc...
MARGIN_LOANSThis grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds.
OVERDRAFTSThis grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements.
PERS_LOANSThis grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans.
RESIDENTIAL_MORTGAGESThis grouping of products includes all lending products that are available for the primary purpose of borrowing for the purpose of purchasing or renovating residential property, where a residential property will be used as security. This group will include both fixed, variable & secured overdraft types of product and may include both owner-occupied and investment purpose borrowing.
TRADE_FINANCEThis grouping of products includes specialised lending products specifically designed to facilitate domestic & international trade. This includes the issuance of letters of credit, factoring, export credit.
+

Product & Account Components

+

+

Product Feature Types

+ +

Description of the usage of the featureType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
ADDITIONAL_CARDSAdditional cards can be requestedThe maximum number of additional cards. If no maximum then should be set to null
BALANCE_TRANSFERSBalance transfers can be made to the account (eg. for credit cards)NA
BILL_PAYMENTThe product can be attached to an automatic budgeting and bill payment serviceOptional name of the service
BONUS_REWARDSBonus loyalty rewards points are availableNumber of points available
CARD_ACCESSA card is available for the product to access fundsText describing list of card types that this product can be linked to
CASHBACK_OFFERSubject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer.The amount of the cashback offer (in AUD)
COMPLEMENTARY_PRODUCT_DISCOUNTSIndicates that complementary, discounted offerings (such as gift cards, or discounted travel) is availableDescription of the complementary offering
EXTRA_DOWN_PAYMENTAn ability to make a larger than usual down-payment to reduce a repayment amount outstanding. This may enable a purchase that would otherwise have been rejected due to exceeding a credit limitNA
DIGITAL_BANKINGAccess is available to online banking features for the productNA
DIGITAL_WALLETA Digital wallet can be attached to the productThe name or brand of the wallet
DONATE_INTERESTIndicates that interest generated from the product can be automatically donated to a charity or community groupNA
EXTRA_REPAYMENTSIndicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis).NA
FRAUD_PROTECTIONThe product includes fraud protection features.NA
FREE_TXNSA set number of free transactions available per monthThe number of free transactions
FREE_TXNS_ALLOWANCEA set amount of transaction fee value that is discounted per monthThe amount of transaction fee discounted (in AUD)
FUNDS_AVAILABLE_AFTERDeposited funds are available after a specified time period. This is distinct from a term deposit durationThe specified time period. Formatted according to ISO 8601 Durations
GUARANTORSubject to terms and conditions, the customer may be able to nominate a guarantor during the origination process.NA
INSTALMENT_PLANThe product has the option to pay for eligible purchases over time with a set number of payments.NA
INSURANCEInsurance is provided as an additional feature of the productText description of the type of insurance (e.g. Travel Insurance)
INTEREST_FREEInterest free period for purchasesInterest free period. Formatted according to ISO 8601 Durations
INTEREST_FREE_TRANSFERSInterest free period for balance transfersInterest free period. Formatted according to ISO 8601 Durations
LOYALTY_PROGRAMA points based loyalty program is availableName of the loyalty program
MAX_BALANCEA maximum balance is defined for the productThe maximum balance in AmountString format
MAX_LIMITA maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)The maximum limit in AmountString format
MAX_TXNSA maximum number of transactions per month is defined for the productThe maximum number of transactions
MIN_BALANCEA minimum balance is required for the productThe minimum balance in AmountString format
MIN_LIMITA minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)The minimum limit in AmountString format
NOTIFICATIONSAdvanced notifications are available for the productDescription of the notification capability
NPP_ENABLEDAn account of this product type can be used to receive funds as a result of a BSB/Number based NPP paymentNA
NPP_PAYIDAn account of this product type can be used as the target of an NPP PayIDNA
OFFSETAn offset account can be connected to the productNA
OTHERAnother feature that can not be included in any of the other categories. The additionalInfo field is mandatory for this typeNA
OVERDRAFTAn overdraft can be applied forNA
REDRAWRedraw of repaid principal above minimum required is availableNA
RELATIONSHIP_MANAGEMENTRelationship management is available for eligible customers.NA
UNLIMITED_TXNSUnlimited free transactions availableNA
+ +

+

Product Constraint Types

+ +

Description of the usage of the constraintType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
MAX_BALANCEA maximum balance is required for the productThe maximum balance in AmountString format
MAX_LIMITA maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)The maximum limit in AmountString format
MIN_BALANCEA minimum balance is required for the productThe minimum balance in AmountString format
MIN_LIMITA minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)The minimum limit in AmountString format
OPENING_BALANCEAn opening balance is required for the productThe minimum opening balance in AmountString format
OTHERAnother constraint that can not be included in any of the other categories. The additionalInfo field is mandatory for this typeNA
+ +

+

Product Eligibility Types

+ +

Description of the usage of the eligibilityType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BUSINESSOnly business may apply for the accountNA
EMPLOYMENT_STATUSAn eligibility constraint based on employment status appliesA description of the status required
MAX_AGEOnly customers younger than a maximum age may applyThe maximum age in years
MIN_AGEOnly customers older than a minimum age may applyThe minimum age in years
MIN_INCOMEThe customer must have an income greater than a specified threshold to obtain the productMinimum income in AmountString format
MIN_TURNOVEROnly a business with greater than a minimum turnover may applyMinimum turnover in AmountString format
NATURAL_PERSONThe customer must be a natural person rather than another legal entityNA
OTHERAnother eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)NA
PENSION_RECIPIENTOnly a recipient of a government pension may apply for the productOptional. If present, MUST contain a description of which pensions qualify.
RESIDENCY_STATUSAn eligibility constraint based on residency status appliesA description of the status required
STAFFOnly a staff member of the provider may applyNA
STUDENTOnly students may apply for the productOptional. If present, MUST contain a description of who qualifies as a student, e.g. do apprentices qualify?.
+ +

+

Product Fee Categories

+ +

Description of the usage of the feeCategory field as it applies to products. Used to classify Product Fee Types.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
APPLICATIONFees associated with the application or origination of a product
ATMFees associated with the usage of ATMs
BRANCHFees associated with in-branch or over-the-counter interactions
BUY_NOW_PAY_LATERFees associated with a Buy Now, Pay Later product or feature
CARDFees associated with the usage of cards
CHEQUEFees associated with cheques or cheque books
CLOSUREFees associated with the closure of an account or service
CORRESPONDENCEFees associated with correspondence, including paper statements or other types of document requests
FOREIGN_EXCHANGEFees associated with foreign currency exchange services
OTHERAnother fee category that can not be included in any of the other categories. The additionalInfo field is mandatory for this type
POSFees associated with value-added Point-Of-Sale (POS) services
SERVICEFees associated with general product or account service and maintenance requests
TELEGRAPHIC_TRANSFERFees associated with SWIFT or 'Telegraphic Transfer' transactions
TELEPHONE_BANKINGFees associated with services available via telephone banking
TERMS_CONDITIONSFees associated with breaches or requests for variations to contracts or other product terms and conditions
THIRD_PARTYFees associated with services that incur third-party costs
TRANSACTIONFees associated with making transactions that are not aligned to other more specific categories
+ +

+

Product Fee Types

+ +

Description of the usage of the feeType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
CASH_ADVANCEA fee associated with a cash advanceNA
DEPOSITA fee associated with making a depositNA
DISHONOURA fee associated with a dishonourNA
ENQUIRYA fee associated with an enquiry, including a balance enquiryNA
EVENTA fee in relation to a particular event (e.g. ordering a new card, viewing a balance or stopping a cheque)NA
EXITA fee for closing the productNA
OTHERAnother fee that can not be included in any of the other categories. The additionalInfo field is mandatory for this typeNA
PAYMENTA fee associated with making a paymentNA
PAYMENT_LATEA fee associated with making a payment after a due dateNumber of days late, after which the associated fee will be applied
PERIODICA periodic fee such as a monthly account servicing feeThe period of charge. Formatted according to ISO 8601 Durations
PURCHASEA fee associated with making a purchase at a merchantNA
REPLACEMENTA fee associated with a receiving a replacement, including cards, cheques, statements, security tokensNA
TRANSACTIONA fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE)NA
UPFRONTA fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application feeNA
UPFRONT_PER_PLANA fee paid at the creation of a new payment plan, such as an instalment planNA
VARIATIONA fee associated with a request for a variation, including to an existing process, instruction or termsNA
WITHDRAWALA fee associated with making a withdrawalNA
+ +

+

Product Discount Types

+ +

Description of the usage of the discountType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BALANCEDiscount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the feeThe minimum balance in AmountString format
DEPOSITSDiscount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the feeThe minimum deposit amount in AmountString format
ELIGIBILITY_ONLYDiscount applies based on customer eligibility (eligibility array must be populated)N/A
FEE_CAPThe amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time periodThe time period for which the fee cap applies. Formatted according to ISO 8601 Durations
PAYMENTSDiscount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the feeThe payment threshold amount in AmountString format
+ +

+

Product Discount Eligibility Types

+ +

Description of the usage of the discountEligibilityType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BUSINESSA business or other non-person legal entityNA
EMPLOYMENT_STATUSAn eligibility constraint based on employment status appliesA description of the status required
INTRODUCTORYThe discount is only available during an introductory periodThe period of time for the introductory discount. Formatted according to ISO 8601 Durations
MAX_AGEOnly customers younger than a maximum age receive the discountThe maximum age in years
MIN_AGEOnly customers older than a minimum age receive the discountThe minimum age in years
MIN_INCOMEThe customer must have an income greater than a specified threshold to obtain the discountMinimum income in AmountString format
MIN_TURNOVEROnly a business with greater than a minimum turnover is eligibleMinimum turnover in AmountString format
NATURAL_PERSONThe customer must be a natural person rather than another legal entityNA
OTHERAnother eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)NA
PENSION_RECIPIENTOnly a recipient of a government pension may receive the discountOptional. If present, MUST contain a description of which pensions qualify.
RESIDENCY_STATUSAn eligibility constraint based on residency status appliesA description of the status required
STAFFOnly a staff member of the provider may receive the discountNA
STUDENTOnly students may receive the discountOptional. If present, MUST contain a description of who qualifies as a student, e.g. do apprentices qualify?.
+ +

+

Product Deposit Rate Types

+ +

Description of the usage of the depositRateType field as it applies to products.

+ +

+

  • Deposit Base Rate Types

+ +

A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
FIXEDFixed rate for a period of timeThe period of time fixed. Formatted according to ISO 8601 Durations
FLOATINGA floating rate is relatively fixed but still adjusts under specific circumstancesDetails of the float parameters
MARKET_LINKEDA rate that is linked to a specific market, commodity or asset classDetails of the market linkage
VARIABLEA variable base rate for the productNA
+ +

+

  • Deposit Adjustment Rate Types

+ +

A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.

+ + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BONUSA bonus rate available by meeting specific criteria. A description of the bonus rate, including criteria to obtain the bonus is to be provided in the additionalInfo field, or applicabilityConditions where relevant. If the bonus is obtained by originating or maintaining a bundle instead of a standalone product, the bundle name is specified in the associated adjustmentBundle field.The period of time for the bonus rate if applicable. Formatted according to ISO 8601 Durations
+ +

+

Product Lending Rate Types

+ +

Description of the usage of the lendingRateType field as it applies to products.

+ +

+

  • Lending Base Rate Types

+ +

A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.

+ +

Card products may have two or more base rates, including CASH_ADVANCE and PURCHASE as they may apply to different transaction types within an account. The PURCHASE lendingRateType is considered the rate commonly applicable to a card.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BALANCE_TRANSFERSpecific rate applied to balance transfers to the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category onlyNA
CASH_ADVANCESpecific rate applied to cash advances from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category onlyNA
FEEA fee-based amount rather than a rate applies to the accountNA
FIXEDFixed rate for a period of timeThe period of time fixed. Formatted according to ISO 8601 Durations
FLOATINGA floating rate is relatively fixed but still adjusts under specific circumstancesDetails of the float parameters
MARKET_LINKEDA rate that is linked to a specific market, commodity or asset classDetails of the market linkage
PURCHASESpecific rate applied to purchases from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category onlyNA
VARIABLEA variable base rate for the productNA
+ +

+

  • Lending Adjustment Rate Types

+ +

A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.

+ + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
DISCOUNTA discount rate reduces the interest payable. A description of the discount rate is to be provided in the additionalInfo field. Where applicable, the discount is applied to the rate specified in the adjustmentToBase field. If the discount is obtained by originating or maintaining a bundle instead of a standalone product, the bundle name is specified in the associated adjustmentBundle field.The period of time for the discounted rate if applicable. Formatted according to ISO 8601 Durations
PENALTYA penalty rate increases the interest payable. A description of the penalty rate is to be provided in the additionalInfo field. Where applicable, the penalty is applied to the rate specified in the adjustmentToBase field.The period of time for the penalty rate if applicable. Formatted according to ISO 8601 Durations
+ +

+

Banking Term Deposit Account Types

+ +

Description of the usage of the maturityInstructions field as it applies to accounts.

+ + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
HOLD_ON_MATURITYFunds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customerNA
PAID_OUT_AT_MATURITYFunds are to be paid out at maturityNA
ROLLED_OVERFunds are to be rolled over at maturityNA
+ +

+

Rate and Tier Applicability Types

+ +

Description of the usage of the rateApplicabilityType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
DEPOSITS_MINWhen a minimum number of deposits is made in a month, or the month priorMinimum number of deposits
DEPOSITS_MIN_AMOUNTWhen a minimum deposit amount is made in a month, or the month priorMinimum deposit in AmountString format
DEPOSIT_BALANCE_INCREASEDWhen the overall balance of the account, excluding interest, has increased over the month priorMinimum amount in AmountString format
EXISTING_CUSTApplicable to existing customers of the brandNA
NEW_ACCOUNTSApplicable to new accountsNA
NEW_CUSTOMERApplicable to new customers to the brandNA
NEW_CUSTOMER_TO_GROUPApplicable to new customers to a group of brandsNA
ONLINE_ONLYApplicable to accounts originated onlineNA
OTHERApplicable under other conditions. The additionalInfo field is mandatory for this typeNA
PURCHASES_MINWhen a minimum number of purchases is made and settled in a month, or the month priorMinimum number of purchases
WITHDRAWALS_MAXApplicable up to a maximum number of withdrawals in a month, or the month priorMaximum number of withdrawals
WITHDRAWALS_MAX_AMOUNTApplicable up to a maximum amount withdrawn in a month, or the month priorMaximum withdrawn in AmountString format
+ +

+

Plan Feature Types

+ +

Description of the usage of the planFeatureType field as it applies to card plans.

+ + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BALANCE_TRANSFER_ENDS_INTEREST_FREEA balance transfer will end any existing interest-free period on the planNA
INSTALMENTSThe plan supports converting purchases into instalmentsNA
INTEREST_FREEThe plan offers an interest-free periodInterest free period. Formatted according to ISO 8601 Durations
+ +
+
+
+ Non-normative Examples + Version Delta +
+
+ + +
+
+
+ + diff --git a/docs/includes/additional/candidates/dp306/banking-dp306_apis b/docs/includes/additional/candidates/dp306/banking-dp306_apis new file mode 100644 index 00000000..ee9e2d65 --- /dev/null +++ b/docs/includes/additional/candidates/dp306/banking-dp306_apis @@ -0,0 +1,76 @@ +

Banking APIs

+ + +

This specification defines the APIs for Data Holders exposing Banking endpoints.

+ + + + +
Banking OpenAPI Specification (JSON)
Banking OpenAPI Specification (YAML)
+
Changed the `cardArt` array to a `cardOption` object to provide additional card details in 'Get Products', 'Get Product Detail' and 'Get Account Detail'.
+
+Added the `FEE` `lendingRateType` value to support lending products that have a fee-based rather than rate-based cost. This type may be expected to align to the new `PRINCIPAL_AND_FEE` `repaymentType`.
+
+Added the `BALANCE_TRANSFER` `lendingRateType` value to extend support for credit card plan detail.
+
+Updated the `creditCard` schema in 'Get Account Detail' to allow an array of plan types, each with specific rates, repayments, adjustments and features.
+
+Added `revertRate`, `revertProductId`, `rateStartDate` and `rateEndDate` fields to respective lending rate schemas to support 'revert' rate details.
+
+Added `referenceRate` to multiple lending and deposit rate schemas.
+
+Added `adjustmentToBase` and `adjustmentBundle` fields to the 'BankingProductLendingRate' and 'BankingProductDepositRate' schemas. The `adjustmentToBase` field is provided to allow an adjustment rate type to specify which base rate type the adjustment applies to, where many may be offered for a product.
+
+Updated and added the `applicabilityConditions` field in the 'BankingProductLendingRate', 'BankingProductDepositRate' and 'BankingProductRateTier' schemas.
+
+Added the `applicationType` field to clarify whether an associated `applicationFrequency` value is to be expected.
+
+Updated the description of the `features` property of 'Get Product Detail' and 'Get Account Detail' to clarify that the schema also supports providing details of any key operational product limitations.
+
+Updated the description of the `constraints` property of 'Get Product Detail' to clarify that the schema is only intended to provide details of constraints on application for the product.
+
+Added new `featureType` values to support operational limitations and the `OTHER` `constraintType` to allow additional detail to be provided.
+
+Added new `feeCategory` field and new `feeType` values to improve classification and comparison of fees.
+
+Updated the 'BankingProductFee' schema to separate different fee types by UType and added minimum and maximum fee details and `feeCap` fields.
+
+Incorporated rate detail into the 'Get Account Detail' schemas to provide specific rate fields separated from the generic Product Reference rate objects.
+
+Extended the `termDeposit` schema in 'Get Account Detail' to allow each deposit to be specified with specific rates and terms.
+
+Updated the 'adjustment' rate type values to remove the `INTRODUCTORY`, `BUNDLE_BONUS`, `BUNDLE_DISCOUNT_FIXED`, `BUNDLE_DISCOUNT_VARIABLE` options. Time and bundle-based rate detail will be supported through new fields to capture that detail: `adjustmentBundle`, `adjustmentPeriod` and `adjustmentEndDate`, leaving the `additionalValue` field available for other detail where necessary.
+
+Added a `deposit` schema in 'Get Account Detail' to provide rate detail for general deposit structures without term deposit maturity detail.
+
+Removed the `specificAccountUType` field in 'Get Account Detail' to clarify that multiple types may be present in a single account.
+
+Updated the 'Use of additionalValue Field' descriptions for the `PENSION_RECIPIENT` and `STUDENT` 'Product Eligibility' and 'Product Discount Eligibility' types.
+
+Updated the description of the `comparisonRate` field to clarify how it could be interpreted when associated with an adjustment rate type.
+
+Updated the description of the rate tier `unitOfMeasure` field to clarify the format of the associated values, including specifying `PERCENT` values as a RateString.
+
+This candidate incorporates the latest Non-Bank Lending (NBL) Draft changes including the `BUY_NOW_PAY_LATER` product category value, the `instalments` object, and related feature and fee types. The endpoint versions incremented due to changes related to the NBL Draft only, are: 
+ - Get Accounts (v3)
+ - Get Bulk Balances (v2)
+ - Get Bulk Direct Debits (v2)
+ - Get Scheduled Payments Bulk (v3).
+ - Other NBL changes affecting the Register APIs are only shown in the NBL Draft.
+
+The endpoint versions incremented primarily for Decision Proposal 306, but also including NBL detail are: 
+ - Get Account Detail (v4)
+ - Get Products (v4)
+ - Get Product Detail (v5).
+
+Corrected minor typos and updated documentation formatting.
+
\ No newline at end of file diff --git a/docs/includes/additional/candidates/telco.html b/docs/includes/additional/candidates/telco.html index 50888a2b..c26c663e 100644 --- a/docs/includes/additional/candidates/telco.html +++ b/docs/includes/additional/candidates/telco.html @@ -593,8 +593,7 @@
-

Telco APIs

Removed references to 'Other Versions' in 'Get Telco Accounts' and 'Get Telco Account Detail'
-
diff --git a/docs/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis b/docs/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis index d1343fe2..2a4fe600 100644 --- a/docs/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis +++ b/docs/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis @@ -5,3 +5,26 @@ Banking OpenAPI Specification (JSON) Banking OpenAPI Specification (YAML) +
Updated Banking endpoint versions affected by the addition of the `BUY_NOW_PAY_LATER` value in the `product-category` query.
+
+Added `instalments` object in 'Get Product Detail' and 'Get Account Detail' endpoints.
+
+Added `EXTRA_DOWN_PAYMENT` `featureType` to support 'Buy Now, Pay Later' or similar products where a variable down-payment may be made.
+
+Added the 'Product Categories' section to include a general description of the `BUY_NOW_PAY_LATER` category.
+
+Added the 'Product & Account Components' section to include descriptions of the previously included `PAYMENT_LATE` and `UPFRONT_PER_PLAN` `feeType` values.
+
+The endpoint versions incremented due to these changes are:
+ - Get Accounts (v3)
+ - Get Bulk Balances (v2)
+ - Get Account Detail (v4)
+ - Get Bulk Direct Debits (v2)
+ - Get Scheduled Payments Bulk (v3)
+ - Get Products (v4)
+ - Get Product Detail (v5).
+
+Previous Banking endpoint versions are available through the respective 'Obsolete versions' links.
+
+Corrected minor typos and updated documentation formatting.
+
\ No newline at end of file diff --git a/docs/includes/additional/drafts/non-bank-lending/cx_nbl b/docs/includes/additional/drafts/non-bank-lending/cx_nbl new file mode 100644 index 00000000..26956fbb --- /dev/null +++ b/docs/includes/additional/drafts/non-bank-lending/cx_nbl @@ -0,0 +1,3 @@ +

Consumer Experience

Added Consumer Experience section with Banking Language for reference only
+
+

Note: The Draft Consumer Experience (CX) Standards for Non-Bank Lending reflect the existing Banking Language Standards. Other sections of the CX Standards relating to data language not explicitly included on the Draft Standards page including the common data language standards, customer data language, and profile scopes, apply regardless of the sector.

diff --git a/docs/includes/archives b/docs/includes/archives index 1e489cd8..2da5c8e7 100644 --- a/docs/includes/archives +++ b/docs/includes/archives @@ -9,6 +9,11 @@ +10/10/2023 +1.27.0 +Changes arising from Decision 313 (Maintenance Iteration 16) + + 24/08/2023 1.26.0 Changes to obligations for the implementation of Get Metrics diff --git a/docs/includes/cds_admin b/docs/includes/cds_admin index 3747bd31..7e1c212b 100644 --- a/docs/includes/cds_admin +++ b/docs/includes/cds_admin @@ -836,7 +836,7 @@ This operation may only be called by the CDR Register » action -string +Enum mandatory The action to take for the meta data. At the moment the only option is REFRESH which requires the data holder to call the ACCC to refresh meta data as soon as practicable diff --git a/docs/includes/cds_banking b/docs/includes/cds_banking index 0e9bb87a..99a289ae 100644 --- a/docs/includes/cds_banking +++ b/docs/includes/cds_banking @@ -6507,7 +6507,7 @@ This operation does not require authentication featureType -string +Enum mandatory The type of feature described @@ -6676,7 +6676,7 @@ This operation does not require authentication constraintType -string +Enum mandatory The type of constraint described. See the next section for an overview of valid values and their meaning @@ -6749,7 +6749,7 @@ This operation does not require authentication eligibilityType -string +Enum mandatory The type of eligibility criteria described. See the next section for an overview of valid values and their meaning @@ -6885,7 +6885,7 @@ This operation does not require authentication feeType -string +Enum mandatory The type of fee @@ -7040,7 +7040,7 @@ This operation does not require authentication discountType -string +Enum mandatory The type of discount. See the next section for an overview of valid values and their meaning @@ -7149,7 +7149,7 @@ This operation does not require authentication discountEligibilityType -string +Enum mandatory The type of the specific eligibility constraint for a discount @@ -7272,7 +7272,7 @@ This operation does not require authentication depositRateType -string +Enum mandatory The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning @@ -7399,7 +7399,7 @@ This operation does not require authentication lendingRateType -string +Enum mandatory The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning @@ -7429,19 +7429,19 @@ This operation does not require authentication interestPaymentDue -string +Enum optional When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered repaymentType -string +Enum optional Options in place for repayments. If absent, the lending rate is applicable to all repayment types loanPurpose -string +Enum optional The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes @@ -7583,7 +7583,7 @@ This operation does not require authentication unitOfMeasure -string +Enum mandatory The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers) @@ -7601,7 +7601,7 @@ This operation does not require authentication rateApplicationMethod -string +Enum optional The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps') @@ -7809,7 +7809,7 @@ This operation does not require authentication openStatus -string +Enum optional Open or closed status for the account. If not present then OPEN is assumed @@ -7821,7 +7821,7 @@ This operation does not require authentication accountOwnership -string +Enum mandatory Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers @@ -8365,7 +8365,7 @@ This operation does not require authentication » specificAccountUType -string +Enum optional The type of structure to present account specific fields. @@ -8551,7 +8551,7 @@ This operation does not require authentication maturityInstructions -string +Enum mandatory Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments @@ -8734,7 +8734,7 @@ This operation does not require authentication repaymentType -string +Enum optional Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST @@ -8892,13 +8892,13 @@ This operation does not require authentication type -string +Enum mandatory The type of the transaction status -string +Enum mandatory Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction @@ -9190,7 +9190,7 @@ This operation does not require authentication »» extensionUType -string +Enum optional Optional extended data specific to transactions originated via NPP @@ -9220,7 +9220,7 @@ This operation does not require authentication »» service -string +Enum mandatory Identifier of the applicable overlay service. Valid values are: X2P1.01 @@ -9665,7 +9665,7 @@ This operation does not require authentication type -string +Enum mandatory The type of payee.
DOMESTIC means a registered payee for domestic payments including NPP.
INTERNATIONAL means a registered payee for international payments.
BILLER means a registered payee for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital wallet @@ -9798,7 +9798,7 @@ This operation does not require authentication » payeeUType -string +Enum mandatory Type of object included that describes the payee in detail @@ -9883,7 +9883,7 @@ This operation does not require authentication payeeAccountUType -string +Enum mandatory Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number. card A credit or charge card to pay to (note that PANs are masked). payId A PayID recognised by NPP @@ -10021,7 +10021,7 @@ This operation does not require authentication type -string +Enum mandatory The type of the PayID @@ -10254,13 +10254,13 @@ This operation does not require authentication type -string +Enum mandatory The type of the digital wallet identifier provider -string +Enum mandatory The provider of the digital wallet @@ -10760,7 +10760,7 @@ This operation does not require authentication status -string +Enum mandatory Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped. @@ -10977,7 +10977,7 @@ This operation does not require authentication toUType -string +Enum mandatory The type of object provided that specifies the destination of the funds for the payment. @@ -11140,7 +11140,7 @@ This operation does not require authentication recurrenceUType -string +Enum mandatory The type of recurrence used to define the schedule @@ -11260,7 +11260,7 @@ This operation does not require authentication nonBusinessDayTreatment -string +Enum optional Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored @@ -11369,13 +11369,13 @@ This operation does not require authentication lastWeekDay -string +Enum mandatory The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval. nonBusinessDayTreatment -string +Enum optional Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored @@ -11511,7 +11511,7 @@ This operation does not require authentication addressUType -string +Enum mandatory The type of address object present @@ -12059,7 +12059,7 @@ This operation does not require authentication anonymous -string +Enum mandatory The category to which a product or account belongs. See here for more details diff --git a/docs/includes/cds_banking_dp306 b/docs/includes/cds_banking_dp306 new file mode 100644 index 00000000..87ad6eae --- /dev/null +++ b/docs/includes/cds_banking_dp306 @@ -0,0 +1,15093 @@ +

Get Accounts

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts

+ +

Obtain a list of accounts.

+ +

Obsolete versions: v1, v2

+

Endpoint Version

+ + + + + + + + + + +
Version3
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "creationDate": "string",
+        "displayName": "string",
+        "nickname": "string",
+        "openStatus": "CLOSED",
+        "isOwned": true,
+        "accountOwnership": "UNKNOWN",
+        "maskedNumber": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "productName": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountListV3
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Bulk Balances

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/balances

+ +

Obtain balances for multiple, filtered accounts

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Balances For Specific Accounts

+

+ +
+

Code samples

+
+
POST https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+const inputBody = '{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}';
+const headers = {
+  'Content-Type':'application/json',
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

POST /banking/accounts/balances

+ +

Obtain balances for a specified list of accounts

+ +
+

Body parameter

+
+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe 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.
bodybodyRequestAccountIdsmandatoryThe list of account IDs to obtain balances for
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Account Balance

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/balance

+ +

Obtain the balance for a single specified account

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the specific account requested
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accountId": "string",
+    "currentBalance": "string",
+    "availableBalance": "string",
+    "creditLimit": "string",
+    "amortisedLimit": "string",
+    "currency": "string",
+    "purses": [
+      {
+        "amount": "string",
+        "currency": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceById
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Account Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}

+ +

Obtain detailed information on a single account.

+ +

Obsolete versions: v1, v2, v3

+

Endpoint Version

+ + + + + + + + + + +
Version4
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryA tokenised identifier for the account which is unique but not shareable
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accountId": "string",
+    "creationDate": "string",
+    "displayName": "string",
+    "nickname": "string",
+    "openStatus": "CLOSED",
+    "isOwned": true,
+    "accountOwnership": "UNKNOWN",
+    "maskedNumber": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "productName": "string",
+    "bsb": "string",
+    "accountNumber": "string",
+    "bundleName": "string",
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4,
+      "plans": [
+        {
+          "planNickname": "string",
+          "creationDate": "string",
+          "amount": "string",
+          "duration": "string",
+          "instalmentInterval": "string",
+          "schedule": [
+            {
+              "amountDue": "string",
+              "dueDate": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "termDeposit": [
+      {
+        "lodgementDate": "string",
+        "maturityDate": "string",
+        "maturityAmount": "string",
+        "maturityCurrency": "string",
+        "maturityInstructions": "HOLD_ON_MATURITY",
+        "depositRateDetail": {
+          "depositRateType": "FIXED",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "tiers": [
+            {
+              "name": "string",
+              "unitOfMeasure": "DAY",
+              "minimumValue": "string",
+              "maximumValue": "string",
+              "rateApplicationMethod": "PER_TIER",
+              "applicabilityConditions": [
+                {
+                  "rateApplicabilityType": "NEW_CUSTOMER",
+                  "additionalValue": "string",
+                  "additionalInfo": "string",
+                  "additionalInfoUri": "string"
+                }
+              ],
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      }
+    ],
+    "creditCard": {
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string",
+      "cardPlans": [
+        {
+          "nickname": "string",
+          "planType": "PURCHASE_PLAN",
+          "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+          "planCreationDate": "string",
+          "planPeriod": "string",
+          "planEndDate": "string",
+          "planReferenceRate": "string",
+          "planEffectiveRate": "string",
+          "minPaymentAmount": "string",
+          "paymentDueAmount": "string",
+          "paymentCurrency": "string",
+          "paymentDueDate": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "interestFreePeriods": [
+            {
+              "from": "string",
+              "to": "string"
+            }
+          ],
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "planFeatures": [
+            {
+              "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+              "period": "string",
+              "endDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "loan": {
+      "originalStartDate": "string",
+      "originalLoanAmount": "string",
+      "originalLoanCurrency": "string",
+      "loanEndDate": "string",
+      "nextInstalmentDate": "string",
+      "minInstalmentAmount": "string",
+      "minInstalmentCurrency": "string",
+      "maxRedraw": "string",
+      "maxRedrawCurrency": "string",
+      "minRedraw": "string",
+      "minRedrawCurrency": "string",
+      "offsetAccountEnabled": true,
+      "offsetAccountIds": [
+        "string"
+      ],
+      "lendingRateDetail": [
+        {
+          "loanPurpose": "OWNER_OCCUPIED",
+          "repaymentType": "PRINCIPAL_AND_INTEREST",
+          "rateStartDate": "string",
+          "rateEndDate": "string",
+          "revertProductId": "string",
+          "repaymentUType": "fixedRate",
+          "fixedRate": {
+            "fixedPeriod": "string",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "variableRate": {
+            "variableRateType": "FLOATING",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "feeAmount": {
+            "amount": "string",
+            "currency": "string",
+            "repaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "deposit": {
+      "lodgementDate": "string",
+      "nickname": "string",
+      "depositRateDetail": {
+        "depositRateType": "FIXED",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    },
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "isActivated": true
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "addresses": [
+      {
+        "addressUType": "paf",
+        "simple": {
+          "mailingName": "string",
+          "addressLine1": "string",
+          "addressLine2": "string",
+          "addressLine3": "string",
+          "postcode": "string",
+          "city": "string",
+          "state": "string",
+          "country": "AUS"
+        },
+        "paf": {
+          "dpid": "string",
+          "thoroughfareNumber1": 0,
+          "thoroughfareNumber1Suffix": "string",
+          "thoroughfareNumber2": 0,
+          "thoroughfareNumber2Suffix": "string",
+          "flatUnitType": "string",
+          "flatUnitNumber": "string",
+          "floorLevelType": "string",
+          "floorLevelNumber": "string",
+          "lotNumber": "string",
+          "buildingName1": "string",
+          "buildingName2": "string",
+          "streetName": "string",
+          "streetType": "string",
+          "streetSuffix": "string",
+          "postalDeliveryType": "string",
+          "postalDeliveryNumber": 0,
+          "postalDeliveryNumberPrefix": "string",
+          "postalDeliveryNumberSuffix": "string",
+          "localityName": "string",
+          "postcode": "string",
+          "state": "string"
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountByIdV4
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Transactions For Account

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/transactions

+ +

Obtain transactions for a specific account.

+ +

Some general notes that apply to all endpoints that retrieve transactions:

+ + +

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.
oldest-timequeryDateTimeStringoptionalConstrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type
newest-timequeryDateTimeStringoptionalConstrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type
min-amountqueryAmountStringoptionalFilter transactions to only transactions with amounts higher than or equal to this amount
max-amountqueryAmountStringoptionalFilter transactions to only transactions with amounts less than or equal to this amount
textquerystringoptionalFilter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "transactions": [
+      {
+        "accountId": "string",
+        "transactionId": "string",
+        "isDetailAvailable": true,
+        "type": "DIRECT_DEBIT",
+        "status": "PENDING",
+        "description": "string",
+        "postingDateTime": "string",
+        "valueDateTime": "string",
+        "executionDateTime": "string",
+        "amount": "string",
+        "currency": "string",
+        "reference": "string",
+        "merchantName": "string",
+        "merchantCategoryCode": "string",
+        "billerCode": "string",
+        "billerName": "string",
+        "crn": "string",
+        "apcaNumber": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0,
+    "isQueryParamUnsupported": false
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingTransactionList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Transaction Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/transactions/{transactionId}

+ +

Obtain detailed information on a transaction for a specific account

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get transactions for. Must have previously been returned by one of the account list endpoints
transactionIdpathASCIIStringmandatoryID of the transaction obtained from a previous call to one of the other transaction endpoints
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accountId": "string",
+    "transactionId": "string",
+    "isDetailAvailable": true,
+    "type": "DIRECT_DEBIT",
+    "status": "PENDING",
+    "description": "string",
+    "postingDateTime": "string",
+    "valueDateTime": "string",
+    "executionDateTime": "string",
+    "amount": "string",
+    "currency": "string",
+    "reference": "string",
+    "merchantName": "string",
+    "merchantCategoryCode": "string",
+    "billerCode": "string",
+    "billerName": "string",
+    "crn": "string",
+    "apcaNumber": "string",
+    "extendedData": {
+      "payer": "string",
+      "payee": "string",
+      "extensionUType": "x2p101Payload",
+      "x2p101Payload": {
+        "extendedDescription": "string",
+        "endToEndId": "string",
+        "purposeCode": "string"
+      },
+      "service": "X2P1.01"
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingTransactionById
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Direct Debits For Account

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/direct-debits

+ +

Obtain direct debit authorisations for a specific account

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Bulk Direct Debits

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/direct-debits

+ +

Obtain direct debit authorisations for multiple, filtered accounts

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Direct Debits For Specific Accounts

+

+ +
+

Code samples

+
+
POST https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+const inputBody = '{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}';
+const headers = {
+  'Content-Type':'application/json',
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

POST /banking/accounts/direct-debits

+ +

Obtain direct debit authorisations for a specified list of accounts

+ +
+

Body parameter

+
+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe 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.
bodybodyRequestAccountIdsmandatoryArray of specific accountIds to obtain authorisations for
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Scheduled Payments for Account

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/{accountId}/payments/scheduled

+ +

Obtain scheduled, outgoing payments for a specific account

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
accountIdpathASCIIStringmandatoryID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Scheduled Payments Bulk

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payments/scheduled

+ +

Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments

+ +

Obsolete versions: v1, v2

+

Endpoint Version

+ + + + + + + + + + +
Version3
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Scheduled Payments For Specific Accounts

+

+ +
+

Code samples

+
+
POST https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+const inputBody = '{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}';
+const headers = {
+  'Content-Type':'application/json',
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

POST /banking/payments/scheduled

+ +

Obtain scheduled payments for a specified list of accounts

+ +

Obsolete versions: v1

+ +
+

Body parameter

+
+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe 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.
bodybodyRequestAccountIdsmandatoryArray of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Payees

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payees HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payees',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payees

+ +

Obtain a list of pre-registered payees.

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
typequerystringoptionalFilter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
typeALL
typeBILLER
typeDIGITAL_WALLET
typeDOMESTIC
typeINTERNATIONAL
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "payees": [
+      {
+        "payeeId": "string",
+        "nickname": "string",
+        "description": "string",
+        "type": "BILLER",
+        "creationDate": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingPayeeListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Payee Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payees/{payeeId}

+ +

Obtain detailed information on a single payee.

+ +

Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient.

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
payeeIdpathASCIIStringmandatoryThe ID used to locate the details of a particular payee
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "payeeId": "string",
+    "nickname": "string",
+    "description": "string",
+    "type": "BILLER",
+    "creationDate": "string",
+    "payeeUType": "biller",
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingPayeeByIdV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+

Get Products

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/products HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/products',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/products

+ +

Obtain a list of products that are currently openly offered to the market

+ +

Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.

+

Conventions

+

In the product reference payloads there are a number of recurring conventions that are explained here, in one place.

+

Arrays Of Features

+

In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:

+ + +

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 actually has been instantiated and created along with the associated decisions inherent in that process.

+

Dates

+

It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.

+ +

In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.

+ +

Obsolete versions: v1, v2, v3

+

Endpoint Version

+ + + + + + + + + + +
Version4
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
effectivequerystringoptionalAllows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are CURRENT, FUTURE and ALL. If absent defaults to CURRENT
updated-sincequeryDateTimeStringoptionalOnly include products that have been updated after the specified date and time. If absent defaults to include all products
brandquerystringoptionalFilter results based on a specific brand
product-categoryquerystringoptionalUsed 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.
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
effectiveALL
effectiveCURRENT
effectiveFUTURE
product-categoryBUSINESS_LOANS
product-categoryBUY_NOW_PAY_LATER
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "products": [
+      {
+        "productId": "string",
+        "effectiveFrom": "string",
+        "effectiveTo": "string",
+        "lastUpdated": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "name": "string",
+        "description": "string",
+        "brand": "string",
+        "brandName": "string",
+        "applicationUri": "string",
+        "isTailored": true,
+        "additionalInformation": {
+          "overviewUri": "string",
+          "termsUri": "string",
+          "eligibilityUri": "string",
+          "feesAndPricingUri": "string",
+          "bundleUri": "string",
+          "additionalOverviewUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalTermsUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalEligibilityUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalFeesAndPricingUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalBundleUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        },
+        "cardOption": {
+          "cardScheme": "AMEX",
+          "cardType": "CHARGE",
+          "cardImages": [
+            {
+              "title": "string",
+              "imageUri": "string"
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingProductListV3
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
+ +

+

Get Product Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/products/{productId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/products/{productId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/products/{productId}

+ +

Obtain detailed information on a single product offered openly to the market.

+ +

Obsolete versions: v1, v2, v3, v4

+

Endpoint Version

+ + + + + + + + + + +
Version5
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
productIdpathASCIIStringmandatoryID of the specific product requested
x-vheaderstringmandatoryVersion of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "productId": "string",
+    "effectiveFrom": "string",
+    "effectiveTo": "string",
+    "lastUpdated": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "name": "string",
+    "description": "string",
+    "brand": "string",
+    "brandName": "string",
+    "applicationUri": "string",
+    "isTailored": true,
+    "additionalInformation": {
+      "overviewUri": "string",
+      "termsUri": "string",
+      "eligibilityUri": "string",
+      "feesAndPricingUri": "string",
+      "bundleUri": "string",
+      "additionalOverviewUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalTermsUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalEligibilityUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalFeesAndPricingUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalBundleUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    },
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "bundles": [
+      {
+        "name": "string",
+        "description": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "productIds": [
+          "string"
+        ]
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "constraints": [
+      {
+        "constraintType": "MAX_BALANCE",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "eligibility": [
+      {
+        "eligibilityType": "BUSINESS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "depositRates": [
+      {
+        "depositRateType": "VARIABLE",
+        "rate": "string",
+        "adjustmentToBase": "FIXED",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "DISCOUNT",
+        "rate": "string",
+        "referenceRate": "string",
+        "comparisonRate": "string",
+        "revertRate": "string",
+        "revertProductId": "string",
+        "adjustmentToBase": "BALANCE_TRANSFER",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingProductByIdV5
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API endpoint that the data holder has responded with.
+ +

+ +

Schemas

+ +

+ +

RequestAccountIds

+ +

+
{
+  "data": {
+    "accountIds": [
+      "string"
+    ]
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» accountIds[string]mandatorynone
metaMetaoptionalnone
+ +

ResponseBankingProductListV3

+ +

+
{
+  "data": {
+    "products": [
+      {
+        "productId": "string",
+        "effectiveFrom": "string",
+        "effectiveTo": "string",
+        "lastUpdated": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "name": "string",
+        "description": "string",
+        "brand": "string",
+        "brandName": "string",
+        "applicationUri": "string",
+        "isTailored": true,
+        "additionalInformation": {
+          "overviewUri": "string",
+          "termsUri": "string",
+          "eligibilityUri": "string",
+          "feesAndPricingUri": "string",
+          "bundleUri": "string",
+          "additionalOverviewUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalTermsUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalEligibilityUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalFeesAndPricingUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalBundleUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        },
+        "cardOption": {
+          "cardScheme": "AMEX",
+          "cardType": "CHARGE",
+          "cardImages": [
+            {
+              "title": "string",
+              "imageUri": "string"
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» products[BankingProductV5]mandatoryThe list of products returned. If the filter results in an empty set then this array may have no records
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingProductV5

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardOption": {
+    "cardScheme": "AMEX",
+    "cardType": "CHARGE",
+    "cardImages": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ]
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
productIdASCIIStringmandatoryA data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
effectiveFromDateTimeStringoptionalThe date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
effectiveToDateTimeStringoptionalThe date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products
lastUpdatedDateTimeStringmandatoryThe last date and time that the information for this product was changed (or the creation date for the product if it has never been altered)
productCategoryBankingProductCategoryV2mandatoryThe category to which a product or account belongs. See here for more details
namestringmandatoryThe display name of the product
descriptionstringmandatoryA description of the product
brandstringmandatoryA label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required
brandNamestringoptionalAn optional display name of the brand
applicationUriURIStringoptionalA link to an application web page where this product can be applied for.
isTailoredBooleanmandatoryIndicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable
additionalInformationBankingProductAdditionalInformationV2optionalObject that contains links to additional information on specific topics
cardOptionBankingProductCardOptionoptionalInformation about the type of card available with the account
+ +

BankingProductCardOption

+ +

+
{
+  "cardScheme": "AMEX",
+  "cardType": "CHARGE",
+  "cardImages": [
+    {
+      "title": "string",
+      "imageUri": "string"
+    }
+  ]
+}
+
+
+

Information about the type of card available with the account

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
cardSchemeEnummandatoryCard scheme available with the account
cardTypeEnummandatoryCard type available with the account
cardImages[BankingProductCardOption_cardImages]optionalAn array of card art images
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
cardSchemeAMEX
cardSchemeDINERS
cardSchemeEFTPOS
cardSchemeMASTERCARD
cardSchemeVISA
cardSchemeOTHER
cardTypeCHARGE
cardTypeCREDIT
cardTypeDEBIT
+ +

BankingProductCardOption_cardImages

+ +

+
{
+  "title": "string",
+  "imageUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
titlestringoptionalDisplay label for the specific image
imageUriURIStringmandatoryURI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]
+ +

BankingProductAdditionalInformationV2

+ +

+
{
+  "overviewUri": "string",
+  "termsUri": "string",
+  "eligibilityUri": "string",
+  "feesAndPricingUri": "string",
+  "bundleUri": "string",
+  "additionalOverviewUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalTermsUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalEligibilityUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalFeesAndPricingUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalBundleUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Object that contains links to additional information on specific topics

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
overviewUriURIStringconditionalGeneral overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents.
termsUriURIStringconditionalTerms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents.
eligibilityUriURIStringconditionalEligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents.
feesAndPricingUriURIStringconditionalDescription of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents.
bundleUriURIStringconditionalDescription of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents.
additionalOverviewUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri.
additionalTermsUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri.
additionalEligibilityUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri.
additionalFeesAndPricingUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri.
additionalBundleUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri.
+ +

BankingProductAdditionalInformationV2_additionalInformationUris

+ +

+
{
+  "description": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDisplay text providing more information about the document URI
additionalInfoUriURIStringmandatoryThe URI describing the additional information
+ +

ResponseBankingProductByIdV5

+ +

+
{
+  "data": {
+    "productId": "string",
+    "effectiveFrom": "string",
+    "effectiveTo": "string",
+    "lastUpdated": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "name": "string",
+    "description": "string",
+    "brand": "string",
+    "brandName": "string",
+    "applicationUri": "string",
+    "isTailored": true,
+    "additionalInformation": {
+      "overviewUri": "string",
+      "termsUri": "string",
+      "eligibilityUri": "string",
+      "feesAndPricingUri": "string",
+      "bundleUri": "string",
+      "additionalOverviewUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalTermsUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalEligibilityUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalFeesAndPricingUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalBundleUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    },
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "bundles": [
+      {
+        "name": "string",
+        "description": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "productIds": [
+          "string"
+        ]
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "constraints": [
+      {
+        "constraintType": "MAX_BALANCE",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "eligibility": [
+      {
+        "eligibilityType": "BUSINESS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "depositRates": [
+      {
+        "depositRateType": "VARIABLE",
+        "rate": "string",
+        "adjustmentToBase": "FIXED",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "DISCOUNT",
+        "rate": "string",
+        "referenceRate": "string",
+        "comparisonRate": "string",
+        "revertRate": "string",
+        "revertProductId": "string",
+        "adjustmentToBase": "BALANCE_TRANSFER",
+        "adjustmentBundle": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingProductDetailV5mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingProductDetailV5

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardOption": {
+    "cardScheme": "AMEX",
+    "cardType": "CHARGE",
+    "cardImages": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ]
+  },
+  "bundles": [
+    {
+      "name": "string",
+      "description": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "productIds": [
+        "string"
+      ]
+    }
+  ],
+  "features": [
+    {
+      "featureType": "ADDITIONAL_CARDS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "constraints": [
+    {
+      "constraintType": "MAX_BALANCE",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "eligibility": [
+    {
+      "eligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "fees": [
+    {
+      "name": "string",
+      "feeCategory": "CARD",
+      "feeType": "CASH_ADVANCE",
+      "feeMethodUType": "fixedAmount",
+      "fixedAmount": {
+        "amount": "string"
+      },
+      "rateBased": {
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "amountRange": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        }
+      },
+      "variable": {
+        "feeMinimum": "string",
+        "feeMaximum": "string"
+      },
+      "feeCap": "string",
+      "feeCapPeriod": "string",
+      "currency": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "discounts": [
+        {
+          "description": "string",
+          "discountType": "BALANCE",
+          "amount": "string",
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "feeRate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "eligibility": [
+            {
+              "discountEligibilityType": "BUSINESS",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "depositRates": [
+    {
+      "depositRateType": "VARIABLE",
+      "rate": "string",
+      "adjustmentToBase": "FIXED",
+      "adjustmentBundle": "string",
+      "calculationFrequency": "string",
+      "applicationType": "PERIODIC",
+      "applicationFrequency": "string",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": "string",
+          "maximumValue": "string",
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "lendingRates": [
+    {
+      "lendingRateType": "DISCOUNT",
+      "rate": "string",
+      "referenceRate": "string",
+      "comparisonRate": "string",
+      "revertRate": "string",
+      "revertProductId": "string",
+      "adjustmentToBase": "BALANCE_TRANSFER",
+      "adjustmentBundle": "string",
+      "calculationFrequency": "string",
+      "applicationType": "PERIODIC",
+      "applicationFrequency": "string",
+      "interestPaymentDue": "IN_ADVANCE",
+      "repaymentType": "INTEREST_ONLY",
+      "loanPurpose": "INVESTMENT",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": "string",
+          "maximumValue": "string",
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "instalments": {
+    "maximumPlanCount": 1,
+    "instalmentsLimit": "string",
+    "minimumPlanValue": "string",
+    "maximumPlanValue": "string",
+    "minimumSplit": 4,
+    "maximumSplit": 4
+  }
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingProductV5mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» bundles[BankingProductBundle]optionalAn array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also
» features[BankingProductFeatureV3]optionalArray of features and limitations of the product
» constraints[BankingProductConstraintV2]optionalConstraints on the application for the product such as minimum balances or limit thresholds
» eligibility[BankingProductEligibility]optionalEligibility criteria for the product
» fees[BankingProductFeeV2]optionalFees applicable to the product
» depositRates[BankingProductDepositRateV2]optionalInterest rates available for deposits
» lendingRates[BankingProductLendingRateV3]optionalInterest rates charged against lending balances
» instalmentsBankingProductInstalmentsoptionalDetails of instalment features on the account
+ +

BankingProductBundle

+ +

+
{
+  "name": "string",
+  "description": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "productIds": [
+    "string"
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the bundle
descriptionstringmandatoryDescription of the bundle
additionalInfostringoptionalDisplay text providing more information on the bundle
additionalInfoUriURIStringoptionalLink to a web page with more information on the bundle criteria and benefits
productIds[string]optionalArray of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints
+ +

BankingProductFeatureV3

+ +

+
{
+  "featureType": "ADDITIONAL_CARDS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Array of features and limitations of the product

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
featureTypeEnummandatoryThe type of feature described. For further details, refer to Product Feature Types
additionalValuestringconditionalGeneric field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
additionalInfostringconditionalDisplay text providing more information on the feature. Mandatory if the feature type is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this feature
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
featureTypeADDITIONAL_CARDS
featureTypeBALANCE_TRANSFERS
featureTypeBILL_PAYMENT
featureTypeBONUS_REWARDS
featureTypeCARD_ACCESS
featureTypeCASHBACK_OFFER
featureTypeCOMPLEMENTARY_PRODUCT_DISCOUNTS
featureTypeEXTRA_DOWN_PAYMENT
featureTypeDIGITAL_BANKING
featureTypeDIGITAL_WALLET
featureTypeDONATE_INTEREST
featureTypeEXTRA_REPAYMENTS
featureTypeFRAUD_PROTECTION
featureTypeFREE_TXNS
featureTypeFREE_TXNS_ALLOWANCE
featureTypeFUNDS_AVAILABLE_AFTER
featureTypeGUARANTOR
featureTypeINSTALMENT_PLAN
featureTypeINSURANCE
featureTypeINTEREST_FREE
featureTypeINTEREST_FREE_TRANSFERS
featureTypeLOYALTY_PROGRAM
featureTypeMAX_BALANCE
featureTypeMAX_LIMIT
featureTypeMAX_TXNS
featureTypeMIN_BALANCE
featureTypeMIN_LIMIT
featureTypeNOTIFICATIONS
featureTypeNPP_ENABLED
featureTypeNPP_PAYID
featureTypeOFFSET
featureTypeOTHER
featureTypeOVERDRAFT
featureTypeREDRAW
featureTypeRELATIONSHIP_MANAGEMENT
featureTypeUNLIMITED_TXNS
+ +

BankingProductConstraintV2

+ +

+
{
+  "constraintType": "MAX_BALANCE",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
constraintTypeEnummandatoryThe type of constraint described. For further details, refer to Product Constraint Types
additionalValuestringconditionalGeneric field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
additionalInfostringconditionalDisplay text providing more information on the constraint. Mandatory if the constraint type is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on the constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
constraintTypeMAX_BALANCE
constraintTypeMAX_LIMIT
constraintTypeMIN_BALANCE
constraintTypeMIN_LIMIT
constraintTypeOPENING_BALANCE
constraintTypeOTHER
+ +

BankingProductEligibility

+ +

+
{
+  "eligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
eligibilityTypeEnummandatoryThe type of eligibility criteria described. For further details, refer to Product Eligibility Types
additionalValuestringconditionalGeneric field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
additionalInfostringconditionalDisplay text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility criteria
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
eligibilityTypeBUSINESS
eligibilityTypeEMPLOYMENT_STATUS
eligibilityTypeMAX_AGE
eligibilityTypeMIN_AGE
eligibilityTypeMIN_INCOME
eligibilityTypeMIN_TURNOVER
eligibilityTypeNATURAL_PERSON
eligibilityTypeOTHER
eligibilityTypePENSION_RECIPIENT
eligibilityTypeRESIDENCY_STATUS
eligibilityTypeSTAFF
eligibilityTypeSTUDENT
+ +

BankingProductFeeV2

+ +

+
{
+  "name": "string",
+  "feeCategory": "CARD",
+  "feeType": "CASH_ADVANCE",
+  "feeMethodUType": "fixedAmount",
+  "fixedAmount": {
+    "amount": "string"
+  },
+  "rateBased": {
+    "balanceRate": "string",
+    "transactionRate": "string",
+    "accruedRate": "string",
+    "accrualFrequency": "string",
+    "amountRange": {
+      "feeMinimum": "string",
+      "feeMaximum": "string"
+    }
+  },
+  "variable": {
+    "feeMinimum": "string",
+    "feeMaximum": "string"
+  },
+  "feeCap": "string",
+  "feeCapPeriod": "string",
+  "currency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "discounts": [
+    {
+      "description": "string",
+      "discountType": "BALANCE",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "feeRate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "eligibility": [
+        {
+          "discountEligibilityType": "BUSINESS",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the fee
feeCategoryEnummandatoryThe category of fee, used to group feeType values. For further details, refer to Product Fee Categories.
feeTypeEnummandatoryThe type of fee. For further details, refer to Product Fee Types.
feeMethodUTypeEnummandatoryThe fee charge method
fixedAmountBankingFeeAmountconditionalPresent if feeMethodUType is set to fixedAmount. Where the fee is a specific amount
rateBasedBankingFeeRateconditionalPresent if feeMethodUType is set to rateBased. Where the fee is based on a type of rate
variableBankingFeeRangeconditionalPresent if feeMethodUType is set to variable. Where the amount or rate may not be known until the fee is incurred
feeCapAmountStringoptionalThe cap amount if multiple occurrences of the fee are capped to a limit
feeCapPeriodExternalRefoptionalSpecifies a duration over which multiple occurrences of the fee will be capped. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
currencyCurrencyStringoptionalThe currency the fee will be charged in. Assumes AUD if absent
additionalValuestringconditionalGeneric field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
additionalInfostringconditionalDisplay text providing more information on the fee
additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
discounts[BankingProductDiscount]optionalAn optional list of discounts to this fee that may be available
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
feeCategoryAPPLICATION
feeCategoryATM
feeCategoryBRANCH
feeCategoryBUY_NOW_PAY_LATER
feeCategoryCARD
feeCategoryCHEQUE
feeCategoryCLOSURE
feeCategoryCORRESPONDENCE
feeCategoryFOREIGN_EXCHANGE
feeCategoryOTHER
feeCategoryPOS
feeCategorySERVICE
feeCategoryTELEGRAPHIC_TRANSFER
feeCategoryTELEPHONE_BANKING
feeCategoryTERMS_CONDITIONS
feeCategoryTHIRD_PARTY
feeCategoryTRANSACTION
feeTypeCASH_ADVANCE
feeTypeDEPOSIT
feeTypeDISHONOUR
feeTypeENQUIRY
feeTypeEVENT
feeTypeEXIT
feeTypeOTHER
feeTypePAYMENT
feeTypePAYMENT_LATE
feeTypePERIODIC
feeTypePURCHASE
feeTypeREPLACEMENT
feeTypeTRANSACTION
feeTypeUPFRONT
feeTypeUPFRONT_PER_PLAN
feeTypeVARIATION
feeTypeWITHDRAWAL
feeMethodUTypefixedAmount
feeMethodUTyperateBased
feeMethodUTypevariable
+ +

BankingFeeAmount

+ +

+
{
+  "amount": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryThe specific amount charged for the fee each time it is incurred
+ +

BankingFeeRate

+ +

+
{
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "accrualFrequency": "string",
+  "amountRange": {
+    "feeMinimum": "string",
+    "feeMaximum": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
balanceRateRateStringconditionalA fee rate calculated based on a proportion of the balance. One of balanceRate, transactionRate and accruedRate is mandatory
transactionRateRateStringconditionalA fee rate calculated based on a proportion of a transaction. One of balanceRate, transactionRate and accruedRate is mandatory
accruedRateRateStringconditionalA fee rate calculated based on a proportion of the calculated interest accrued on the account. One of balanceRate, transactionRate and accruedRate is mandatory
accrualFrequencyExternalRefoptionalThe indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
amountRangeBankingFeeRangeoptionalA minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred
+ +

BankingFeeRange

+ +

+
{
+  "feeMinimum": "string",
+  "feeMaximum": "string"
+}
+
+
+

A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred

+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
feeMinimumAmountStringoptionalThe minimum fee that will be charged per occurrence
feeMaximumAmountStringoptionalThe maximum fee that will be charged per occurrence
+ +

BankingProductDiscount

+ +

+
{
+  "description": "string",
+  "discountType": "BALANCE",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "feeRate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "eligibility": [
+    {
+      "discountEligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the discount
discountTypeEnummandatoryThe type of discount. For further details, refer to Product Discount Types
amountAmountStringconditionalDollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
balanceRateRateStringconditionalA discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
transactionRateRateStringconditionalA discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
accruedRateRateStringconditionalA discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
feeRateRateStringconditionalA discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
additionalValuestringconditionalGeneric field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
additionalInfostringoptionalDisplay text providing more information on the discount
additionalInfoUriURIStringoptionalLink to a web page with more information on this discount
eligibility[BankingProductDiscountEligibility]conditionalEligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountTypeBALANCE
discountTypeDEPOSITS
discountTypeELIGIBILITY_ONLY
discountTypeFEE_CAP
discountTypePAYMENTS
+ +

BankingProductDiscountEligibility

+ +

+
{
+  "discountEligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
discountEligibilityTypeEnummandatoryThe type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types
additionalValuestringconditionalGeneric field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfostringconditionalDisplay text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountEligibilityTypeBUSINESS
discountEligibilityTypeEMPLOYMENT_STATUS
discountEligibilityTypeINTRODUCTORY
discountEligibilityTypeMAX_AGE
discountEligibilityTypeMIN_AGE
discountEligibilityTypeMIN_INCOME
discountEligibilityTypeMIN_TURNOVER
discountEligibilityTypeNATURAL_PERSON
discountEligibilityTypeOTHER
discountEligibilityTypePENSION_RECIPIENT
discountEligibilityTypeRESIDENCY_STATUS
discountEligibilityTypeSTAFF
discountEligibilityTypeSTUDENT
+ +

BankingProductDepositRateV2

+ +

+
{
+  "depositRateType": "VARIABLE",
+  "rate": "string",
+  "adjustmentToBase": "FIXED",
+  "adjustmentBundle": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": "string",
+      "maximumValue": "string",
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
depositRateTypeEnummandatoryThe type of rate (FIXED, VARIABLE, BONUS, etc). For further details, refer to Product Deposit Rate Types
rateRateStringmandatoryThe rate to be applied
adjustmentToBaseEnumoptionalFor an adjustment depositRateType, the base rate that the adjustment value will apply to. The value of the additionalValue field may be used to further qualify the corresponding base.
adjustmentBundlestringoptionalThe name of the bundle that makes the adjustment rate applicable
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
tiers[BankingProductRateTierV4]optionalRate tiers applicable for this rate
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a rate
additionalValuestringconditionalGeneric field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
depositRateTypeBONUS
depositRateTypeFIXED
depositRateTypeFLOATING
depositRateTypeMARKET_LINKED
depositRateTypeVARIABLE
adjustmentToBaseFIXED
adjustmentToBaseFLOATING
adjustmentToBaseMARKET_LINKED
adjustmentToBaseVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
+ +

BankingProductLendingRateV3

+ +

+
{
+  "lendingRateType": "DISCOUNT",
+  "rate": "string",
+  "referenceRate": "string",
+  "comparisonRate": "string",
+  "revertRate": "string",
+  "revertProductId": "string",
+  "adjustmentToBase": "BALANCE_TRANSFER",
+  "adjustmentBundle": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentType": "INTEREST_ONLY",
+  "loanPurpose": "INVESTMENT",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": "string",
+      "maximumValue": "string",
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lendingRateTypeEnummandatoryThe type of rate (fixed, variable, etc). For further details, refer to Product Lending Rate Types
rateRateStringconditionalThe rate to be applied. Mandatory unless the lendingRateType FEE is supplied
referenceRateRateStringoptionalThe reference or index rate for this account option, or variant
comparisonRateRateStringoptionalA comparison rate equivalent for this rate. The comparison rate associated with an 'adjustment' lendingRateType is the full comparison rate assuming the adjusted rate is available for origination.
revertRateRateStringoptionalThe revert rate applicable after the respective rate expires. For example, FIXED, or INTEREST_ONLY rates may revert to a different rate when those terms expire. Expected where this product will continue to operate with a new 'revert' rate.
revertProductIdstringoptionalA reference to a productId that the associated product will revert to after the respective rate terms expire. For example, FIXED, or INTEREST_ONLY rates may revert to a different rate when those terms expire. Expected if the product will change when the rate reverts to different terms.
adjustmentToBaseEnumoptionalFor an adjustment lendingRateType, the base rate that the adjustment value will apply to. The values of the repaymentType, loanPurpose and additionalValue fields may be used to further qualify the corresponding base.
adjustmentBundlestringoptionalThe name of the bundle that makes the adjustment rate applicable
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDueEnumoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentTypeEnumoptionalOptions in place for repayments. If absent, the lending rate is applicable to all repayment types
loanPurposeEnumoptionalThe reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
tiers[BankingProductRateTierV4]optionalRate tiers applicable for this rate
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a rate
additionalValuestringconditionalGeneric field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
lendingRateTypeBALANCE_TRANSFER
lendingRateTypeCASH_ADVANCE
lendingRateTypeDISCOUNT
lendingRateTypeFEE
lendingRateTypeFIXED
lendingRateTypeFLOATING
lendingRateTypeMARKET_LINKED
lendingRateTypePENALTY
lendingRateTypePURCHASE
lendingRateTypeVARIABLE
adjustmentToBaseBALANCE_TRANSFER
adjustmentToBaseCASH_ADVANCE
adjustmentToBaseFEE
adjustmentToBaseFIXED
adjustmentToBaseFLOATING
adjustmentToBaseMARKET_LINKED
adjustmentToBasePURCHASE
adjustmentToBaseVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
repaymentTypeINTEREST_ONLY
repaymentTypePRINCIPAL_AND_FEE
repaymentTypePRINCIPAL_AND_INTEREST
loanPurposeINVESTMENT
loanPurposeOWNER_OCCUPIED
+ +

BankingProductRateTierV4

+ +

+
{
+  "name": "string",
+  "unitOfMeasure": "DAY",
+  "minimumValue": "string",
+  "maximumValue": "string",
+  "rateApplicationMethod": "PER_TIER",
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Defines the criteria and conditions for which a rate applies

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryA display name for the tier
unitOfMeasureEnummandatoryThe unit of measure that applies to the minimumValue and maximumValue values, e.g.:
  • DOLLAR for a dollar amount (with values in AmountString format)
  • PERCENT for Loan-to-Value Ratio or LVR (with values in RateString format)
  • MONTH or DAY for a period representing a discrete number of months or days for a fixed-term deposit or loan (with values as a string containing a positive integer)
minimumValuestringmandatoryThe number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
maximumValuestringoptionalThe number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
rateApplicationMethodEnumoptionalThe method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a tier
additionalInfostringoptionalDisplay text providing more information on the rate tier
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate tier
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
unitOfMeasureDAY
unitOfMeasureDOLLAR
unitOfMeasureMONTH
unitOfMeasurePERCENT
rateApplicationMethodPER_TIER
rateApplicationMethodWHOLE_BALANCE
+ +

BankingProductRateConditionV2

+ +

+
{
+  "rateApplicabilityType": "NEW_CUSTOMER",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Defines a condition for the applicability of a tiered rate

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
rateApplicabilityTypeEnumoptionalCategory of applicability condition associated with the rate. For more information refer to Rate and Tier Applicability Types
additionalValuestringconditionalGeneric field containing additional information relevant to the rateApplicabilityType specified. Whether mandatory or not is dependent on the value of rateApplicabilityType
additionalInfostringconditionalDisplay text providing more information on the condition
additionalInfoUriURIStringoptionalLink to a web page with more information on this condition
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
rateApplicabilityTypeDEPOSITS_MIN
rateApplicabilityTypeDEPOSITS_MIN_AMOUNT
rateApplicabilityTypeDEPOSIT_BALANCE_INCREASED
rateApplicabilityTypeEXISTING_CUST
rateApplicabilityTypeNEW_ACCOUNTS
rateApplicabilityTypeNEW_CUSTOMER
rateApplicabilityTypeNEW_CUSTOMER_TO_GROUP
rateApplicabilityTypeONLINE_ONLY
rateApplicabilityTypeOTHER
rateApplicabilityTypePURCHASES_MIN
rateApplicabilityTypeWITHDRAWALS_MAX
rateApplicabilityTypeWITHDRAWALS_MAX_AMOUNT
+ +

BankingProductInstalments

+ +

+
{
+  "maximumPlanCount": 1,
+  "instalmentsLimit": "string",
+  "minimumPlanValue": "string",
+  "maximumPlanValue": "string",
+  "minimumSplit": 4,
+  "maximumSplit": 4
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
maximumPlanCountPositiveIntegermandatoryTotal number of plans that may be created
instalmentsLimitAmountStringmandatoryMaximum combined limit of all instalment plans that may be created
minimumPlanValueAmountStringmandatoryMinimum value that can be opened as an instalment plan
maximumPlanValueAmountStringmandatoryMaximum value that can be opened as an instalment plan
minimumSplitPositiveIntegermandatoryMinimum number of instalment payments a plan can be created with
maximumSplitPositiveIntegermandatoryMaximum number of instalment payments a plan can be created with
+ +

ResponseBankingAccountListV3

+ +

+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "creationDate": "string",
+        "displayName": "string",
+        "nickname": "string",
+        "openStatus": "CLOSED",
+        "isOwned": true,
+        "accountOwnership": "UNKNOWN",
+        "maskedNumber": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "productName": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» accounts[BankingAccountV3]mandatoryThe list of accounts returned. If the filter results in an empty set then this array may have no records
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingAccountV3

+ +

+
{
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
creationDateDateStringoptionalDate that the account was created (if known)
displayNamestringmandatoryThe display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.
nicknamestringoptionalA customer supplied nick name for the account
openStatusEnumoptionalOpen or closed status for the account. If not present then OPEN is assumed
isOwnedBooleanoptionalFlag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then true is assumed
accountOwnershipEnummandatoryValue indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers
maskedNumberMaskedAccountStringmandatoryA masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
productCategoryBankingProductCategoryV2mandatoryThe category to which a product or account belongs. See here for more details
productNamestringmandatoryThe unique identifier of the account as defined by the data holder (akin to model number for the account)
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
openStatusCLOSED
openStatusOPEN
accountOwnershipUNKNOWN
accountOwnershipONE_PARTY
accountOwnershipTWO_PARTY
accountOwnershipMANY_PARTY
accountOwnershipOTHER
+ +

ResponseBankingAccountByIdV4

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "creationDate": "string",
+    "displayName": "string",
+    "nickname": "string",
+    "openStatus": "CLOSED",
+    "isOwned": true,
+    "accountOwnership": "UNKNOWN",
+    "maskedNumber": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "productName": "string",
+    "bsb": "string",
+    "accountNumber": "string",
+    "bundleName": "string",
+    "cardOption": {
+      "cardScheme": "AMEX",
+      "cardType": "CHARGE",
+      "cardImages": [
+        {
+          "title": "string",
+          "imageUri": "string"
+        }
+      ]
+    },
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4,
+      "plans": [
+        {
+          "planNickname": "string",
+          "creationDate": "string",
+          "amount": "string",
+          "duration": "string",
+          "instalmentInterval": "string",
+          "schedule": [
+            {
+              "amountDue": "string",
+              "dueDate": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "termDeposit": [
+      {
+        "lodgementDate": "string",
+        "maturityDate": "string",
+        "maturityAmount": "string",
+        "maturityCurrency": "string",
+        "maturityInstructions": "HOLD_ON_MATURITY",
+        "depositRateDetail": {
+          "depositRateType": "FIXED",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "tiers": [
+            {
+              "name": "string",
+              "unitOfMeasure": "DAY",
+              "minimumValue": "string",
+              "maximumValue": "string",
+              "rateApplicationMethod": "PER_TIER",
+              "applicabilityConditions": [
+                {
+                  "rateApplicabilityType": "NEW_CUSTOMER",
+                  "additionalValue": "string",
+                  "additionalInfo": "string",
+                  "additionalInfoUri": "string"
+                }
+              ],
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      }
+    ],
+    "creditCard": {
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string",
+      "cardPlans": [
+        {
+          "nickname": "string",
+          "planType": "PURCHASE_PLAN",
+          "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+          "planCreationDate": "string",
+          "planPeriod": "string",
+          "planEndDate": "string",
+          "planReferenceRate": "string",
+          "planEffectiveRate": "string",
+          "minPaymentAmount": "string",
+          "paymentDueAmount": "string",
+          "paymentCurrency": "string",
+          "paymentDueDate": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "interestFreePeriods": [
+            {
+              "from": "string",
+              "to": "string"
+            }
+          ],
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "planFeatures": [
+            {
+              "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+              "period": "string",
+              "endDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "loan": {
+      "originalStartDate": "string",
+      "originalLoanAmount": "string",
+      "originalLoanCurrency": "string",
+      "loanEndDate": "string",
+      "nextInstalmentDate": "string",
+      "minInstalmentAmount": "string",
+      "minInstalmentCurrency": "string",
+      "maxRedraw": "string",
+      "maxRedrawCurrency": "string",
+      "minRedraw": "string",
+      "minRedrawCurrency": "string",
+      "offsetAccountEnabled": true,
+      "offsetAccountIds": [
+        "string"
+      ],
+      "lendingRateDetail": [
+        {
+          "loanPurpose": "OWNER_OCCUPIED",
+          "repaymentType": "PRINCIPAL_AND_INTEREST",
+          "rateStartDate": "string",
+          "rateEndDate": "string",
+          "revertProductId": "string",
+          "repaymentUType": "fixedRate",
+          "fixedRate": {
+            "fixedPeriod": "string",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "variableRate": {
+            "variableRateType": "FLOATING",
+            "referenceRate": "string",
+            "effectiveRate": "string",
+            "calculationFrequency": "string",
+            "applicationType": "PERIODIC",
+            "applicationFrequency": "string",
+            "interestPaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "feeAmount": {
+            "amount": "string",
+            "currency": "string",
+            "repaymentDue": "IN_ADVANCE",
+            "repaymentFrequency": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "adjustments": [
+            {
+              "adjustmentType": "BONUS",
+              "amount": "string",
+              "currency": "string",
+              "rate": "string",
+              "adjustmentBundle": "string",
+              "adjustmentPeriod": "string",
+              "adjustmentEndDate": "string",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    },
+    "deposit": {
+      "lodgementDate": "string",
+      "nickname": "string",
+      "depositRateDetail": {
+        "depositRateType": "FIXED",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    },
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "isActivated": true
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeCategory": "CARD",
+        "feeType": "CASH_ADVANCE",
+        "feeMethodUType": "fixedAmount",
+        "fixedAmount": {
+          "amount": "string"
+        },
+        "rateBased": {
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "accrualFrequency": "string",
+          "amountRange": {
+            "feeMinimum": "string",
+            "feeMaximum": "string"
+          }
+        },
+        "variable": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        },
+        "feeCap": "string",
+        "feeCapPeriod": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "addresses": [
+      {
+        "addressUType": "paf",
+        "simple": {
+          "mailingName": "string",
+          "addressLine1": "string",
+          "addressLine2": "string",
+          "addressLine3": "string",
+          "postcode": "string",
+          "city": "string",
+          "state": "string",
+          "country": "AUS"
+        },
+        "paf": {
+          "dpid": "string",
+          "thoroughfareNumber1": 0,
+          "thoroughfareNumber1Suffix": "string",
+          "thoroughfareNumber2": 0,
+          "thoroughfareNumber2Suffix": "string",
+          "flatUnitType": "string",
+          "flatUnitNumber": "string",
+          "floorLevelType": "string",
+          "floorLevelNumber": "string",
+          "lotNumber": "string",
+          "buildingName1": "string",
+          "buildingName2": "string",
+          "streetName": "string",
+          "streetType": "string",
+          "streetSuffix": "string",
+          "postalDeliveryType": "string",
+          "postalDeliveryNumber": 0,
+          "postalDeliveryNumberPrefix": "string",
+          "postalDeliveryNumberSuffix": "string",
+          "localityName": "string",
+          "postcode": "string",
+          "state": "string"
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingAccountDetailV4mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingAccountDetailV4

+ +

+
{
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string",
+  "bsb": "string",
+  "accountNumber": "string",
+  "bundleName": "string",
+  "cardOption": {
+    "cardScheme": "AMEX",
+    "cardType": "CHARGE",
+    "cardImages": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ]
+  },
+  "instalments": {
+    "maximumPlanCount": 1,
+    "instalmentsLimit": "string",
+    "minimumPlanValue": "string",
+    "maximumPlanValue": "string",
+    "minimumSplit": 4,
+    "maximumSplit": 4,
+    "plans": [
+      {
+        "planNickname": "string",
+        "creationDate": "string",
+        "amount": "string",
+        "duration": "string",
+        "instalmentInterval": "string",
+        "schedule": [
+          {
+            "amountDue": "string",
+            "dueDate": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "termDeposit": [
+    {
+      "lodgementDate": "string",
+      "maturityDate": "string",
+      "maturityAmount": "string",
+      "maturityCurrency": "string",
+      "maturityInstructions": "HOLD_ON_MATURITY",
+      "depositRateDetail": {
+        "depositRateType": "FIXED",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": "string",
+            "maximumValue": "string",
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": [
+              {
+                "rateApplicabilityType": "NEW_CUSTOMER",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ],
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    }
+  ],
+  "creditCard": {
+    "minPaymentAmount": "string",
+    "paymentDueAmount": "string",
+    "paymentCurrency": "string",
+    "paymentDueDate": "string",
+    "cardPlans": [
+      {
+        "nickname": "string",
+        "planType": "PURCHASE_PLAN",
+        "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+        "planCreationDate": "string",
+        "planPeriod": "string",
+        "planEndDate": "string",
+        "planReferenceRate": "string",
+        "planEffectiveRate": "string",
+        "minPaymentAmount": "string",
+        "paymentDueAmount": "string",
+        "paymentCurrency": "string",
+        "paymentDueDate": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "interestFreePeriods": [
+          {
+            "from": "string",
+            "to": "string"
+          }
+        ],
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "planFeatures": [
+          {
+            "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+            "period": "string",
+            "endDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "loan": {
+    "originalStartDate": "string",
+    "originalLoanAmount": "string",
+    "originalLoanCurrency": "string",
+    "loanEndDate": "string",
+    "nextInstalmentDate": "string",
+    "minInstalmentAmount": "string",
+    "minInstalmentCurrency": "string",
+    "maxRedraw": "string",
+    "maxRedrawCurrency": "string",
+    "minRedraw": "string",
+    "minRedrawCurrency": "string",
+    "offsetAccountEnabled": true,
+    "offsetAccountIds": [
+      "string"
+    ],
+    "lendingRateDetail": [
+      {
+        "loanPurpose": "OWNER_OCCUPIED",
+        "repaymentType": "PRINCIPAL_AND_INTEREST",
+        "rateStartDate": "string",
+        "rateEndDate": "string",
+        "revertProductId": "string",
+        "repaymentUType": "fixedRate",
+        "fixedRate": {
+          "fixedPeriod": "string",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "interestPaymentDue": "IN_ADVANCE",
+          "repaymentFrequency": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        },
+        "variableRate": {
+          "variableRateType": "FLOATING",
+          "referenceRate": "string",
+          "effectiveRate": "string",
+          "calculationFrequency": "string",
+          "applicationType": "PERIODIC",
+          "applicationFrequency": "string",
+          "interestPaymentDue": "IN_ADVANCE",
+          "repaymentFrequency": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        },
+        "feeAmount": {
+          "amount": "string",
+          "currency": "string",
+          "repaymentDue": "IN_ADVANCE",
+          "repaymentFrequency": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        },
+        "adjustments": [
+          {
+            "adjustmentType": "BONUS",
+            "amount": "string",
+            "currency": "string",
+            "rate": "string",
+            "adjustmentBundle": "string",
+            "adjustmentPeriod": "string",
+            "adjustmentEndDate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "deposit": {
+    "lodgementDate": "string",
+    "nickname": "string",
+    "depositRateDetail": {
+      "depositRateType": "FIXED",
+      "referenceRate": "string",
+      "effectiveRate": "string",
+      "calculationFrequency": "string",
+      "applicationType": "PERIODIC",
+      "applicationFrequency": "string",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": "string",
+          "maximumValue": "string",
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": [
+            {
+              "rateApplicabilityType": "NEW_CUSTOMER",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "adjustments": [
+        {
+          "adjustmentType": "BONUS",
+          "amount": "string",
+          "currency": "string",
+          "rate": "string",
+          "adjustmentBundle": "string",
+          "adjustmentPeriod": "string",
+          "adjustmentEndDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  },
+  "features": [
+    {
+      "featureType": "ADDITIONAL_CARDS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "isActivated": true
+    }
+  ],
+  "fees": [
+    {
+      "name": "string",
+      "feeCategory": "CARD",
+      "feeType": "CASH_ADVANCE",
+      "feeMethodUType": "fixedAmount",
+      "fixedAmount": {
+        "amount": "string"
+      },
+      "rateBased": {
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "amountRange": {
+          "feeMinimum": "string",
+          "feeMaximum": "string"
+        }
+      },
+      "variable": {
+        "feeMinimum": "string",
+        "feeMaximum": "string"
+      },
+      "feeCap": "string",
+      "feeCapPeriod": "string",
+      "currency": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "discounts": [
+        {
+          "description": "string",
+          "discountType": "BALANCE",
+          "amount": "string",
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "feeRate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "eligibility": [
+            {
+              "discountEligibilityType": "BUSINESS",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "addresses": [
+    {
+      "addressUType": "paf",
+      "simple": {
+        "mailingName": "string",
+        "addressLine1": "string",
+        "addressLine2": "string",
+        "addressLine3": "string",
+        "postcode": "string",
+        "city": "string",
+        "state": "string",
+        "country": "AUS"
+      },
+      "paf": {
+        "dpid": "string",
+        "thoroughfareNumber1": 0,
+        "thoroughfareNumber1Suffix": "string",
+        "thoroughfareNumber2": 0,
+        "thoroughfareNumber2Suffix": "string",
+        "flatUnitType": "string",
+        "flatUnitNumber": "string",
+        "floorLevelType": "string",
+        "floorLevelNumber": "string",
+        "lotNumber": "string",
+        "buildingName1": "string",
+        "buildingName2": "string",
+        "streetName": "string",
+        "streetType": "string",
+        "streetSuffix": "string",
+        "postalDeliveryType": "string",
+        "postalDeliveryNumber": 0,
+        "postalDeliveryNumberPrefix": "string",
+        "postalDeliveryNumberSuffix": "string",
+        "localityName": "string",
+        "postcode": "string",
+        "state": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingAccountV3mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» bsbstringoptionalThe unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
» accountNumberstringoptionalThe unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
» bundleNamestringoptionalOptional field to indicate if this account is part of a bundle that is providing additional benefit to the customer
» cardOptionBankingProductCardOptionoptionalInformation about the type of card available with the account
» instalmentsBankingAccountInstalmentsoptionalDetails of instalment features on the account
» termDeposit[BankingTermDepositAccountV2]optionalA structure suited to accounts that have term deposit-like features
» creditCardBankingCreditCardAccountV2optionalA structure suited to accounts that have credit card-like features
» loanBankingLoanAccountV3optionalA structure suited to accounts that have loan-like features
» depositBankingDepositAccountoptionalA structure suited to accounts that have deposit-like features without term deposit maturity detail
» features[allOf]optionalArray of features of the account based on the equivalent structure in Product Reference with the following additional field
+ +

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
»» anonymousBankingProductFeatureV3mandatoryArray of features and limitations of the product
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
»» anonymousobjectmandatorynone
»»» isActivatedBooleanoptional
  • true if the feature has been activated by the customer or is a standard feature of the product.
  • false if the feature is not activated but is available for activation.
  • null or absent if the activation state is unknown.
(Note this is an additional field appended to the feature object defined in the Product Reference payload.)
+ +

continued

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
» fees[BankingProductFeeV2]optionalFees and charges applicable to the account based on the equivalent structure in Product Reference
» addresses[CommonPhysicalAddress]optionalThe addresses for the account to be used for correspondence
+ +

BankingAccountInstalments

+ +

+
{
+  "maximumPlanCount": 1,
+  "instalmentsLimit": "string",
+  "minimumPlanValue": "string",
+  "maximumPlanValue": "string",
+  "minimumSplit": 4,
+  "maximumSplit": 4,
+  "plans": [
+    {
+      "planNickname": "string",
+      "creationDate": "string",
+      "amount": "string",
+      "duration": "string",
+      "instalmentInterval": "string",
+      "schedule": [
+        {
+          "amountDue": "string",
+          "dueDate": "string"
+        }
+      ]
+    }
+  ]
+}
+
+
+

Details of instalment features on the account

+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingProductInstalmentsmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» plans[BankingInstalmentPlans]optionalArray of instalment plans
+ +

BankingInstalmentPlans

+ +

+
{
+  "planNickname": "string",
+  "creationDate": "string",
+  "amount": "string",
+  "duration": "string",
+  "instalmentInterval": "string",
+  "schedule": [
+    {
+      "amountDue": "string",
+      "dueDate": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
planNicknamestringmandatoryThe short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels
creationDateDateStringmandatoryThe date the plan was created
amountAmountStringmandatoryThe total amount of the plan
durationExternalRefmandatoryThe original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
instalmentIntervalExternalRefmandatoryThe expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
schedule[BankingInstalmentPlanSchedule]mandatoryArray of expected repayment amounts and dates
+ +

BankingInstalmentPlanSchedule

+ +

+
{
+  "amountDue": "string",
+  "dueDate": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountDueAmountStringmandatoryAmount due with this repayment
dueDateDateStringmandatoryDate this repayment is due
+ +

BankingTermDepositAccountV2

+ +

+
{
+  "lodgementDate": "string",
+  "maturityDate": "string",
+  "maturityAmount": "string",
+  "maturityCurrency": "string",
+  "maturityInstructions": "HOLD_ON_MATURITY",
+  "depositRateDetail": {
+    "depositRateType": "FIXED",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "tiers": [
+      {
+        "name": "string",
+        "unitOfMeasure": "DAY",
+        "minimumValue": "string",
+        "maximumValue": "string",
+        "rateApplicationMethod": "PER_TIER",
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "applicabilityConditions": [
+      {
+        "rateApplicabilityType": "NEW_CUSTOMER",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalValue": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string",
+    "adjustments": [
+      {
+        "adjustmentType": "BONUS",
+        "amount": "string",
+        "currency": "string",
+        "rate": "string",
+        "adjustmentBundle": "string",
+        "adjustmentPeriod": "string",
+        "adjustmentEndDate": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lodgementDateDateStringmandatoryThe lodgement date of the original deposit
maturityDateDateStringmandatoryMaturity date for the term deposit
maturityAmountAmountStringoptionalAmount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated
maturityCurrencyCurrencyStringoptionalIf absent assumes AUD
maturityInstructionsEnummandatoryCurrent instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments
depositRateDetailBankingDepositRateDetailoptionalDetail about deposit rates and adjustments
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
maturityInstructionsHOLD_ON_MATURITY
maturityInstructionsPAID_OUT_AT_MATURITY
maturityInstructionsROLLED_OVER
+ +

BankingDepositRateDetail

+ +

+
{
+  "depositRateType": "FIXED",
+  "referenceRate": "string",
+  "effectiveRate": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": "string",
+      "maximumValue": "string",
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": [
+        {
+          "rateApplicabilityType": "NEW_CUSTOMER",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "applicabilityConditions": [
+    {
+      "rateApplicabilityType": "NEW_CUSTOMER",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "adjustments": [
+    {
+      "adjustmentType": "BONUS",
+      "amount": "string",
+      "currency": "string",
+      "rate": "string",
+      "adjustmentBundle": "string",
+      "adjustmentPeriod": "string",
+      "adjustmentEndDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Detail about deposit rates and adjustments

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
depositRateTypeEnummandatoryThe type of rate
referenceRateRateStringmandatoryReference rate for this account type and terms
effectiveRateRateStringmandatoryRate being paid for this deposit
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
tiers[BankingProductRateTierV4]optionalRate tiers applicable for this rate
applicabilityConditions[BankingProductRateConditionV2]optionalArray of applicability conditions for a rate
additionalValuestringconditionalGeneric field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
adjustments[BankingRateAdjustments]optionalAdjustments applicable to the rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
depositRateTypeFIXED
depositRateTypeFLOATING
depositRateTypeMARKET_LINKED
depositRateTypeVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
+ +

BankingRateAdjustments

+ +

+
{
+  "adjustmentType": "BONUS",
+  "amount": "string",
+  "currency": "string",
+  "rate": "string",
+  "adjustmentBundle": "string",
+  "adjustmentPeriod": "string",
+  "adjustmentEndDate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Information about adjustments to an associated rate

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
adjustmentTypeEnummandatoryThe type of adjustment. For further details, refer to Deposit Adjustment Rate Types and Lending Adjustment Rate Types
amountAmountStringoptionalAdjustment amount if not a rate
currencyCurrencyStringoptionalAdjustment amount currency. If absent assumes AUD
rateRateStringoptionalAdjustment to an associated base rate. The impact to the base rate depends on the type of base (deposit or loan) and the adjustmentType (bonus, discount or penalty)
adjustmentBundlestringoptionalThe name of the bundle that makes the adjustment rate applicable
adjustmentPeriodExternalRefoptionalThe original or standard adjustment period after which the adjustment ends. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
adjustmentEndDateDateStringoptionalDate the adjustment will cease to apply
additionalValuestringconditionalGeneric field containing additional information relevant to the adjustmentType specified. Whether mandatory or not is dependent on the value of adjustmentType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
adjustmentTypeBONUS
adjustmentTypeDISCOUNT
adjustmentTypePENALTY
+ +

BankingCreditCardAccountV2

+ +

+
{
+  "minPaymentAmount": "string",
+  "paymentDueAmount": "string",
+  "paymentCurrency": "string",
+  "paymentDueDate": "string",
+  "cardPlans": [
+    {
+      "nickname": "string",
+      "planType": "PURCHASE_PLAN",
+      "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+      "planCreationDate": "string",
+      "planPeriod": "string",
+      "planEndDate": "string",
+      "planReferenceRate": "string",
+      "planEffectiveRate": "string",
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "interestFreePeriods": [
+        {
+          "from": "string",
+          "to": "string"
+        }
+      ],
+      "adjustments": [
+        {
+          "adjustmentType": "BONUS",
+          "amount": "string",
+          "currency": "string",
+          "rate": "string",
+          "adjustmentBundle": "string",
+          "adjustmentPeriod": "string",
+          "adjustmentEndDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "planFeatures": [
+        {
+          "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+          "period": "string",
+          "endDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
minPaymentAmountAmountStringmandatoryThe minimum payment amount due for the next card payment
paymentDueAmountAmountStringmandatoryThe amount due for the next card payment
paymentCurrencyCurrencyStringoptionalIf absent assumes AUD
paymentDueDateDateStringmandatoryDate that the next payment for the card is due
cardPlans[BankingCreditCardPlan]mandatoryCard plans sorted in order of repayment allocation. Repayments are allocated to the first entry first.
+ +

BankingCreditCardPlan

+ +

+
{
+  "nickname": "string",
+  "planType": "PURCHASE_PLAN",
+  "atExpiryBalanceTransfersTo": "PURCHASE_PLAN",
+  "planCreationDate": "string",
+  "planPeriod": "string",
+  "planEndDate": "string",
+  "planReferenceRate": "string",
+  "planEffectiveRate": "string",
+  "minPaymentAmount": "string",
+  "paymentDueAmount": "string",
+  "paymentCurrency": "string",
+  "paymentDueDate": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "interestFreePeriods": [
+    {
+      "from": "string",
+      "to": "string"
+    }
+  ],
+  "adjustments": [
+    {
+      "adjustmentType": "BONUS",
+      "amount": "string",
+      "currency": "string",
+      "rate": "string",
+      "adjustmentBundle": "string",
+      "adjustmentPeriod": "string",
+      "adjustmentEndDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "planFeatures": [
+    {
+      "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+      "period": "string",
+      "endDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
nicknamestringoptionalA short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided
planTypeBankingCardPlanTypesmandatoryThe credit card plan type
atExpiryBalanceTransfersToBankingCardPlanTypesoptionalA reference to the plan type that any balance will be transferred to at the expiry of this plan
planCreationDateDateStringoptionalDate this plan was created
planPeriodExternalRefoptionalOriginal duration for this plan. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
planEndDateDateStringoptionalDate this plan is expected to end
planReferenceRateRateStringmandatoryReference rate for this plan type
planEffectiveRateRateStringmandatoryEffective rate for this plan
minPaymentAmountAmountStringoptionalThe minimum payment amount due for this plan
paymentDueAmountAmountStringoptionalThe amount due for this plan
paymentCurrencyCurrencyStringoptionalIf absent assumes AUD
paymentDueDateDateStringoptionalDate that the next payment for this plan is due
additionalInfostringoptionalDisplay text providing more information on the plan
additionalInfoUriURIStringoptionalLink to a web page with more information on this plan
interestFreePeriods[object]optionalDefines when any current or future interest-free periods will be applicable to this plan. The interest-free period itself will be specified through an associated INTEREST_FREE plan feature.
» fromDateStringoptionalThe date any associated interest-free period will be available for the plan
» toDateStringmandatoryThe date any associated interest-free period will no longer be available
adjustments[BankingRateAdjustments]optionalAdjustments applicable to the plan rate
planFeatures[BankingCardPlanFeatures]optionalArray of features available or applicable to this plan
+ +

BankingCardPlanTypes

+ +

+
"PURCHASE_PLAN"
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousEnummandatorynone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBALANCE_TRANSFER_PLAN
anonymousCASH_ADVANCE_PLAN
anonymousINSTALMENT_PLAN
anonymousPURCHASE_PLAN
+ +

BankingCardPlanFeatures

+ +

+
{
+  "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE",
+  "period": "string",
+  "endDate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Features and limitations available or applicable to the associated plan

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
planFeatureTypeEnummandatoryType of feature or limitation. For details refer to Plan Feature Types.
periodExternalRefoptionalOriginal duration of the feature or limitation. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
endDateDateStringoptionalDate that the feature or limitation will cease to apply
additionalValuestringconditionalDetail associated with the planFeatureType. For details refer to Plan Feature Types.
additionalInfostringoptionalDisplay text providing more information on the plan feature
additionalInfoUriURIStringoptionalLink to a web page with more information on this plan feature
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
planFeatureTypeBALANCE_TRANSFER_ENDS_INTEREST_FREE
planFeatureTypeINSTALMENTS
planFeatureTypeINTEREST_FREE
+ +

BankingDepositAccount

+ +

+
{
+  "lodgementDate": "string",
+  "nickname": "string",
+  "depositRateDetail": {
+    "depositRateType": "FIXED",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "tiers": [
+      {
+        "name": "string",
+        "unitOfMeasure": "DAY",
+        "minimumValue": "string",
+        "maximumValue": "string",
+        "rateApplicationMethod": "PER_TIER",
+        "applicabilityConditions": [
+          {
+            "rateApplicabilityType": "NEW_CUSTOMER",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "applicabilityConditions": [
+      {
+        "rateApplicabilityType": "NEW_CUSTOMER",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalValue": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string",
+    "adjustments": [
+      {
+        "adjustmentType": "BONUS",
+        "amount": "string",
+        "currency": "string",
+        "rate": "string",
+        "adjustmentBundle": "string",
+        "adjustmentPeriod": "string",
+        "adjustmentEndDate": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lodgementDateDateStringoptionalThe lodgement date of the deposit
nicknameDateStringoptionalA short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided
depositRateDetailBankingDepositRateDetailoptionalDetail about deposit rates and adjustments
+ +

BankingLoanAccountV3

+ +

+
{
+  "originalStartDate": "string",
+  "originalLoanAmount": "string",
+  "originalLoanCurrency": "string",
+  "loanEndDate": "string",
+  "nextInstalmentDate": "string",
+  "minInstalmentAmount": "string",
+  "minInstalmentCurrency": "string",
+  "maxRedraw": "string",
+  "maxRedrawCurrency": "string",
+  "minRedraw": "string",
+  "minRedrawCurrency": "string",
+  "offsetAccountEnabled": true,
+  "offsetAccountIds": [
+    "string"
+  ],
+  "lendingRateDetail": [
+    {
+      "loanPurpose": "OWNER_OCCUPIED",
+      "repaymentType": "PRINCIPAL_AND_INTEREST",
+      "rateStartDate": "string",
+      "rateEndDate": "string",
+      "revertProductId": "string",
+      "repaymentUType": "fixedRate",
+      "fixedRate": {
+        "fixedPeriod": "string",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentFrequency": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "variableRate": {
+        "variableRateType": "FLOATING",
+        "referenceRate": "string",
+        "effectiveRate": "string",
+        "calculationFrequency": "string",
+        "applicationType": "PERIODIC",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentFrequency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "feeAmount": {
+        "amount": "string",
+        "currency": "string",
+        "repaymentDue": "IN_ADVANCE",
+        "repaymentFrequency": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "adjustments": [
+        {
+          "adjustmentType": "BONUS",
+          "amount": "string",
+          "currency": "string",
+          "rate": "string",
+          "adjustmentBundle": "string",
+          "adjustmentPeriod": "string",
+          "adjustmentEndDate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
originalStartDateDateStringoptionalOptional original start date for the loan
originalLoanAmountAmountStringoptionalOptional original loan value
originalLoanCurrencyCurrencyStringoptionalIf absent assumes AUD
loanEndDateDateStringoptionalDate that the loan is due to be repaid in full
nextInstalmentDateDateStringoptionalNext date that an instalment is required
minInstalmentAmountAmountStringoptionalMinimum amount of next instalment
minInstalmentCurrencyCurrencyStringoptionalIf absent assumes AUD
maxRedrawAmountStringoptionalMaximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account
maxRedrawCurrencyCurrencyStringoptionalIf absent assumes AUD
minRedrawAmountStringoptionalMinimum redraw amount
minRedrawCurrencyCurrencyStringoptionalIf absent assumes AUD
offsetAccountEnabledBooleanoptionalSet to true if one or more offset accounts are configured for this loan account
offsetAccountIds[string]optionalThe accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation
lendingRateDetail[BankingLendingRateDetail]optionalInformation about lending rates and adjustments
+ +

BankingLendingRateDetail

+ +

+
{
+  "loanPurpose": "OWNER_OCCUPIED",
+  "repaymentType": "PRINCIPAL_AND_INTEREST",
+  "rateStartDate": "string",
+  "rateEndDate": "string",
+  "revertProductId": "string",
+  "repaymentUType": "fixedRate",
+  "fixedRate": {
+    "fixedPeriod": "string",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "interestPaymentDue": "IN_ADVANCE",
+    "repaymentFrequency": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "variableRate": {
+    "variableRateType": "FLOATING",
+    "referenceRate": "string",
+    "effectiveRate": "string",
+    "calculationFrequency": "string",
+    "applicationType": "PERIODIC",
+    "applicationFrequency": "string",
+    "interestPaymentDue": "IN_ADVANCE",
+    "repaymentFrequency": "string",
+    "additionalValue": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "feeAmount": {
+    "amount": "string",
+    "currency": "string",
+    "repaymentDue": "IN_ADVANCE",
+    "repaymentFrequency": "string",
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "adjustments": [
+    {
+      "adjustmentType": "BONUS",
+      "amount": "string",
+      "currency": "string",
+      "rate": "string",
+      "adjustmentBundle": "string",
+      "adjustmentPeriod": "string",
+      "adjustmentEndDate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Information about lending rates and adjustments. Future-dated rates allow scheduled rate changes such as 'revert' rates to be specified.

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
loanPurposeEnumoptionalThe reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
repaymentTypeEnumoptionalOptions in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
rateStartDateDateStringoptionalDate this rate will begin to apply. If not specified, the rate is currently applicable to the account.
rateEndDateDateStringoptionalDate this rate will cease to apply. If not specified, the rate on the account is not scheduled to change or 'revert' to a different rate setting.
revertProductIdstringoptionalThe productId of the product that this account will revert to at the specified rateEndDate
repaymentUTypeEnummandatoryThe type of structure to present account specific fields
fixedRateBankingLendingRateFixedoptionalnone
variableRateBankingLendingRateVariableoptionalnone
feeAmountBankingLendingFeeoptionalnone
adjustments[BankingRateAdjustments]optionalAdjustments applicable to the rate or fee
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
loanPurposeINVESTMENT
loanPurposeOWNER_OCCUPIED
repaymentTypeINTEREST_ONLY
repaymentTypePRINCIPAL_AND_FEE
repaymentTypePRINCIPAL_AND_INTEREST
repaymentUTypefixedRate
repaymentUTypevariableRate
repaymentUTypefeeAmount
+ +

BankingLendingRateFixed

+ +

+
{
+  "fixedPeriod": "string",
+  "referenceRate": "string",
+  "effectiveRate": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentFrequency": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
fixedPeriodExternalRefoptionalThe period of time for the fixed rate. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
referenceRateRateStringmandatoryReference rate for this account type and terms
effectiveRateRateStringmandatoryThe current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDueEnumoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
+ +

BankingLendingRateVariable

+ +

+
{
+  "variableRateType": "FLOATING",
+  "referenceRate": "string",
+  "effectiveRate": "string",
+  "calculationFrequency": "string",
+  "applicationType": "PERIODIC",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentFrequency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
variableRateTypeEnummandatoryThe type of variable rate
referenceRateRateStringmandatoryReference rate for this account type and terms
effectiveRateRateStringmandatoryThe current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationTypeEnumoptionalThe type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDueEnumoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
additionalValuestringconditionalGeneric field containing additional information relevant to the variableRateType specified. Whether mandatory or not is dependent on the value of variableRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
variableRateTypeFLOATING
variableRateTypeMARKET_LINKED
variableRateTypeVARIABLE
applicationTypeMATURITY
applicationTypePERIODIC
applicationTypeUPFRONT
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
+ +

BankingLendingFee

+ +

+
{
+  "amount": "string",
+  "currency": "string",
+  "repaymentDue": "IN_ADVANCE",
+  "repaymentFrequency": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryMinimum payment due at specified repaymentFrequency
currencyCurrencyStringoptionalCurrency of the fee. AUD assumed if not present
repaymentDueEnumoptionalWhen loan payments are due to be paid within each period
repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
additionalInfostringoptionalDisplay text providing more information on the fee
additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
repaymentDueIN_ADVANCE
repaymentDueIN_ARREARS
+ +

ResponseBankingTransactionList

+ +

+
{
+  "data": {
+    "transactions": [
+      {
+        "accountId": "string",
+        "transactionId": "string",
+        "isDetailAvailable": true,
+        "type": "DIRECT_DEBIT",
+        "status": "PENDING",
+        "description": "string",
+        "postingDateTime": "string",
+        "valueDateTime": "string",
+        "executionDateTime": "string",
+        "amount": "string",
+        "currency": "string",
+        "reference": "string",
+        "merchantName": "string",
+        "merchantCategoryCode": "string",
+        "billerCode": "string",
+        "billerName": "string",
+        "crn": "string",
+        "apcaNumber": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0,
+    "isQueryParamUnsupported": false
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» transactions[BankingTransaction]mandatorynone
linksLinksPaginatedmandatorynone
metaMetaPaginatedTransactionmandatorynone
+ +

BankingTransaction

+ +

+
{
+  "accountId": "string",
+  "transactionId": "string",
+  "isDetailAvailable": true,
+  "type": "DIRECT_DEBIT",
+  "status": "PENDING",
+  "description": "string",
+  "postingDateTime": "string",
+  "valueDateTime": "string",
+  "executionDateTime": "string",
+  "amount": "string",
+  "currency": "string",
+  "reference": "string",
+  "merchantName": "string",
+  "merchantCategoryCode": "string",
+  "billerCode": "string",
+  "billerName": "string",
+  "crn": "string",
+  "apcaNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryID of the account for which transactions are provided
transactionIdASCIIStringconditionalA unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if isDetailAvailable is set to true.
isDetailAvailableBooleanmandatorytrue if extended information is available using the transaction detail endpoint. false if extended data is not available
typeEnummandatoryThe type of the transaction
statusEnummandatoryStatus of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction
descriptionstringmandatoryThe transaction description as applied by the financial institution
postingDateTimeDateTimeStringconditionalThe time the transaction was posted. This field is Mandatory if the transaction has status POSTED. This is the time that appears on a standard statement
valueDateTimeDateTimeStringoptionalDate and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry
executionDateTimeDateTimeStringoptionalThe time the transaction was executed by the originating customer, if available
amountAmountStringmandatoryThe value of the transaction. Negative values mean money was outgoing from the account
currencyCurrencyStringoptionalThe currency for the transaction amount. AUD assumed if not present
referencestringmandatoryThe reference for the transaction provided by the originating institution. Empty string if no data provided
merchantNamestringoptionalName of the merchant for an outgoing payment to a merchant
merchantCategoryCodestringoptionalThe merchant category code (or MCC) for an outgoing payment to a merchant
billerCodestringoptionalBPAY Biller Code for the transaction (if available)
billerNamestringoptionalName of the BPAY biller for the transaction (if available)
crnstringconditionalBPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
apcaNumberstringoptional6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeDIRECT_DEBIT
typeFEE
typeINTEREST_CHARGED
typeINTEREST_PAID
typeOTHER
typePAYMENT
typeTRANSFER_INCOMING
typeTRANSFER_OUTGOING
statusPENDING
statusPOSTED
+ +

ResponseBankingTransactionById

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "transactionId": "string",
+    "isDetailAvailable": true,
+    "type": "DIRECT_DEBIT",
+    "status": "PENDING",
+    "description": "string",
+    "postingDateTime": "string",
+    "valueDateTime": "string",
+    "executionDateTime": "string",
+    "amount": "string",
+    "currency": "string",
+    "reference": "string",
+    "merchantName": "string",
+    "merchantCategoryCode": "string",
+    "billerCode": "string",
+    "billerName": "string",
+    "crn": "string",
+    "apcaNumber": "string",
+    "extendedData": {
+      "payer": "string",
+      "payee": "string",
+      "extensionUType": "x2p101Payload",
+      "x2p101Payload": {
+        "extendedDescription": "string",
+        "endToEndId": "string",
+        "purposeCode": "string"
+      },
+      "service": "X2P1.01"
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingTransactionDetailmandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingTransactionDetail

+ +

+
{
+  "accountId": "string",
+  "transactionId": "string",
+  "isDetailAvailable": true,
+  "type": "DIRECT_DEBIT",
+  "status": "PENDING",
+  "description": "string",
+  "postingDateTime": "string",
+  "valueDateTime": "string",
+  "executionDateTime": "string",
+  "amount": "string",
+  "currency": "string",
+  "reference": "string",
+  "merchantName": "string",
+  "merchantCategoryCode": "string",
+  "billerCode": "string",
+  "billerName": "string",
+  "crn": "string",
+  "apcaNumber": "string",
+  "extendedData": {
+    "payer": "string",
+    "payee": "string",
+    "extensionUType": "x2p101Payload",
+    "x2p101Payload": {
+      "extendedDescription": "string",
+      "endToEndId": "string",
+      "purposeCode": "string"
+    },
+    "service": "X2P1.01"
+  }
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingTransactionmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» extendedDataobjectmandatorynone
»» payerstringconditionalLabel of the originating payer. Mandatory for inbound payment
»» payeestringconditionalLabel of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)
»» extensionUTypeEnumoptionalOptional extended data specific to transactions originated via NPP
»» x2p101Payloadobjectconditionalnone
»»» extendedDescriptionstringconditionalAn extended string description. Required if the extensionUType field is x2p101Payload
»»» endToEndIdstringoptionalAn end to end ID for the payment created at initiation
»»» purposeCodestringoptionalPurpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service
»» serviceEnummandatoryIdentifier of the applicable overlay service. Valid values are: X2P1.01
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
extensionUTypex2p101Payload
serviceX2P1.01
+ +

ResponseBankingAccountsBalanceList

+ +

+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» balances[BankingBalance]mandatoryThe list of balances returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

ResponseBankingAccountsBalanceById

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "currentBalance": "string",
+    "availableBalance": "string",
+    "creditLimit": "string",
+    "amortisedLimit": "string",
+    "currency": "string",
+    "purses": [
+      {
+        "amount": "string",
+        "currency": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingBalancemandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingBalance

+ +

+
{
+  "accountId": "string",
+  "currentBalance": "string",
+  "availableBalance": "string",
+  "creditLimit": "string",
+  "amortisedLimit": "string",
+  "currency": "string",
+  "purses": [
+    {
+      "amount": "string",
+      "currency": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
currentBalanceAmountStringmandatoryThe balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing
availableBalanceAmountStringmandatoryBalance representing the amount of funds available for transfer. Assumed to be zero or positive
creditLimitAmountStringoptionalObject representing the maximum amount of credit that is available for this account. Assumed to be zero if absent
amortisedLimitAmountStringoptionalObject representing the available limit amortised according to payment schedule. Assumed to be zero if absent
currencyCurrencyStringoptionalThe currency for the balance amounts. If absent assumed to be AUD
purses[BankingBalancePurse]optionalOptional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards
+ +

BankingBalancePurse

+ +

+
{
+  "amount": "string",
+  "currency": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryThe balance available for this additional currency purse
currencyCurrencyStringoptionalThe currency for the purse
+ +

ResponseBankingPayeeListV2

+ +

+
{
+  "data": {
+    "payees": [
+      {
+        "payeeId": "string",
+        "nickname": "string",
+        "description": "string",
+        "type": "BILLER",
+        "creationDate": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» payees[BankingPayeeV2]mandatoryThe list of payees returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

ResponseBankingPayeeByIdV2

+ +

+
{
+  "data": {
+    "payeeId": "string",
+    "nickname": "string",
+    "description": "string",
+    "type": "BILLER",
+    "creationDate": "string",
+    "payeeUType": "biller",
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingPayeeDetailV2mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingPayeeV2

+ +

+
{
+  "payeeId": "string",
+  "nickname": "string",
+  "description": "string",
+  "type": "BILLER",
+  "creationDate": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
payeeIdASCIIStringmandatoryID of the payee adhering to the rules of ID permanence
nicknamestringmandatoryThe short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels
descriptionstringoptionalA description of the payee provided by the customer
typeEnummandatoryThe type of payee.
  • DOMESTIC means a registered payee for domestic payments including NPP.
  • INTERNATIONAL means a registered payee for international payments.
  • BILLER means a registered payee for BPAY.
  • DIGITAL_WALLET means a registered payee for a bank's digital wallet
creationDateDateStringoptionalThe date the payee was created by the customer
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeBILLER
typeDIGITAL_WALLET
typeDOMESTIC
typeINTERNATIONAL
+ +

BankingPayeeDetailV2

+ +

+
{
+  "payeeId": "string",
+  "nickname": "string",
+  "description": "string",
+  "type": "BILLER",
+  "creationDate": "string",
+  "payeeUType": "biller",
+  "biller": {
+    "billerCode": "string",
+    "crn": "string",
+    "billerName": "string"
+  },
+  "domestic": {
+    "payeeAccountUType": "account",
+    "account": {
+      "accountName": "string",
+      "bsb": "string",
+      "accountNumber": "string"
+    },
+    "card": {
+      "cardNumber": "string"
+    },
+    "payId": {
+      "name": "string",
+      "identifier": "string",
+      "type": "ABN"
+    }
+  },
+  "digitalWallet": {
+    "name": "string",
+    "identifier": "string",
+    "type": "EMAIL",
+    "provider": "PAYPAL_AU"
+  },
+  "international": {
+    "beneficiaryDetails": {
+      "name": "string",
+      "country": "string",
+      "message": "string"
+    },
+    "bankDetails": {
+      "country": "string",
+      "accountNumber": "string",
+      "bankAddress": {
+        "name": "string",
+        "address": "string"
+      },
+      "beneficiaryBankBIC": "string",
+      "fedWireNumber": "string",
+      "sortCode": "string",
+      "chipNumber": "string",
+      "routingNumber": "string",
+      "legalEntityIdentifier": "string"
+    }
+  }
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingPayeeV2mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» payeeUTypeEnummandatoryType of object included that describes the payee in detail
» billerBankingBillerPayeeconditionalnone
» domesticBankingDomesticPayeeconditionalnone
» digitalWalletBankingDigitalWalletPayeeconditionalnone
» internationalBankingInternationalPayeeconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
payeeUTypebiller
payeeUTypedigitalWallet
payeeUTypedomestic
payeeUTypeinternational
+ +

BankingDomesticPayee

+ +

+
{
+  "payeeAccountUType": "account",
+  "account": {
+    "accountName": "string",
+    "bsb": "string",
+    "accountNumber": "string"
+  },
+  "card": {
+    "cardNumber": "string"
+  },
+  "payId": {
+    "name": "string",
+    "identifier": "string",
+    "type": "ABN"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
payeeAccountUTypeEnummandatoryType of account object included. Valid values are:
  • account A standard Australian account defined by BSB/Account Number.
  • card A credit or charge card to pay to (note that PANs are masked).
  • payId A PayID recognised by NPP
accountBankingDomesticPayeeAccountconditionalnone
cardBankingDomesticPayeeCardconditionalnone
payIdBankingDomesticPayeePayIdconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
payeeAccountUTypeaccount
payeeAccountUTypecard
payeeAccountUTypepayId
+ +

BankingDomesticPayeeAccount

+ +

+
{
+  "accountName": "string",
+  "bsb": "string",
+  "accountNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountNamestringoptionalName of the account to pay to
bsbstringmandatoryBSB of the account to pay to
accountNumberstringmandatoryNumber of the account to pay to
+ +

BankingDomesticPayeeCard

+ +

+
{
+  "cardNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
cardNumberMaskedPANStringmandatoryName of the account to pay to
+ +

BankingDomesticPayeePayId

+ +

+
{
+  "name": "string",
+  "identifier": "string",
+  "type": "ABN"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringoptionalThe name assigned to the PayID by the owner of the PayID
identifierstringmandatoryThe identifier of the PayID (dependent on type)
typeEnummandatoryThe type of the PayID
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeABN
typeEMAIL
typeORG_IDENTIFIER
typeTELEPHONE
+ +

BankingBillerPayee

+ +

+
{
+  "billerCode": "string",
+  "crn": "string",
+  "billerName": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
billerCodestringmandatoryBPAY Biller Code of the Biller
crnstringconditionalBPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
billerNamestringmandatoryName of the Biller
+ +

BankingInternationalPayee

+ +

+
{
+  "beneficiaryDetails": {
+    "name": "string",
+    "country": "string",
+    "message": "string"
+  },
+  "bankDetails": {
+    "country": "string",
+    "accountNumber": "string",
+    "bankAddress": {
+      "name": "string",
+      "address": "string"
+    },
+    "beneficiaryBankBIC": "string",
+    "fedWireNumber": "string",
+    "sortCode": "string",
+    "chipNumber": "string",
+    "routingNumber": "string",
+    "legalEntityIdentifier": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
beneficiaryDetailsobjectmandatorynone
» namestringoptionalName of the beneficiary
» countryExternalRefmandatoryCountry where the beneficiary resides. A valid ISO 3166 Alpha-3 country code
» messagestringoptionalResponse message for the payment
bankDetailsobjectmandatorynone
» countryExternalRefmandatoryCountry of the recipient institution. A valid ISO 3166 Alpha-3 country code
» accountNumberstringmandatoryAccount Targeted for payment
» bankAddressobjectoptionalnone
»» namestringmandatoryName of the recipient Bank
»» addressstringmandatoryAddress of the recipient Bank
» beneficiaryBankBICExternalRefoptionalSwift bank code. Aligns with standard ISO 9362
» fedWireNumberstringoptionalNumber for Fedwire payment (Federal Reserve Wire Network)
» sortCodestringoptionalSort code used for account identification in some jurisdictions
» chipNumberstringoptionalNumber for the Clearing House Interbank Payments System
» routingNumberstringoptionalInternational bank routing number
» legalEntityIdentifierExternalRefoptionalThe legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442
+ +

BankingDigitalWalletPayee

+ +

+
{
+  "name": "string",
+  "identifier": "string",
+  "type": "EMAIL",
+  "provider": "PAYPAL_AU"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryThe display name of the wallet as given by the customer, else a default value defined by the data holder
identifierstringmandatoryThe identifier of the digital wallet (dependent on type)
typeEnummandatoryThe type of the digital wallet identifier
providerEnummandatoryThe provider of the digital wallet
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeEMAIL
typeCONTACT_NAME
typeTELEPHONE
providerPAYPAL_AU
providerOTHER
+ +

ResponseBankingDirectDebitAuthorisationList

+ +

+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» directDebitAuthorisations[BankingDirectDebit]mandatoryThe list of authorisations returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingDirectDebit

+ +

+
{
+  "accountId": "string",
+  "authorisedEntity": {
+    "description": "string",
+    "financialInstitution": "string",
+    "abn": "string",
+    "acn": "string",
+    "arbn": "string"
+  },
+  "lastDebitDateTime": "string",
+  "lastDebitAmount": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence.
authorisedEntityBankingAuthorisedEntitymandatorynone
lastDebitDateTimeDateTimeStringoptionalThe date and time of the last debit executed under this authorisation
lastDebitAmountAmountStringoptionalThe amount of the last debit executed under this authorisation
+ +

BankingAuthorisedEntity

+ +

+
{
+  "description": "string",
+  "financialInstitution": "string",
+  "abn": "string",
+  "acn": "string",
+  "arbn": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDescription of the authorised entity derived from previously executed direct debits
financialInstitutionstringconditionalName of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme
abnstringoptionalAustralian Business Number for the authorised entity
acnstringoptionalAustralian Company Number for the authorised entity
arbnstringoptionalAustralian Registered Body Number for the authorised entity
+ +

ResponseBankingScheduledPaymentsListV2

+ +

+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» scheduledPayments[BankingScheduledPaymentV2]mandatoryThe list of scheduled payments to return
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingScheduledPaymentV2

+ +

+
{
+  "scheduledPaymentId": "string",
+  "nickname": "string",
+  "payerReference": "string",
+  "payeeReference": "string",
+  "status": "ACTIVE",
+  "from": {
+    "accountId": "string"
+  },
+  "paymentSet": [
+    {
+      "to": {
+        "toUType": "accountId",
+        "accountId": "string",
+        "payeeId": "string",
+        "nickname": "string",
+        "payeeReference": "string",
+        "digitalWallet": {
+          "name": "string",
+          "identifier": "string",
+          "type": "EMAIL",
+          "provider": "PAYPAL_AU"
+        },
+        "domestic": {
+          "payeeAccountUType": "account",
+          "account": {
+            "accountName": "string",
+            "bsb": "string",
+            "accountNumber": "string"
+          },
+          "card": {
+            "cardNumber": "string"
+          },
+          "payId": {
+            "name": "string",
+            "identifier": "string",
+            "type": "ABN"
+          }
+        },
+        "biller": {
+          "billerCode": "string",
+          "crn": "string",
+          "billerName": "string"
+        },
+        "international": {
+          "beneficiaryDetails": {
+            "name": "string",
+            "country": "string",
+            "message": "string"
+          },
+          "bankDetails": {
+            "country": "string",
+            "accountNumber": "string",
+            "bankAddress": {
+              "name": "string",
+              "address": "string"
+            },
+            "beneficiaryBankBIC": "string",
+            "fedWireNumber": "string",
+            "sortCode": "string",
+            "chipNumber": "string",
+            "routingNumber": "string",
+            "legalEntityIdentifier": "string"
+          }
+        }
+      },
+      "isAmountCalculated": true,
+      "amount": "string",
+      "currency": "string"
+    }
+  ],
+  "recurrence": {
+    "nextPaymentDate": "string",
+    "recurrenceUType": "eventBased",
+    "onceOff": {
+      "paymentDate": "string"
+    },
+    "intervalSchedule": {
+      "finalPaymentDate": "string",
+      "paymentsRemaining": 1,
+      "nonBusinessDayTreatment": "AFTER",
+      "intervals": [
+        {
+          "interval": "string",
+          "dayInInterval": "string"
+        }
+      ]
+    },
+    "lastWeekDay": {
+      "finalPaymentDate": "string",
+      "paymentsRemaining": 1,
+      "interval": "string",
+      "lastWeekDay": "FRI",
+      "nonBusinessDayTreatment": "AFTER"
+    },
+    "eventBased": {
+      "description": "string"
+    }
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
scheduledPaymentIdASCIIStringmandatoryA unique ID of the scheduled payment adhering to the standards for ID permanence
nicknamestringoptionalThe short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels
payerReferencestringmandatoryThe reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided
payeeReferencestringconditionalThe reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided
statusEnummandatoryIndicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
fromBankingScheduledPaymentFrommandatoryObject containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
paymentSet[BankingScheduledPaymentSetV2]mandatory[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]
recurrenceBankingScheduledPaymentRecurrencemandatoryObject containing the detail of the schedule for the payment
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
statusACTIVE
statusINACTIVE
statusSKIP
+ +

BankingScheduledPaymentSetV2

+ +

+
{
+  "to": {
+    "toUType": "accountId",
+    "accountId": "string",
+    "payeeId": "string",
+    "nickname": "string",
+    "payeeReference": "string",
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "isAmountCalculated": true,
+  "amount": "string",
+  "currency": "string"
+}
+
+
+

The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
toBankingScheduledPaymentToV2mandatoryObject containing details of the destination of the payment. Used to specify a variety of payment destination types
isAmountCalculatedBooleanoptionalFlag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed
amountAmountStringconditionalThe amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
currencyCurrencyStringoptionalThe currency for the payment. AUD assumed if not present
+ +

BankingScheduledPaymentToV2

+ +

+
{
+  "toUType": "accountId",
+  "accountId": "string",
+  "payeeId": "string",
+  "nickname": "string",
+  "payeeReference": "string",
+  "digitalWallet": {
+    "name": "string",
+    "identifier": "string",
+    "type": "EMAIL",
+    "provider": "PAYPAL_AU"
+  },
+  "domestic": {
+    "payeeAccountUType": "account",
+    "account": {
+      "accountName": "string",
+      "bsb": "string",
+      "accountNumber": "string"
+    },
+    "card": {
+      "cardNumber": "string"
+    },
+    "payId": {
+      "name": "string",
+      "identifier": "string",
+      "type": "ABN"
+    }
+  },
+  "biller": {
+    "billerCode": "string",
+    "crn": "string",
+    "billerName": "string"
+  },
+  "international": {
+    "beneficiaryDetails": {
+      "name": "string",
+      "country": "string",
+      "message": "string"
+    },
+    "bankDetails": {
+      "country": "string",
+      "accountNumber": "string",
+      "bankAddress": {
+        "name": "string",
+        "address": "string"
+      },
+      "beneficiaryBankBIC": "string",
+      "fedWireNumber": "string",
+      "sortCode": "string",
+      "chipNumber": "string",
+      "routingNumber": "string",
+      "legalEntityIdentifier": "string"
+    }
+  }
+}
+
+
+

Object containing details of the destination of the payment. Used to specify a variety of payment destination types

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
toUTypeEnummandatoryThe type of object provided that specifies the destination of the funds for the payment.
accountIdASCIIStringconditionalPresent if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
payeeIdASCIIStringconditionalPresent if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead
nicknamestringconditionalThe short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels
payeeReferencestringconditionalThe reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.
digitalWalletBankingDigitalWalletPayeeconditionalnone
domesticBankingDomesticPayeeconditionalnone
billerBankingBillerPayeeconditionalnone
internationalBankingInternationalPayeeconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
toUTypeaccountId
toUTypebiller
toUTypedigitalWallet
toUTypedomestic
toUTypeinternational
toUTypepayeeId
+ +

BankingScheduledPaymentFrom

+ +

+
{
+  "accountId": "string"
+}
+
+
+

Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryID of the account that is the source of funds for the payment
+ +

BankingScheduledPaymentRecurrence

+ +

+
{
+  "nextPaymentDate": "string",
+  "recurrenceUType": "eventBased",
+  "onceOff": {
+    "paymentDate": "string"
+  },
+  "intervalSchedule": {
+    "finalPaymentDate": "string",
+    "paymentsRemaining": 1,
+    "nonBusinessDayTreatment": "AFTER",
+    "intervals": [
+      {
+        "interval": "string",
+        "dayInInterval": "string"
+      }
+    ]
+  },
+  "lastWeekDay": {
+    "finalPaymentDate": "string",
+    "paymentsRemaining": 1,
+    "interval": "string",
+    "lastWeekDay": "FRI",
+    "nonBusinessDayTreatment": "AFTER"
+  },
+  "eventBased": {
+    "description": "string"
+  }
+}
+
+
+

Object containing the detail of the schedule for the payment

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
nextPaymentDateDateStringoptionalThe date of the next payment under the recurrence schedule
recurrenceUTypeEnummandatoryThe type of recurrence used to define the schedule
onceOffBankingScheduledPaymentRecurrenceOnceOffconditionalIndicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
intervalScheduleBankingScheduledPaymentRecurrenceIntervalScheduleconditionalIndicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
lastWeekDayBankingScheduledPaymentRecurrenceLastWeekdayconditionalIndicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay
eventBasedBankingScheduledPaymentRecurrenceEventBasedconditionalIndicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
recurrenceUTypeeventBased
recurrenceUTypeintervalSchedule
recurrenceUTypelastWeekDay
recurrenceUTypeonceOff
+ +

BankingScheduledPaymentRecurrenceOnceOff

+ +

+
{
+  "paymentDate": "string"
+}
+
+
+

Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
paymentDateDateStringmandatoryThe scheduled date for the once off payment
+ +

BankingScheduledPaymentRecurrenceIntervalSchedule

+ +

+
{
+  "finalPaymentDate": "string",
+  "paymentsRemaining": 1,
+  "nonBusinessDayTreatment": "AFTER",
+  "intervals": [
+    {
+      "interval": "string",
+      "dayInInterval": "string"
+    }
+  ]
+}
+
+
+

Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
finalPaymentDateDateStringoptionalThe limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
paymentsRemainingPositiveIntegeroptionalIndicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely
nonBusinessDayTreatmentEnumoptionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
intervals[BankingScheduledPaymentInterval]mandatoryAn array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
nonBusinessDayTreatmentAFTER
nonBusinessDayTreatmentBEFORE
nonBusinessDayTreatmentON
nonBusinessDayTreatmentONLY
+ +

BankingScheduledPaymentInterval

+ +

+
{
+  "interval": "string",
+  "dayInInterval": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
intervalExternalRefmandatoryAn interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
dayInIntervalExternalRefoptionalUses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
+ +

BankingScheduledPaymentRecurrenceLastWeekday

+ +

+
{
+  "finalPaymentDate": "string",
+  "paymentsRemaining": 1,
+  "interval": "string",
+  "lastWeekDay": "FRI",
+  "nonBusinessDayTreatment": "AFTER"
+}
+
+
+

Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
finalPaymentDateDateStringoptionalThe limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
paymentsRemainingPositiveIntegeroptionalIndicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
intervalExternalRefmandatoryThe interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
lastWeekDayEnummandatoryThe weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
nonBusinessDayTreatmentEnumoptionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
lastWeekDayFRI
lastWeekDayMON
lastWeekDaySAT
lastWeekDaySUN
lastWeekDayTHU
lastWeekDayTUE
lastWeekDayWED
nonBusinessDayTreatmentAFTER
nonBusinessDayTreatmentBEFORE
nonBusinessDayTreatmentON
nonBusinessDayTreatmentONLY
+ +

BankingScheduledPaymentRecurrenceEventBased

+ +

+
{
+  "description": "string"
+}
+
+
+

Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
+ +

CommonPhysicalAddress

+ +

+
{
+  "addressUType": "paf",
+  "simple": {
+    "mailingName": "string",
+    "addressLine1": "string",
+    "addressLine2": "string",
+    "addressLine3": "string",
+    "postcode": "string",
+    "city": "string",
+    "state": "string",
+    "country": "AUS"
+  },
+  "paf": {
+    "dpid": "string",
+    "thoroughfareNumber1": 0,
+    "thoroughfareNumber1Suffix": "string",
+    "thoroughfareNumber2": 0,
+    "thoroughfareNumber2Suffix": "string",
+    "flatUnitType": "string",
+    "flatUnitNumber": "string",
+    "floorLevelType": "string",
+    "floorLevelNumber": "string",
+    "lotNumber": "string",
+    "buildingName1": "string",
+    "buildingName2": "string",
+    "streetName": "string",
+    "streetType": "string",
+    "streetSuffix": "string",
+    "postalDeliveryType": "string",
+    "postalDeliveryNumber": 0,
+    "postalDeliveryNumberPrefix": "string",
+    "postalDeliveryNumberSuffix": "string",
+    "localityName": "string",
+    "postcode": "string",
+    "state": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
addressUTypeEnummandatoryThe type of address object present
simpleCommonSimpleAddressconditionalnone
pafCommonPAFAddressconditionalAustralian address formatted according to the file format defined by the PAF file format
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
addressUTypepaf
addressUTypesimple
+ +

CommonSimpleAddress

+ +

+
{
+  "mailingName": "string",
+  "addressLine1": "string",
+  "addressLine2": "string",
+  "addressLine3": "string",
+  "postcode": "string",
+  "city": "string",
+  "state": "string",
+  "country": "AUS"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
mailingNamestringoptionalName of the individual or business formatted for inclusion in an address used for physical mail
addressLine1stringmandatoryFirst line of the standard address object
addressLine2stringoptionalSecond line of the standard address object
addressLine3stringoptionalThird line of the standard address object
postcodestringconditionalMandatory for Australian addresses
citystringmandatoryName of the city or locality
statestringmandatoryFree text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
countryExternalRefoptionalA valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
+ +

CommonPAFAddress

+ +

+
{
+  "dpid": "string",
+  "thoroughfareNumber1": 0,
+  "thoroughfareNumber1Suffix": "string",
+  "thoroughfareNumber2": 0,
+  "thoroughfareNumber2Suffix": "string",
+  "flatUnitType": "string",
+  "flatUnitNumber": "string",
+  "floorLevelType": "string",
+  "floorLevelNumber": "string",
+  "lotNumber": "string",
+  "buildingName1": "string",
+  "buildingName2": "string",
+  "streetName": "string",
+  "streetType": "string",
+  "streetSuffix": "string",
+  "postalDeliveryType": "string",
+  "postalDeliveryNumber": 0,
+  "postalDeliveryNumberPrefix": "string",
+  "postalDeliveryNumberSuffix": "string",
+  "localityName": "string",
+  "postcode": "string",
+  "state": "string"
+}
+
+
+

Australian address formatted according to the file format defined by the PAF file format

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dpidstringoptionalUnique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
thoroughfareNumber1PositiveIntegeroptionalThoroughfare number for a property (first number in a property ranged address)
thoroughfareNumber1SuffixstringoptionalSuffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
thoroughfareNumber2PositiveIntegeroptionalSecond thoroughfare number (only used if the property has a ranged address eg 23-25)
thoroughfareNumber2SuffixstringoptionalSuffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
flatUnitTypestringoptionalType of flat or unit for the address
flatUnitNumberstringoptionalUnit number (including suffix, if applicable)
floorLevelTypestringoptionalType of floor or level for the address
floorLevelNumberstringoptionalFloor or level number (including alpha characters)
lotNumberstringoptionalAllotment number for the address
buildingName1stringoptionalBuilding/Property name 1
buildingName2stringoptionalBuilding/Property name 2
streetNamestringoptionalThe name of the street
streetTypestringoptionalThe street type. Valid enumeration defined by Australia Post PAF code file
streetSuffixstringoptionalThe street type suffix. Valid enumeration defined by Australia Post PAF code file
postalDeliveryTypestringoptionalPostal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
postalDeliveryNumberPositiveIntegeroptionalPostal delivery number if the address is a postal delivery type
postalDeliveryNumberPrefixstringoptionalPostal delivery number prefix related to the postal delivery number
postalDeliveryNumberSuffixstringoptionalPostal delivery number suffix related to the postal delivery number
localityNamestringmandatoryFull name of locality
postcodestringmandatoryPostcode for the locality
statestringmandatoryState in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
+ + + +

+
{
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
+ +

Meta

+ +

+
{}
+
+

Properties

+

None

+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaPaginatedTransaction

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0,
+  "isQueryParamUnsupported": false
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousMetaPaginatedmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» isQueryParamUnsupportedBooleanoptionaltrue if "text" query parameter is not supported
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategoryV2

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousEnummandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousBUY_NOW_PAY_LATER
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
diff --git a/docs/includes/cds_banking_non_bank_lending b/docs/includes/cds_banking_non_bank_lending index 918cb309..2cfb72e3 100644 --- a/docs/includes/cds_banking_non_bank_lending +++ b/docs/includes/cds_banking_non_bank_lending @@ -44,7 +44,7 @@

Obtain a list of accounts.

-

Obsolete versions: v1

+

Obsolete versions: v1, v2

Endpoint Version

@@ -54,7 +54,7 @@ - +
Version23
@@ -74,14 +74,14 @@ query string optional -Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.) +Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.) open-status query string optional -Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed +Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed is-owned @@ -109,14 +109,14 @@ header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -269,7 +269,7 @@ 200 OK Success -ResponseBankingAccountListV2 +ResponseBankingAccountListV3 400 @@ -305,7 +305,7 @@ x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -386,6 +386,8 @@ To perform this operation, you must be authenticated and authorised with the fol

GET /banking/accounts/balances

Obtain balances for multiple, filtered accounts

+ +

Obsolete versions: v1

Endpoint Version

@@ -395,7 +397,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
Version12
@@ -415,14 +417,14 @@ To perform this operation, you must be authenticated and authorised with the fol query string optional -Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. +Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. open-status query string optional -Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed +Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed is-owned @@ -450,14 +452,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -648,7 +650,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -793,14 +795,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -926,7 +928,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -1043,14 +1045,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -1158,7 +1160,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -1240,7 +1242,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Obtain detailed information on a single account.

-

Obsolete versions: v1, v2

+

Obsolete versions: v1, v2, v3

Endpoint Version

@@ -1250,7 +1252,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
Version34
@@ -1277,14 +1279,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -1336,6 +1338,29 @@ To perform this operation, you must be authenticated and authorised with the fol "bsb": "string", "accountNumber": "string", "bundleName": "string", + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4, + "plans": [ + { + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] + } + ] + }, "specificAccountUType": "creditCard", "termDeposit": [ { @@ -1535,7 +1560,7 @@ To perform this operation, you must be authenticated and authorised with the fol 200 OK Success -ResponseBankingAccountByIdV3 +ResponseBankingAccountByIdV4 400 @@ -1571,7 +1596,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -1653,7 +1678,7 @@ To perform this operation, you must be authenticated and authorised with the fol

Obtain transactions for a specific account.

-

Some general notes that apply to all end points that retrieve transactions:

+

Some general notes that apply to all endpoints that retrieve transactions:

  • Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
    • @@ -1696,7 +1721,7 @@ To perform this operation, you must be authenticated and authorised with the fol path ASCIIString mandatory -ID of the account to get transactions for. Must have previously been returned by one of the account list end points. +ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints. oldest-time @@ -1752,14 +1777,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -1831,7 +1856,7 @@ To perform this operation, you must be authenticated and authorised with the fol "meta": { "totalRecords": 0, "totalPages": 0, - "isQueryParamUnsupported": true + "isQueryParamUnsupported": false } } @@ -1891,7 +1916,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -2008,28 +2033,28 @@ To perform this operation, you must be authenticated and authorised with the fol path ASCIIString mandatory -ID of the account to get transactions for. Must have previously been returned by one of the account list end points +ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints transactionId path ASCIIString mandatory -ID of the transaction obtained from a previous call to one of the other transaction end points +ID of the transaction obtained from a previous call to one of the other transaction endpoints x-v header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -2154,7 +2179,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -2264,7 +2289,7 @@ To perform this operation, you must be authenticated and authorised with the fol path ASCIIString mandatory -ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points. +ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints. page @@ -2285,14 +2310,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -2415,7 +2440,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -2503,6 +2528,8 @@ To perform this operation, you must be authenticated and authorised with the fol

    GET /banking/accounts/direct-debits

    Obtain direct debit authorisations for multiple, filtered accounts

    + +

    Obsolete versions: v1

    Endpoint Version

    @@ -2512,7 +2539,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
    Version12
    @@ -2532,14 +2559,14 @@ To perform this operation, you must be authenticated and authorised with the fol query string optional -Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. +Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. open-status query string optional -Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed +Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed is-owned @@ -2567,14 +2594,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -2763,7 +2790,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -2908,14 +2935,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -3039,7 +3066,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -3151,7 +3178,7 @@ To perform this operation, you must be authenticated and authorised with the fol path ASCIIString mandatory -ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment +ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment page @@ -3172,14 +3199,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -3390,7 +3417,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -3479,7 +3506,7 @@ To perform this operation, you must be authenticated and authorised with the fol

    Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments

    -

    Obsolete versions: v1

    +

    Obsolete versions: v1, v2

    Endpoint Version

    @@ -3489,7 +3516,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
    Version23
    @@ -3509,14 +3536,14 @@ To perform this operation, you must be authenticated and authorised with the fol query string optional -Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. +Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. open-status query string optional -Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed +Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed is-owned @@ -3544,14 +3571,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -3828,7 +3855,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -3975,14 +4002,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -4194,7 +4221,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -4327,14 +4354,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -4474,7 +4501,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -4595,14 +4622,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. x-fapi-interaction-id @@ -4758,7 +4785,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. 200 @@ -4839,7 +4866,7 @@ To perform this operation, you must be authenticated and authorised with the fol

    Obtain a list of products that are currently openly offered to the market

    -

    Note that the results returned by this end point are expected to be ordered in descending order according to lastUpdated.

    +

    Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.

    Conventions

    In the product reference payloads there are a number of recurring conventions that are explained here, in one place.

    Arrays Of Features

    @@ -4848,9 +4875,9 @@ To perform this operation, you must be authenticated and authorised with the fol
    • 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.
      • +
    • 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.
      • +
    • 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

    @@ -4860,15 +4887,15 @@ To perform this operation, you must be authenticated and authorised with the fol

    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.

    +

    For this reason, while productCategory is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime.

    Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process.

    Dates

    -

    It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.

    +

    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.

    -

    Obsolete versions: v1 v2

    +

    Obsolete versions: v1, v2, v3

    Endpoint Version

    @@ -4878,7 +4905,7 @@ To perform this operation, you must be authenticated and authorised with the fol - +
    Version34
    @@ -4898,7 +4925,7 @@ To perform this operation, you must be authenticated and authorised with the fol query string optional -Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' +Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are CURRENT, FUTURE and ALL. If absent defaults to CURRENT updated-since @@ -4919,7 +4946,7 @@ To perform this operation, you must be authenticated and authorised with the fol query string optional -Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. +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 @@ -4940,14 +4967,14 @@ To perform this operation, you must be authenticated and authorised with the fol header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

    Enumerated Values

    @@ -5116,7 +5143,7 @@ To perform this operation, you must be authenticated and authorised with the fol 200 OK Success -ResponseBankingProductListV2 +ResponseBankingProductListV3 400 @@ -5152,7 +5179,7 @@ To perform this operation, you must be authenticated and authorised with the fol x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. @@ -5197,7 +5224,7 @@ This operation does not require authentication

    Obtain detailed information on a single product offered openly to the market.

    -

    Obsolete versions: v1 v2 v3

    +

    Obsolete versions: v1, v2, v3, v4

    Endpoint Version

    @@ -5207,7 +5234,7 @@ This operation does not require authentication - +
    Version45
    @@ -5234,14 +5261,14 @@ This operation does not require authentication header string mandatory -Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers +Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers x-min-v header string optional -Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. +Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. @@ -5433,7 +5460,15 @@ This operation does not require authentication "additionalInfo": "string", "additionalInfoUri": "string" } - ] + ], + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4 + } }, "links": { "self": "string" @@ -5455,7 +5490,7 @@ This operation does not require authentication 200 OK Success -ResponseBankingProductByIdV4 +ResponseBankingProductByIdV5 400 @@ -5491,7 +5526,7 @@ This operation does not require authentication x-v string -The version of the API end point that the data holder has responded with. +The version of the API endpoint that the data holder has responded with. @@ -5544,9 +5579,9 @@ This operation does not require authentication -

    ResponseBankingProductListV2

    +

    ResponseBankingProductListV3

    -

    +

    {
   "data": {
     "products": [
@@ -5638,7 +5673,7 @@ This operation does not require authentication
 
 
 » products
-[BankingProductV4]
+[BankingProductV5]
 mandatory
 The list of products returned.  If the filter results in an empty set then this array may have no records
 
@@ -5656,9 +5691,9 @@ This operation does not require authentication
 
 
 
-
    BankingProductV4
    
+
    BankingProductV5
    
 
-
    
+
    
 
    {
   "productId": "string",
   "effectiveFrom": "string",
@@ -5751,7 +5786,7 @@ This operation does not require authentication
 
 
 productCategory
-BankingProductCategory
+BankingProductCategoryV2
 mandatory
 The category to which a product or account belongs. See here for more details
 
@@ -5962,9 +5997,9 @@ This operation does not require authentication
 
 
 
-
    ResponseBankingProductByIdV4
    
+
    ResponseBankingProductByIdV5
    
 
-
    
+
    
 
    {
   "data": {
     "productId": "string",
@@ -6148,7 +6183,15 @@ This operation does not require authentication
         "additionalInfo": "string",
         "additionalInfoUri": "string"
       }
-    ]
+    ],
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4
+    }
   },
   "links": {
     "self": "string"
@@ -6167,7 +6210,7 @@ This operation does not require authentication
 
 
 data
-BankingProductDetailV4
+BankingProductDetailV5
 mandatory
 none
 
@@ -6185,9 +6228,9 @@ This operation does not require authentication
 
 
 
-
    BankingProductDetailV4
    
+
    BankingProductDetailV5
    
 
-
    
+
    
 
    {
   "productId": "string",
   "effectiveFrom": "string",
@@ -6370,7 +6413,15 @@ This operation does not require authentication
       "additionalInfo": "string",
       "additionalInfoUri": "string"
     }
-  ]
+  ],
+  "instalments": {
+    "maximumPlanCount": 1,
+    "instalmentsLimit": "string",
+    "minimumPlanValue": "string",
+    "maximumPlanValue": "string",
+    "minimumSplit": 4,
+    "maximumSplit": 4
+  }
 }
 
 
    Properties
    
@@ -6386,7 +6437,7 @@ This operation does not require authentication
 
 
 anonymous
-BankingProductV4
+BankingProductV5
 mandatory
 none
 
@@ -6416,7 +6467,7 @@ This operation does not require authentication
 
 
 » features
-[BankingProductFeatureV2]
+[BankingProductFeatureV3]
 optional
 Array of features available for the product
 
@@ -6436,7 +6487,7 @@ This operation does not require authentication
 » fees
 [BankingProductFee]
 optional
-Fees applicable for the product
+Fees applicable to the product
 
 
 » depositRates
@@ -6450,6 +6501,12 @@ This operation does not require authentication
 optional
 Interest rates charged against lending balances
 
+
+» instalments
+BankingProductInstalments
+optional
+Details of instalment features on the account
+
 
 
 
    BankingProductBundle
    
@@ -6502,13 +6559,13 @@ This operation does not require authentication
 productIds
 [string]
 optional
-Array of product IDs for products included in the bundle that are available via the product end points.  Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points
+Array of product IDs for products included in the bundle that are available via the product endpoints.  Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints
 
 
 
-
    BankingProductFeatureV2
    
+
    BankingProductFeatureV3
    
 
-
    
+
    
 
    {
   "featureType": "ADDITIONAL_CARDS",
   "additionalValue": "string",
@@ -6527,9 +6584,9 @@ This operation does not require authentication
 
 
 featureType
-string
+Enum
 mandatory
-The type of feature described
+The type of feature described. For further details, refer to featureType
 
 
 additionalValue
@@ -6541,7 +6598,7 @@ This operation does not require authentication
 additionalInfo
 string
 conditional
-Display text providing more information on the feature. Mandatory if the feature type is set to OTHER
+Display text providing more information on the feature. Mandatory if the feature type is set to OTHER
 
 
 additionalInfoUri
@@ -6587,6 +6644,10 @@ This operation does not require authentication
 
 
 featureType
+EXTRA_DOWN_PAYMENT
+
+
+featureType
 DIGITAL_BANKING
 
 
@@ -6696,9 +6757,9 @@ This operation does not require authentication
 
 
 constraintType
-string
+Enum
 mandatory
-The type of constraint described.  See the next section for an overview of valid values and their meaning
+The type of constraint described. See the next section for an overview of valid values and their meaning
 
 
 additionalValue
@@ -6710,7 +6771,7 @@ This operation does not require authentication
 additionalInfo
 string
 optional
-Display text providing more information the constraint
+Display text providing more information on the constraint
 
 
 additionalInfoUri
@@ -6769,7 +6830,7 @@ This operation does not require authentication
 
 
 eligibilityType
-string
+Enum
 mandatory
 The type of eligibility criteria described.  See the next section for an overview of valid values and their meaning
 
@@ -6783,7 +6844,7 @@ This operation does not require authentication
 additionalInfo
 string
 conditional
-Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
+Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
 
 
 additionalInfoUri
@@ -6905,9 +6966,9 @@ This operation does not require authentication
 
 
 feeType
-string
+Enum
 mandatory
-The type of fee
+The type of fee. For details refer to Product Fee Types.
 
 
 amount
@@ -7068,7 +7129,7 @@ This operation does not require authentication
 
 
 discountType
-string
+Enum
 mandatory
 The type of discount. See the next section for an overview of valid values and their meaning
 
@@ -7177,7 +7238,7 @@ This operation does not require authentication
 
 
 discountEligibilityType
-string
+Enum
 mandatory
 The type of the specific eligibility constraint for a discount
 
@@ -7300,7 +7361,7 @@ This operation does not require authentication
 
 
 depositRateType
-string
+Enum
 mandatory
 The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning
 
@@ -7314,13 +7375,13 @@ This operation does not require authentication
 calculationFrequency
 ExternalRef
 optional
-The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
 
 
 applicationFrequency
 ExternalRef
 optional
-The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
 
 
 tiers
@@ -7427,7 +7488,7 @@ This operation does not require authentication
 
 
 lendingRateType
-string
+Enum
 mandatory
 The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning
 
@@ -7447,29 +7508,29 @@ This operation does not require authentication
 calculationFrequency
 ExternalRef
 optional
-The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
 
 
 applicationFrequency
 ExternalRef
 optional
-The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
 
 
 interestPaymentDue
-string
+Enum
 optional
 When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
 
 
 repaymentType
-string
+Enum
 optional
 Options in place for repayments. If absent, the lending rate is applicable to all repayment types
 
 
 loanPurpose
-string
+Enum
 optional
 The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
 
@@ -7489,7 +7550,7 @@ This operation does not require authentication
 additionalInfo
 string
 optional
-Display text providing more information on the rate.
+Display text providing more information on the rate
 
 
 additionalInfoUri
@@ -7611,25 +7672,25 @@ This operation does not require authentication
 
 
 unitOfMeasure
-string
+Enum
 mandatory
-The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers)
+The unit of measure that applies to the minimumValue and maximumValue values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers)
 
 
 minimumValue
 Number
 mandatory
-The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
+The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
 
 
 maximumValue
 Number
 optional
-The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
+The number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
 
 
 rateApplicationMethod
-string
+Enum
 optional
 The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')
 
@@ -7643,7 +7704,7 @@ This operation does not require authentication
 additionalInfo
 string
 optional
-Display text providing more information on the rate tier.
+Display text providing more information on the rate tier
 
 
 additionalInfoUri
@@ -7718,9 +7779,68 @@ This operation does not require authentication
 
 
 
-
    ResponseBankingAccountListV2
    
+
    BankingProductInstalments
    
 
-
    
+
    
+
    {
+  "maximumPlanCount": 1,
+  "instalmentsLimit": "string",
+  "minimumPlanValue": "string",
+  "maximumPlanValue": "string",
+  "minimumSplit": 4,
+  "maximumSplit": 4
+}
+
+
    Properties
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    NameTypeRequiredDescription
    maximumPlanCountPositiveIntegermandatoryTotal number of plans that may be created
    instalmentsLimitAmountStringmandatoryMaximum combined limit of all instalment plans that may be created
    minimumPlanValueAmountStringmandatoryMinimum value that can be opened as an instalment plan
    maximumPlanValueAmountStringmandatoryMaximum value that can be opened as an instalment plan
    minimumSplitPositiveIntegermandatoryMinimum number of instalment payments a plan can be created with
    maximumSplitPositiveIntegermandatoryMaximum number of instalment payments a plan can be created with
    
+
+
    ResponseBankingAccountListV3
    
+
+
    
 
    {
   "data": {
     "accounts": [
@@ -7751,7 +7871,7 @@ This operation does not require authentication
   }
 }
 
-
    Properties
    
+
    Properties
    
 
@@ -7768,7 +7888,7 @@ This operation does not require authentication
 
-
+
@@ -7786,9 +7906,9 @@ This operation does not require authentication
 
    
 
    
 Name
    
 
    
 » accounts[BankingAccountV2][BankingAccountV3]
 mandatory
 The list of accounts returned. If the filter results in an empty set then this array may have no records
 
    
 
    
 
-
    BankingAccountV2
    
+
    BankingAccountV3
    
 
-
    
+
    
 
    {
   "accountId": "string",
   "creationDate": "string",
@@ -7802,7 +7922,7 @@ This operation does not require authentication
   "productName": "string"
 }
 
-
    Properties
    
+
    Properties
    
 
@@ -7837,9 +7957,9 @@ This operation does not require authentication
 
-
+
-
+
@@ -7849,7 +7969,7 @@ This operation does not require authentication
 
-
+
@@ -7861,7 +7981,7 @@ This operation does not require authentication
 
-
+
@@ -7909,9 +8029,9 @@ This operation does not require authentication
 
    
 
    
 Name
    
 
    
 openStatusstringEnum
 optionalOpen or closed status for the account. If not present then OPEN is assumedOpen or closed status for the account. If not present then OPEN is assumed
 
    
 
    
 isOwned
    
 
    
 accountOwnershipstringEnum
 mandatory
 Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers
 
    
 
    
 productCategoryBankingProductCategoryBankingProductCategoryV2
 mandatory
 The category to which a product or account belongs. See here for more details
 
    
 
    
 
-
    ResponseBankingAccountByIdV3
    
+
    ResponseBankingAccountByIdV4
    
 
-
    
+
    
 
    {
   "data": {
     "accountId": "string",
@@ -7927,6 +8047,29 @@ This operation does not require authentication
     "bsb": "string",
     "accountNumber": "string",
     "bundleName": "string",
+    "instalments": {
+      "maximumPlanCount": 1,
+      "instalmentsLimit": "string",
+      "minimumPlanValue": "string",
+      "maximumPlanValue": "string",
+      "minimumSplit": 4,
+      "maximumSplit": 4,
+      "plans": [
+        {
+          "planNickname": "string",
+          "creationDate": "string",
+          "amount": "string",
+          "duration": "string",
+          "instalmentInterval": "string",
+          "schedule": [
+            {
+              "amountDue": "string",
+              "dueDate": "string"
+            }
+          ]
+        }
+      ]
+    },
     "specificAccountUType": "creditCard",
     "termDeposit": [
       {
@@ -8112,7 +8255,7 @@ This operation does not require authentication
   "meta": {}
 }
 
-
    Properties
    
+
    Properties
    
 
@@ -8123,7 +8266,7 @@ This operation does not require authentication
 
-
+
@@ -8141,9 +8284,9 @@ This operation does not require authentication
 
    
 
    
 Name
    
 
    
 dataBankingAccountDetailV3BankingAccountDetailV4
 mandatory
 none
 
    
 
    
 
-
    BankingAccountDetailV3
    
+
    BankingAccountDetailV4
    
 
-
    
+
    
 
    {
   "accountId": "string",
   "creationDate": "string",
@@ -8158,6 +8301,29 @@ This operation does not require authentication
   "bsb": "string",
   "accountNumber": "string",
   "bundleName": "string",
+  "instalments": {
+    "maximumPlanCount": 1,
+    "instalmentsLimit": "string",
+    "minimumPlanValue": "string",
+    "maximumPlanValue": "string",
+    "minimumSplit": 4,
+    "maximumSplit": 4,
+    "plans": [
+      {
+        "planNickname": "string",
+        "creationDate": "string",
+        "amount": "string",
+        "duration": "string",
+        "instalmentInterval": "string",
+        "schedule": [
+          {
+            "amountDue": "string",
+            "dueDate": "string"
+          }
+        ]
+      }
+    ]
+  },
   "specificAccountUType": "creditCard",
   "termDeposit": [
     {
@@ -8338,7 +8504,7 @@ This operation does not require authentication
   ]
 }
 
-
    Properties
    
+

    Properties

    allOf

    @@ -8351,7 +8517,7 @@ This operation does not require authentication - + @@ -8392,8 +8558,14 @@ This operation does not require authentication + + + + + + - + @@ -8459,7 +8631,7 @@ This operation does not require authentication - + @@ -8533,6 +8705,173 @@ This operation does not require authentication
    anonymousBankingAccountV2BankingAccountV3 mandatory none
    Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer
    » instalmentsBankingAccountInstalmentsoptionalDetails of instalment features on the account
    » specificAccountUTypestringEnum optional The type of structure to present account specific fields.
    »» anonymousBankingProductFeatureV2BankingProductFeatureV3 mandatory none
    +

    BankingAccountInstalments

    + +

    +
    {
+  "maximumPlanCount": 1,
+  "instalmentsLimit": "string",
+  "minimumPlanValue": "string",
+  "maximumPlanValue": "string",
+  "minimumSplit": 4,
+  "maximumSplit": 4,
+  "plans": [
+    {
+      "planNickname": "string",
+      "creationDate": "string",
+      "amount": "string",
+      "duration": "string",
+      "instalmentInterval": "string",
+      "schedule": [
+        {
+          "amountDue": "string",
+          "dueDate": "string"
+        }
+      ]
+    }
+  ]
+}
+
+
    +

    Details of instalment features on the account

    +

    Properties

    +

    allOf

    + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousBankingProductInstalmentsmandatorynone
    + +

    and

    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousobjectmandatorynone
    » plans[BankingInstalmentPlans]optionalArray of instalment plans
    + +

    BankingInstalmentPlans

    + +

    +
    {
+  "planNickname": "string",
+  "creationDate": "string",
+  "amount": "string",
+  "duration": "string",
+  "instalmentInterval": "string",
+  "schedule": [
+    {
+      "amountDue": "string",
+      "dueDate": "string"
+    }
+  ]
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    planNicknamestringmandatoryThe short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels
    creationDateDateStringmandatoryThe date the plan was created
    amountAmountStringmandatoryThe total amount of the plan
    durationExternalRefmandatoryThe original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    instalmentIntervalExternalRefmandatoryThe expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    schedule[BankingInstalmentPlanSchedule]mandatoryArray of expected repayment amounts and dates
    + +

    BankingInstalmentPlanSchedule

    + +

    +
    {
+  "amountDue": "string",
+  "dueDate": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    amountDueAmountStringmandatoryAmount due with this repayment
    dueDateDateStringmandatoryDate this repayment is due
    +

    BankingTermDepositAccount

    @@ -8544,7 +8883,7 @@ This operation does not require authentication     "maturityInstructions": "HOLD_ON_MATURITY" } -

    Properties

    +

    Properties

    @@ -8579,7 +8918,7 @@ This operation does not require authentication - + @@ -8615,7 +8954,7 @@ This operation does not require authentication "paymentDueDate": "string" } -

    Properties

    +

    Properties

    Name
    maturityInstructionsstringEnum mandatory Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments
    @@ -8673,7 +9012,7 @@ This operation does not require authentication "repaymentFrequency": "string" } -

    Properties

    +

    Properties

    Name
    @@ -8762,7 +9101,7 @@ This operation does not require authentication - + @@ -8828,11 +9167,11 @@ This operation does not require authentication "meta": { "totalRecords": 0, "totalPages": 0, - "isQueryParamUnsupported": true + "isQueryParamUnsupported": false } } -

    Properties

    +

    Properties

    Name
    repaymentTypestringEnum optional Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
    @@ -8891,7 +9230,7 @@ This operation does not require authentication "apcaNumber": "string" } -

    Properties

    +

    Properties

    Name
    @@ -8916,17 +9255,17 @@ This operation does not require authentication - + - + - + @@ -9099,7 +9438,7 @@ This operation does not require authentication "meta": {} } -

    Properties

    +

    Properties

    NameisDetailAvailable Boolean mandatoryTrue if extended information is available using the transaction detail end point. False if extended data is not availableTrue if extended information is available using the transaction detail endpoint. False if extended data is not available
    typestringEnum mandatory The type of the transaction
    statusstringEnum mandatory Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction
    @@ -9163,7 +9502,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    allOf

    Name
    @@ -9218,7 +9557,7 @@ This operation does not require authentication - + @@ -9248,7 +9587,7 @@ This operation does not require authentication - + @@ -9305,7 +9644,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    »» extensionUTypestringEnum optional Optional extended data specific to transactions originated via NPP
    »» servicestringEnum mandatory Identifier of the applicable overlay service. Valid values are: X2P1.01
    @@ -9364,7 +9703,7 @@ This operation does not require authentication "meta": {} } -

    Properties

    +

    Properties

    Name
    @@ -9411,7 +9750,7 @@ This operation does not require authentication ] } -

    Properties

    +

    Properties

    Name
    @@ -9472,7 +9811,7 @@ This operation does not require authentication "currency": "string" } -

    Properties

    +

    Properties

    Name
    @@ -9523,7 +9862,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    Name
    @@ -9624,7 +9963,7 @@ This operation does not require authentication "meta": {} } -

    Properties

    +

    Properties

    Name
    @@ -9664,7 +10003,7 @@ This operation does not require authentication "creationDate": "string" } -

    Properties

    +

    Properties

    Name
    @@ -9693,7 +10032,7 @@ This operation does not require authentication - + @@ -9789,7 +10128,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    allOf

    Name
    typestringEnum mandatory The type of payee.
    DOMESTIC means a registered payee for domestic payments including NPP.
    INTERNATIONAL means a registered payee for international payments.
    BILLER means a registered payee for BPAY.
    DIGITAL_WALLET means a registered payee for a bank's digital wallet
    @@ -9826,7 +10165,7 @@ This operation does not require authentication - + @@ -9900,7 +10239,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    » payeeUTypestringEnum mandatory Type of object included that describes the payee in detail
    @@ -9911,7 +10250,7 @@ This operation does not require authentication - + @@ -9964,7 +10303,7 @@ This operation does not require authentication "accountNumber": "string" } -

    Properties

    +

    Properties

    Name
    payeeAccountUTypestringEnum mandatory Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number. card A credit or charge card to pay to (note that PANs are masked). payId A PayID recognised by NPP
    @@ -10000,7 +10339,7 @@ This operation does not require authentication "cardNumber": "string" } -

    Properties

    +

    Properties

    Name
    @@ -10026,7 +10365,7 @@ This operation does not require authentication "type": "ABN" } -

    Properties

    +

    Properties

    Name
    @@ -10049,7 +10388,7 @@ This operation does not require authentication - + @@ -10088,7 +10427,7 @@ This operation does not require authentication "billerName": "string" } -

    Properties

    +

    Properties

    Name
    typestringEnum mandatory The type of the PayID
    @@ -10142,7 +10481,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    Name
    @@ -10259,7 +10598,7 @@ This operation does not require authentication "provider": "PAYPAL_AU" } -

    Properties

    +

    Properties

    Name
    @@ -10282,13 +10621,13 @@ This operation does not require authentication - + - + @@ -10355,7 +10694,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    Name
    typestringEnum mandatory The type of the digital wallet identifier
    providerstringEnum mandatory The provider of the digital wallet
    @@ -10406,7 +10745,7 @@ This operation does not require authentication "lastDebitAmount": "string" } -

    Properties

    +

    Properties

    Name
    @@ -10452,7 +10791,7 @@ This operation does not require authentication "arbn": "string" } -

    Properties

    +

    Properties

    Name
    @@ -10614,7 +10953,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    Name
    @@ -10753,7 +11092,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    Name
    @@ -10788,7 +11127,7 @@ This operation does not require authentication - + @@ -10898,7 +11237,7 @@ This operation does not require authentication

    The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry

    -

    Properties

    +

    Properties

    Name
    statusstringEnum mandatory Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
    @@ -10994,7 +11333,7 @@ This operation does not require authentication

    Object containing details of the destination of the payment. Used to specify a variety of payment destination types

    -

    Properties

    +

    Properties

    Name
    @@ -11005,7 +11344,7 @@ This operation does not require authentication - + @@ -11013,19 +11352,19 @@ This operation does not require authentication - + - + - + @@ -11100,7 +11439,7 @@ This operation does not require authentication

    Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object

    -

    Properties

    +

    Properties

    Name
    toUTypestringEnum mandatory The type of object provided that specifies the destination of the funds for the payment.
    accountId ASCIIString conditionalPresent if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consentPresent if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
    payeeId ASCIIString conditionalPresent if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided insteadPresent if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead
    nickname string conditionalThe short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channelsThe short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels
    payeeReference
    @@ -11151,7 +11490,7 @@ This operation does not require authentication

    Object containing the detail of the schedule for the payment

    -

    Properties

    +

    Properties

    Name
    @@ -11168,7 +11507,7 @@ This operation does not require authentication - + @@ -11231,7 +11570,7 @@ This operation does not require authentication

    Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff

    -

    Properties

    +

    Properties

    Name
    recurrenceUTypestringEnum mandatory The type of recurrence used to define the schedule
    @@ -11265,7 +11604,7 @@ This operation does not require authentication

    Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule

    -

    Properties

    +

    Properties

    Name
    @@ -11288,9 +11627,9 @@ This operation does not require authentication - + - + @@ -11332,7 +11671,7 @@ This operation does not require authentication "dayInInterval": "string" } -

    Properties

    +

    Properties

    Name
    nonBusinessDayTreatmentstringEnum optionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
    AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
    BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
    ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
    ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored    		Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
    AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
    BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
    ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
    ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
    intervals
    @@ -11368,7 +11707,7 @@ This operation does not require authentication

    Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay

    -

    Properties

    +

    Properties

    Name
    @@ -11397,15 +11736,15 @@ This operation does not require authentication - + - + - +
    Name
    lastWeekDaystringEnum mandatory The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
    nonBusinessDayTreatmentstringEnum optionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
    AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
    BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
    ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
    ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored    		Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
    AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
    BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
    ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
    ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored

    Enumerated Values

    @@ -11470,7 +11809,7 @@ This operation does not require authentication

    Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased

    -

    Properties

    +

    Properties

    @@ -11528,7 +11867,7 @@ This operation does not require authentication } } -

    Properties

    +

    Properties

    Name
    @@ -11539,7 +11878,7 @@ This operation does not require authentication - + @@ -11587,7 +11926,7 @@ This operation does not require authentication "country": "AUS" } -

    Properties

    +

    Properties

    Name
    addressUTypestringEnum mandatory The type of address object present
    @@ -11676,7 +12015,7 @@ This operation does not require authentication

    Australian address formatted according to the file format defined by the PAF file format

    -

    Properties

    +

    Properties

    Name
    @@ -11826,7 +12165,7 @@ This operation does not require authentication "self": "string" } -

    Properties

    +

    Properties

    Name
    @@ -11848,7 +12187,7 @@ This operation does not require authentication 

    {}
 
-

    Properties

    +

    Properties

    None

    LinksPaginated

    @@ -11862,7 +12201,7 @@ This operation does not require authentication "last": "string" } -

    Properties

    +

    Properties

    Name
    @@ -11911,7 +12250,7 @@ This operation does not require authentication "totalPages": 0 } -

    Properties

    +

    Properties

    Name
    @@ -11940,10 +12279,10 @@ This operation does not require authentication 
    {
   "totalRecords": 0,
   "totalPages": 0,
-  "isQueryParamUnsupported": true
+  "isQueryParamUnsupported": false
 }
 
-

    Properties

    +

    Properties

    allOf

    Name
    @@ -11995,7 +12334,7 @@ This operation does not require authentication

    Additional data for customised error codes

    -

    Properties

    +

    Properties

    @@ -12028,7 +12367,7 @@ This operation does not require authentication ] } -

    Properties

    +

    Properties

    Name
    @@ -12069,14 +12408,14 @@ This operation does not require authentication
    Name
    -

    BankingProductCategory

    +

    BankingProductCategoryV2

    -

    +

    "BUSINESS_LOANS"

    The category to which a product or account belongs. See here for more details

    -

    Properties

    +

    Properties

    @@ -12087,7 +12426,7 @@ This operation does not require authentication - + diff --git a/docs/includes/cds_common b/docs/includes/cds_common index e57e67b7..11898f1a 100644 --- a/docs/includes/cds_common +++ b/docs/includes/cds_common @@ -904,7 +904,7 @@ This operation does not require authentication - + @@ -1129,7 +1129,7 @@ This operation does not require authentication - + @@ -1332,7 +1332,7 @@ This operation does not require authentication - + @@ -1447,7 +1447,7 @@ This operation does not require authentication - + @@ -1704,13 +1704,13 @@ This operation does not require authentication - + - + @@ -1902,7 +1902,7 @@ This operation does not require authentication - + @@ -1996,7 +1996,7 @@ This operation does not require authentication - + @@ -2111,7 +2111,7 @@ This operation does not require authentication - + @@ -2197,7 +2197,7 @@ This operation does not require authentication - + diff --git a/docs/includes/cds_dcr b/docs/includes/cds_dcr index 6d3ad29a..3bdd10c1 100644 --- a/docs/includes/cds_dcr +++ b/docs/includes/cds_dcr @@ -860,13 +860,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -896,19 +896,19 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + - + diff --git a/docs/includes/cds_energy b/docs/includes/cds_energy index 648683a4..eeed517d 100644 --- a/docs/includes/cds_energy +++ b/docs/includes/cds_energy @@ -9758,13 +9758,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -9824,7 +9824,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -10740,13 +10740,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -10770,7 +10770,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11176,7 +11176,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11317,7 +11317,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11371,7 +11371,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11419,7 +11419,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11437,7 +11437,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11467,7 +11467,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11638,7 +11638,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11722,13 +11722,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -11740,7 +11740,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -11896,13 +11896,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -11996,7 +11996,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12132,13 +12132,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -12366,19 +12366,19 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + - + @@ -12402,7 +12402,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12420,7 +12420,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12438,7 +12438,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12456,7 +12456,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12695,7 +12695,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12725,13 +12725,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -12773,7 +12773,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12821,7 +12821,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12839,7 +12839,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12857,7 +12857,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12887,7 +12887,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12905,7 +12905,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -12923,13 +12923,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -13236,19 +13236,19 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + - + @@ -13278,13 +13278,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -13518,19 +13518,19 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + - + @@ -13560,13 +13560,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -13608,7 +13608,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -13638,13 +13638,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -13698,7 +13698,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -13716,7 +13716,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -13734,7 +13734,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -14092,7 +14092,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -14104,7 +14104,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -14158,7 +14158,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -14416,7 +14416,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -14446,7 +14446,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -14488,13 +14488,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -14630,7 +14630,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15296,7 +15296,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15460,7 +15460,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15472,7 +15472,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15484,7 +15484,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15520,7 +15520,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15544,13 +15544,13 @@ To perform this operation, you must be authenticated and authorised with the fol - + - + @@ -15562,7 +15562,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15713,7 +15713,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15767,7 +15767,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -15987,7 +15987,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16072,7 +16072,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16191,7 +16191,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16408,7 +16408,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16523,7 +16523,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16553,7 +16553,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16583,7 +16583,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16745,7 +16745,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16799,7 +16799,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -16988,7 +16988,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -17018,7 +17018,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -17111,7 +17111,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + @@ -17205,7 +17205,7 @@ To perform this operation, you must be authenticated and authorised with the fol - + diff --git a/docs/includes/cds_energy_sdh b/docs/includes/cds_energy_sdh index a6c97dda..5552692f 100644 --- a/docs/includes/cds_energy_sdh +++ b/docs/includes/cds_energy_sdh @@ -2302,19 +2302,19 @@ This operation may only be called by an Energy Retailer using the information se - + - + - + @@ -2344,13 +2344,13 @@ This operation may only be called by an Energy Retailer using the information se - + - + @@ -2584,19 +2584,19 @@ This operation may only be called by an Energy Retailer using the information se - + - + - + @@ -2626,13 +2626,13 @@ This operation may only be called by an Energy Retailer using the information se - + - + @@ -2674,7 +2674,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -2704,13 +2704,13 @@ This operation may only be called by an Energy Retailer using the information se - + - + @@ -2764,7 +2764,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -2782,7 +2782,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -2800,7 +2800,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -3158,7 +3158,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -3170,7 +3170,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -3224,7 +3224,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -3482,7 +3482,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -3512,7 +3512,7 @@ This operation may only be called by an Energy Retailer using the information se - + @@ -3554,13 +3554,13 @@ This operation may only be called by an Energy Retailer using the information se - + - + @@ -3708,7 +3708,7 @@ This operation may only be called by an Energy Retailer using the information se - + diff --git a/docs/includes/cds_register b/docs/includes/cds_register index f276a4f8..53ba90ea 100644 --- a/docs/includes/cds_register +++ b/docs/includes/cds_register @@ -2128,7 +2128,7 @@ This operation does not require authentication - + @@ -2316,7 +2316,7 @@ This operation does not require authentication - + diff --git a/docs/includes/cds_register_banking_non_bank_lending b/docs/includes/cds_register_banking_non_bank_lending index 6d38facf..9ec5a527 100644 --- a/docs/includes/cds_register_banking_non_bank_lending +++ b/docs/includes/cds_register_banking_non_bank_lending @@ -38,7 +38,7 @@ x-min-v: string

    Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem.

    -

    Obsolete versions: v1

    +

    Obsolete versions: v1, v2

    Endpoint Version

    Name
    anonymousstringEnum mandatory The category to which a product or account belongs. See here for more details
    » statusstringEnum mandatory Enumeration with values. OK (implementation is fully functional). PARTIAL_FAILURE (one or more end points are unexpectedly unavailable). UNAVAILABLE (the full implementation is unexpectedly unavailable). SCHEDULED_OUTAGE (an advertised outage is in effect)
    » customerUTypestringEnum mandatory The type of customer object that is present
    » customerUTypestringEnum mandatory The type of customer object that is present
    occupationCodeVersionstringEnum conditional The applicable [ANZSCO] release version of the occupation code provided. Mandatory if an occupationCode is supplied. If occupationCode is supplied but occupationCodeVersion is absent, default is ANZSCO_1220.0_2013_V1.2
    industryCodeVersionstringEnum conditional The applicable ANZSIC release version of the industry code provided. Should only be supplied if industryCode is also supplied. If industryCode is supplied but industryCodeVersion is absent, default is ANZSIC_1292.0_2006_V2.0
    organisationTypestringEnum mandatory Legal organisation type
    purposestringEnum mandatory The purpose of the number as specified by the customer
    purposestringEnum mandatory The purpose for the email, as specified by the customer (Enumeration)
    » purposestringEnum mandatory Enumeration of values indicating the purpose of the physical address
    addressUTypestringEnum mandatory The type of address object present
    grant_types[string][Enum] mandatory Array of OAuth 2.0 grant type strings that the client can use at the token endpoint
    response_types[string][Enum] mandatory Array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint.

    Response type value code is required for Authorization Code Flow. Response type value code id_token is required for OIDC Hybrid Flow.
    authorization_signed_response_algstringEnum optional The JWS alg algorithm required for signing authorization responses. If this is specified, the response will be signed using JWS and the configured algorithm. The algorithm “none” is not allowed.

    Required if response_type of “code” is registered by the client.
    authorization_encrypted_response_algstringEnum optional The JWE alg algorithm required for encrypting authorization responses. If unspecified, the default is that no encryption is performed.

    Required if “authorization_encrypted_response_enc” is included.
    authorization_encrypted_response_encstringEnum optional The JWE enc algorithm required for encrypting authorization responses. If “authorization_encrypted_response_alg” is specified, the default for this value is “A128CBC-HS256”.
    typestringEnum mandatory The type of the plan
    fuelTypestringEnum mandatory The fuel types covered by the plan
    customerTypestringEnum optional The type of customer that the plan is offered to. If absent then the plan is available to all customers
    pricingModelstringEnum mandatory The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:
    • SINGLE_RATE - all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a ‘block’ or ‘step’ tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.
    • SINGLE_RATE_CONT_LOAD - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
    • TIME_OF_USE - energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumed
    • TIME_OF_USE_CONT_LOAD - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
    • FLEXIBLE - energy usage is charged at unit rates that vary based on external factors
    • FLEXIBLE_CONT_LOAD - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
    • QUOTA - all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage
    timeZonestringEnum conditional Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent
    paymentOption[string][Enum] mandatory Payment options for this contract
    » termTypestringEnum optional The term for the contract. If absent assumes no specified term
    rateBlockUTypestringEnum mandatory Specifies the type of controlloed load rate
    »» measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    »» measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    »» days[string][Enum] optional The days that the rate applies to
    » typestringEnum mandatory The type of usage that the rate applies to
    categorystringEnum mandatory The type of the incentive
    typestringEnum mandatory The type of the discount
    categorystringEnum optional The type of the discount. Mandatory if the discount type is CONDITIONAL
    methodUTypestringEnum mandatory The method of calculation of the discount
    schemestringEnum mandatory The applicable green power scheme
    typestringEnum mandatory The type of charge
    typestringEnum mandatory The type of the eligibility restriction.
    The CONTINGENT_PLAN value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up)
    typestringEnum mandatory The type of the fee
    termstringEnum mandatory The term of the fee
    schemestringEnum mandatory The applicable scheme
    payerTypestringEnum mandatory The type of the payer
    tariffUTypestringEnum mandatory The type of the payer
    »» measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    » typestringEnum optional The type of the charging time period. If absent applies to all periods
    »» measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    »» days[string][Enum] mandatory The days that the tariff applies to. At least one entry required
    typestringEnum optional Type of charge. Assumed to be other if absent
    timeZonestringEnum optional Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.
    rateBlockUTypestringEnum mandatory Specifies the type of rate applicable to this tariff period
    »» measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    »» measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    »» days[string][Enum] mandatory The days that the rate applies to
    » typestringEnum mandatory The type of usage that the rate applies to
    » measureUnitstringEnum optional The measurement unit of charge amount. Assumed to be KWH if absent
    » days[string][Enum] optional The days that the demand tariff applies to
    » measurementPeriodstringEnum mandatory Application period for the demand tariff
    » chargePeriodstringEnum mandatory Charge period for the demand tariff
    servicePointClassificationstringEnum mandatory The classification of the service point as defined in MSATS procedures
    servicePointStatusstringEnum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
    • ACTIVE - An active, energised, service point
    • DE_ENERGISED - The service point exists but is deenergised
    • EXTINCT - The service point has been permanently decommissioned
    • GREENFIELD - Applies to a service point that has never been energised
    • OFF_MARKET - Applies when the service point is no longer settled in the NEM
    jurisdictionCodestringEnum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
    • ALL - All Jurisdictions
    • ACT - Australian Capital Territory
    • NEM - National Electricity Market
    • NSW - New South Wales
    • QLD - Queensland
    • SA - South Australia
    • TAS - Tasmania
    • VIC - Victoria
    » classificationstringEnum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments
    » thresholdanyEnum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
    • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
    • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
    • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
    servicePointClassificationstringEnum mandatory The classification of the service point as defined in MSATS procedures
    servicePointStatusstringEnum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
    • ACTIVE - An active, energised, service point
    • DE_ENERGISED - The service point exists but is deenergised
    • EXTINCT - The service point has been permanently decommissioned
    • GREENFIELD - Applies to a service point that has never been energised
    • OFF_MARKET - Applies when the service point is no longer settled in the NEM
    jurisdictionCodestringEnum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
    • ALL - All Jurisdictions
    • ACT - Australian Capital Territory
    • NEM - National Electricity Market
    • NSW - New South Wales
    • QLD - Queensland
    • SA - South Australia
    • TAS - Tasmania
    • VIC - Victoria
    » classificationstringEnum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments
    » thresholdanyEnum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
    • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
    • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
    • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
    » rolestringEnum mandatory The role performed by this participant in relation to the service point. Note the details of enumeration values below:
    • FRMP - Financially Responsible Market Participant
    • LNSP - Local Network Service Provider or Embedded Network Manager for child connection points
    • DRSP - wholesale Demand Response and/or market ancillary Service Provider and note that where it is not relevant for a NMI it will not be included
    »» statusstringEnum mandatory A code to denote the status of the meter. Note the details of enumeration values below:
    • CURRENT -Applies when a meter is current and not disconnected
    • DISCONNECTED - Applies when a meter is present but has been remotely disconnected
    »» installationTypestringEnum mandatory The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
    • BASIC - Accumulation Meter – Type 6
    • COMMS1 - Interval Meter with communications – Type 1
    • COMMS2 - Interval Meter with communications – Type 2
    • COMMS3 - Interval Meter with communications – Type 3
    • COMMS4 - Interval Meter with communications – Type 4
    • COMMS4C - CT connected metering installation that meets the minimum services specifications
    • COMMS4D - Whole current metering installation that meets the minimum services specifications
    • MRAM - Small customer metering installation – Type 4A
    • MRIM - Manually Read Interval Meter – Type 5
    • UMCP - Unmetered Supply – Type 7
    • VICAMI - A relevant metering installation as defined in clause 9.9C of the NER
    • NCONUML - Non-contestable unmeter load - Introduced as part of Global Settlement
    »» registerConsumptionTypestringEnum mandatory Indicates the consumption type of register
    »» timeOfDaystringEnum optional Code to identify the time validity of register contents
    »» consumptionTypestringEnum optional Actual/Subtractive Indicator. Note the details of enumeration values below:
    • ACTUAL implies volume of energy actually metered between two dates
    • CUMULATIVE indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates
    readUTypestringEnum mandatory Specify the type of the meter read data
    » qualitystringEnum optional The quality of the read taken. If absent then assumed to be ACTUAL
    »» qualitystringEnum mandatory The quality of the read taken
    » equipmentTypestringEnum optional Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g. rotating machine). If absent, assume equipment type to be “OTHER”.
    » statusstringEnum mandatory Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned
    »» statusstringEnum optional Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned
    »» typestringEnum mandatory Used to indicate the primary technology used in the DER device
    openStatusstringEnum optional Open or closed status for the account. If not present then OPEN is assumed
    »»» fuelTypestringEnum mandatory The fuel types covered by the plan
    paymentScheduleUTypestringEnum mandatory The type of object present in this response
    » cardSchemestringEnum mandatory The type of credit card held on file
    » calculationTypestringEnum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    • STATIC - Indicates a consistent, static amount, per payment
    • BALANCE - Indicates that the outstanding balance for the account is paid per period
    • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    » calculationTypestringEnum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    • STATIC - Indicates a consistent, static amount, per payment
    • BALANCE - Indicates that the outstanding balance for the account is paid per period
    • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    » typestringEnum mandatory The type of the digital wallet identifier
    » providerstringEnum mandatory The provider of the digital wallet
    » calculationTypestringEnum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    • STATIC - Indicates a consistent, static amount, per payment
    • BALANCE - Indicates that the outstanding balance for the account is paid per period
    • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    typestringEnum mandatory Indicator of the method of concession calculation
    appliedTo[string][Enum] optional Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed
    paymentStatusstringEnum mandatory Indicator of the payment status for the invoice
    » typestringEnum optional Type of charge. Assumed to be other if absent
    » typestringEnum optional Type of charge. Assumed to be other if absent
    transactionUTypestringEnum mandatory Indicator of the type of transaction object present in this record
    timeOfUseTypestringEnum mandatory The time of use type that the transaction applies to
    measureUnitstringEnum optional The measurement unit of rate. Assumed to be KWH if absent
    » typestringEnum mandatory The type of the calculation factor
    timeOfUseTypestringEnum mandatory The time of use type that the transaction applies to
    » typestringEnum mandatory The type of the calculation factor
    typestringEnum optional Type of charge. Assumed to be other if absent
    » typestringEnum mandatory The type of the calculation factor
    methodstringEnum mandatory The method of payment
    addressUTypestringEnum mandatory The type of address object present
    servicePointClassificationstringEnum mandatory The classification of the service point as defined in MSATS procedures
    servicePointStatusstringEnum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
    • ACTIVE - An active, energised, service point
    • DE_ENERGISED - The service point exists but is deenergised
    • EXTINCT - The service point has been permanently decommissioned
    • GREENFIELD - Applies to a service point that has never been energised
    • OFF_MARKET - Applies when the service point is no longer settled in the NEM
    jurisdictionCodestringEnum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
    • ALL - All Jurisdictions
    • ACT - Australian Capital Territory
    • NEM - National Electricity Market
    • NSW - New South Wales
    • QLD - Queensland
    • SA - South Australia
    • TAS - Tasmania
    • VIC - Victoria
    » classificationstringEnum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments
    » thresholdanyEnum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
    • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
    • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
    • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
    servicePointClassificationstringEnum mandatory The classification of the service point as defined in MSATS procedures
    servicePointStatusstringEnum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
    • ACTIVE - An active, energised, service point
    • DE_ENERGISED - The service point exists but is deenergised
    • EXTINCT - The service point has been permanently decommissioned
    • GREENFIELD - Applies to a service point that has never been energised
    • OFF_MARKET - Applies when the service point is no longer settled in the NEM
    jurisdictionCodestringEnum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
    • ALL - All Jurisdictions
    • ACT - Australian Capital Territory
    • NEM - National Electricity Market
    • NSW - New South Wales
    • QLD - Queensland
    • SA - South Australia
    • TAS - Tasmania
    • VIC - Victoria
    » classificationstringEnum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments
    » thresholdanyEnum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
    • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
    • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
    • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
    » rolestringEnum mandatory The role performed by this participant in relation to the service point. Note the details of enumeration values below:
    • FRMP - Financially Responsible Market Participant
    • LNSP - Local Network Service Provider or Embedded Network Manager for child connection points
    • DRSP - wholesale Demand Response and/or market ancillary Service Provider and note that where it is not relevant for a NMI it will not be included
    »» statusstringEnum mandatory A code to denote the status of the meter. Note the details of enumeration values below:
    • CURRENT -Applies when a meter is current and not disconnected
    • DISCONNECTED - Applies when a meter is present but has been remotely disconnected
    »» installationTypestringEnum mandatory The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
    • BASIC - Accumulation Meter – Type 6
    • COMMS1 - Interval Meter with communications – Type 1
    • COMMS2 - Interval Meter with communications – Type 2
    • COMMS3 - Interval Meter with communications – Type 3
    • COMMS4 - Interval Meter with communications – Type 4
    • COMMS4C - CT connected metering installation that meets the minimum services specifications
    • COMMS4D - Whole current metering installation that meets the minimum services specifications
    • MRAM - Small customer metering installation – Type 4A
    • MRIM - Manually Read Interval Meter – Type 5
    • UMCP - Unmetered Supply – Type 7
    • VICAMI - A relevant metering installation as defined in clause 9.9C of the NER
    • NCONUML - Non-contestable unmeter load - Introduced as part of Global Settlement
    »» registerConsumptionTypestringEnum mandatory Indicates the consumption type of register
    »» timeOfDaystringEnum optional Code to identify the time validity of register contents
    »» consumptionTypestringEnum optional Actual/Subtractive Indicator. Note the details of enumeration values below:
    • ACTUAL implies volume of energy actually metered between two dates
    • CUMULATIVE indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates
    readUTypestringEnum mandatory Specify the type of the meter read data
    » qualitystringEnum optional The quality of the read taken. If absent then assumed to be ACTUAL
    »» qualitystringEnum mandatory The quality of the read taken
    » equipmentTypestringEnum optional Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g. rotating machine). If absent, assume equipment type to be “OTHER”.
    » statusstringEnum mandatory Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned
    »» statusstringEnum optional Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned
    »» typestringEnum mandatory Used to indicate the primary technology used in the DER device
    addressUTypestringEnum mandatory The type of address object present
    industries[string][Enum] mandatory The industries the Data Holder Brand belongs to
    industries[string][Enum] mandatory The industries the Data Holder Brand belongs to
    @@ -48,7 +48,7 @@ x-min-v: string - +
    Version23
    @@ -298,6 +298,8 @@ If-None-Match: string

    GET /cdr-register/v1/{industry}/data-holders/brands/summary

    Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register

    + +

    Obsolete versions: v1

    Endpoint Version

    @@ -307,7 +309,7 @@ If-None-Match: string - +
    Version12
    @@ -524,6 +526,8 @@ If-None-Match: string

    GET /cdr-register/v1/{industry}/data-holders/status

    Endpoint used by participants to discover the statuses for Data Holders from the CDR Register

    + +

    Obsolete versions: v1

    Endpoint Version

    @@ -533,7 +537,7 @@ If-None-Match: string - +
    Version12
    @@ -853,7 +857,7 @@ This operation does not require authentication industries -[string] +[Enum] mandatory The industries the Data Holder Brand belongs to @@ -1045,7 +1049,7 @@ This operation does not require authentication industries -[string] +[Enum] mandatory The industries the Data Holder Brand belongs to diff --git a/docs/includes/cds_telco b/docs/includes/cds_telco index f78d347d..0ae41438 100644 --- a/docs/includes/cds_telco +++ b/docs/includes/cds_telco @@ -6762,19 +6762,19 @@ To perform this operation, you must be authenticated and authorised with the fol type -string +Enum mandatory The type of product. MOBILE service or BROADBAND fixed internet service purpose -string +Enum optional The purpose type of the product. If absent, then the value PERSONAL is assumed billingType -string +Enum mandatory The type of product @@ -7194,7 +7194,7 @@ To perform this operation, you must be authenticated and authorised with the fol openStatus -string +Enum optional Open or closed status for the account. If not present then OPEN is assumed @@ -7423,7 +7423,7 @@ To perform this operation, you must be authenticated and authorised with the fol paymentScheduleUType -string +Enum mandatory The type of object present in this response @@ -7506,7 +7506,7 @@ To perform this operation, you must be authenticated and authorised with the fol type -string +Enum mandatory The concession type @@ -7560,7 +7560,7 @@ To perform this operation, you must be authenticated and authorised with the fol appliedTo -[string] +[Enum] optional Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed @@ -7757,7 +7757,7 @@ To perform this operation, you must be authenticated and authorised with the fol paymentStatus -string +Enum mandatory Indicator of the payment status for the invoice @@ -7997,7 +7997,7 @@ To perform this operation, you must be authenticated and authorised with the fol transactionUType -string +Enum mandatory Indicator of the type of transaction object present in this record @@ -8221,7 +8221,7 @@ To perform this operation, you must be authenticated and authorised with the fol type -string +Enum optional Type of charge. Assumed to be OTHER if absent @@ -8298,7 +8298,7 @@ To perform this operation, you must be authenticated and authorised with the fol method -string +Enum mandatory The method of payment @@ -8560,7 +8560,7 @@ To perform this operation, you must be authenticated and authorised with the fol anonymous -string +Enum mandatory Plan type for this feature. METERED: A plan is charged by usage for the feature. UNMETERED: A plan with no limits for a feature. LIMITED: Where plan limit inclusions apply. UNSUPPORTED: Feature is not supported @@ -8642,7 +8642,7 @@ To perform this operation, you must be authenticated and authorised with the fol addressUType -string +Enum mandatory The type of address object present @@ -10207,7 +10207,7 @@ To perform this operation, you must be authenticated and authorised with the fol category -string +Enum optional The type of the feature @@ -10811,13 +10811,13 @@ To perform this operation, you must be authenticated and authorised with the fol type -string +Enum mandatory The type of the plan. The type of plan. A MOBILE service or BROADBAND fixed internet service billingType -string +Enum mandatory The billing type of then plan @@ -11112,7 +11112,7 @@ To perform this operation, you must be authenticated and authorised with the fol cardScheme -string +Enum mandatory The type of credit card held on file @@ -11124,7 +11124,7 @@ To perform this operation, you must be authenticated and authorised with the fol calculationType -string +Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    • STATIC - Indicates a consistent, static amount, per payment
    • BALANCE - Indicates that the outstanding balance for the account is paid per period
    • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    @@ -11222,7 +11222,7 @@ To perform this operation, you must be authenticated and authorised with the fol calculationType -string +Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    • STATIC - Indicates a consistent, static amount, per payment
    • BALANCE - Indicates that the outstanding balance for the account is paid per period
    • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    @@ -11285,13 +11285,13 @@ To perform this operation, you must be authenticated and authorised with the fol type -string +Enum mandatory The type of the digital wallet identifier provider -string +Enum mandatory The provider of the digital wallet @@ -11303,7 +11303,7 @@ To perform this operation, you must be authenticated and authorised with the fol calculationType -string +Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    • STATIC - Indicates a consistent, static amount, per payment
    • BALANCE - Indicates that the outstanding balance for the account is paid per period
    • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    @@ -11881,7 +11881,7 @@ To perform this operation, you must be authenticated and authorised with the fol type -string +Enum optional A free text description of the charge diff --git a/docs/includes/changelog b/docs/includes/changelog index 52ddc946..59b80b54 100644 --- a/docs/includes/changelog +++ b/docs/includes/changelog @@ -1,5 +1,4 @@ -

    Change Log

    Updated release notes for version 1.25.0 to include references to three maintenance issues that were part of the release but not previously noted
-
    +

    Change Log

    The following table lists the changes made to these standards in reverse date order (most recent change is at the top).

    @@ -11,6 +10,12 @@ + + + + + + diff --git a/docs/includes/obsolete/get-account-detail-v3.html b/docs/includes/obsolete/get-account-detail-v3.html new file mode 100644 index 00000000..962fb36c --- /dev/null +++ b/docs/includes/obsolete/get-account-detail-v3.html @@ -0,0 +1,3295 @@ + + + + + + + + Get Account Detail v3 + + + + + + + + + + + + NAV + Navbar + + +
    + + + +
    +
    +
    +
    +

    Get Account Detail V3

    +

    This page documents the obsolete version 3 of the Get Account Detail endpoint.

    + +

    This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

    +

    Get Account Detail

    +

    + +
    +

    Code samples

    +
    +
    GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
    const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
    +

    GET /banking/accounts/{accountId}

    + +

    Obtain detailed information on a single account.

    + +

    Obsolete versions: v1, v2

    +

    Endpoint Version

    +
    10/11/20231.28.0Candidate standards arising from Decision 306 and updated draft non-bank lending standardsSee release notes and Decision 306 for details.
    10/10/2023 1.27.0 Changes arising from Decision 313 (Maintenance Iteration 16)
    + + + + + + + + + +
    Version3
    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameInTypeRequiredDescription
    accountIdpathASCIIStringmandatoryA tokenised identifier for the account which is unique but not shareable
    x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
    x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
    x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
    x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
    + +
    +

    Example responses

    + +

    200 Response

    +
    +
    {
+  "data": {
+    "accountId": "string",
+    "creationDate": "string",
+    "displayName": "string",
+    "nickname": "string",
+    "openStatus": "CLOSED",
+    "isOwned": true,
+    "accountOwnership": "UNKNOWN",
+    "maskedNumber": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "productName": "string",
+    "bsb": "string",
+    "accountNumber": "string",
+    "bundleName": "string",
+    "specificAccountUType": "creditCard",
+    "termDeposit": [
+      {
+        "lodgementDate": "string",
+        "maturityDate": "string",
+        "maturityAmount": "string",
+        "maturityCurrency": "string",
+        "maturityInstructions": "HOLD_ON_MATURITY"
+      }
+    ],
+    "creditCard": {
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string"
+    },
+    "loan": {
+      "originalStartDate": "string",
+      "originalLoanAmount": "string",
+      "originalLoanCurrency": "string",
+      "loanEndDate": "string",
+      "nextInstalmentDate": "string",
+      "minInstalmentAmount": "string",
+      "minInstalmentCurrency": "string",
+      "maxRedraw": "string",
+      "maxRedrawCurrency": "string",
+      "minRedraw": "string",
+      "minRedrawCurrency": "string",
+      "offsetAccountEnabled": true,
+      "offsetAccountIds": [
+        "string"
+      ],
+      "repaymentType": "INTEREST_ONLY",
+      "repaymentFrequency": "string"
+    },
+    "depositRate": "string",
+    "lendingRate": "string",
+    "depositRates": [
+      {
+        "depositRateType": "BONUS",
+        "rate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+        "rate": "string",
+        "comparisonRate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "isActivated": true
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeType": "DEPOSIT",
+        "amount": "string",
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "addresses": [
+      {
+        "addressUType": "paf",
+        "simple": {
+          "mailingName": "string",
+          "addressLine1": "string",
+          "addressLine2": "string",
+          "addressLine3": "string",
+          "postcode": "string",
+          "city": "string",
+          "state": "string",
+          "country": "AUS"
+        },
+        "paf": {
+          "dpid": "string",
+          "thoroughfareNumber1": 0,
+          "thoroughfareNumber1Suffix": "string",
+          "thoroughfareNumber2": 0,
+          "thoroughfareNumber2Suffix": "string",
+          "flatUnitType": "string",
+          "flatUnitNumber": "string",
+          "floorLevelType": "string",
+          "floorLevelNumber": "string",
+          "lotNumber": "string",
+          "buildingName1": "string",
+          "buildingName2": "string",
+          "streetName": "string",
+          "streetType": "string",
+          "streetSuffix": "string",
+          "postalDeliveryType": "string",
+          "postalDeliveryNumber": 0,
+          "postalDeliveryNumberPrefix": "string",
+          "postalDeliveryNumberSuffix": "string",
+          "localityName": "string",
+          "postcode": "string",
+          "state": "string"
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKSuccessResponseBankingAccountByIdV3
    400Bad RequestThe following error codes MUST be supported:
    		ResponseErrorListV2
    404Not FoundThe following error codes MUST be supported:
    		ResponseErrorListV2
    406Not AcceptableThe following error codes MUST be supported:
    		ResponseErrorListV2
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    200x-vstringThe version of the API end point that the data holder has responded with.
    200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
    400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
    404x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
    406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
    + +

    + +

    Schemas

    + +

    + +

    BankingProductFeatureV2

    + +

    +
    {
+  "featureType": "ADDITIONAL_CARDS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    featureTypestringmandatoryThe type of feature described
    additionalValuestringconditionalGeneric field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
    additionalInfostringconditionalDisplay text providing more information on the feature. Mandatory if the feature type is set to OTHER
    additionalInfoUriURIStringoptionalLink to a web page with more information on this feature
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    featureTypeADDITIONAL_CARDS
    featureTypeBALANCE_TRANSFERS
    featureTypeBILL_PAYMENT
    featureTypeBONUS_REWARDS
    featureTypeCARD_ACCESS
    featureTypeCASHBACK_OFFER
    featureTypeCOMPLEMENTARY_PRODUCT_DISCOUNTS
    featureTypeDIGITAL_BANKING
    featureTypeDIGITAL_WALLET
    featureTypeDONATE_INTEREST
    featureTypeEXTRA_REPAYMENTS
    featureTypeFRAUD_PROTECTION
    featureTypeFREE_TXNS
    featureTypeFREE_TXNS_ALLOWANCE
    featureTypeGUARANTOR
    featureTypeINSURANCE
    featureTypeINSTALMENT_PLAN
    featureTypeINTEREST_FREE
    featureTypeINTEREST_FREE_TRANSFERS
    featureTypeLOYALTY_PROGRAM
    featureTypeNOTIFICATIONS
    featureTypeNPP_ENABLED
    featureTypeNPP_PAYID
    featureTypeOFFSET
    featureTypeOTHER
    featureTypeOVERDRAFT
    featureTypeREDRAW
    featureTypeRELATIONSHIP_MANAGEMENT
    featureTypeUNLIMITED_TXNS
    + +

    BankingProductFee

    + +

    +
    {
+  "name": "string",
+  "feeType": "DEPOSIT",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "accrualFrequency": "string",
+  "currency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "discounts": [
+    {
+      "description": "string",
+      "discountType": "BALANCE",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "feeRate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "eligibility": [
+        {
+          "discountEligibilityType": "BUSINESS",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    namestringmandatoryName of the fee
    feeTypestringmandatoryThe type of fee
    amountAmountStringconditionalThe amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
    balanceRateRateStringconditionalA fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied.
    transactionRateRateStringconditionalA fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
    accruedRateRateStringconditionalA fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
    accrualFrequencyExternalRefoptionalThe indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    currencyCurrencyStringoptionalThe currency the fee will be charged in. Assumes AUD if absent
    additionalValuestringconditionalGeneric field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
    additionalInfostringoptionalDisplay text providing more information on the fee
    additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
    discounts[BankingProductDiscount]optionalAn optional list of discounts to this fee that may be available
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    feeTypeDEPOSIT
    feeTypeEVENT
    feeTypeEXIT
    feeTypePAYMENT
    feeTypePERIODIC
    feeTypePURCHASE
    feeTypeTRANSACTION
    feeTypeUPFRONT
    feeTypeVARIABLE
    feeTypeWITHDRAWAL
    + +

    BankingProductDiscount

    + +

    +
    {
+  "description": "string",
+  "discountType": "BALANCE",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "feeRate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "eligibility": [
+    {
+      "discountEligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    descriptionstringmandatoryDescription of the discount
    discountTypestringmandatoryThe type of discount. See the next section for an overview of valid values and their meaning
    amountAmountStringconditionalDollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
    balanceRateRateStringconditionalA discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
    transactionRateRateStringconditionalA discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory
    accruedRateRateStringconditionalA discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
    feeRateRateStringconditionalA discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
    additionalValuestringconditionalGeneric field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
    additionalInfostringoptionalDisplay text providing more information on the discount
    additionalInfoUriURIStringoptionalLink to a web page with more information on this discount
    eligibility[BankingProductDiscountEligibility]conditionalEligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    discountTypeBALANCE
    discountTypeDEPOSITS
    discountTypeELIGIBILITY_ONLY
    discountTypeFEE_CAP
    discountTypePAYMENTS
    + +

    BankingProductDiscountEligibility

    + +

    +
    {
+  "discountEligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    discountEligibilityTypestringmandatoryThe type of the specific eligibility constraint for a discount
    additionalValuestringconditionalGeneric field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
    additionalInfostringconditionalDisplay text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
    additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility constraint
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    discountEligibilityTypeBUSINESS
    discountEligibilityTypeEMPLOYMENT_STATUS
    discountEligibilityTypeINTRODUCTORY
    discountEligibilityTypeMAX_AGE
    discountEligibilityTypeMIN_AGE
    discountEligibilityTypeMIN_INCOME
    discountEligibilityTypeMIN_TURNOVER
    discountEligibilityTypeNATURAL_PERSON
    discountEligibilityTypeOTHER
    discountEligibilityTypePENSION_RECIPIENT
    discountEligibilityTypeRESIDENCY_STATUS
    discountEligibilityTypeSTAFF
    discountEligibilityTypeSTUDENT
    + +

    BankingProductDepositRate

    + +

    +
    {
+  "depositRateType": "BONUS",
+  "rate": "string",
+  "calculationFrequency": "string",
+  "applicationFrequency": "string",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": 0,
+      "maximumValue": 0,
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": {
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    depositRateTypestringmandatoryThe type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning
    rateRateStringmandatoryThe rate to be applied
    calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    tiers[BankingProductRateTierV3]optionalRate tiers applicable for this rate
    additionalValuestringconditionalGeneric field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
    additionalInfostringoptionalDisplay text providing more information on the rate
    additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    depositRateTypeBONUS
    depositRateTypeBUNDLE_BONUS
    depositRateTypeFIXED
    depositRateTypeFLOATING
    depositRateTypeINTRODUCTORY
    depositRateTypeMARKET_LINKED
    depositRateTypeVARIABLE
    + +

    BankingProductLendingRateV2

    + +

    +
    {
+  "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+  "rate": "string",
+  "comparisonRate": "string",
+  "calculationFrequency": "string",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentType": "INTEREST_ONLY",
+  "loanPurpose": "INVESTMENT",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": 0,
+      "maximumValue": 0,
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": {
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    lendingRateTypestringmandatoryThe type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning
    rateRateStringmandatoryThe rate to be applied
    comparisonRateRateStringoptionalA comparison rate equivalent for this rate
    calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    interestPaymentDuestringoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
    repaymentTypestringoptionalOptions in place for repayments. If absent, the lending rate is applicable to all repayment types
    loanPurposestringoptionalThe reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
    tiers[BankingProductRateTierV3]optionalRate tiers applicable for this rate
    additionalValuestringconditionalGeneric field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
    additionalInfostringoptionalDisplay text providing more information on the rate.
    additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    lendingRateTypeBUNDLE_DISCOUNT_FIXED
    lendingRateTypeBUNDLE_DISCOUNT_VARIABLE
    lendingRateTypeCASH_ADVANCE
    lendingRateTypeDISCOUNT
    lendingRateTypeFIXED
    lendingRateTypeFLOATING
    lendingRateTypeINTRODUCTORY
    lendingRateTypeMARKET_LINKED
    lendingRateTypePENALTY
    lendingRateTypePURCHASE
    lendingRateTypeVARIABLE
    interestPaymentDueIN_ADVANCE
    interestPaymentDueIN_ARREARS
    repaymentTypeINTEREST_ONLY
    repaymentTypePRINCIPAL_AND_INTEREST
    loanPurposeINVESTMENT
    loanPurposeOWNER_OCCUPIED
    + +

    BankingProductRateTierV3

    + +

    +
    {
+  "name": "string",
+  "unitOfMeasure": "DAY",
+  "minimumValue": 0,
+  "maximumValue": 0,
+  "rateApplicationMethod": "PER_TIER",
+  "applicabilityConditions": {
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
    +

    Defines the criteria and conditions for which a rate applies

    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    namestringmandatoryA display name for the tier
    unitOfMeasurestringmandatoryThe unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers)
    minimumValueNumbermandatoryThe number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
    maximumValueNumberoptionalThe number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
    rateApplicationMethodstringoptionalThe method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')
    applicabilityConditionsBankingProductRateConditionoptionalDefines a condition for the applicability of a tiered rate
    additionalInfostringoptionalDisplay text providing more information on the rate tier.
    additionalInfoUriURIStringoptionalLink to a web page with more information on this rate tier
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    unitOfMeasureDAY
    unitOfMeasureDOLLAR
    unitOfMeasureMONTH
    unitOfMeasurePERCENT
    rateApplicationMethodPER_TIER
    rateApplicationMethodWHOLE_BALANCE
    + +

    BankingProductRateCondition

    + +

    +
    {
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
    +

    Defines a condition for the applicability of a tiered rate

    +

    Properties

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    additionalInfostringoptionalDisplay text providing more information on the condition
    additionalInfoUriURIStringoptionalLink to a web page with more information on this condition
    + +

    BankingAccountV2

    + +

    +
    {
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
    creationDateDateStringoptionalDate that the account was created (if known)
    displayNamestringmandatoryThe display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.
    nicknamestringoptionalA customer supplied nick name for the account
    openStatusstringoptionalOpen or closed status for the account. If not present then OPEN is assumed
    isOwnedBooleanoptionalFlag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed
    accountOwnershipstringmandatoryValue indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers
    maskedNumberMaskedAccountStringmandatoryA masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
    productCategoryBankingProductCategorymandatoryThe category to which a product or account belongs. See here for more details
    productNamestringmandatoryThe unique identifier of the account as defined by the data holder (akin to model number for the account)
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    openStatusCLOSED
    openStatusOPEN
    accountOwnershipUNKNOWN
    accountOwnershipONE_PARTY
    accountOwnershipTWO_PARTY
    accountOwnershipMANY_PARTY
    accountOwnershipOTHER
    + +

    ResponseBankingAccountByIdV3

    + +

    +
    {
+  "data": {
+    "accountId": "string",
+    "creationDate": "string",
+    "displayName": "string",
+    "nickname": "string",
+    "openStatus": "CLOSED",
+    "isOwned": true,
+    "accountOwnership": "UNKNOWN",
+    "maskedNumber": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "productName": "string",
+    "bsb": "string",
+    "accountNumber": "string",
+    "bundleName": "string",
+    "specificAccountUType": "creditCard",
+    "termDeposit": [
+      {
+        "lodgementDate": "string",
+        "maturityDate": "string",
+        "maturityAmount": "string",
+        "maturityCurrency": "string",
+        "maturityInstructions": "HOLD_ON_MATURITY"
+      }
+    ],
+    "creditCard": {
+      "minPaymentAmount": "string",
+      "paymentDueAmount": "string",
+      "paymentCurrency": "string",
+      "paymentDueDate": "string"
+    },
+    "loan": {
+      "originalStartDate": "string",
+      "originalLoanAmount": "string",
+      "originalLoanCurrency": "string",
+      "loanEndDate": "string",
+      "nextInstalmentDate": "string",
+      "minInstalmentAmount": "string",
+      "minInstalmentCurrency": "string",
+      "maxRedraw": "string",
+      "maxRedrawCurrency": "string",
+      "minRedraw": "string",
+      "minRedrawCurrency": "string",
+      "offsetAccountEnabled": true,
+      "offsetAccountIds": [
+        "string"
+      ],
+      "repaymentType": "INTEREST_ONLY",
+      "repaymentFrequency": "string"
+    },
+    "depositRate": "string",
+    "lendingRate": "string",
+    "depositRates": [
+      {
+        "depositRateType": "BONUS",
+        "rate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+        "rate": "string",
+        "comparisonRate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "isActivated": true
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeType": "DEPOSIT",
+        "amount": "string",
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "addresses": [
+      {
+        "addressUType": "paf",
+        "simple": {
+          "mailingName": "string",
+          "addressLine1": "string",
+          "addressLine2": "string",
+          "addressLine3": "string",
+          "postcode": "string",
+          "city": "string",
+          "state": "string",
+          "country": "AUS"
+        },
+        "paf": {
+          "dpid": "string",
+          "thoroughfareNumber1": 0,
+          "thoroughfareNumber1Suffix": "string",
+          "thoroughfareNumber2": 0,
+          "thoroughfareNumber2Suffix": "string",
+          "flatUnitType": "string",
+          "flatUnitNumber": "string",
+          "floorLevelType": "string",
+          "floorLevelNumber": "string",
+          "lotNumber": "string",
+          "buildingName1": "string",
+          "buildingName2": "string",
+          "streetName": "string",
+          "streetType": "string",
+          "streetSuffix": "string",
+          "postalDeliveryType": "string",
+          "postalDeliveryNumber": 0,
+          "postalDeliveryNumberPrefix": "string",
+          "postalDeliveryNumberSuffix": "string",
+          "localityName": "string",
+          "postcode": "string",
+          "state": "string"
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    dataBankingAccountDetailV3mandatorynone
    linksLinksmandatorynone
    metaMetaoptionalnone
    + +

    BankingAccountDetailV3

    + +

    +
    {
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string",
+  "bsb": "string",
+  "accountNumber": "string",
+  "bundleName": "string",
+  "specificAccountUType": "creditCard",
+  "termDeposit": [
+    {
+      "lodgementDate": "string",
+      "maturityDate": "string",
+      "maturityAmount": "string",
+      "maturityCurrency": "string",
+      "maturityInstructions": "HOLD_ON_MATURITY"
+    }
+  ],
+  "creditCard": {
+    "minPaymentAmount": "string",
+    "paymentDueAmount": "string",
+    "paymentCurrency": "string",
+    "paymentDueDate": "string"
+  },
+  "loan": {
+    "originalStartDate": "string",
+    "originalLoanAmount": "string",
+    "originalLoanCurrency": "string",
+    "loanEndDate": "string",
+    "nextInstalmentDate": "string",
+    "minInstalmentAmount": "string",
+    "minInstalmentCurrency": "string",
+    "maxRedraw": "string",
+    "maxRedrawCurrency": "string",
+    "minRedraw": "string",
+    "minRedrawCurrency": "string",
+    "offsetAccountEnabled": true,
+    "offsetAccountIds": [
+      "string"
+    ],
+    "repaymentType": "INTEREST_ONLY",
+    "repaymentFrequency": "string"
+  },
+  "depositRate": "string",
+  "lendingRate": "string",
+  "depositRates": [
+    {
+      "depositRateType": "BONUS",
+      "rate": "string",
+      "calculationFrequency": "string",
+      "applicationFrequency": "string",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": 0,
+          "maximumValue": 0,
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": {
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "lendingRates": [
+    {
+      "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+      "rate": "string",
+      "comparisonRate": "string",
+      "calculationFrequency": "string",
+      "applicationFrequency": "string",
+      "interestPaymentDue": "IN_ADVANCE",
+      "repaymentType": "INTEREST_ONLY",
+      "loanPurpose": "INVESTMENT",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": 0,
+          "maximumValue": 0,
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": {
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "features": [
+    {
+      "featureType": "ADDITIONAL_CARDS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "isActivated": true
+    }
+  ],
+  "fees": [
+    {
+      "name": "string",
+      "feeType": "DEPOSIT",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "accrualFrequency": "string",
+      "currency": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "discounts": [
+        {
+          "description": "string",
+          "discountType": "BALANCE",
+          "amount": "string",
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "feeRate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "eligibility": [
+            {
+              "discountEligibilityType": "BUSINESS",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "addresses": [
+    {
+      "addressUType": "paf",
+      "simple": {
+        "mailingName": "string",
+        "addressLine1": "string",
+        "addressLine2": "string",
+        "addressLine3": "string",
+        "postcode": "string",
+        "city": "string",
+        "state": "string",
+        "country": "AUS"
+      },
+      "paf": {
+        "dpid": "string",
+        "thoroughfareNumber1": 0,
+        "thoroughfareNumber1Suffix": "string",
+        "thoroughfareNumber2": 0,
+        "thoroughfareNumber2Suffix": "string",
+        "flatUnitType": "string",
+        "flatUnitNumber": "string",
+        "floorLevelType": "string",
+        "floorLevelNumber": "string",
+        "lotNumber": "string",
+        "buildingName1": "string",
+        "buildingName2": "string",
+        "streetName": "string",
+        "streetType": "string",
+        "streetSuffix": "string",
+        "postalDeliveryType": "string",
+        "postalDeliveryNumber": 0,
+        "postalDeliveryNumberPrefix": "string",
+        "postalDeliveryNumberSuffix": "string",
+        "localityName": "string",
+        "postcode": "string",
+        "state": "string"
+      }
+    }
+  ]
+}
+
+

    Properties

    +

    allOf

    + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousBankingAccountV2mandatorynone
    + +

    and

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousobjectmandatorynone
    » bsbstringoptionalThe unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
    » accountNumberstringoptionalThe unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
    » bundleNamestringoptionalOptional field to indicate if this account is part of a bundle that is providing additional benefit to the customer
    » specificAccountUTypestringoptionalThe type of structure to present account specific fields.
    » termDeposit[BankingTermDepositAccount]conditionalnone
    » creditCardBankingCreditCardAccountconditionalnone
    » loanBankingLoanAccountV2conditionalnone
    » depositRateRateStringoptionalcurrent rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call
    » lendingRateRateStringoptionalThe current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
    » depositRates[BankingProductDepositRate]optionalFully described deposit rates for this account based on the equivalent structure in Product Reference
    » lendingRates[BankingProductLendingRateV2]optionalFully described lending rates for this account based on the equivalent structure in Product Reference
    » features[allOf]optionalArray of features of the account based on the equivalent structure in Product Reference with the following additional field
    + +

    allOf

    + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    »» anonymousBankingProductFeatureV2mandatorynone
    + +

    and

    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    »» anonymousobjectmandatorynone
    »»» isActivatedBooleanoptionalTrue if the feature is already activated and false if the feature is available for activation. Defaults to true if absent. (note this is an additional field appended to the feature object defined in the Product Reference payload)
    + +

    continued

    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    » fees[BankingProductFee]optionalFees and charges applicable to the account based on the equivalent structure in Product Reference
    » addresses[CommonPhysicalAddress]optionalThe addresses for the account to be used for correspondence
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + +
    PropertyValue
    specificAccountUTypecreditCard
    specificAccountUTypeloan
    specificAccountUTypetermDeposit
    + +

    BankingTermDepositAccount

    + +

    +
    {
+  "lodgementDate": "string",
+  "maturityDate": "string",
+  "maturityAmount": "string",
+  "maturityCurrency": "string",
+  "maturityInstructions": "HOLD_ON_MATURITY"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    lodgementDateDateStringmandatoryThe lodgement date of the original deposit
    maturityDateDateStringmandatoryMaturity date for the term deposit
    maturityAmountAmountStringoptionalAmount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated
    maturityCurrencyCurrencyStringoptionalIf absent assumes AUD
    maturityInstructionsstringmandatoryCurrent instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + +
    PropertyValue
    maturityInstructionsHOLD_ON_MATURITY
    maturityInstructionsPAID_OUT_AT_MATURITY
    maturityInstructionsROLLED_OVER
    + +

    BankingCreditCardAccount

    + +

    +
    {
+  "minPaymentAmount": "string",
+  "paymentDueAmount": "string",
+  "paymentCurrency": "string",
+  "paymentDueDate": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    minPaymentAmountAmountStringmandatoryThe minimum payment amount due for the next card payment
    paymentDueAmountAmountStringmandatoryThe amount due for the next card payment
    paymentCurrencyCurrencyStringoptionalIf absent assumes AUD
    paymentDueDateDateStringmandatoryDate that the next payment for the card is due
    + +

    BankingLoanAccountV2

    + +

    +
    {
+  "originalStartDate": "string",
+  "originalLoanAmount": "string",
+  "originalLoanCurrency": "string",
+  "loanEndDate": "string",
+  "nextInstalmentDate": "string",
+  "minInstalmentAmount": "string",
+  "minInstalmentCurrency": "string",
+  "maxRedraw": "string",
+  "maxRedrawCurrency": "string",
+  "minRedraw": "string",
+  "minRedrawCurrency": "string",
+  "offsetAccountEnabled": true,
+  "offsetAccountIds": [
+    "string"
+  ],
+  "repaymentType": "INTEREST_ONLY",
+  "repaymentFrequency": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    originalStartDateDateStringoptionalOptional original start date for the loan
    originalLoanAmountAmountStringoptionalOptional original loan value
    originalLoanCurrencyCurrencyStringoptionalIf absent assumes AUD
    loanEndDateDateStringoptionalDate that the loan is due to be repaid in full
    nextInstalmentDateDateStringoptionalNext date that an instalment is required
    minInstalmentAmountAmountStringoptionalMinimum amount of next instalment
    minInstalmentCurrencyCurrencyStringoptionalIf absent assumes AUD
    maxRedrawAmountStringoptionalMaximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account
    maxRedrawCurrencyCurrencyStringoptionalIf absent assumes AUD
    minRedrawAmountStringoptionalMinimum redraw amount
    minRedrawCurrencyCurrencyStringoptionalIf absent assumes AUD
    offsetAccountEnabledBooleanoptionalSet to true if one or more offset accounts are configured for this loan account
    offsetAccountIds[string]optionalThe accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation
    repaymentTypestringoptionalOptions in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
    repaymentFrequencyExternalRefoptionalThe expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
    +

    Enumerated Values

    + + + + + + + + + + + + + + +
    PropertyValue
    repaymentTypeINTEREST_ONLY
    repaymentTypePRINCIPAL_AND_INTEREST
    + + + +

    +
    {
+  "self": "string"
+}
+
+

    Properties

    + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    selfURIStringmandatoryFully qualified link that generated the current response document
    + +

    CommonPhysicalAddress

    + +

    +
    {
+  "addressUType": "paf",
+  "simple": {
+    "mailingName": "string",
+    "addressLine1": "string",
+    "addressLine2": "string",
+    "addressLine3": "string",
+    "postcode": "string",
+    "city": "string",
+    "state": "string",
+    "country": "AUS"
+  },
+  "paf": {
+    "dpid": "string",
+    "thoroughfareNumber1": 0,
+    "thoroughfareNumber1Suffix": "string",
+    "thoroughfareNumber2": 0,
+    "thoroughfareNumber2Suffix": "string",
+    "flatUnitType": "string",
+    "flatUnitNumber": "string",
+    "floorLevelType": "string",
+    "floorLevelNumber": "string",
+    "lotNumber": "string",
+    "buildingName1": "string",
+    "buildingName2": "string",
+    "streetName": "string",
+    "streetType": "string",
+    "streetSuffix": "string",
+    "postalDeliveryType": "string",
+    "postalDeliveryNumber": 0,
+    "postalDeliveryNumberPrefix": "string",
+    "postalDeliveryNumberSuffix": "string",
+    "localityName": "string",
+    "postcode": "string",
+    "state": "string"
+  }
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    addressUTypestringmandatoryThe type of address object present
    simpleCommonSimpleAddressconditionalnone
    pafCommonPAFAddressconditionalAustralian address formatted according to the file format defined by the PAF file format
    +

    Enumerated Values

    + + + + + + + + + + + + + + +
    PropertyValue
    addressUTypepaf
    addressUTypesimple
    + +

    CommonSimpleAddress

    + +

    +
    {
+  "mailingName": "string",
+  "addressLine1": "string",
+  "addressLine2": "string",
+  "addressLine3": "string",
+  "postcode": "string",
+  "city": "string",
+  "state": "string",
+  "country": "AUS"
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    mailingNamestringoptionalName of the individual or business formatted for inclusion in an address used for physical mail
    addressLine1stringmandatoryFirst line of the standard address object
    addressLine2stringoptionalSecond line of the standard address object
    addressLine3stringoptionalThird line of the standard address object
    postcodestringconditionalMandatory for Australian addresses
    citystringmandatoryName of the city or locality
    statestringmandatoryFree text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
    countryExternalRefoptionalA valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
    + +

    CommonPAFAddress

    + +

    +
    {
+  "dpid": "string",
+  "thoroughfareNumber1": 0,
+  "thoroughfareNumber1Suffix": "string",
+  "thoroughfareNumber2": 0,
+  "thoroughfareNumber2Suffix": "string",
+  "flatUnitType": "string",
+  "flatUnitNumber": "string",
+  "floorLevelType": "string",
+  "floorLevelNumber": "string",
+  "lotNumber": "string",
+  "buildingName1": "string",
+  "buildingName2": "string",
+  "streetName": "string",
+  "streetType": "string",
+  "streetSuffix": "string",
+  "postalDeliveryType": "string",
+  "postalDeliveryNumber": 0,
+  "postalDeliveryNumberPrefix": "string",
+  "postalDeliveryNumberSuffix": "string",
+  "localityName": "string",
+  "postcode": "string",
+  "state": "string"
+}
+
+
    +

    Australian address formatted according to the file format defined by the PAF file format

    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    dpidstringoptionalUnique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
    thoroughfareNumber1PositiveIntegeroptionalThoroughfare number for a property (first number in a property ranged address)
    thoroughfareNumber1SuffixstringoptionalSuffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
    thoroughfareNumber2PositiveIntegeroptionalSecond thoroughfare number (only used if the property has a ranged address eg 23-25)
    thoroughfareNumber2SuffixstringoptionalSuffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
    flatUnitTypestringoptionalType of flat or unit for the address
    flatUnitNumberstringoptionalUnit number (including suffix, if applicable)
    floorLevelTypestringoptionalType of floor or level for the address
    floorLevelNumberstringoptionalFloor or level number (including alpha characters)
    lotNumberstringoptionalAllotment number for the address
    buildingName1stringoptionalBuilding/Property name 1
    buildingName2stringoptionalBuilding/Property name 2
    streetNamestringoptionalThe name of the street
    streetTypestringoptionalThe street type. Valid enumeration defined by Australia Post PAF code file
    streetSuffixstringoptionalThe street type suffix. Valid enumeration defined by Australia Post PAF code file
    postalDeliveryTypestringoptionalPostal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
    postalDeliveryNumberPositiveIntegeroptionalPostal delivery number if the address is a postal delivery type
    postalDeliveryNumberPrefixstringoptionalPostal delivery number prefix related to the postal delivery number
    postalDeliveryNumberSuffixstringoptionalPostal delivery number suffix related to the postal delivery number
    localityNamestringmandatoryFull name of locality
    postcodestringmandatoryPostcode for the locality
    statestringmandatoryState in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
    + +

    Meta

    + +

    +
    {}
+
+

    Properties

    +

    None

    + +

    MetaError

    + +

    +
    {
+  "urn": "string"
+}
+
+
    +

    Additional data for customised error codes

    +

    Properties

    + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
    + +

    ResponseErrorListV2

    + +

    +
    {
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    errors[object]mandatorynone
    » codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
    » titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
    » detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
    » metaMetaErroroptionalAdditional data for customised error codes
    + +

    BankingProductCategory

    + +

    +
    "BUSINESS_LOANS"
+
+
    +

    The category to which a product or account belongs. See here for more details

    +

    Properties

    + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyValue
    anonymousBUSINESS_LOANS
    anonymousCRED_AND_CHRG_CARDS
    anonymousLEASES
    anonymousMARGIN_LOANS
    anonymousOVERDRAFTS
    anonymousPERS_LOANS
    anonymousREGULATED_TRUST_ACCOUNTS
    anonymousRESIDENTIAL_MORTGAGES
    anonymousTERM_DEPOSITS
    anonymousTRADE_FINANCE
    anonymousTRANS_AND_SAVINGS_ACCOUNTS
    anonymousTRAVEL_CARDS
    + +
+
+
+ + +
+
+ + + diff --git a/docs/includes/obsolete/get-accounts-v2.html b/docs/includes/obsolete/get-accounts-v2.html new file mode 100644 index 00000000..bd08064e --- /dev/null +++ b/docs/includes/obsolete/get-accounts-v2.html @@ -0,0 +1,1052 @@ + + + + + + + + Get Accounts v2 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Accounts V2

+

This page documents the obsolete version 2 of the Get Accounts endpoint.

+ +

This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

+

Get Accounts

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts

+ +

Obtain a list of accounts.

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "creationDate": "string",
+        "displayName": "string",
+        "nickname": "string",
+        "openStatus": "CLOSED",
+        "isOwned": true,
+        "accountOwnership": "UNKNOWN",
+        "maskedNumber": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "productName": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+ +

Schemas

+ +

+ +

ResponseBankingAccountListV2

+ +

+
{
+  "data": {
+    "accounts": [
+      {
+        "accountId": "string",
+        "creationDate": "string",
+        "displayName": "string",
+        "nickname": "string",
+        "openStatus": "CLOSED",
+        "isOwned": true,
+        "accountOwnership": "UNKNOWN",
+        "maskedNumber": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "productName": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» accounts[BankingAccountV2]mandatoryThe list of accounts returned. If the filter results in an empty set then this array may have no records
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingAccountV2

+ +

+
{
+  "accountId": "string",
+  "creationDate": "string",
+  "displayName": "string",
+  "nickname": "string",
+  "openStatus": "CLOSED",
+  "isOwned": true,
+  "accountOwnership": "UNKNOWN",
+  "maskedNumber": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "productName": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
creationDateDateStringoptionalDate that the account was created (if known)
displayNamestringmandatoryThe display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.
nicknamestringoptionalA customer supplied nick name for the account
openStatusstringoptionalOpen or closed status for the account. If not present then OPEN is assumed
isOwnedBooleanoptionalFlag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed
accountOwnershipstringmandatoryValue indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers
maskedNumberMaskedAccountStringmandatoryA masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
productCategoryBankingProductCategorymandatoryThe category to which a product or account belongs. See here for more details
productNamestringmandatoryThe unique identifier of the account as defined by the data holder (akin to model number for the account)
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
openStatusCLOSED
openStatusOPEN
accountOwnershipUNKNOWN
accountOwnershipONE_PARTY
accountOwnershipTWO_PARTY
accountOwnershipMANY_PARTY
accountOwnershipOTHER
+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategory

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-bulk-balances-v1.html b/docs/includes/obsolete/get-bulk-balances-v1.html new file mode 100644 index 00000000..bc9c531c --- /dev/null +++ b/docs/includes/obsolete/get-bulk-balances-v1.html @@ -0,0 +1,1092 @@ + + + + + + + + Get Bulk Balances v1 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Bulk Balances V1

+

This page documents the obsolete version 1 of the Get Bulk Balances endpoint.

+ +

This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

+

Get Bulk Balances

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/balances

+ +

Obtain balances for multiple, filtered accounts

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingAccountsBalanceList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+ +

Schemas

+ +

+ +

ResponseBankingAccountsBalanceList

+ +

+
{
+  "data": {
+    "balances": [
+      {
+        "accountId": "string",
+        "currentBalance": "string",
+        "availableBalance": "string",
+        "creditLimit": "string",
+        "amortisedLimit": "string",
+        "currency": "string",
+        "purses": [
+          {
+            "amount": "string",
+            "currency": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» balances[BankingBalance]mandatoryThe list of balances returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

ResponseBankingAccountsBalanceById

+ +

+
{
+  "data": {
+    "accountId": "string",
+    "currentBalance": "string",
+    "availableBalance": "string",
+    "creditLimit": "string",
+    "amortisedLimit": "string",
+    "currency": "string",
+    "purses": [
+      {
+        "amount": "string",
+        "currency": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingBalancemandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingBalance

+ +

+
{
+  "accountId": "string",
+  "currentBalance": "string",
+  "availableBalance": "string",
+  "creditLimit": "string",
+  "amortisedLimit": "string",
+  "currency": "string",
+  "purses": [
+    {
+      "amount": "string",
+      "currency": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence
currentBalanceAmountStringmandatoryThe balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing
availableBalanceAmountStringmandatoryBalance representing the amount of funds available for transfer. Assumed to be zero or positive
creditLimitAmountStringoptionalObject representing the maximum amount of credit that is available for this account. Assumed to be zero if absent
amortisedLimitAmountStringoptionalObject representing the available limit amortised according to payment schedule. Assumed to be zero if absent
currencyCurrencyStringoptionalThe currency for the balance amounts. If absent assumed to be AUD
purses[BankingBalancePurse]optionalOptional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards
+ +

BankingBalancePurse

+ +

+
{
+  "amount": "string",
+  "currency": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
amountAmountStringmandatoryThe balance available for this additional currency purse
currencyCurrencyStringoptionalThe currency for the purse
+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategory

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-bulk-direct-debits-v1.html b/docs/includes/obsolete/get-bulk-direct-debits-v1.html new file mode 100644 index 00000000..2e5de16f --- /dev/null +++ b/docs/includes/obsolete/get-bulk-direct-debits-v1.html @@ -0,0 +1,1033 @@ + + + + + + + + Get Bulk Direct Debits v1 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Bulk Direct Debits V1

+

This page documents the obsolete version 1 of the Get Bulk Direct Debits endpoint.

+ +

This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

+

Get Bulk Direct Debits

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/accounts/direct-debits

+ +

Obtain direct debit authorisations for multiple, filtered accounts

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingDirectDebitAuthorisationList
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+ +

Schemas

+ +

+ +

ResponseBankingDirectDebitAuthorisationList

+ +

+
{
+  "data": {
+    "directDebitAuthorisations": [
+      {
+        "accountId": "string",
+        "authorisedEntity": {
+          "description": "string",
+          "financialInstitution": "string",
+          "abn": "string",
+          "acn": "string",
+          "arbn": "string"
+        },
+        "lastDebitDateTime": "string",
+        "lastDebitAmount": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» directDebitAuthorisations[BankingDirectDebit]mandatoryThe list of authorisations returned
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingDirectDebit

+ +

+
{
+  "accountId": "string",
+  "authorisedEntity": {
+    "description": "string",
+    "financialInstitution": "string",
+    "abn": "string",
+    "acn": "string",
+    "arbn": "string"
+  },
+  "lastDebitDateTime": "string",
+  "lastDebitAmount": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryA unique ID of the account adhering to the standards for ID permanence.
authorisedEntityBankingAuthorisedEntitymandatorynone
lastDebitDateTimeDateTimeStringoptionalThe date and time of the last debit executed under this authorisation
lastDebitAmountAmountStringoptionalThe amount of the last debit executed under this authorisation
+ +

BankingAuthorisedEntity

+ +

+
{
+  "description": "string",
+  "financialInstitution": "string",
+  "abn": "string",
+  "acn": "string",
+  "arbn": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDescription of the authorised entity derived from previously executed direct debits
financialInstitutionstringconditionalName of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme
abnstringoptionalAustralian Business Number for the authorised entity
acnstringoptionalAustralian Company Number for the authorised entity
arbnstringoptionalAustralian Registered Body Number for the authorised entity
+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategory

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-data-holder-brands-summary-v1.html b/docs/includes/obsolete/get-data-holder-brands-summary-v1.html new file mode 100644 index 00000000..d33d03a3 --- /dev/null +++ b/docs/includes/obsolete/get-data-holder-brands-summary-v1.html @@ -0,0 +1,800 @@ + + + + + + + + Get Data Holder Brands Summary V1 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Data Holder Brands Summary V1

+

This page documents the obsolete version 1 of the Get Data Holder Brands Summary endpoint.

+ + +

Get Data Holder Brands Summary

+

+ +
+

Code samples

+
+
GET https://<register-base-url>/cdr-register/v1/{industry}/data-holders/brands/summary HTTP/1.1
+
+Accept: application/json
+x-v: string
+x-min-v: string
+If-None-Match: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'If-None-Match':'string'
+
+};
+
+fetch('https://<register-base-url>/cdr-register/v1/{industry}/data-holders/brands/summary',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /cdr-register/v1/{industry}/data-holders/brands/summary

+ +

Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
industrypathstringmandatoryThe industry the participant is retrieving data for (Banking, etc)
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable.
If-None-MatchheaderstringoptionalMakes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
industrybanking
industryenergy
industrytelco
industryall
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": [
+    {
+      "dataHolderBrandId": "string",
+      "interimId": "string",
+      "brandName": "string",
+      "publicBaseUri": "string",
+      "logoUri": "string",
+      "industries": [
+        "banking"
+      ],
+      "lastUpdated": "string",
+      "abn": "string",
+      "acn": "string",
+      "arbn": "string"
+    }
+  ],
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseDataHoldersBrandSummaryList
304Not ModifiedNot Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request headerNone
400Bad RequestMissing Required Header / Invalid Version / Invalid Path ParameterResponseErrorListV2
404Not FoundIndustry Not FoundResponseErrorListV2
406Not AcceptableUnsupported VersionResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the CDR Register has responded with.
200EtagstringEntity tag that uniquely represents the requested resource.
304EtagstringEntity tag that uniquely represents the requested resource.
+ +

+ +

Schemas

+ +

ResponseDataHoldersBrandSummaryList

+ +

+
{
+  "data": [
+    {
+      "dataHolderBrandId": "string",
+      "interimId": "string",
+      "brandName": "string",
+      "publicBaseUri": "string",
+      "logoUri": "string",
+      "industries": [
+        "banking"
+      ],
+      "lastUpdated": "string",
+      "abn": "string",
+      "acn": "string",
+      "arbn": "string"
+    }
+  ],
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
data[DataHolderBrandSummary]mandatoryResponse data for the query
linksLinksmandatorynone
metaMetamandatorynone
+ +

DataHolderBrandSummary

+ +

+
{
+  "dataHolderBrandId": "string",
+  "interimId": "string",
+  "brandName": "string",
+  "publicBaseUri": "string",
+  "logoUri": "string",
+  "industries": [
+    "banking"
+  ],
+  "lastUpdated": "string",
+  "abn": "string",
+  "acn": "string",
+  "arbn": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataHolderBrandIdstringoptionalUnique id of the Data Holder Brand issued by the CDR Register
interimIdstringoptionalInterim id of the Data Holder Brand issued by the CDR Register. This is to be used to uniquely identify the record when dataHolderBrandId is not populated and is not to be reused
brandNamestringmandatoryThe name of Data Holder Brand
publicBaseUriURIStringmandatoryBase URI for the Data Holder's Consumer Data Standard public endpoints
logoUriURIStringmandatoryBrand logo URI
industries[string]mandatoryThe industries the Data Holder Brand belongs to
lastUpdatedDateTimeStringmandatoryThe date/time that the Data Holder Brand data was last updated in the Register
abnstringoptionalAustralian Business Number for the organisation
acnstringoptionalAustralian Company Number for the organisation
arbnstringoptionalAustralian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
industriesbanking
industriesenergy
industriestelco
+ + + +

+
{
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link to this API call
+ +

Meta

+ +

+
{}
+
+

Properties

+

None

+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[ResponseErrorListV2_errors]mandatorynone
+ +

ResponseErrorListV2_errors

+ +

+
{
+  "code": "string",
+  "title": "string",
+  "detail": "string",
+  "meta": {
+    "urn": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
metaMetaErroroptionalAdditional data for customised error codes
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-data-holder-brands-v2.html b/docs/includes/obsolete/get-data-holder-brands-v2.html new file mode 100644 index 00000000..00780f61 --- /dev/null +++ b/docs/includes/obsolete/get-data-holder-brands-v2.html @@ -0,0 +1,1234 @@ + + + + + + + + Get Data Holder Brands V2 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Data Holder Brands V2

+

This page documents the obsolete version 2 of the Get Data Holder Brands endpoint.

+ + +

Get Data Holder Brands

+

+ +
+

Code samples

+
+
GET https://<register-base-url>/cdr-register/v1/{industry}/data-holders/brands HTTP/1.1
+
+Accept: application/json
+Authorization: string
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'string',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://<register-base-url>/cdr-register/v1/{industry}/data-holders/brands',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /cdr-register/v1/{industry}/data-holders/brands

+ +

Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem.

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
industrypathstringmandatoryThe industry the participant is retrieving data for (Banking, etc)
AuthorizationheaderstringmandatoryAn Authorisation Token as per [RFC6750].
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The Register should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The Register should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the Register must respond with a 406 Not Acceptable.
updated-sincequerystringoptionalquery filter returns results updated since the specified date-time
pagequeryPositiveIntegeroptionalthe page number to return
page-sizequeryPositiveIntegeroptionalthe number of records to return per page
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
industrybanking
industryenergy
industrytelco
industryall
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": [
+    {
+      "dataHolderBrandId": "string",
+      "brandName": "string",
+      "industries": [
+        "banking"
+      ],
+      "logoUri": "string",
+      "legalEntity": {
+        "legalEntityId": "string",
+        "legalEntityName": "string",
+        "logoUri": "string",
+        "registrationNumber": "string",
+        "registrationDate": "string",
+        "registeredCountry": "string",
+        "abn": "string",
+        "acn": "string",
+        "arbn": "string",
+        "anzsicDivision": "string",
+        "organisationType": "SOLE_TRADER",
+        "status": "ACTIVE"
+      },
+      "status": "ACTIVE",
+      "endpointDetail": {
+        "version": "string",
+        "publicBaseUri": "string",
+        "resourceBaseUri": "string",
+        "infosecBaseUri": "string",
+        "extensionBaseUri": "string",
+        "websiteUri": "string"
+      },
+      "authDetails": [
+        {
+          "registerUType": "SIGNED-JWT",
+          "jwksEndpoint": "string"
+        }
+      ],
+      "lastUpdated": "string"
+    }
+  ],
+  "links": {
+    "first": "string",
+    "last": "string",
+    "next": "string",
+    "prev": "string",
+    "self": "string"
+  },
+  "meta": {
+    "totalPages": 0,
+    "totalRecords": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseRegisterDataHolderBrandList
400Bad RequestMissing Required Header / Invalid Version / Invalid Path ParameterResponseErrorListV2
401UnauthorizedInvalid Bearer TokenResponseErrorListV2
406Not AcceptableUnsupported VersionResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the CDR Register has responded with.
+ +

+ +

Schemas

+ +

ResponseRegisterDataHolderBrandList

+ +

+
{
+  "data": [
+    {
+      "dataHolderBrandId": "string",
+      "brandName": "string",
+      "industries": [
+        "banking"
+      ],
+      "logoUri": "string",
+      "legalEntity": {
+        "legalEntityId": "string",
+        "legalEntityName": "string",
+        "logoUri": "string",
+        "registrationNumber": "string",
+        "registrationDate": "string",
+        "registeredCountry": "string",
+        "abn": "string",
+        "acn": "string",
+        "arbn": "string",
+        "anzsicDivision": "string",
+        "organisationType": "SOLE_TRADER",
+        "status": "ACTIVE"
+      },
+      "status": "ACTIVE",
+      "endpointDetail": {
+        "version": "string",
+        "publicBaseUri": "string",
+        "resourceBaseUri": "string",
+        "infosecBaseUri": "string",
+        "extensionBaseUri": "string",
+        "websiteUri": "string"
+      },
+      "authDetails": [
+        {
+          "registerUType": "SIGNED-JWT",
+          "jwksEndpoint": "string"
+        }
+      ],
+      "lastUpdated": "string"
+    }
+  ],
+  "links": {
+    "first": "string",
+    "last": "string",
+    "next": "string",
+    "prev": "string",
+    "self": "string"
+  },
+  "meta": {
+    "totalPages": 0,
+    "totalRecords": 0
+  }
+}
+
+
+

Response containing a list of CDR Register Data Holder Brand objects

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
data[RegisterDataHolderBrand]mandatoryResponse data for the query
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

RegisterDataHolderBrand

+ +

+
{
+  "dataHolderBrandId": "string",
+  "brandName": "string",
+  "industries": [
+    "banking"
+  ],
+  "logoUri": "string",
+  "legalEntity": {
+    "legalEntityId": "string",
+    "legalEntityName": "string",
+    "logoUri": "string",
+    "registrationNumber": "string",
+    "registrationDate": "string",
+    "registeredCountry": "string",
+    "abn": "string",
+    "acn": "string",
+    "arbn": "string",
+    "anzsicDivision": "string",
+    "organisationType": "SOLE_TRADER",
+    "status": "ACTIVE"
+  },
+  "status": "ACTIVE",
+  "endpointDetail": {
+    "version": "string",
+    "publicBaseUri": "string",
+    "resourceBaseUri": "string",
+    "infosecBaseUri": "string",
+    "extensionBaseUri": "string",
+    "websiteUri": "string"
+  },
+  "authDetails": [
+    {
+      "registerUType": "SIGNED-JWT",
+      "jwksEndpoint": "string"
+    }
+  ],
+  "lastUpdated": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataHolderBrandIdstringmandatoryUnique id of the Data Holder Brand issued by the CDR Register
brandNamestringmandatoryThe name of Data Holder Brand
industries[string]mandatoryThe industries the Data Holder Brand belongs to
logoUriURIStringmandatoryBrand logo URI
legalEntityLegalEntityDetailmandatoryThe data that is common to all organisations, regardless of the type (e.g. company, trust, partnership, government)
statusEnummandatorynone
endpointDetailRegisterDataHolderBrandServiceEndpointmandatoryEndpoints related to Data Holder Brand services
authDetails[RegisterDataHolderAuth]mandatory[Defines the mechanism used and associated endpoints for Data Holder to Data Recipient authentication]
lastUpdatedDateTimeStringmandatoryThe date/time that the Data Holder Brand data was last updated in the Register
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
industriesbanking
industriesenergy
industriestelco
statusACTIVE
statusINACTIVE
statusREMOVED
+ +

LegalEntityDetail

+ +

+
{
+  "legalEntityId": "string",
+  "legalEntityName": "string",
+  "logoUri": "string",
+  "registrationNumber": "string",
+  "registrationDate": "string",
+  "registeredCountry": "string",
+  "abn": "string",
+  "acn": "string",
+  "arbn": "string",
+  "anzsicDivision": "string",
+  "organisationType": "SOLE_TRADER",
+  "status": "ACTIVE"
+}
+
+
+

The data that is common to all organisations, regardless of the type (e.g. company, trust, partnership, government)

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
legalEntityIdstringmandatoryUnique id of the organisation issued by the CDR Register
legalEntityNamestringmandatoryUnique legal name of the organisation
logoUriURIStringmandatoryLegal Entity logo URI
registrationNumberstringoptionalUnique registration number (if the company is registered outside Australia)
registrationDateDateStringoptionalDate of registration (if the company is registered outside Australia)
registeredCountrystringoptionalCountry of registration (if the company is registered outside Australia)
abnstringoptionalAustralian Business Number for the organisation
acnstringoptionalAustralian Company Number for the organisation
arbnstringoptionalAustralian Registered Body Number. ARBNs are issued to registrable Australian bodies and foreign companies
anzsicDivisionExternalRefoptionalANZSIC division of the organisation. [ANZSIC-2006]
organisationTypeEnumoptionalLegal organisation type
statusEnummandatorynone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
organisationTypeSOLE_TRADER
organisationTypeCOMPANY
organisationTypePARTNERSHIP
organisationTypeTRUST
organisationTypeGOVERNMENT_ENTITY
organisationTypeOTHER
statusACTIVE
statusREMOVED
+ +

RegisterDataHolderBrandServiceEndpoint

+ +

+
{
+  "version": "string",
+  "publicBaseUri": "string",
+  "resourceBaseUri": "string",
+  "infosecBaseUri": "string",
+  "extensionBaseUri": "string",
+  "websiteUri": "string"
+}
+
+
+

Endpoints related to Data Holder Brand services

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
versionstringmandatoryThe major version of the high level standards. This is not the version of the endpoint or the payload being requested but the version of the overall standards being applied. This version number will be "v" followed by the major version of the standards as a positive integer (e.g. v1, v12 or v76)
publicBaseUriURIStringmandatoryBase URI for the Data Holder's Consumer Data Standard public endpoints
resourceBaseUriURIStringmandatoryBase URI for the Data Holder's Consumer Data Standard resource endpoints
infosecBaseUriURIStringmandatoryBase URI for the Data Holder's Consumer Data Standard information security endpoints
extensionBaseUriURIStringoptionalBase URI for the Data Holder extension endpoints to the Consumer Data Standard (optional)
websiteUriURIStringmandatoryPublicly available website or web resource URI
+ +

RegisterDataHolderAuth

+ +

+
{
+  "registerUType": "SIGNED-JWT",
+  "jwksEndpoint": "string"
+}
+
+
+

Defines the mechanism used and associated endpoints for Data Holder to Data Recipient authentication

+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
registerUTypeEnummandatoryThe type of authentication and authorisation mechanism in use
jwksEndpointURIStringmandatoryJWKS endpoint used for authentication by the Data Holder with the Data Recipient
+

Enumerated Values

+ + + + + + + + + + +
PropertyValue
registerUTypeSIGNED-JWT
+ +

LinksPaginated

+ +

+
{
+  "first": "string",
+  "last": "string",
+  "next": "string",
+  "prev": "string",
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
firstURIStringoptionalURI to the first page of this set. Mandatory if this response is not the first page
lastURIStringoptionalURI to the last page of this set. Mandatory if this response is not the last page
nextURIStringoptionalURI to the next page of this set. Mandatory if this response is not the last page
prevURIStringoptionalURI to the previous page of this set. Mandatory if this response is not the first page
selfURIStringmandatoryFully qualified link to this API call
+ +

MetaPaginated

+ +

+
{
+  "totalPages": 0,
+  "totalRecords": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalPagesNaturalNumbermandatoryThe total number of pages in the full set
totalRecordsNaturalNumbermandatoryThe total number of records in the full set
+ + + +

+
{
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link to this API call
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[ResponseErrorListV2_errors]mandatorynone
+ +

ResponseErrorListV2_errors

+ +

+
{
+  "code": "string",
+  "title": "string",
+  "detail": "string",
+  "meta": {
+    "urn": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
metaMetaErroroptionalAdditional data for customised error codes
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-data-holder-statuses-v1.html b/docs/includes/obsolete/get-data-holder-statuses-v1.html new file mode 100644 index 00000000..939acf25 --- /dev/null +++ b/docs/includes/obsolete/get-data-holder-statuses-v1.html @@ -0,0 +1,712 @@ + + + + + + + + Get Data Holder Statuses V1 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Data Holder Statuses V1

+

This page documents the obsolete version 1 of the Get Data Holder Statuses endpoint.

+ + +

Get Data Holder Statuses

+

+ +
+

Code samples

+
+
GET https://<register-base-url>/cdr-register/v1/{industry}/data-holders/status HTTP/1.1
+
+Accept: application/json
+x-v: 1
+x-min-v: string
+If-None-Match: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'1',
+  'x-min-v':'string',
+  'If-None-Match':'string'
+
+};
+
+fetch('https://<register-base-url>/cdr-register/v1/{industry}/data-holders/status',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /cdr-register/v1/{industry}/data-holders/status

+ +

Endpoint used by participants to discover the statuses for Data Holders from the CDR Register

+

Endpoint Version

+ + + + + + + + + + +
Version1
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
industrypathstringmandatoryThe industry the participant is retrieving data for (Banking, etc)
x-vheaderstringoptionalThe version of the API end point requested by the client. Must be set to a positive integer. For backwards compatiblity defaults to 1 if absent. Note that once version 1 is decommissioned the header will be mandatory for a valid response to be obtained
x-min-vheaderstringoptionalThe minimum version of the API end point requested by the client. Must be set to a positive integer if provided.
If-None-MatchheaderstringoptionalMakes the request method conditional on a recipient cache or origin server not having any current representation of the target resource with an entity-tag that does not match any of those listed in the field-value.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
industrybanking
industryenergy
industrytelco
industryall
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": [
+    {
+      "legalEntityId": "string",
+      "status": "ACTIVE"
+    }
+  ],
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessDataHoldersStatusList
304Not ModifiedNot Modified - The current representation of the target resource matches with the entity-tag provided in the If-None-Match request headerNone
400Bad RequestMissing Required Header / Invalid Version / Invalid Path ParameterResponseErrorListV2
406Not AcceptableUnsupported VersionResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the CDR Register has responded with.
200EtagstringEntity tag that uniquely represents the requested resource.
304EtagstringEntity tag that uniquely represents the requested resource.
+ +

+ +

Schemas

+ +

DataHoldersStatusList

+ +

+
{
+  "data": [
+    {
+      "legalEntityId": "string",
+      "status": "ACTIVE"
+    }
+  ],
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
data[DataHolderStatus]mandatoryResponse data for the query
linksLinksmandatorynone
metaMetamandatorynone
+ +

DataHolderStatus

+ +

+
{
+  "legalEntityId": "string",
+  "status": "ACTIVE"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
legalEntityIdstringmandatoryUnique id of the Data Holder Legal Entity issued by the CDR Register.
statusEnummandatoryData Holder status in the CDR Register
+

Enumerated Values

+ + + + + + + + + + + + + + +
PropertyValue
statusACTIVE
statusREMOVED
+ + + +

+
{
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link to this API call
+ +

Meta

+ +

+
{}
+
+

Properties

+

None

+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[ResponseErrorListV2_errors]mandatorynone
+ +

ResponseErrorListV2_errors

+ +

+
{
+  "code": "string",
+  "title": "string",
+  "detail": "string",
+  "meta": {
+    "urn": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
metaMetaErroroptionalAdditional data for customised error codes
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-product-detail-v4.html b/docs/includes/obsolete/get-product-detail-v4.html new file mode 100644 index 00000000..a317e9c6 --- /dev/null +++ b/docs/includes/obsolete/get-product-detail-v4.html @@ -0,0 +1,3540 @@ + + + + + + + + Get Product Detail v4 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Product Detail V4

+

This page documents the obsolete version 4 of the Get Product Detail endpoint.

+ +

This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

+

Get Product Detail

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/products/{productId} HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/products/{productId}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/products/{productId}

+ +

Obtain detailed information on a single product offered openly to the market.

+ +

Obsolete versions: v1, v2, v3

+

Endpoint Version

+ + + + + + + + + + +
Version4
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
productIdpathASCIIStringmandatoryID of the specific product requested
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "productId": "string",
+    "effectiveFrom": "string",
+    "effectiveTo": "string",
+    "lastUpdated": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "name": "string",
+    "description": "string",
+    "brand": "string",
+    "brandName": "string",
+    "applicationUri": "string",
+    "isTailored": true,
+    "additionalInformation": {
+      "overviewUri": "string",
+      "termsUri": "string",
+      "eligibilityUri": "string",
+      "feesAndPricingUri": "string",
+      "bundleUri": "string",
+      "additionalOverviewUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalTermsUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalEligibilityUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalFeesAndPricingUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalBundleUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    },
+    "cardArt": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ],
+    "bundles": [
+      {
+        "name": "string",
+        "description": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "productIds": [
+          "string"
+        ]
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "constraints": [
+      {
+        "constraintType": "MAX_BALANCE",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "eligibility": [
+      {
+        "eligibilityType": "BUSINESS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeType": "DEPOSIT",
+        "amount": "string",
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "depositRates": [
+      {
+        "depositRateType": "BONUS",
+        "rate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+        "rate": "string",
+        "comparisonRate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingProductByIdV4
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
404Not FoundThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the data holder has responded with.
+ +

+ +

Schemas

+ +

+ +

BankingProductV4

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardArt": [
+    {
+      "title": "string",
+      "imageUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
productIdASCIIStringmandatoryA data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
effectiveFromDateTimeStringoptionalThe date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
effectiveToDateTimeStringoptionalThe date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products
lastUpdatedDateTimeStringmandatoryThe last date and time that the information for this product was changed (or the creation date for the product if it has never been altered)
productCategoryBankingProductCategorymandatoryThe category to which a product or account belongs. See here for more details
namestringmandatoryThe display name of the product
descriptionstringmandatoryA description of the product
brandstringmandatoryA label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required
brandNamestringoptionalAn optional display name of the brand
applicationUriURIStringoptionalA link to an application web page where this product can be applied for.
isTailoredBooleanmandatoryIndicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable
additionalInformationBankingProductAdditionalInformationV2optionalObject that contains links to additional information on specific topics
cardArt[object]optionalAn array of card art images
» titlestringoptionalDisplay label for the specific image
» imageUriURIStringmandatoryURI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]
+ +

BankingProductAdditionalInformationV2

+ +

+
{
+  "overviewUri": "string",
+  "termsUri": "string",
+  "eligibilityUri": "string",
+  "feesAndPricingUri": "string",
+  "bundleUri": "string",
+  "additionalOverviewUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalTermsUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalEligibilityUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalFeesAndPricingUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalBundleUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Object that contains links to additional information on specific topics

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
overviewUriURIStringconditionalGeneral overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents.
termsUriURIStringconditionalTerms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents.
eligibilityUriURIStringconditionalEligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents.
feesAndPricingUriURIStringconditionalDescription of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents.
bundleUriURIStringconditionalDescription of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents.
additionalOverviewUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri.
additionalTermsUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri.
additionalEligibilityUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri.
additionalFeesAndPricingUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri.
additionalBundleUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri.
+ +

BankingProductAdditionalInformationV2_additionalInformationUris

+ +

+
{
+  "description": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDisplay text providing more information about the document URI
additionalInfoUriURIStringmandatoryThe URI describing the additional information
+ +

ResponseBankingProductByIdV4

+ +

+
{
+  "data": {
+    "productId": "string",
+    "effectiveFrom": "string",
+    "effectiveTo": "string",
+    "lastUpdated": "string",
+    "productCategory": "BUSINESS_LOANS",
+    "name": "string",
+    "description": "string",
+    "brand": "string",
+    "brandName": "string",
+    "applicationUri": "string",
+    "isTailored": true,
+    "additionalInformation": {
+      "overviewUri": "string",
+      "termsUri": "string",
+      "eligibilityUri": "string",
+      "feesAndPricingUri": "string",
+      "bundleUri": "string",
+      "additionalOverviewUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalTermsUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalEligibilityUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalFeesAndPricingUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalBundleUris": [
+        {
+          "description": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    },
+    "cardArt": [
+      {
+        "title": "string",
+        "imageUri": "string"
+      }
+    ],
+    "bundles": [
+      {
+        "name": "string",
+        "description": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "productIds": [
+          "string"
+        ]
+      }
+    ],
+    "features": [
+      {
+        "featureType": "ADDITIONAL_CARDS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "constraints": [
+      {
+        "constraintType": "MAX_BALANCE",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "eligibility": [
+      {
+        "eligibilityType": "BUSINESS",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "fees": [
+      {
+        "name": "string",
+        "feeType": "DEPOSIT",
+        "amount": "string",
+        "balanceRate": "string",
+        "transactionRate": "string",
+        "accruedRate": "string",
+        "accrualFrequency": "string",
+        "currency": "string",
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string",
+        "discounts": [
+          {
+            "description": "string",
+            "discountType": "BALANCE",
+            "amount": "string",
+            "balanceRate": "string",
+            "transactionRate": "string",
+            "accruedRate": "string",
+            "feeRate": "string",
+            "additionalValue": "string",
+            "additionalInfo": "string",
+            "additionalInfoUri": "string",
+            "eligibility": [
+              {
+                "discountEligibilityType": "BUSINESS",
+                "additionalValue": "string",
+                "additionalInfo": "string",
+                "additionalInfoUri": "string"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "depositRates": [
+      {
+        "depositRateType": "BONUS",
+        "rate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "lendingRates": [
+      {
+        "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+        "rate": "string",
+        "comparisonRate": "string",
+        "calculationFrequency": "string",
+        "applicationFrequency": "string",
+        "interestPaymentDue": "IN_ADVANCE",
+        "repaymentType": "INTEREST_ONLY",
+        "loanPurpose": "INVESTMENT",
+        "tiers": [
+          {
+            "name": "string",
+            "unitOfMeasure": "DAY",
+            "minimumValue": 0,
+            "maximumValue": 0,
+            "rateApplicationMethod": "PER_TIER",
+            "applicabilityConditions": {
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            },
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          }
+        ],
+        "additionalValue": "string",
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "links": {
+    "self": "string"
+  },
+  "meta": {}
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataBankingProductDetailV4mandatorynone
linksLinksmandatorynone
metaMetaoptionalnone
+ +

BankingProductDetailV4

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardArt": [
+    {
+      "title": "string",
+      "imageUri": "string"
+    }
+  ],
+  "bundles": [
+    {
+      "name": "string",
+      "description": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "productIds": [
+        "string"
+      ]
+    }
+  ],
+  "features": [
+    {
+      "featureType": "ADDITIONAL_CARDS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "constraints": [
+    {
+      "constraintType": "MAX_BALANCE",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "eligibility": [
+    {
+      "eligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "fees": [
+    {
+      "name": "string",
+      "feeType": "DEPOSIT",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "accrualFrequency": "string",
+      "currency": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "discounts": [
+        {
+          "description": "string",
+          "discountType": "BALANCE",
+          "amount": "string",
+          "balanceRate": "string",
+          "transactionRate": "string",
+          "accruedRate": "string",
+          "feeRate": "string",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string",
+          "eligibility": [
+            {
+              "discountEligibilityType": "BUSINESS",
+              "additionalValue": "string",
+              "additionalInfo": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "depositRates": [
+    {
+      "depositRateType": "BONUS",
+      "rate": "string",
+      "calculationFrequency": "string",
+      "applicationFrequency": "string",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": 0,
+          "maximumValue": 0,
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": {
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "lendingRates": [
+    {
+      "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+      "rate": "string",
+      "comparisonRate": "string",
+      "calculationFrequency": "string",
+      "applicationFrequency": "string",
+      "interestPaymentDue": "IN_ADVANCE",
+      "repaymentType": "INTEREST_ONLY",
+      "loanPurpose": "INVESTMENT",
+      "tiers": [
+        {
+          "name": "string",
+          "unitOfMeasure": "DAY",
+          "minimumValue": 0,
+          "maximumValue": 0,
+          "rateApplicationMethod": "PER_TIER",
+          "applicabilityConditions": {
+            "additionalInfo": "string",
+            "additionalInfoUri": "string"
+          },
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ],
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousBankingProductV4mandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» bundles[BankingProductBundle]optionalAn array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also
» features[BankingProductFeatureV2]optionalArray of features available for the product
» constraints[BankingProductConstraint]optionalConstraints on the application for or operation of the product such as minimum balances or limit thresholds
» eligibility[BankingProductEligibility]optionalEligibility criteria for the product
» fees[BankingProductFee]optionalFees applicable for the product
» depositRates[BankingProductDepositRate]optionalInterest rates available for deposits
» lendingRates[BankingProductLendingRateV2]optionalInterest rates charged against lending balances
+ +

BankingProductBundle

+ +

+
{
+  "name": "string",
+  "description": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "productIds": [
+    "string"
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the bundle
descriptionstringmandatoryDescription of the bundle
additionalInfostringoptionalDisplay text providing more information on the bundle
additionalInfoUriURIStringoptionalLink to a web page with more information on the bundle criteria and benefits
productIds[string]optionalArray of product IDs for products included in the bundle that are available via the product end points. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points
+ +

BankingProductFeatureV2

+ +

+
{
+  "featureType": "ADDITIONAL_CARDS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
featureTypestringmandatoryThe type of feature described
additionalValuestringconditionalGeneric field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
additionalInfostringconditionalDisplay text providing more information on the feature. Mandatory if the feature type is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this feature
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
featureTypeADDITIONAL_CARDS
featureTypeBALANCE_TRANSFERS
featureTypeBILL_PAYMENT
featureTypeBONUS_REWARDS
featureTypeCARD_ACCESS
featureTypeCASHBACK_OFFER
featureTypeCOMPLEMENTARY_PRODUCT_DISCOUNTS
featureTypeDIGITAL_BANKING
featureTypeDIGITAL_WALLET
featureTypeDONATE_INTEREST
featureTypeEXTRA_REPAYMENTS
featureTypeFRAUD_PROTECTION
featureTypeFREE_TXNS
featureTypeFREE_TXNS_ALLOWANCE
featureTypeGUARANTOR
featureTypeINSURANCE
featureTypeINSTALMENT_PLAN
featureTypeINTEREST_FREE
featureTypeINTEREST_FREE_TRANSFERS
featureTypeLOYALTY_PROGRAM
featureTypeNOTIFICATIONS
featureTypeNPP_ENABLED
featureTypeNPP_PAYID
featureTypeOFFSET
featureTypeOTHER
featureTypeOVERDRAFT
featureTypeREDRAW
featureTypeRELATIONSHIP_MANAGEMENT
featureTypeUNLIMITED_TXNS
+ +

BankingProductConstraint

+ +

+
{
+  "constraintType": "MAX_BALANCE",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
constraintTypestringmandatoryThe type of constraint described. See the next section for an overview of valid values and their meaning
additionalValuestringconditionalGeneric field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
additionalInfostringoptionalDisplay text providing more information the constraint
additionalInfoUriURIStringoptionalLink to a web page with more information on the constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
constraintTypeMAX_BALANCE
constraintTypeMAX_LIMIT
constraintTypeMIN_BALANCE
constraintTypeMIN_LIMIT
constraintTypeOPENING_BALANCE
+ +

BankingProductEligibility

+ +

+
{
+  "eligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
eligibilityTypestringmandatoryThe type of eligibility criteria described. See the next section for an overview of valid values and their meaning
additionalValuestringconditionalGeneric field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
additionalInfostringconditionalDisplay text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility criteria
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
eligibilityTypeBUSINESS
eligibilityTypeEMPLOYMENT_STATUS
eligibilityTypeMAX_AGE
eligibilityTypeMIN_AGE
eligibilityTypeMIN_INCOME
eligibilityTypeMIN_TURNOVER
eligibilityTypeNATURAL_PERSON
eligibilityTypeOTHER
eligibilityTypePENSION_RECIPIENT
eligibilityTypeRESIDENCY_STATUS
eligibilityTypeSTAFF
eligibilityTypeSTUDENT
+ +

BankingProductFee

+ +

+
{
+  "name": "string",
+  "feeType": "DEPOSIT",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "accrualFrequency": "string",
+  "currency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "discounts": [
+    {
+      "description": "string",
+      "discountType": "BALANCE",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "feeRate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "eligibility": [
+        {
+          "discountEligibilityType": "BUSINESS",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the fee
feeTypestringmandatoryThe type of fee
amountAmountStringconditionalThe amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
balanceRateRateStringconditionalA fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied.
transactionRateRateStringconditionalA fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
accruedRateRateStringconditionalA fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
accrualFrequencyExternalRefoptionalThe indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
currencyCurrencyStringoptionalThe currency the fee will be charged in. Assumes AUD if absent
additionalValuestringconditionalGeneric field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
additionalInfostringoptionalDisplay text providing more information on the fee
additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
discounts[BankingProductDiscount]optionalAn optional list of discounts to this fee that may be available
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
feeTypeDEPOSIT
feeTypeEVENT
feeTypeEXIT
feeTypePAYMENT
feeTypePERIODIC
feeTypePURCHASE
feeTypeTRANSACTION
feeTypeUPFRONT
feeTypeVARIABLE
feeTypeWITHDRAWAL
+ +

BankingProductDiscount

+ +

+
{
+  "description": "string",
+  "discountType": "BALANCE",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "feeRate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "eligibility": [
+    {
+      "discountEligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the discount
discountTypestringmandatoryThe type of discount. See the next section for an overview of valid values and their meaning
amountAmountStringconditionalDollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
balanceRateRateStringconditionalA discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
transactionRateRateStringconditionalA discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory
accruedRateRateStringconditionalA discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
feeRateRateStringconditionalA discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
additionalValuestringconditionalGeneric field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
additionalInfostringoptionalDisplay text providing more information on the discount
additionalInfoUriURIStringoptionalLink to a web page with more information on this discount
eligibility[BankingProductDiscountEligibility]conditionalEligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountTypeBALANCE
discountTypeDEPOSITS
discountTypeELIGIBILITY_ONLY
discountTypeFEE_CAP
discountTypePAYMENTS
+ +

BankingProductDiscountEligibility

+ +

+
{
+  "discountEligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
discountEligibilityTypestringmandatoryThe type of the specific eligibility constraint for a discount
additionalValuestringconditionalGeneric field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfostringconditionalDisplay text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountEligibilityTypeBUSINESS
discountEligibilityTypeEMPLOYMENT_STATUS
discountEligibilityTypeINTRODUCTORY
discountEligibilityTypeMAX_AGE
discountEligibilityTypeMIN_AGE
discountEligibilityTypeMIN_INCOME
discountEligibilityTypeMIN_TURNOVER
discountEligibilityTypeNATURAL_PERSON
discountEligibilityTypeOTHER
discountEligibilityTypePENSION_RECIPIENT
discountEligibilityTypeRESIDENCY_STATUS
discountEligibilityTypeSTAFF
discountEligibilityTypeSTUDENT
+ +

BankingProductDepositRate

+ +

+
{
+  "depositRateType": "BONUS",
+  "rate": "string",
+  "calculationFrequency": "string",
+  "applicationFrequency": "string",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": 0,
+      "maximumValue": 0,
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": {
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
depositRateTypestringmandatoryThe type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning
rateRateStringmandatoryThe rate to be applied
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
tiers[BankingProductRateTierV3]optionalRate tiers applicable for this rate
additionalValuestringconditionalGeneric field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
additionalInfostringoptionalDisplay text providing more information on the rate
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
depositRateTypeBONUS
depositRateTypeBUNDLE_BONUS
depositRateTypeFIXED
depositRateTypeFLOATING
depositRateTypeINTRODUCTORY
depositRateTypeMARKET_LINKED
depositRateTypeVARIABLE
+ +

BankingProductLendingRateV2

+ +

+
{
+  "lendingRateType": "BUNDLE_DISCOUNT_FIXED",
+  "rate": "string",
+  "comparisonRate": "string",
+  "calculationFrequency": "string",
+  "applicationFrequency": "string",
+  "interestPaymentDue": "IN_ADVANCE",
+  "repaymentType": "INTEREST_ONLY",
+  "loanPurpose": "INVESTMENT",
+  "tiers": [
+    {
+      "name": "string",
+      "unitOfMeasure": "DAY",
+      "minimumValue": 0,
+      "maximumValue": 0,
+      "rateApplicationMethod": "PER_TIER",
+      "applicabilityConditions": {
+        "additionalInfo": "string",
+        "additionalInfoUri": "string"
+      },
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
lendingRateTypestringmandatoryThe type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning
rateRateStringmandatoryThe rate to be applied
comparisonRateRateStringoptionalA comparison rate equivalent for this rate
calculationFrequencyExternalRefoptionalThe period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
applicationFrequencyExternalRefoptionalThe period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDuestringoptionalWhen loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentTypestringoptionalOptions in place for repayments. If absent, the lending rate is applicable to all repayment types
loanPurposestringoptionalThe reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
tiers[BankingProductRateTierV3]optionalRate tiers applicable for this rate
additionalValuestringconditionalGeneric field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
additionalInfostringoptionalDisplay text providing more information on the rate.
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
lendingRateTypeBUNDLE_DISCOUNT_FIXED
lendingRateTypeBUNDLE_DISCOUNT_VARIABLE
lendingRateTypeCASH_ADVANCE
lendingRateTypeDISCOUNT
lendingRateTypeFIXED
lendingRateTypeFLOATING
lendingRateTypeINTRODUCTORY
lendingRateTypeMARKET_LINKED
lendingRateTypePENALTY
lendingRateTypePURCHASE
lendingRateTypeVARIABLE
interestPaymentDueIN_ADVANCE
interestPaymentDueIN_ARREARS
repaymentTypeINTEREST_ONLY
repaymentTypePRINCIPAL_AND_INTEREST
loanPurposeINVESTMENT
loanPurposeOWNER_OCCUPIED
+ +

BankingProductRateTierV3

+ +

+
{
+  "name": "string",
+  "unitOfMeasure": "DAY",
+  "minimumValue": 0,
+  "maximumValue": 0,
+  "rateApplicationMethod": "PER_TIER",
+  "applicabilityConditions": {
+    "additionalInfo": "string",
+    "additionalInfoUri": "string"
+  },
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Defines the criteria and conditions for which a rate applies

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryA display name for the tier
unitOfMeasurestringmandatoryThe unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers)
minimumValueNumbermandatoryThe number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
maximumValueNumberoptionalThe number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
rateApplicationMethodstringoptionalThe method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')
applicabilityConditionsBankingProductRateConditionoptionalDefines a condition for the applicability of a tiered rate
additionalInfostringoptionalDisplay text providing more information on the rate tier.
additionalInfoUriURIStringoptionalLink to a web page with more information on this rate tier
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
unitOfMeasureDAY
unitOfMeasureDOLLAR
unitOfMeasureMONTH
unitOfMeasurePERCENT
rateApplicationMethodPER_TIER
rateApplicationMethodWHOLE_BALANCE
+ +

BankingProductRateCondition

+ +

+
{
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+
+

Defines a condition for the applicability of a tiered rate

+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
additionalInfostringoptionalDisplay text providing more information on the condition
additionalInfoUriURIStringoptionalLink to a web page with more information on this condition
+ + + +

+
{
+  "self": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
+ +

Meta

+ +

+
{}
+
+

Properties

+

None

+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategory

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+

Product & Account Components

+

+

Product Feature Types

+ +

Description of the usage of the featureType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
ADDITIONAL_CARDSAdditional cards can be requestedThe maximum number of additional cards. If no maximum then should be set to null
BALANCE_TRANSFERSBalance transfers can be made to the account (eg. for credit cards)NA
BILL_PAYMENTThe product can be attached to an automatic budgeting and bill payment serviceOptional name of the service
BONUS_REWARDSBonus loyalty rewards points are availableNumber of points available
CARD_ACCESSA card is available for the product to access fundsText describing list of card types that this product can be linked to
CASHBACK_OFFERSubject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer.The amount of the cashback offer (in AUD)
COMPLEMENTARY_PRODUCT_DISCOUNTSIndicates that complementary, discounted offerings (such as gift cards, or discounted travel) is availableDescription of the complementary offering
DIGITAL_BANKINGAccess is available to online banking features for the productNA
DIGITAL_WALLETA Digital wallet can be attached to the productThe name or brand of the wallet
DONATE_INTERESTIndicates that interest generated from the product can be automatically donated to a charity or community groupNA
EXTRA_REPAYMENTSIndicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis).NA
FRAUD_PROTECTIONThe product includes fraud protection features.NA
FREE_TXNSA set number of free transactions available per monthThe number of free transactions
FREE_TXNS_ALLOWANCEA set amount of transaction fee value that is discounted per monthThe amount of transaction fee discounted (in AUD)
GUARANTORSubject to terms and conditions, the customer may be able to nominate a guarantor during the origination process.NA
INSURANCEInsurance is provided as an additional feature of the productText description of the type of insurance (e.g. Travel Insurance)
INSTALMENT_PLANThe product has the option to pay for eligible purchases over time with a set number of payments.NA
INTEREST_FREEInterest free period for purchasesInterest free period. Formatted according to ISO 8601 Durations
INTEREST_FREE_TRANSFERSInterest free period for balance transfersInterest free period. Formatted according to ISO 8601 Durations
LOYALTY_PROGRAMA points based loyalty program is availableName of the loyalty program
NOTIFICATIONSAdvanced notifications are available for the productDescription of the notification capability
NPP_ENABLEDAn account of this product type can be used to receive funds as a result of a BSB/Number based NPP paymentNA
NPP_PAYIDAn account of this product type can be used as the target of an NPP PayIDNA
OFFSETAn offset account can be connected to the productNA
OTHERAnother feature that can not be included in any of the other categories. The additionalInfo field is mandatory for this typeNA
OVERDRAFTAn overdraft can be applied forNA
REDRAWRedraw of repaid principal above minimum required is availableNA
RELATIONSHIP_MANAGEMENTRelationship management is available for eligible customers.NA
UNLIMITED_TXNSUnlimited free transactions availableNA
+ +

+

Product Constraint Types

+ +

Description of the usage of the constraintType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
MAX_BALANCEA maximum balance is required for the productThe maximum balance in AmountString format
MAX_LIMITA maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)The maximum limit in AmountString format
MIN_BALANCEA minimum balance is required for the productThe minimum balance in AmountString format
MIN_LIMITA minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)The minimum limit in AmountString format
OPENING_BALANCEAn opening balance is required for the productThe minimum opening balance in AmountString format
+ +

+

Product Eligibility Types

+ +

Description of the usage of the eligibilityType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BUSINESSOnly business may apply for the accountNA
EMPLOYMENT_STATUSAn eligibility constraint based on employment status appliesA description of the status required
MAX_AGEOnly customers younger than a maximum age may applyThe maximum age in years
MIN_AGEOnly customers older than a minimum age may applyThe minimum age in years
MIN_INCOMEThe customer must have an income greater than a specified threshold to obtain the productMinimum income in AmountString format
MIN_TURNOVEROnly a business with greater than a minimum turnover may applyMinimum turnover in AmountString format
NATURAL_PERSONThe customer must be a natural person rather than another legal entityNA
OTHERAnother eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)NA
PENSION_RECIPIENTOnly a recipient of a government pension may apply for the productNA
RESIDENCY_STATUSAn eligibility constraint based on residency status appliesA description of the status required
STAFFOnly a staff member of the provider may applyNA
STUDENTOnly students may apply for the productNA
+ +

+

Product Fee Types

+ +

Description of the usage of the feeType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
DEPOSITA fee associated with making a depositNA
EVENTA fee in relation to a particular event (e.g. ordering a new card, viewing a balance or stopping a cheque)NA
EXITA fee for closing the productNA
PAYMENTA fee associated with making a paymentNA
PERIODICA periodic fee such as a monthly account servicing feeThe period of charge. Formatted according to ISO 8601 Durations
PURCHASEA fee associated with making a purchase at a merchantNA
TRANSACTIONA fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE)NA
UPFRONTA fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application feeNA
VARIABLEAn at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customerNA
WITHDRAWALA fee associated with making a withdrawalNA
+ +

+

Product Discount Types

+ +

Description of the usage of the discountType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BALANCEDiscount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the feeThe minimum balance in AmountString format
DEPOSITSDiscount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the feeThe minimum deposit amount in AmountString format
ELIGIBILITY_ONLYDiscount applies based on customer eligibility (eligibility array must be populated)N/A
FEE_CAPThe amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time periodThe time period for which the fee cap applies. Formatted according to ISO 8601 Durations
PAYMENTSDiscount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the feeThe payment threshold amount in AmountString format
+ +

+

Product Discount Eligibility Types

+ +

Description of the usage of the discountEligibilityType field as it applies to products.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BUSINESSA business or other non-person legal entityNA
EMPLOYMENT_STATUSAn eligibility constraint based on employment status appliesA description of the status required
INTRODUCTORYThe discount is only available during an introductory periodThe period of time for the introductory discount. Formatted according to ISO 8601 Durations
MAX_AGEOnly customers younger than a maximum age receive the discountThe maximum age in years
MIN_AGEOnly customers older than a minimum age receive the discountThe minimum age in years
MIN_INCOMEThe customer must have an income greater than a specified threshold to obtain the discountMinimum income in AmountString format
MIN_TURNOVEROnly a business with greater than a minimum turnover is eligibleMinimum turnover in AmountString format
NATURAL_PERSONThe customer must be a natural person rather than another legal entityNA
OTHERAnother eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)NA
PENSION_RECIPIENTOnly a recipient of a government pension may receive the discountOptional. Should contain a description of which pensions qualify
RESIDENCY_STATUSAn eligibility constraint based on residency status appliesA description of the status required
STAFFOnly a staff member of the provider may receive the discountNA
STUDENTOnly students may receive the discountOptional. Should contain a description of who qualifies as a student, e.g. do apprentices qualify?
+ +

+

Product Deposit Rate Types

+ +

Description of the usage of the depositRateType field as it applies to products.

+ +

+

  • Deposit Base Rate Types

+ +

A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
FIXEDFixed rate for a period of timeThe period of time fixed. Formatted according to ISO 8601 Durations
FLOATINGA floating rate is relatively fixed but still adjusts under specific circumstancesDetails of the float parameters
MARKET_LINKEDA rate that is linked to a specific market, commodity or asset classDetails of the market linkage
VARIABLEA variable base rate for the productNA
+ +

+

  • Deposit Adjustment Rate Types

+ +

A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.

+ + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BONUSA bonus rate available by meeting a specific criteriaA description of the criteria to obtain the bonus
BUNDLE_BONUSA bonus rate obtained by originating a bundle instead of a standalone productThe name of the bundle
INTRODUCTORYAn introductory bonus that will expire after a set periodThe period of time for the introductory rate. Formatted according to ISO 8601 Durations
+ +

+

Product Lending Rate Types

+ +

Description of the usage of the lendingRateType field as it applies to products.

+ +

+

  • Lending Base Rate Types

+ +

A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.

+ +

Card products may have two or more base rates, including CASH_ADVANCE and PURCHASE as they may apply to different transaction types within an account. The PURCHASE lendingRateType is considered the rate commonly applicable to a card.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
CASH_ADVANCESpecific rate applied to cash advances from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category onlyNA
FIXEDFixed rate for a period of timeThe period of time fixed. Formatted according to ISO 8601 Durations
FLOATINGA floating rate is relatively fixed but still adjusts under specific circumstancesDetails of the float parameters
MARKET_LINKEDA rate that is linked to a specific market, commodity or asset classDetails of the market linkage
PURCHASESpecific rate applied to purchases from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category onlyNA
VARIABLEA variable base rate for the productNA
+ +

+

  • Lending Adjustment Rate Types

+ +

A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
BUNDLE_DISCOUNT_FIXEDA discount rate off the fixed rate obtained by originating a bundle instead of a standalone productThe name of the bundle
BUNDLE_DISCOUNT_VARIABLEA discount rate off the variable rate obtained by originating a bundle instead of a standalone productThe name of the bundle
DISCOUNTA specific discount rate that may be applied. A discount rate reduces the interest payableDescription of the discount rate that is applicable
INTRODUCTORYAn introductory discount that will expire after a set periodThe period of time for the introductory rate. Formatted according to ISO 8601 Durations
PENALTYA specific penalty rate that may be applied. A penalty rate increases the interest payableDescription of the penalty rate that is applicable
+ +

+

Banking Term Deposit Account Types

+ +

Description of the usage of the maturityInstructions field as it applies to accounts.

+ + + + + + + + + + + + + +
ValueDescriptionUse of additionalValue Field
HOLD_ON_MATURITYFunds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customerNA
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-products-v3.html b/docs/includes/obsolete/get-products-v3.html new file mode 100644 index 00000000..b2d7d33d --- /dev/null +++ b/docs/includes/obsolete/get-products-v3.html @@ -0,0 +1,2177 @@ + + + + + + + + Get Products v3 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Products V3

+

This page documents the obsolete version 3 of the Get Products endpoint.

+ +

This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

+

Get Products

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/products HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/products',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/products

+ +

Obtain a list of products that are currently openly offered to the market

+ +

Note that the results returned by this 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 actually has been instantiated and created along with the associated decisions inherent in that process.

+

Dates

+

It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.

+ +

In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.

+ +

Obsolete versions: v1, v2

+

Endpoint Version

+ + + + + + + + + + +
Version3
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
effectivequerystringoptionalAllows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'
updated-sincequeryDateTimeStringoptionalOnly include products that have been updated after the specified date and time. If absent defaults to include all products
brandquerystringoptionalFilter results based on a specific brand
product-categoryquerystringoptionalUsed 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.
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
effectiveALL
effectiveCURRENT
effectiveFUTURE
product-categoryBUSINESS_LOANS
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "products": [
+      {
+        "productId": "string",
+        "effectiveFrom": "string",
+        "effectiveTo": "string",
+        "lastUpdated": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "name": "string",
+        "description": "string",
+        "brand": "string",
+        "brandName": "string",
+        "applicationUri": "string",
+        "isTailored": true,
+        "additionalInformation": {
+          "overviewUri": "string",
+          "termsUri": "string",
+          "eligibilityUri": "string",
+          "feesAndPricingUri": "string",
+          "bundleUri": "string",
+          "additionalOverviewUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalTermsUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalEligibilityUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalFeesAndPricingUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalBundleUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        },
+        "cardArt": [
+          {
+            "title": "string",
+            "imageUri": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingProductListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the data holder has responded with.
+ +

+ +

Schemas

+ +

+ +

ResponseBankingProductListV2

+ +

+
{
+  "data": {
+    "products": [
+      {
+        "productId": "string",
+        "effectiveFrom": "string",
+        "effectiveTo": "string",
+        "lastUpdated": "string",
+        "productCategory": "BUSINESS_LOANS",
+        "name": "string",
+        "description": "string",
+        "brand": "string",
+        "brandName": "string",
+        "applicationUri": "string",
+        "isTailored": true,
+        "additionalInformation": {
+          "overviewUri": "string",
+          "termsUri": "string",
+          "eligibilityUri": "string",
+          "feesAndPricingUri": "string",
+          "bundleUri": "string",
+          "additionalOverviewUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalTermsUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalEligibilityUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalFeesAndPricingUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ],
+          "additionalBundleUris": [
+            {
+              "description": "string",
+              "additionalInfoUri": "string"
+            }
+          ]
+        },
+        "cardArt": [
+          {
+            "title": "string",
+            "imageUri": "string"
+          }
+        ]
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» products[BankingProductV4]mandatoryThe list of products returned. If the filter results in an empty set then this array may have no records
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingProductV4

+ +

+
{
+  "productId": "string",
+  "effectiveFrom": "string",
+  "effectiveTo": "string",
+  "lastUpdated": "string",
+  "productCategory": "BUSINESS_LOANS",
+  "name": "string",
+  "description": "string",
+  "brand": "string",
+  "brandName": "string",
+  "applicationUri": "string",
+  "isTailored": true,
+  "additionalInformation": {
+    "overviewUri": "string",
+    "termsUri": "string",
+    "eligibilityUri": "string",
+    "feesAndPricingUri": "string",
+    "bundleUri": "string",
+    "additionalOverviewUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalTermsUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalEligibilityUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalFeesAndPricingUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ],
+    "additionalBundleUris": [
+      {
+        "description": "string",
+        "additionalInfoUri": "string"
+      }
+    ]
+  },
+  "cardArt": [
+    {
+      "title": "string",
+      "imageUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
productIdASCIIStringmandatoryA data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
effectiveFromDateTimeStringoptionalThe date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
effectiveToDateTimeStringoptionalThe date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products
lastUpdatedDateTimeStringmandatoryThe last date and time that the information for this product was changed (or the creation date for the product if it has never been altered)
productCategoryBankingProductCategorymandatoryThe category to which a product or account belongs. See here for more details
namestringmandatoryThe display name of the product
descriptionstringmandatoryA description of the product
brandstringmandatoryA label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required
brandNamestringoptionalAn optional display name of the brand
applicationUriURIStringoptionalA link to an application web page where this product can be applied for.
isTailoredBooleanmandatoryIndicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable
additionalInformationBankingProductAdditionalInformationV2optionalObject that contains links to additional information on specific topics
cardArt[object]optionalAn array of card art images
» titlestringoptionalDisplay label for the specific image
» imageUriURIStringmandatoryURI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]
+ +

BankingProductAdditionalInformationV2

+ +

+
{
+  "overviewUri": "string",
+  "termsUri": "string",
+  "eligibilityUri": "string",
+  "feesAndPricingUri": "string",
+  "bundleUri": "string",
+  "additionalOverviewUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalTermsUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalEligibilityUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalFeesAndPricingUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ],
+  "additionalBundleUris": [
+    {
+      "description": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+
+

Object that contains links to additional information on specific topics

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
overviewUriURIStringconditionalGeneral overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents.
termsUriURIStringconditionalTerms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents.
eligibilityUriURIStringconditionalEligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents.
feesAndPricingUriURIStringconditionalDescription of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents.
bundleUriURIStringconditionalDescription of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents.
additionalOverviewUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri.
additionalTermsUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri.
additionalEligibilityUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri.
additionalFeesAndPricingUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri.
additionalBundleUris[BankingProductAdditionalInformationV2_additionalInformationUris]optionalAn array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri.
+ +

BankingProductAdditionalInformationV2_additionalInformationUris

+ +

+
{
+  "description": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringoptionalDisplay text providing more information about the document URI
additionalInfoUriURIStringmandatoryThe URI describing the additional information
+ +

BankingProductBundle

+ +

+
{
+  "name": "string",
+  "description": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "productIds": [
+    "string"
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the bundle
descriptionstringmandatoryDescription of the bundle
additionalInfostringoptionalDisplay text providing more information on the bundle
additionalInfoUriURIStringoptionalLink to a web page with more information on the bundle criteria and benefits
productIds[string]optionalArray of product IDs for products included in the bundle that are available via the product end points. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points
+ +

BankingProductFeatureV2

+ +

+
{
+  "featureType": "ADDITIONAL_CARDS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
featureTypestringmandatoryThe type of feature described
additionalValuestringconditionalGeneric field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
additionalInfostringconditionalDisplay text providing more information on the feature. Mandatory if the feature type is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this feature
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
featureTypeADDITIONAL_CARDS
featureTypeBALANCE_TRANSFERS
featureTypeBILL_PAYMENT
featureTypeBONUS_REWARDS
featureTypeCARD_ACCESS
featureTypeCASHBACK_OFFER
featureTypeCOMPLEMENTARY_PRODUCT_DISCOUNTS
featureTypeDIGITAL_BANKING
featureTypeDIGITAL_WALLET
featureTypeDONATE_INTEREST
featureTypeEXTRA_REPAYMENTS
featureTypeFRAUD_PROTECTION
featureTypeFREE_TXNS
featureTypeFREE_TXNS_ALLOWANCE
featureTypeGUARANTOR
featureTypeINSURANCE
featureTypeINSTALMENT_PLAN
featureTypeINTEREST_FREE
featureTypeINTEREST_FREE_TRANSFERS
featureTypeLOYALTY_PROGRAM
featureTypeNOTIFICATIONS
featureTypeNPP_ENABLED
featureTypeNPP_PAYID
featureTypeOFFSET
featureTypeOTHER
featureTypeOVERDRAFT
featureTypeREDRAW
featureTypeRELATIONSHIP_MANAGEMENT
featureTypeUNLIMITED_TXNS
+ +

BankingProductConstraint

+ +

+
{
+  "constraintType": "MAX_BALANCE",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
constraintTypestringmandatoryThe type of constraint described. See the next section for an overview of valid values and their meaning
additionalValuestringconditionalGeneric field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
additionalInfostringoptionalDisplay text providing more information the constraint
additionalInfoUriURIStringoptionalLink to a web page with more information on the constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
constraintTypeMAX_BALANCE
constraintTypeMAX_LIMIT
constraintTypeMIN_BALANCE
constraintTypeMIN_LIMIT
constraintTypeOPENING_BALANCE
+ +

BankingProductEligibility

+ +

+
{
+  "eligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
eligibilityTypestringmandatoryThe type of eligibility criteria described. See the next section for an overview of valid values and their meaning
additionalValuestringconditionalGeneric field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
additionalInfostringconditionalDisplay text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility criteria
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
eligibilityTypeBUSINESS
eligibilityTypeEMPLOYMENT_STATUS
eligibilityTypeMAX_AGE
eligibilityTypeMIN_AGE
eligibilityTypeMIN_INCOME
eligibilityTypeMIN_TURNOVER
eligibilityTypeNATURAL_PERSON
eligibilityTypeOTHER
eligibilityTypePENSION_RECIPIENT
eligibilityTypeRESIDENCY_STATUS
eligibilityTypeSTAFF
eligibilityTypeSTUDENT
+ +

BankingProductFee

+ +

+
{
+  "name": "string",
+  "feeType": "DEPOSIT",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "accrualFrequency": "string",
+  "currency": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "discounts": [
+    {
+      "description": "string",
+      "discountType": "BALANCE",
+      "amount": "string",
+      "balanceRate": "string",
+      "transactionRate": "string",
+      "accruedRate": "string",
+      "feeRate": "string",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string",
+      "eligibility": [
+        {
+          "discountEligibilityType": "BUSINESS",
+          "additionalValue": "string",
+          "additionalInfo": "string",
+          "additionalInfoUri": "string"
+        }
+      ]
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryName of the fee
feeTypestringmandatoryThe type of fee
amountAmountStringconditionalThe amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
balanceRateRateStringconditionalA fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied.
transactionRateRateStringconditionalA fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
accruedRateRateStringconditionalA fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
accrualFrequencyExternalRefoptionalThe indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
currencyCurrencyStringoptionalThe currency the fee will be charged in. Assumes AUD if absent
additionalValuestringconditionalGeneric field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
additionalInfostringoptionalDisplay text providing more information on the fee
additionalInfoUriURIStringoptionalLink to a web page with more information on this fee
discounts[BankingProductDiscount]optionalAn optional list of discounts to this fee that may be available
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
feeTypeDEPOSIT
feeTypeEVENT
feeTypeEXIT
feeTypePAYMENT
feeTypePERIODIC
feeTypePURCHASE
feeTypeTRANSACTION
feeTypeUPFRONT
feeTypeVARIABLE
feeTypeWITHDRAWAL
+ +

BankingProductDiscount

+ +

+
{
+  "description": "string",
+  "discountType": "BALANCE",
+  "amount": "string",
+  "balanceRate": "string",
+  "transactionRate": "string",
+  "accruedRate": "string",
+  "feeRate": "string",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string",
+  "eligibility": [
+    {
+      "discountEligibilityType": "BUSINESS",
+      "additionalValue": "string",
+      "additionalInfo": "string",
+      "additionalInfoUri": "string"
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the discount
discountTypestringmandatoryThe type of discount. See the next section for an overview of valid values and their meaning
amountAmountStringconditionalDollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
balanceRateRateStringconditionalA discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
transactionRateRateStringconditionalA discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory
accruedRateRateStringconditionalA discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
feeRateRateStringconditionalA discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
additionalValuestringconditionalGeneric field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
additionalInfostringoptionalDisplay text providing more information on the discount
additionalInfoUriURIStringoptionalLink to a web page with more information on this discount
eligibility[BankingProductDiscountEligibility]conditionalEligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountTypeBALANCE
discountTypeDEPOSITS
discountTypeELIGIBILITY_ONLY
discountTypeFEE_CAP
discountTypePAYMENTS
+ +

BankingProductDiscountEligibility

+ +

+
{
+  "discountEligibilityType": "BUSINESS",
+  "additionalValue": "string",
+  "additionalInfo": "string",
+  "additionalInfoUri": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
discountEligibilityTypestringmandatoryThe type of the specific eligibility constraint for a discount
additionalValuestringconditionalGeneric field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfostringconditionalDisplay text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfoUriURIStringoptionalLink to a web page with more information on this eligibility constraint
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
discountEligibilityTypeBUSINESS
discountEligibilityTypeEMPLOYMENT_STATUS
discountEligibilityTypeINTRODUCTORY
discountEligibilityTypeMAX_AGE
discountEligibilityTypeMIN_AGE
discountEligibilityTypeMIN_INCOME
discountEligibilityTypeMIN_TURNOVER
discountEligibilityTypeNATURAL_PERSON
discountEligibilityTypeOTHER
discountEligibilityTypePENSION_RECIPIENT
discountEligibilityTypeRESIDENCY_STATUS
discountEligibilityTypeSTAFF
discountEligibilityTypeSTUDENT
+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaPaginatedTransaction

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0,
+  "isQueryParamUnsupported": false
+}
+
+

Properties

+

allOf

+ + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousMetaPaginatedmandatorynone
+ +

and

+ + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousobjectmandatorynone
» isQueryParamUnsupportedBooleanoptionaltrue if "text" query parameter is not supported
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategory

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/obsolete/get-scheduled-payments-bulk-v2.html b/docs/includes/obsolete/get-scheduled-payments-bulk-v2.html new file mode 100644 index 00000000..f0e288bd --- /dev/null +++ b/docs/includes/obsolete/get-scheduled-payments-bulk-v2.html @@ -0,0 +1,2433 @@ + + + + + + + + Get Scheduled Payments Bulk v2 + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+
+

Get Scheduled Payments Bulk V2

+

This page documents the obsolete version 2 of the Get Scheduled Payments Bulk endpoint.

+ +

This version is to be ceased to be called by data recipients by Date TBC and can be decommissioned by data holders as of that date.

+

Get Scheduled Payments Bulk

+

+ +
+

Code samples

+
+
GET https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'x-v':'string',
+  'x-min-v':'string',
+  'x-fapi-interaction-id':'string',
+  'x-fapi-auth-date':'string',
+  'x-fapi-customer-ip-address':'string',
+  'x-cds-client-headers':'string'
+
+};
+
+fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+
+

GET /banking/payments/scheduled

+ +

Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments

+ +

Obsolete versions: v1

+

Endpoint Version

+ + + + + + + + + + +
Version2
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInTypeRequiredDescription
product-categoryquerystringoptionalUsed 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-statusquerystringoptionalUsed to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
is-ownedqueryBooleanoptionalFilters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
pagequeryPositiveIntegeroptionalPage of results to request (standard pagination)
page-sizequeryPositiveIntegeroptionalPage size to request. Default is 25 (standard pagination)
x-vheaderstringmandatoryVersion of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-vheaderstringoptionalMinimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
x-fapi-interaction-idheaderstringoptionalAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-dateheaderstringconditionalThe 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-addressheaderstringoptionalThe 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-headersheaderBase64conditionalThe customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
product-categoryBUSINESS_LOANS
product-categoryCRED_AND_CHRG_CARDS
product-categoryLEASES
product-categoryMARGIN_LOANS
product-categoryOVERDRAFTS
product-categoryPERS_LOANS
product-categoryREGULATED_TRUST_ACCOUNTS
product-categoryRESIDENTIAL_MORTGAGES
product-categoryTERM_DEPOSITS
product-categoryTRADE_FINANCE
product-categoryTRANS_AND_SAVINGS_ACCOUNTS
product-categoryTRAVEL_CARDS
open-statusALL
open-statusCLOSED
open-statusOPEN
+ +
+

Example responses

+ +

200 Response

+
+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Responses

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusMeaningDescriptionSchema
200OKSuccessResponseBankingScheduledPaymentsListV2
400Bad RequestThe following error codes MUST be supported:
ResponseErrorListV2
406Not AcceptableThe following error codes MUST be supported:
ResponseErrorListV2
422Unprocessable EntityThe following error codes MUST be supported:
ResponseErrorListV2
+

Response Headers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatusHeaderTypeFormatDescription
200x-vstringThe version of the API end point that the data holder has responded with.
200x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422x-fapi-interaction-idstringAn [RFC4122] UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
+ +

+ +

Schemas

+ +

+ +

ResponseBankingScheduledPaymentsListV2

+ +

+
{
+  "data": {
+    "scheduledPayments": [
+      {
+        "scheduledPaymentId": "string",
+        "nickname": "string",
+        "payerReference": "string",
+        "payeeReference": "string",
+        "status": "ACTIVE",
+        "from": {
+          "accountId": "string"
+        },
+        "paymentSet": [
+          {
+            "to": {
+              "toUType": "accountId",
+              "accountId": "string",
+              "payeeId": "string",
+              "nickname": "string",
+              "payeeReference": "string",
+              "digitalWallet": {
+                "name": "string",
+                "identifier": "string",
+                "type": "EMAIL",
+                "provider": "PAYPAL_AU"
+              },
+              "domestic": {
+                "payeeAccountUType": "account",
+                "account": {
+                  "accountName": "string",
+                  "bsb": "string",
+                  "accountNumber": "string"
+                },
+                "card": {
+                  "cardNumber": "string"
+                },
+                "payId": {
+                  "name": "string",
+                  "identifier": "string",
+                  "type": "ABN"
+                }
+              },
+              "biller": {
+                "billerCode": "string",
+                "crn": "string",
+                "billerName": "string"
+              },
+              "international": {
+                "beneficiaryDetails": {
+                  "name": "string",
+                  "country": "string",
+                  "message": "string"
+                },
+                "bankDetails": {
+                  "country": "string",
+                  "accountNumber": "string",
+                  "bankAddress": {
+                    "name": "string",
+                    "address": "string"
+                  },
+                  "beneficiaryBankBIC": "string",
+                  "fedWireNumber": "string",
+                  "sortCode": "string",
+                  "chipNumber": "string",
+                  "routingNumber": "string",
+                  "legalEntityIdentifier": "string"
+                }
+              }
+            },
+            "isAmountCalculated": true,
+            "amount": "string",
+            "currency": "string"
+          }
+        ],
+        "recurrence": {
+          "nextPaymentDate": "string",
+          "recurrenceUType": "eventBased",
+          "onceOff": {
+            "paymentDate": "string"
+          },
+          "intervalSchedule": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "nonBusinessDayTreatment": "AFTER",
+            "intervals": [
+              {
+                "interval": "string",
+                "dayInInterval": "string"
+              }
+            ]
+          },
+          "lastWeekDay": {
+            "finalPaymentDate": "string",
+            "paymentsRemaining": 1,
+            "interval": "string",
+            "lastWeekDay": "FRI",
+            "nonBusinessDayTreatment": "AFTER"
+          },
+          "eventBased": {
+            "description": "string"
+          }
+        }
+      }
+    ]
+  },
+  "links": {
+    "self": "string",
+    "first": "string",
+    "prev": "string",
+    "next": "string",
+    "last": "string"
+  },
+  "meta": {
+    "totalRecords": 0,
+    "totalPages": 0
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
dataobjectmandatorynone
» scheduledPayments[BankingScheduledPaymentV2]mandatoryThe list of scheduled payments to return
linksLinksPaginatedmandatorynone
metaMetaPaginatedmandatorynone
+ +

BankingScheduledPaymentV2

+ +

+
{
+  "scheduledPaymentId": "string",
+  "nickname": "string",
+  "payerReference": "string",
+  "payeeReference": "string",
+  "status": "ACTIVE",
+  "from": {
+    "accountId": "string"
+  },
+  "paymentSet": [
+    {
+      "to": {
+        "toUType": "accountId",
+        "accountId": "string",
+        "payeeId": "string",
+        "nickname": "string",
+        "payeeReference": "string",
+        "digitalWallet": {
+          "name": "string",
+          "identifier": "string",
+          "type": "EMAIL",
+          "provider": "PAYPAL_AU"
+        },
+        "domestic": {
+          "payeeAccountUType": "account",
+          "account": {
+            "accountName": "string",
+            "bsb": "string",
+            "accountNumber": "string"
+          },
+          "card": {
+            "cardNumber": "string"
+          },
+          "payId": {
+            "name": "string",
+            "identifier": "string",
+            "type": "ABN"
+          }
+        },
+        "biller": {
+          "billerCode": "string",
+          "crn": "string",
+          "billerName": "string"
+        },
+        "international": {
+          "beneficiaryDetails": {
+            "name": "string",
+            "country": "string",
+            "message": "string"
+          },
+          "bankDetails": {
+            "country": "string",
+            "accountNumber": "string",
+            "bankAddress": {
+              "name": "string",
+              "address": "string"
+            },
+            "beneficiaryBankBIC": "string",
+            "fedWireNumber": "string",
+            "sortCode": "string",
+            "chipNumber": "string",
+            "routingNumber": "string",
+            "legalEntityIdentifier": "string"
+          }
+        }
+      },
+      "isAmountCalculated": true,
+      "amount": "string",
+      "currency": "string"
+    }
+  ],
+  "recurrence": {
+    "nextPaymentDate": "string",
+    "recurrenceUType": "eventBased",
+    "onceOff": {
+      "paymentDate": "string"
+    },
+    "intervalSchedule": {
+      "finalPaymentDate": "string",
+      "paymentsRemaining": 1,
+      "nonBusinessDayTreatment": "AFTER",
+      "intervals": [
+        {
+          "interval": "string",
+          "dayInInterval": "string"
+        }
+      ]
+    },
+    "lastWeekDay": {
+      "finalPaymentDate": "string",
+      "paymentsRemaining": 1,
+      "interval": "string",
+      "lastWeekDay": "FRI",
+      "nonBusinessDayTreatment": "AFTER"
+    },
+    "eventBased": {
+      "description": "string"
+    }
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
scheduledPaymentIdASCIIStringmandatoryA unique ID of the scheduled payment adhering to the standards for ID permanence
nicknamestringoptionalThe short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels
payerReferencestringmandatoryThe reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided
payeeReferencestringconditionalThe reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided
statusstringmandatoryIndicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
fromBankingScheduledPaymentFrommandatoryObject containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
paymentSet[BankingScheduledPaymentSetV2]mandatory[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]
recurrenceBankingScheduledPaymentRecurrencemandatoryObject containing the detail of the schedule for the payment
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
statusACTIVE
statusINACTIVE
statusSKIP
+ +

BankingScheduledPaymentSetV2

+ +

+
{
+  "to": {
+    "toUType": "accountId",
+    "accountId": "string",
+    "payeeId": "string",
+    "nickname": "string",
+    "payeeReference": "string",
+    "digitalWallet": {
+      "name": "string",
+      "identifier": "string",
+      "type": "EMAIL",
+      "provider": "PAYPAL_AU"
+    },
+    "domestic": {
+      "payeeAccountUType": "account",
+      "account": {
+        "accountName": "string",
+        "bsb": "string",
+        "accountNumber": "string"
+      },
+      "card": {
+        "cardNumber": "string"
+      },
+      "payId": {
+        "name": "string",
+        "identifier": "string",
+        "type": "ABN"
+      }
+    },
+    "biller": {
+      "billerCode": "string",
+      "crn": "string",
+      "billerName": "string"
+    },
+    "international": {
+      "beneficiaryDetails": {
+        "name": "string",
+        "country": "string",
+        "message": "string"
+      },
+      "bankDetails": {
+        "country": "string",
+        "accountNumber": "string",
+        "bankAddress": {
+          "name": "string",
+          "address": "string"
+        },
+        "beneficiaryBankBIC": "string",
+        "fedWireNumber": "string",
+        "sortCode": "string",
+        "chipNumber": "string",
+        "routingNumber": "string",
+        "legalEntityIdentifier": "string"
+      }
+    }
+  },
+  "isAmountCalculated": true,
+  "amount": "string",
+  "currency": "string"
+}
+
+
+

The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
toBankingScheduledPaymentToV2mandatoryObject containing details of the destination of the payment. Used to specify a variety of payment destination types
isAmountCalculatedBooleanoptionalFlag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed
amountAmountStringconditionalThe amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
currencyCurrencyStringoptionalThe currency for the payment. AUD assumed if not present
+ +

BankingScheduledPaymentToV2

+ +

+
{
+  "toUType": "accountId",
+  "accountId": "string",
+  "payeeId": "string",
+  "nickname": "string",
+  "payeeReference": "string",
+  "digitalWallet": {
+    "name": "string",
+    "identifier": "string",
+    "type": "EMAIL",
+    "provider": "PAYPAL_AU"
+  },
+  "domestic": {
+    "payeeAccountUType": "account",
+    "account": {
+      "accountName": "string",
+      "bsb": "string",
+      "accountNumber": "string"
+    },
+    "card": {
+      "cardNumber": "string"
+    },
+    "payId": {
+      "name": "string",
+      "identifier": "string",
+      "type": "ABN"
+    }
+  },
+  "biller": {
+    "billerCode": "string",
+    "crn": "string",
+    "billerName": "string"
+  },
+  "international": {
+    "beneficiaryDetails": {
+      "name": "string",
+      "country": "string",
+      "message": "string"
+    },
+    "bankDetails": {
+      "country": "string",
+      "accountNumber": "string",
+      "bankAddress": {
+        "name": "string",
+        "address": "string"
+      },
+      "beneficiaryBankBIC": "string",
+      "fedWireNumber": "string",
+      "sortCode": "string",
+      "chipNumber": "string",
+      "routingNumber": "string",
+      "legalEntityIdentifier": "string"
+    }
+  }
+}
+
+
+

Object containing details of the destination of the payment. Used to specify a variety of payment destination types

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
toUTypestringmandatoryThe type of object provided that specifies the destination of the funds for the payment.
accountIdASCIIStringconditionalPresent if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
payeeIdASCIIStringconditionalPresent if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead
nicknamestringconditionalThe short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels
payeeReferencestringconditionalThe reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.
digitalWalletBankingDigitalWalletPayeeconditionalnone
domesticBankingDomesticPayeeconditionalnone
billerBankingBillerPayeeconditionalnone
internationalBankingInternationalPayeeconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
toUTypeaccountId
toUTypebiller
toUTypedigitalWallet
toUTypedomestic
toUTypeinternational
toUTypepayeeId
+ +

BankingScheduledPaymentFrom

+ +

+
{
+  "accountId": "string"
+}
+
+
+

Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountIdASCIIStringmandatoryID of the account that is the source of funds for the payment
+ +

BankingScheduledPaymentRecurrence

+ +

+
{
+  "nextPaymentDate": "string",
+  "recurrenceUType": "eventBased",
+  "onceOff": {
+    "paymentDate": "string"
+  },
+  "intervalSchedule": {
+    "finalPaymentDate": "string",
+    "paymentsRemaining": 1,
+    "nonBusinessDayTreatment": "AFTER",
+    "intervals": [
+      {
+        "interval": "string",
+        "dayInInterval": "string"
+      }
+    ]
+  },
+  "lastWeekDay": {
+    "finalPaymentDate": "string",
+    "paymentsRemaining": 1,
+    "interval": "string",
+    "lastWeekDay": "FRI",
+    "nonBusinessDayTreatment": "AFTER"
+  },
+  "eventBased": {
+    "description": "string"
+  }
+}
+
+
+

Object containing the detail of the schedule for the payment

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
nextPaymentDateDateStringoptionalThe date of the next payment under the recurrence schedule
recurrenceUTypestringmandatoryThe type of recurrence used to define the schedule
onceOffBankingScheduledPaymentRecurrenceOnceOffconditionalIndicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
intervalScheduleBankingScheduledPaymentRecurrenceIntervalScheduleconditionalIndicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
lastWeekDayBankingScheduledPaymentRecurrenceLastWeekdayconditionalIndicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay
eventBasedBankingScheduledPaymentRecurrenceEventBasedconditionalIndicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
recurrenceUTypeeventBased
recurrenceUTypeintervalSchedule
recurrenceUTypelastWeekDay
recurrenceUTypeonceOff
+ +

BankingScheduledPaymentRecurrenceOnceOff

+ +

+
{
+  "paymentDate": "string"
+}
+
+
+

Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
paymentDateDateStringmandatoryThe scheduled date for the once off payment
+ +

BankingScheduledPaymentRecurrenceIntervalSchedule

+ +

+
{
+  "finalPaymentDate": "string",
+  "paymentsRemaining": 1,
+  "nonBusinessDayTreatment": "AFTER",
+  "intervals": [
+    {
+      "interval": "string",
+      "dayInInterval": "string"
+    }
+  ]
+}
+
+
+

Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
finalPaymentDateDateStringoptionalThe limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
paymentsRemainingPositiveIntegeroptionalIndicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely
nonBusinessDayTreatmentstringoptionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
intervals[BankingScheduledPaymentInterval]mandatoryAn array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
nonBusinessDayTreatmentAFTER
nonBusinessDayTreatmentBEFORE
nonBusinessDayTreatmentON
nonBusinessDayTreatmentONLY
+ +

BankingScheduledPaymentInterval

+ +

+
{
+  "interval": "string",
+  "dayInInterval": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
intervalExternalRefmandatoryAn interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
dayInIntervalExternalRefoptionalUses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
+ +

BankingScheduledPaymentRecurrenceLastWeekday

+ +

+
{
+  "finalPaymentDate": "string",
+  "paymentsRemaining": 1,
+  "interval": "string",
+  "lastWeekDay": "FRI",
+  "nonBusinessDayTreatment": "AFTER"
+}
+
+
+

Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay

+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
finalPaymentDateDateStringoptionalThe limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
paymentsRemainingPositiveIntegeroptionalIndicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
intervalExternalRefmandatoryThe interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
lastWeekDaystringmandatoryThe weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
nonBusinessDayTreatmentstringoptionalEnumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
lastWeekDayFRI
lastWeekDayMON
lastWeekDaySAT
lastWeekDaySUN
lastWeekDayTHU
lastWeekDayTUE
lastWeekDayWED
nonBusinessDayTreatmentAFTER
nonBusinessDayTreatmentBEFORE
nonBusinessDayTreatmentON
nonBusinessDayTreatmentONLY
+ +

BankingScheduledPaymentRecurrenceEventBased

+ +

+
{
+  "description": "string"
+}
+
+
+

Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
descriptionstringmandatoryDescription of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
+ +

BankingDomesticPayee

+ +

+
{
+  "payeeAccountUType": "account",
+  "account": {
+    "accountName": "string",
+    "bsb": "string",
+    "accountNumber": "string"
+  },
+  "card": {
+    "cardNumber": "string"
+  },
+  "payId": {
+    "name": "string",
+    "identifier": "string",
+    "type": "ABN"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
payeeAccountUTypestringmandatoryType of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number. card A credit or charge card to pay to (note that PANs are masked). payId A PayID recognised by NPP
accountBankingDomesticPayeeAccountconditionalnone
cardBankingDomesticPayeeCardconditionalnone
payIdBankingDomesticPayeePayIdconditionalnone
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + +
PropertyValue
payeeAccountUTypeaccount
payeeAccountUTypecard
payeeAccountUTypepayId
+ +

BankingDomesticPayeeAccount

+ +

+
{
+  "accountName": "string",
+  "bsb": "string",
+  "accountNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
accountNamestringoptionalName of the account to pay to
bsbstringmandatoryBSB of the account to pay to
accountNumberstringmandatoryNumber of the account to pay to
+ +

BankingDomesticPayeeCard

+ +

+
{
+  "cardNumber": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
cardNumberMaskedPANStringmandatoryName of the account to pay to
+ +

BankingDomesticPayeePayId

+ +

+
{
+  "name": "string",
+  "identifier": "string",
+  "type": "ABN"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringoptionalThe name assigned to the PayID by the owner of the PayID
identifierstringmandatoryThe identifier of the PayID (dependent on type)
typestringmandatoryThe type of the PayID
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeABN
typeEMAIL
typeORG_IDENTIFIER
typeTELEPHONE
+ +

BankingBillerPayee

+ +

+
{
+  "billerCode": "string",
+  "crn": "string",
+  "billerName": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
billerCodestringmandatoryBPAY Biller Code of the Biller
crnstringconditionalBPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
billerNamestringmandatoryName of the Biller
+ +

BankingInternationalPayee

+ +

+
{
+  "beneficiaryDetails": {
+    "name": "string",
+    "country": "string",
+    "message": "string"
+  },
+  "bankDetails": {
+    "country": "string",
+    "accountNumber": "string",
+    "bankAddress": {
+      "name": "string",
+      "address": "string"
+    },
+    "beneficiaryBankBIC": "string",
+    "fedWireNumber": "string",
+    "sortCode": "string",
+    "chipNumber": "string",
+    "routingNumber": "string",
+    "legalEntityIdentifier": "string"
+  }
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
beneficiaryDetailsobjectmandatorynone
» namestringoptionalName of the beneficiary
» countryExternalRefmandatoryCountry where the beneficiary resides. A valid ISO 3166 Alpha-3 country code
» messagestringoptionalResponse message for the payment
bankDetailsobjectmandatorynone
» countryExternalRefmandatoryCountry of the recipient institution. A valid ISO 3166 Alpha-3 country code
» accountNumberstringmandatoryAccount Targeted for payment
» bankAddressobjectoptionalnone
»» namestringmandatoryName of the recipient Bank
»» addressstringmandatoryAddress of the recipient Bank
» beneficiaryBankBICExternalRefoptionalSwift bank code. Aligns with standard ISO 9362
» fedWireNumberstringoptionalNumber for Fedwire payment (Federal Reserve Wire Network)
» sortCodestringoptionalSort code used for account identification in some jurisdictions
» chipNumberstringoptionalNumber for the Clearing House Interbank Payments System
» routingNumberstringoptionalInternational bank routing number
» legalEntityIdentifierExternalRefoptionalThe legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442
+ +

BankingDigitalWalletPayee

+ +

+
{
+  "name": "string",
+  "identifier": "string",
+  "type": "EMAIL",
+  "provider": "PAYPAL_AU"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
namestringmandatoryThe display name of the wallet as given by the customer, else a default value defined by the data holder
identifierstringmandatoryThe identifier of the digital wallet (dependent on type)
typestringmandatoryThe type of the digital wallet identifier
providerstringmandatoryThe provider of the digital wallet
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
typeEMAIL
typeCONTACT_NAME
typeTELEPHONE
providerPAYPAL_AU
providerOTHER
+ +

LinksPaginated

+ +

+
{
+  "self": "string",
+  "first": "string",
+  "prev": "string",
+  "next": "string",
+  "last": "string"
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
selfURIStringmandatoryFully qualified link that generated the current response document
firstURIStringconditionalURI to the first page of this set. Mandatory if this response is not the first page
prevURIStringconditionalURI to the previous page of this set. Mandatory if this response is not the first page
nextURIStringconditionalURI to the next page of this set. Mandatory if this response is not the last page
lastURIStringconditionalURI to the last page of this set. Mandatory if this response is not the last page
+ +

MetaPaginated

+ +

+
{
+  "totalRecords": 0,
+  "totalPages": 0
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
totalRecordsNaturalNumbermandatoryThe total number of records in the full set. See pagination.
totalPagesNaturalNumbermandatoryThe total number of pages in the full set. See pagination.
+ +

MetaError

+ +

+
{
+  "urn": "string"
+}
+
+
+

Additional data for customised error codes

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
urnstringconditionalThe CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
+ +

ResponseErrorListV2

+ +

+
{
+  "errors": [
+    {
+      "code": "string",
+      "title": "string",
+      "detail": "string",
+      "meta": {
+        "urn": "string"
+      }
+    }
+  ]
+}
+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeRequiredDescription
errors[object]mandatorynone
» codestringmandatoryThe code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» titlestringmandatoryA short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detailstringmandatoryA human-readable explanation specific to this occurrence of the problem.
» metaMetaErroroptionalAdditional data for customised error codes
+ +

BankingProductCategory

+ +

+
"BUSINESS_LOANS"
+
+
+

The category to which a product or account belongs. See here for more details

+

Properties

+ + + + + + + + + + + + + + +
NameTypeRequiredDescription
anonymousstringmandatoryThe category to which a product or account belongs. See here for more details
+

Enumerated Values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyValue
anonymousBUSINESS_LOANS
anonymousCRED_AND_CHRG_CARDS
anonymousLEASES
anonymousMARGIN_LOANS
anonymousOVERDRAFTS
anonymousPERS_LOANS
anonymousREGULATED_TRUST_ACCOUNTS
anonymousRESIDENTIAL_MORTGAGES
anonymousTERM_DEPOSITS
anonymousTRADE_FINANCE
anonymousTRANS_AND_SAVINGS_ACCOUNTS
anonymousTRAVEL_CARDS
+ +
+
+
+ + +
+
+
+ + diff --git a/docs/includes/releasenotes/releasenotes.1.28.0.html b/docs/includes/releasenotes/releasenotes.1.28.0.html new file mode 100644 index 00000000..2fe4a75c --- /dev/null +++ b/docs/includes/releasenotes/releasenotes.1.28.0.html @@ -0,0 +1,330 @@ + + + + + + + + Consumer Data Standards - v1.28.0 Release Notes + + + + + + + + + + + + NAV + Navbar + + +
+ + + +
+
+
+

V1.28.0 Release Notes

+

Release notes for version v1.28.0 of the CDR Standards.

+

Changes Made

Change Requests

+

This release addresses the following minor defects raised on Standards Staging:

+ +

None

+ +

This release addresses the following change requests raised on Standards Maintenance:

+ +

None

+

Decision Proposals

+

This release addresses the following Decision Proposals published on Standards:

+ + +

General Changes

+ + + + + + + + + + + + +
ChangeDescriptionLink
Enum property typeProperties defined with enumerated values will now show the type as 'Enum' instead of 'string'All schema Properties tables
+

Introduction

+

None

+

High Level Standards

+

None

+

API End Points

+

None

+

Information Security Profile

+

None

+

Register Standards

+

None

+

Consumer Experience

+

None

+

Non-Functional Requirements

+

None

+

Additional Standards

+ + + + + + + + + + + + + + + + + +
ChangeDescriptionLink
Decision Proposal 306 Candidate
  • Changed the cardArt array to a cardOption object to provide additional card details in 'Get Products', 'Get Product Detail' and 'Get Account Detail'.
  • Added the FEE lendingRateType value to support lending products that have a fee-based rather than rate-based cost. This type may be expected to align to the new PRINCIPAL_AND_FEE repaymentType.
  • Added the BALANCE_TRANSFER lendingRateType value to extend support for credit card plan detail.
  • Updated the creditCard schema in 'Get Account Detail' to allow an array of plan types, each with specific rates, repayments, adjustments and features.
  • Added revertRate, revertProductId, rateStartDate and rateEndDate fields to respective lending rate schemas to support 'revert' rate details.
  • Added referenceRate to multiple lending and deposit rate schemas.
  • Added adjustmentToBase and adjustmentBundle fields to the 'BankingProductLendingRate' and 'BankingProductDepositRate' schemas. The adjustmentToBase field is provided to allow an adjustment rate type to specify which base rate type the adjustment applies to, where many may be offered for a product.
  • Updated and added the applicabilityConditions field in the 'BankingProductLendingRate', 'BankingProductDepositRate' and 'BankingProductRateTier' schemas.
  • Added the applicationType field to clarify whether an associated applicationFrequency value is to be expected.
  • Updated the description of the features property of 'Get Product Detail' and 'Get Account Detail' to clarify that the schema also supports providing details of any key operational product limitations.
  • Updated the description of the constraints property of 'Get Product Detail' to clarify that the schema is only intended to provide details of constraints on application for the product.
  • Added new featureType values to support operational limitations and the OTHER constraintType to allow additional detail to be provided.
  • Added new feeCategory field and new feeType values to improve classification and comparison of fees.
  • Updated the 'BankingProductFee' schema to separate different fee types by UType and added minimum and maximum fee details and feeCap fields.
  • Incorporated rate detail into the 'Get Account Detail' schemas to provide specific rate fields separated from the generic Product Reference rate objects.
  • Extended the termDeposit schema in 'Get Account Detail' to allow each deposit to be specified with specific rates and terms.
  • Updated the 'adjustment' rate type values to remove the INTRODUCTORY, BUNDLE_BONUS, BUNDLE_DISCOUNT_FIXED, BUNDLE_DISCOUNT_VARIABLE options. Time and bundle-based rate detail will be supported through new fields to capture that detail: adjustmentBundle, adjustmentPeriod and adjustmentEndDate, leaving the additionalValue field available for other detail where necessary.
  • Added a deposit schema in 'Get Account Detail' to provide rate detail for general deposit structures without term deposit maturity detail.
  • Removed the specificAccountUType field in 'Get Account Detail' to clarify that multiple types may be present in a single account.
  • Updated the 'Use of additionalValue Field' descriptions for the PENSION_RECIPIENT and STUDENT 'Product Eligibility' and 'Product Discount Eligibility' types.
  • Updated the description of the comparisonRate field to clarify how it could be interpreted when associated with an adjustment rate type.
  • Updated the description of the rate tier unitOfMeasure field to clarify the format of the associated values, including specifying PERCENT values as a RateString.
  • This candidate incorporates the latest Non-Bank Lending (NBL) Draft changes including the BUY_NOW_PAY_LATER product category value, the instalments object, and related feature and fee types. The endpoint versions incremented due to changes related to the NBL Draft only, are:
    • Get Accounts (v3)
    • Get Bulk Balances (v2)
    • Get Bulk Direct Debits (v2)
    • Get Scheduled Payments Bulk (v3).
    • Other NBL changes affecting the Register APIs are only shown in the NBL Draft.
  • The endpoint versions incremented primarily for Decision Proposal 306, but also including NBL detail are:
    • Get Account Detail (v4)
    • Get Products (v4)
    • Get Product Detail (v5).
  • Corrected minor typos and updated documentation formatting.
Candidate Standards
Non-Bank Lending Draft
  • Updated Register endpoint versions affected by the addition of the non-bank-lending value in the industry query and industries response field.
  • The endpoint versions incremented due to these changes are:
    • Get Data Holder Brands (v3)
    • Get Data Holder Brands Summary (v2)
    • Get Data Holder Statuses (v2).
  • Previous Register endpoint versions are available through the respective 'Obsolete versions' links.
  • Updated Banking endpoint versions affected by the addition of the BUY_NOW_PAY_LATER value in the product-category query.
  • Added instalments object in 'Get Product Detail' and 'Get Account Detail' endpoints.
  • Added EXTRA_DOWN_PAYMENT featureType to support 'Buy Now, Pay Later' or similar products where a variable down-payment may be made.
  • Added the 'Product Categories' section to include a general description of the BUY_NOW_PAY_LATER category.
  • Added the 'Product & Account Components' section to include descriptions of the previously included PAYMENT_LATE and UPFRONT_PER_PLAN feeType values.
  • The endpoint versions incremented due to these changes are:
    • Get Accounts (v3)
    • Get Bulk Balances (v2)
    • Get Account Detail (v4)
    • Get Bulk Direct Debits (v2)
    • Get Scheduled Payments Bulk (v3)
    • Get Products (v4)
    • Get Product Detail (v5).
  • Previous Banking endpoint versions are available through the respective 'Obsolete versions' links.
  • Corrected minor typos and updated documentation formatting.
  • Added Consumer Experience section with Banking Language for reference only.
Draft Standards
+

Known Issues

+

None

+ +
+
+ + diff --git a/docs/includes/swagger/cds_admin.json b/docs/includes/swagger/cds_admin.json index 5dcee3fd..073cde4e 100644 --- a/docs/includes/swagger/cds_admin.json +++ b/docs/includes/swagger/cds_admin.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Admin API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_admin.yaml b/docs/includes/swagger/cds_admin.yaml index 12f8d445..0c723711 100644 --- a/docs/includes/swagger/cds_admin.yaml +++ b/docs/includes/swagger/cds_admin.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Admin API - version: 1.27.0 + version: 1.28.0 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/includes/swagger/cds_banking.json b/docs/includes/swagger/cds_banking.json index 6c222606..9a1bd82d 100644 --- a/docs/includes/swagger/cds_banking.json +++ b/docs/includes/swagger/cds_banking.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Banking API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_banking.yaml b/docs/includes/swagger/cds_banking.yaml index 9f955709..94257ffe 100644 --- a/docs/includes/swagger/cds_banking.yaml +++ b/docs/includes/swagger/cds_banking.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Banking API - version: 1.27.0 + version: 1.28.0 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/includes/swagger/cds_banking_dp306.json b/docs/includes/swagger/cds_banking_dp306.json new file mode 100644 index 00000000..73144d9f --- /dev/null +++ b/docs/includes/swagger/cds_banking_dp306.json @@ -0,0 +1,6749 @@ +{ + "openapi" : "3.0.3", + "info" : { + "contact" : { + "email" : "contact@consumerdatastandards.gov.au", + "name" : "Consumer Data Standards", + "url" : "https://consumerdatastandards.gov.au" + }, + "description" : "Consumer Data Standards APIs created by the Data Standards Body (DSB), with the Data Standards Chair as the decision maker to meet the needs of the Consumer Data Right", + "license" : { + "name" : "MIT License", + "url" : "https://opensource.org/licenses/MIT" + }, + "title" : "CDR Banking API", + "version" : "1.28.0" + }, + "servers" : [ { + "url" : "https://data.holder.com.au/cds-au/v1" + } ], + "paths" : { + "/banking/accounts" : { + "get" : { + "description" : "Obtain a list of accounts.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html), [v2](../../../../includes/obsolete/get-accounts-v2.html)", + "operationId" : "listAccounts", + "parameters" : [ { + "description" : "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.)", + "explode" : true, + "in" : "query", + "name" : "product-category", + "required" : false, + "schema" : { + "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" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", + "explode" : true, + "in" : "query", + "name" : "open-status", + "required" : false, + "schema" : { + "default" : "ALL", + "enum" : [ "ALL", "CLOSED", "OPEN" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts", + "explode" : true, + "in" : "query", + "name" : "is-owned", + "required" : false, + "schema" : { + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "style" : "form", + "x-cds-type" : "Boolean" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingAccountListV3" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Accounts", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:accounts.basic:read" ], + "x-version" : "3" + } + }, + "/banking/accounts/balances" : { + "get" : { + "description" : "Obtain balances for multiple, filtered accounts\n\nObsolete versions: [v1](../../../../includes/obsolete/get-bulk-balances-v1.html)", + "operationId" : "listBalancesBulk", + "parameters" : [ { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "product-category", + "required" : false, + "schema" : { + "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" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", + "explode" : true, + "in" : "query", + "name" : "open-status", + "required" : false, + "schema" : { + "default" : "ALL", + "enum" : [ "ALL", "CLOSED", "OPEN" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts", + "explode" : true, + "in" : "query", + "name" : "is-owned", + "required" : false, + "schema" : { + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "style" : "form", + "x-cds-type" : "Boolean" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Bulk Balances", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:accounts.basic:read" ], + "x-version" : "2" + }, + "post" : { + "description" : "Obtain balances for a specified list of accounts", + "operationId" : "listBalancesSpecificAccounts", + "parameters" : [ { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccountIds" + } + } + }, + "description" : "The list of account IDs to obtain balances for", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Balances For Specific Accounts", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:accounts.basic:read" ], + "x-version" : "1", + "x-codegen-request-body-name" : "accountIds" + } + }, + "/banking/accounts/{accountId}/balance" : { + "get" : { + "description" : "Obtain the balance for a single specified account", + "operationId" : "getBalance", + "parameters" : [ { + "description" : "ID of the specific account requested", + "explode" : false, + "in" : "path", + "name" : "accountId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceById" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Account Balance", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:accounts.basic:read" ], + "x-version" : "1" + } + }, + "/banking/accounts/{accountId}" : { + "get" : { + "description" : "Obtain detailed information on a single account.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html), [v3](../../../../includes/obsolete/get-account-detail-v3.html)", + "operationId" : "getAccountDetail", + "parameters" : [ { + "description" : "A tokenised identifier for the account which is unique but not shareable", + "explode" : false, + "in" : "path", + "name" : "accountId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingAccountByIdV4" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Account Detail", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:accounts.detail:read" ], + "x-version" : "4" + } + }, + "/banking/accounts/{accountId}/transactions" : { + "get" : { + "description" : "Obtain transactions for a specific account.\n\nSome general notes that apply to all endpoints that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- 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:\n - Posted date/time if available, then\n - Execution date/time if available, then\n - A reasonable date/time nominated by the data holder using internal data structures\n- 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\n- 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", + "operationId" : "getTransactions", + "parameters" : [ { + "description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.", + "explode" : false, + "in" : "path", + "name" : "accountId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type", + "explode" : true, + "in" : "query", + "name" : "oldest-time", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "style" : "form", + "x-cds-type" : "DateTimeString" + }, { + "description" : "Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type", + "explode" : true, + "in" : "query", + "name" : "newest-time", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "style" : "form", + "x-cds-type" : "DateTimeString" + }, { + "description" : "Filter transactions to only transactions with amounts higher than or equal to this amount", + "explode" : true, + "in" : "query", + "name" : "min-amount", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "AmountString" + }, + "style" : "form", + "x-cds-type" : "AmountString" + }, { + "description" : "Filter transactions to only transactions with amounts less than or equal to this amount", + "explode" : true, + "in" : "query", + "name" : "max-amount", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "AmountString" + }, + "style" : "form", + "x-cds-type" : "AmountString" + }, { + "description" : "Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)", + "explode" : true, + "in" : "query", + "name" : "text", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingTransactionList" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Transactions For Account", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:transactions:read" ], + "x-version" : "1" + } + }, + "/banking/accounts/{accountId}/transactions/{transactionId}" : { + "get" : { + "description" : "Obtain detailed information on a transaction for a specific account", + "operationId" : "getTransactionDetail", + "parameters" : [ { + "description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints", + "explode" : false, + "in" : "path", + "name" : "accountId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "ID of the transaction obtained from a previous call to one of the other transaction endpoints", + "explode" : false, + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingTransactionById" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Transaction Detail", + "tags" : [ "Banking", "Accounts" ], + "x-scopes" : [ "bank:transactions:read" ], + "x-version" : "1" + } + }, + "/banking/accounts/{accountId}/direct-debits" : { + "get" : { + "description" : "Obtain direct debit authorisations for a specific account", + "operationId" : "listDirectDebits", + "parameters" : [ { + "description" : "ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.", + "explode" : false, + "in" : "path", + "name" : "accountId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Direct Debits For Account", + "tags" : [ "Banking", "Direct Debits" ], + "x-scopes" : [ "bank:regular_payments:read" ], + "x-version" : "1" + } + }, + "/banking/accounts/direct-debits" : { + "get" : { + "description" : "Obtain direct debit authorisations for multiple, filtered accounts\n\nObsolete versions: [v1](../../../../includes/obsolete/get-bulk-direct-debits-v1.html)", + "operationId" : "listDirectDebitsBulk", + "parameters" : [ { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "product-category", + "required" : false, + "schema" : { + "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" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", + "explode" : true, + "in" : "query", + "name" : "open-status", + "required" : false, + "schema" : { + "default" : "ALL", + "enum" : [ "ALL", "CLOSED", "OPEN" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts", + "explode" : true, + "in" : "query", + "name" : "is-owned", + "required" : false, + "schema" : { + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "style" : "form", + "x-cds-type" : "Boolean" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Bulk Direct Debits", + "tags" : [ "Banking", "Direct Debits" ], + "x-scopes" : [ "bank:regular_payments:read" ], + "x-version" : "2" + }, + "post" : { + "description" : "Obtain direct debit authorisations for a specified list of accounts", + "operationId" : "listDirectDebitsSpecificAccounts", + "parameters" : [ { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccountIds" + } + } + }, + "description" : "Array of specific accountIds to obtain authorisations for", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Direct Debits For Specific Accounts", + "tags" : [ "Banking", "Direct Debits" ], + "x-scopes" : [ "bank:regular_payments:read" ], + "x-version" : "1", + "x-codegen-request-body-name" : "accountIds" + } + }, + "/banking/accounts/{accountId}/payments/scheduled" : { + "get" : { + "description" : "Obtain scheduled, outgoing payments for a specific account\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-account-v1.html)", + "operationId" : "listScheduledPayments", + "parameters" : [ { + "description" : "ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment", + "explode" : false, + "in" : "path", + "name" : "accountId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Scheduled Payments for Account", + "tags" : [ "Banking", "Scheduled Payments" ], + "x-scopes" : [ "bank:regular_payments:read" ], + "x-version" : "2" + } + }, + "/banking/payments/scheduled" : { + "get" : { + "description" : "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](../../../../includes/obsolete/get-scheduled-payments-bulk-v2.html)", + "operationId" : "listScheduledPaymentsBulk", + "parameters" : [ { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "product-category", + "required" : false, + "schema" : { + "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" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", + "explode" : true, + "in" : "query", + "name" : "open-status", + "required" : false, + "schema" : { + "default" : "ALL", + "enum" : [ "ALL", "CLOSED", "OPEN" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts", + "explode" : true, + "in" : "query", + "name" : "is-owned", + "required" : false, + "schema" : { + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "style" : "form", + "x-cds-type" : "Boolean" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Scheduled Payments Bulk", + "tags" : [ "Banking", "Scheduled Payments" ], + "x-scopes" : [ "bank:regular_payments:read" ], + "x-version" : "3" + }, + "post" : { + "description" : "Obtain scheduled payments for a specified list of accounts\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html)", + "operationId" : "listScheduledPaymentsSpecificAccounts", + "parameters" : [ { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccountIds" + } + } + }, + "description" : "Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Scheduled Payments For Specific Accounts", + "tags" : [ "Banking", "Scheduled Payments" ], + "x-scopes" : [ "bank:regular_payments:read" ], + "x-version" : "2", + "x-codegen-request-body-name" : "accountIds" + } + }, + "/banking/payees" : { + "get" : { + "description" : "Obtain a list of pre-registered payees.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-payees-v1.html)", + "operationId" : "listPayees", + "parameters" : [ { + "description" : "Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL", + "explode" : true, + "in" : "query", + "name" : "type", + "required" : false, + "schema" : { + "default" : "ALL", + "enum" : [ "ALL", "BILLER", "DIGITAL_WALLET", "DOMESTIC", "INTERNATIONAL" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingPayeeListV2" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Payees", + "tags" : [ "Banking", "Payees" ], + "x-scopes" : [ "bank:payees:read" ], + "x-version" : "2" + } + }, + "/banking/payees/{payeeId}" : { + "get" : { + "description" : "Obtain detailed information on a single payee.\n\nNote that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-payee-detail-v1.html)", + "operationId" : "getPayeeDetail", + "parameters" : [ { + "description" : "The ID used to locate the details of a particular payee", + "explode" : false, + "in" : "path", + "name" : "payeeId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingPayeeByIdV2" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
", + "headers" : { + "x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + } + }, + "summary" : "Get Payee Detail", + "tags" : [ "Banking", "Payees" ], + "x-scopes" : [ "bank:payees:read" ], + "x-version" : "2" + } + }, + "/banking/products" : { + "get" : { + "description" : "Obtain a list of products that are currently openly offered to the market\n\nNote that the results returned by this endpoint are expected to be ordered in descending order according to `lastUpdated`.\n\n### Conventions\nIn the product reference payloads there are a number of recurring conventions that are explained here, in one place.\n\n#### Arrays Of Features\n\nIn the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:\n\n- Each element in an array has the same structure so that clients can reliably interpret the payloads\n- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.\n- Each element has a field name [additionalValue](#productfeaturetypedoc). 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.\n- 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.\n- 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.\n- Depending on the type of data being represented there may be additional specific fields.\n\n#### URIs To More Information\n\nAs 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.\n\nThese 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.\n\n#### Linkage To Accounts\nFrom 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.\n\nFor 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.\n\nSimilarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process.\n\n#### Dates\nIt 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.\n\nIn 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.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html), [v2](../../../../includes/obsolete/get-products-v2.html), [v3](../../../../includes/obsolete/get-products-v3.html)", + "operationId" : "listProducts", + "parameters" : [ { + "description" : "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`", + "explode" : true, + "in" : "query", + "name" : "effective", + "required" : false, + "schema" : { + "default" : "CURRENT", + "enum" : [ "ALL", "CURRENT", "FUTURE" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Only include products that have been updated after the specified date and time. If absent defaults to include all products", + "explode" : true, + "in" : "query", + "name" : "updated-since", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "style" : "form", + "x-cds-type" : "DateTimeString" + }, { + "description" : "Filter results based on a specific brand", + "explode" : true, + "in" : "query", + "name" : "brand", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "product-category", + "required" : false, + "schema" : { + "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" ], + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingProductListV3" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
" + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
" + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
" + } + }, + "summary" : "Get Products", + "tags" : [ "Banking", "Products" ], + "x-version" : "4" + } + }, + "/banking/products/{productId}" : { + "get" : { + "description" : "Obtain detailed information on a single product offered openly to the market.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html), [v2](../../../../includes/obsolete/get-product-detail-v2.html), [v3](../../../../includes/obsolete/get-product-detail-v3.html), [v4](../../../../includes/obsolete/get-product-detail-v4.html)", + "operationId" : "getProductDetail", + "parameters" : [ { + "description" : "ID of the specific product requested", + "explode" : false, + "in" : "path", + "name" : "productId", + "required" : true, + "schema" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "style" : "simple", + "x-cds-type" : "ASCIIString" + }, { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseBankingProductByIdV5" + } + } + }, + "description" : "Success", + "headers" : { + "x-v" : { + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", + "explode" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
" + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
" + }, + "406" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseErrorListV2" + } + } + }, + "description" : "The following error codes MUST be supported:
" + } + }, + "summary" : "Get Product Detail", + "tags" : [ "Banking", "Products" ], + "x-version" : "5" + } + } + }, + "components" : { + "parameters" : { + "RequestHeader_x-v" : { + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", + "explode" : false, + "in" : "header", + "name" : "x-v", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "RequestHeader_x-min-v" : { + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", + "explode" : false, + "in" : "header", + "name" : "x-min-v", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "RequestHeader_x-fapi-interaction-id" : { + "description" : "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-interaction-id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "RequestHeader_x-fapi-auth-date" : { + "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-auth-date", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true + }, + "style" : "simple", + "x-conditional" : true + }, + "RequestHeader_x-fapi-customer-ip-address" : { + "description" : "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.", + "explode" : false, + "in" : "header", + "name" : "x-fapi-customer-ip-address", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, + "RequestHeader_x-cds-client-headers" : { + "description" : "The customer's original standard http headers [Base64](#common-field-types) 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.", + "explode" : false, + "in" : "header", + "name" : "x-cds-client-headers", + "required" : false, + "schema" : { + "type" : "string", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "style" : "simple", + "x-conditional" : true, + "x-cds-type" : "Base64" + }, + "ParamAccountOpenStatus" : { + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", + "explode" : true, + "in" : "query", + "name" : "open-status", + "required" : false, + "schema" : { + "default" : "ALL", + "enum" : [ "ALL", "CLOSED", "OPEN" ], + "type" : "string" + }, + "style" : "form" + }, + "ParamProductCategory" : { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "product-category", + "required" : false, + "schema" : { + "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" ], + "type" : "string" + }, + "style" : "form" + }, + "ParamAccountIsOwned" : { + "description" : "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts", + "explode" : true, + "in" : "query", + "name" : "is-owned", + "required" : false, + "schema" : { + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "style" : "form", + "x-cds-type" : "Boolean" + }, + "ParamPage" : { + "description" : "Page of results to request (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, + "ParamPageSize" : { + "description" : "Page size to request. Default is 25 (standard pagination)", + "explode" : true, + "in" : "query", + "name" : "page-size", + "required" : false, + "schema" : { + "default" : 25, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "style" : "form", + "x-cds-type" : "PositiveInteger" + }, + "ParamTransactionNewestTime" : { + "description" : "Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type", + "explode" : true, + "in" : "query", + "name" : "newest-time", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "style" : "form", + "x-cds-type" : "DateTimeString" + }, + "ParamTransactionOldestTime" : { + "description" : "Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type", + "explode" : true, + "in" : "query", + "name" : "oldest-time", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "style" : "form", + "x-cds-type" : "DateTimeString" + }, + "ParamTransactionMinAmount" : { + "description" : "Filter transactions to only transactions with amounts higher than or equal to this amount", + "explode" : true, + "in" : "query", + "name" : "min-amount", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "AmountString" + }, + "style" : "form", + "x-cds-type" : "AmountString" + }, + "ParamTransactionMaxAmount" : { + "description" : "Filter transactions to only transactions with amounts less than or equal to this amount", + "explode" : true, + "in" : "query", + "name" : "max-amount", + "required" : false, + "schema" : { + "type" : "string", + "x-cds-type" : "AmountString" + }, + "style" : "form", + "x-cds-type" : "AmountString" + }, + "ParamTransactionText" : { + "description" : "Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)", + "explode" : true, + "in" : "query", + "name" : "text", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } + }, + "schemas" : { + "RequestAccountIds" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/RequestAccountIds_data" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "ResponseBankingProductListV3" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingProductListV3_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "BankingProductV5" : { + "properties" : { + "productId" : { + "description" : "A data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "effectiveFrom" : { + "description" : "The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "effectiveTo" : { + "description" : "The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "lastUpdated" : { + "description" : "The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered)", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "productCategory" : { + "$ref" : "#/components/schemas/BankingProductCategoryV2" + }, + "name" : { + "description" : "The display name of the product", + "type" : "string" + }, + "description" : { + "description" : "A description of the product", + "type" : "string" + }, + "brand" : { + "description" : "A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required", + "type" : "string" + }, + "brandName" : { + "description" : "An optional display name of the brand", + "type" : "string" + }, + "applicationUri" : { + "description" : "A link to an application web page where this product can be applied for.", + "type" : "string", + "x-cds-type" : "URIString" + }, + "isTailored" : { + "description" : "Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable", + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "additionalInformation" : { + "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2" + }, + "cardOption" : { + "$ref" : "#/components/schemas/BankingProductCardOption" + } + }, + "required" : [ "brand", "description", "isTailored", "lastUpdated", "name", "productCategory", "productId" ], + "type" : "object" + }, + "BankingProductCardOption" : { + "description" : "Information about the type of card available with the account", + "properties" : { + "cardScheme" : { + "description" : "Card scheme available with the account", + "enum" : [ "AMEX", "DINERS", "EFTPOS", "MASTERCARD", "VISA", "OTHER" ], + "type" : "string" + }, + "cardType" : { + "description" : "Card type available with the account", + "enum" : [ "CHARGE", "CREDIT", "DEBIT" ], + "type" : "string" + }, + "cardImages" : { + "description" : "An array of card art images", + "items" : { + "$ref" : "#/components/schemas/BankingProductCardOption_cardImages" + }, + "type" : "array" + } + }, + "required" : [ "cardScheme", "cardType" ], + "type" : "object" + }, + "BankingProductCardOption_cardImages" : { + "properties" : { + "title" : { + "description" : "Display label for the specific image", + "type" : "string" + }, + "imageUri" : { + "description" : "URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)**", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "imageUri" ], + "type" : "object" + }, + "BankingProductAdditionalInformationV2" : { + "description" : "Object that contains links to additional information on specific topics", + "properties" : { + "overviewUri" : { + "description" : "General overview of the product. Mandatory if `additionalOverviewUris` includes one or more supporting documents.", + "type" : "string", + "x-cds-type" : "URIString" + }, + "termsUri" : { + "description" : "Terms and conditions for the product. Mandatory if `additionalTermsUris` includes one or more supporting documents.", + "type" : "string", + "x-cds-type" : "URIString" + }, + "eligibilityUri" : { + "description" : "Eligibility rules and criteria for the product. Mandatory if `additionalEligibilityUris` includes one or more supporting documents.", + "type" : "string", + "x-cds-type" : "URIString" + }, + "feesAndPricingUri" : { + "description" : "Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if `additionalFeesAndPricingUris` includes one or more supporting documents.", + "type" : "string", + "x-cds-type" : "URIString" + }, + "bundleUri" : { + "description" : "Description of a bundle that this product can be part of. Mandatory if `additionalBundleUris` includes one or more supporting documents.", + "type" : "string", + "x-cds-type" : "URIString" + }, + "additionalOverviewUris" : { + "description" : "An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the `overviewUri`. Only to be used if there is a primary `overviewUri`.", + "items" : { + "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" + }, + "type" : "array" + }, + "additionalTermsUris" : { + "description" : "An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the `termsUri`. Only to be used if there is a primary `termsUri`.", + "items" : { + "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" + }, + "type" : "array" + }, + "additionalEligibilityUris" : { + "description" : "An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the `eligibilityUri`. Only to be used if there is a primary `eligibilityUri`.", + "items" : { + "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" + }, + "type" : "array" + }, + "additionalFeesAndPricingUris" : { + "description" : "An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the `feesAndPricingUri`. Only to be used if there is a primary `feesAndPricingUri`.", + "items" : { + "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" + }, + "type" : "array" + }, + "additionalBundleUris" : { + "description" : "An array of additional bundles for the product, if applicable. To be treated as secondary documents to the `bundleUri`. Only to be used if there is a primary `bundleUri`.", + "items" : { + "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" + }, + "type" : "array" + } + }, + "type" : "object", + "x-conditional" : [ "overviewUri", "termsUri", "eligibilityUri", "feesAndPricingUri", "bundleUri" ] + }, + "BankingProductAdditionalInformationV2_additionalInformationUris" : { + "properties" : { + "description" : { + "description" : "Display text providing more information about the document URI", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "The URI describing the additional information", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "additionalInfoUri" ], + "type" : "object" + }, + "ResponseBankingProductByIdV5" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/BankingProductDetailV5" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links" ], + "type" : "object" + }, + "BankingProductDetailV5" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingProductV5" + }, { + "$ref" : "#/components/schemas/BankingProductDetailV5_allOf" + } ] + }, + "BankingProductBundle" : { + "properties" : { + "name" : { + "description" : "Name of the bundle", + "type" : "string" + }, + "description" : { + "description" : "Description of the bundle", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the bundle", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on the bundle criteria and benefits", + "type" : "string", + "x-cds-type" : "URIString" + }, + "productIds" : { + "description" : "Array of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints", + "items" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "type" : "array" + } + }, + "required" : [ "description", "name" ], + "type" : "object" + }, + "BankingProductFeatureV3" : { + "description" : "Array of features and limitations of the product", + "properties" : { + "featureType" : { + "description" : "The type of feature described. For further details, refer to [Product Feature Types](#tocSproductfeaturetypedoc)", + "enum" : [ "ADDITIONAL_CARDS", "BALANCE_TRANSFERS", "BILL_PAYMENT", "BONUS_REWARDS", "CARD_ACCESS", "CASHBACK_OFFER", "COMPLEMENTARY_PRODUCT_DISCOUNTS", "EXTRA_DOWN_PAYMENT", "DIGITAL_BANKING", "DIGITAL_WALLET", "DONATE_INTEREST", "EXTRA_REPAYMENTS", "FRAUD_PROTECTION", "FREE_TXNS", "FREE_TXNS_ALLOWANCE", "FUNDS_AVAILABLE_AFTER", "GUARANTOR", "INSTALMENT_PLAN", "INSURANCE", "INTEREST_FREE", "INTEREST_FREE_TRANSFERS", "LOYALTY_PROGRAM", "MAX_BALANCE", "MAX_LIMIT", "MAX_TXNS", "MIN_BALANCE", "MIN_LIMIT", "NOTIFICATIONS", "NPP_ENABLED", "NPP_PAYID", "OFFSET", "OTHER", "OVERDRAFT", "REDRAW", "RELATIONSHIP_MANAGEMENT", "UNLIMITED_TXNS" ], + "type" : "string" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to `OTHER`", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this feature", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "featureType" ], + "type" : "object", + "x-conditional" : [ "additionalValue", "additionalInfo" ] + }, + "BankingProductConstraintV2" : { + "properties" : { + "constraintType" : { + "description" : "The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc)", + "enum" : [ "MAX_BALANCE", "MAX_LIMIT", "MIN_BALANCE", "MIN_LIMIT", "OPENING_BALANCE", "OTHER" ], + "type" : "string" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [constraintType](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the constraint. Mandatory if the [constraint type](#tocSproductconstrainttypedoc) is set to `OTHER`", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on the constraint", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "constraintType" ], + "type" : "object", + "x-conditional" : [ "additionalValue", "additionalInfo" ] + }, + "BankingProductEligibility" : { + "properties" : { + "eligibilityType" : { + "description" : "The type of eligibility criteria described. For further details, refer to [Product Eligibility Types](#tocSproducteligibilitytypedoc)", + "enum" : [ "BUSINESS", "EMPLOYMENT_STATUS", "MAX_AGE", "MIN_AGE", "MIN_INCOME", "MIN_TURNOVER", "NATURAL_PERSON", "OTHER", "PENSION_RECIPIENT", "RESIDENCY_STATUS", "STAFF", "STUDENT" ], + "type" : "string" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [eligibilityType](#tocSproducteligibilitytypedoc) specified. Whether mandatory or not is dependent on the value of [eligibilityType](#tocSproducteligibilitytypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) criteria. Mandatory if the field is set to `OTHER`", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this eligibility criteria", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "eligibilityType" ], + "type" : "object", + "x-conditional" : [ "additionalValue", "additionalInfo" ] + }, + "BankingProductFeeV2" : { + "properties" : { + "name" : { + "description" : "Name of the fee", + "type" : "string" + }, + "feeCategory" : { + "description" : "The category of fee, used to group `feeType` values. For further details, refer to [Product Fee Categories](#tocSproductfeecategorydoc).", + "enum" : [ "APPLICATION", "ATM", "BRANCH", "BUY_NOW_PAY_LATER", "CARD", "CHEQUE", "CLOSURE", "CORRESPONDENCE", "FOREIGN_EXCHANGE", "OTHER", "POS", "SERVICE", "TELEGRAPHIC_TRANSFER", "TELEPHONE_BANKING", "TERMS_CONDITIONS", "THIRD_PARTY", "TRANSACTION" ], + "example" : "CARD", + "type" : "string" + }, + "feeType" : { + "description" : "The type of fee. For further details, refer to [Product Fee Types](#tocSproductfeetypedoc).", + "enum" : [ "CASH_ADVANCE", "DEPOSIT", "DISHONOUR", "ENQUIRY", "EVENT", "EXIT", "OTHER", "PAYMENT", "PAYMENT_LATE", "PERIODIC", "PURCHASE", "REPLACEMENT", "TRANSACTION", "UPFRONT", "UPFRONT_PER_PLAN", "VARIATION", "WITHDRAWAL" ], + "example" : "CASH_ADVANCE", + "type" : "string" + }, + "feeMethodUType" : { + "description" : "The fee charge method", + "enum" : [ "fixedAmount", "rateBased", "variable" ], + "type" : "string" + }, + "fixedAmount" : { + "$ref" : "#/components/schemas/BankingFeeAmount" + }, + "rateBased" : { + "$ref" : "#/components/schemas/BankingFeeRate" + }, + "variable" : { + "$ref" : "#/components/schemas/BankingFeeRange" + }, + "feeCap" : { + "description" : "The cap amount if multiple occurrences of the fee are capped to a limit", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "feeCapPeriod" : { + "description" : "Specifies a duration over which multiple occurrences of the fee will be capped. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "currency" : { + "description" : "The currency the fee will be charged in. Assumes `AUD` if absent", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [feeType](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [feeType](#tocSproductfeetypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the fee", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this fee", + "type" : "string", + "x-cds-type" : "URIString" + }, + "discounts" : { + "description" : "An optional list of discounts to this fee that may be available", + "items" : { + "$ref" : "#/components/schemas/BankingProductDiscount" + }, + "type" : "array" + } + }, + "required" : [ "feeCategory", "feeMethodUType", "feeType", "name" ], + "type" : "object", + "x-conditional" : [ "fixedAmount", "rateBased", "variable", "additionalValue", "additionalInfo" ] + }, + "BankingFeeAmount" : { + "properties" : { + "amount" : { + "description" : "The specific amount charged for the fee each time it is incurred", + "type" : "string", + "x-cds-type" : "AmountString" + } + }, + "required" : [ "amount" ], + "type" : "object" + }, + "BankingFeeRate" : { + "properties" : { + "balanceRate" : { + "description" : "A fee rate calculated based on a proportion of the balance. One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory", + "type" : "string", + "x-cds-type" : "RateString" + }, + "transactionRate" : { + "description" : "A fee rate calculated based on a proportion of a transaction. One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory", + "type" : "string", + "x-cds-type" : "RateString" + }, + "accruedRate" : { + "description" : "A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory", + "type" : "string", + "x-cds-type" : "RateString" + }, + "accrualFrequency" : { + "description" : "The indicative frequency with which the fee is calculated on the account. Only applies if `balanceRate` or `accruedRate` is also present. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "amountRange" : { + "$ref" : "#/components/schemas/BankingFeeRange" + } + }, + "type" : "object", + "x-conditional" : [ "balanceRate", "transactionRate", "accruedRate" ] + }, + "BankingFeeRange" : { + "description" : "A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred", + "properties" : { + "feeMinimum" : { + "description" : "The minimum fee that will be charged per occurrence", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "feeMaximum" : { + "description" : "The maximum fee that will be charged per occurrence", + "type" : "string", + "x-cds-type" : "AmountString" + } + }, + "type" : "object" + }, + "BankingProductDiscount" : { + "properties" : { + "description" : { + "description" : "Description of the discount", + "type" : "string" + }, + "discountType" : { + "description" : "The type of discount. For further details, refer to [Product Discount Types](#tocSproductdiscounttypedoc)", + "enum" : [ "BALANCE", "DEPOSITS", "ELIGIBILITY_ONLY", "FEE_CAP", "PAYMENTS" ], + "type" : "string" + }, + "amount" : { + "description" : "Dollar value of the discount. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory.", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "balanceRate" : { + "description" : "A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, assumes the application and calculation frequency are the same as the corresponding fee", + "type" : "string", + "x-cds-type" : "RateString" + }, + "transactionRate" : { + "description" : "A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory.", + "type" : "string", + "x-cds-type" : "RateString" + }, + "accruedRate" : { + "description" : "A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, assumes the application and calculation frequency are the same as the corresponding fee", + "type" : "string", + "x-cds-type" : "RateString" + }, + "feeRate" : { + "description" : "A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, assumes the application and calculation frequency are the same as the corresponding fee", + "type" : "string", + "x-cds-type" : "RateString" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [discountType](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [discountType](#tocSproductdiscounttypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the discount", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this discount", + "type" : "string", + "x-cds-type" : "URIString" + }, + "eligibility" : { + "description" : "Eligibility constraints that apply to this discount. Mandatory if `discountType` is `ELIGIBILITY_ONLY`.", + "items" : { + "$ref" : "#/components/schemas/BankingProductDiscountEligibility" + }, + "type" : "array" + } + }, + "required" : [ "description", "discountType" ], + "type" : "object", + "x-conditional" : [ "accruedRate", "additionalValue", "amount", "balanceRate", "eligibility", "feeRate", "transactionRate" ] + }, + "BankingProductDiscountEligibility" : { + "properties" : { + "discountEligibilityType" : { + "description" : "The type of the specific eligibility constraint for a discount. For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc)", + "enum" : [ "BUSINESS", "EMPLOYMENT_STATUS", "INTRODUCTORY", "MAX_AGE", "MIN_AGE", "MIN_INCOME", "MIN_TURNOVER", "NATURAL_PERSON", "OTHER", "PENSION_RECIPIENT", "RESIDENCY_STATUS", "STAFF", "STUDENT" ], + "type" : "string" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this eligibility constraint", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "discountEligibilityType" ], + "type" : "object", + "x-conditional" : [ "additionalInfo", "additionalValue" ] + }, + "BankingProductDepositRateV2" : { + "properties" : { + "depositRateType" : { + "description" : "The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc). For further details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc)", + "enum" : [ "BONUS", "FIXED", "FLOATING", "MARKET_LINKED", "VARIABLE" ], + "example" : "VARIABLE", + "type" : "string" + }, + "rate" : { + "description" : "The rate to be applied", + "type" : "string", + "x-cds-type" : "RateString" + }, + "adjustmentToBase" : { + "description" : "For an adjustment `depositRateType`, the base rate that the adjustment value will apply to. The value of the `additionalValue` field may be used to further qualify the corresponding base.", + "enum" : [ "FIXED", "FLOATING", "MARKET_LINKED", "VARIABLE" ], + "example" : "FIXED", + "type" : "string" + }, + "adjustmentBundle" : { + "description" : "The name of the bundle that makes the adjustment rate applicable", + "type" : "string" + }, + "calculationFrequency" : { + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "applicationType" : { + "description" : "The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`", + "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], + "example" : "PERIODIC", + "type" : "string" + }, + "applicationFrequency" : { + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "tiers" : { + "description" : "Rate tiers applicable for this rate", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateTierV4" + }, + "type" : "array" + }, + "applicabilityConditions" : { + "description" : "Array of applicability conditions for a rate", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateConditionV2" + }, + "type" : "array" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "depositRateType", "rate" ], + "type" : "object", + "x-conditional" : [ "additionalValue" ] + }, + "BankingProductLendingRateV3" : { + "properties" : { + "lendingRateType" : { + "description" : "The type of rate (fixed, variable, etc). For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc)", + "enum" : [ "BALANCE_TRANSFER", "CASH_ADVANCE", "DISCOUNT", "FEE", "FIXED", "FLOATING", "MARKET_LINKED", "PENALTY", "PURCHASE", "VARIABLE" ], + "example" : "DISCOUNT", + "type" : "string" + }, + "rate" : { + "description" : "The rate to be applied. Mandatory unless the `lendingRateType` `FEE` is supplied", + "type" : "string", + "x-cds-type" : "RateString" + }, + "referenceRate" : { + "description" : "The reference or index rate for this account option, or variant", + "type" : "string", + "x-cds-type" : "RateString" + }, + "comparisonRate" : { + "description" : "A comparison rate equivalent for this rate. The comparison rate associated with an 'adjustment' [lendingRateType](#tocSproductlendingratetypedoc) is the full comparison rate assuming the adjusted rate is available for origination.", + "type" : "string", + "x-cds-type" : "RateString" + }, + "revertRate" : { + "description" : "The revert rate applicable after the respective rate expires. For example, `FIXED`, or `INTEREST_ONLY` rates may revert to a different rate when those terms expire. Expected where this product will continue to operate with a new 'revert' rate.", + "type" : "string", + "x-cds-type" : "RateString" + }, + "revertProductId" : { + "description" : "A reference to a `productId` that the associated product will revert to after the respective rate terms expire. For example, `FIXED`, or `INTEREST_ONLY` rates may revert to a different rate when those terms expire. Expected if the product will change when the rate reverts to different terms.", + "type" : "string" + }, + "adjustmentToBase" : { + "description" : "For an adjustment `lendingRateType`, the base rate that the adjustment value will apply to. The values of the `repaymentType`, `loanPurpose` and `additionalValue` fields may be used to further qualify the corresponding base.", + "enum" : [ "BALANCE_TRANSFER", "CASH_ADVANCE", "FEE", "FIXED", "FLOATING", "MARKET_LINKED", "PURCHASE", "VARIABLE" ], + "example" : "BALANCE_TRANSFER", + "type" : "string" + }, + "adjustmentBundle" : { + "description" : "The name of the bundle that makes the adjustment rate applicable", + "type" : "string" + }, + "calculationFrequency" : { + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "applicationType" : { + "description" : "The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`", + "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], + "example" : "PERIODIC", + "type" : "string" + }, + "applicationFrequency" : { + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "interestPaymentDue" : { + "description" : "When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered", + "enum" : [ "IN_ADVANCE", "IN_ARREARS" ], + "type" : "string" + }, + "repaymentType" : { + "description" : "Options in place for repayments. If absent, the lending rate is applicable to all repayment types", + "enum" : [ "INTEREST_ONLY", "PRINCIPAL_AND_FEE", "PRINCIPAL_AND_INTEREST" ], + "type" : "string" + }, + "loanPurpose" : { + "description" : "The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes", + "enum" : [ "INVESTMENT", "OWNER_OCCUPIED" ], + "type" : "string" + }, + "tiers" : { + "description" : "Rate tiers applicable for this rate", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateTierV4" + }, + "type" : "array" + }, + "applicabilityConditions" : { + "description" : "Array of applicability conditions for a rate", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateConditionV2" + }, + "type" : "array" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "lendingRateType" ], + "type" : "object", + "x-conditional" : [ "additionalValue", "rate" ] + }, + "BankingProductRateTierV4" : { + "description" : "Defines the criteria and conditions for which a rate applies", + "properties" : { + "name" : { + "description" : "A display name for the tier", + "type" : "string" + }, + "unitOfMeasure" : { + "description" : "The unit of measure that applies to the `minimumValue` and `maximumValue` values, e.g.:", + "enum" : [ "DAY", "DOLLAR", "MONTH", "PERCENT" ], + "type" : "string" + }, + "minimumValue" : { + "description" : "The number of `unitOfMeasure` units that form the lower bound of the tier. The tier should be inclusive of this value", + "type" : "string" + }, + "maximumValue" : { + "description" : "The number of `unitOfMeasure` units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as `minimumValue`. Where this is the same as the `minimumValue` value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.", + "type" : "string" + }, + "rateApplicationMethod" : { + "description" : "The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')", + "enum" : [ "PER_TIER", "WHOLE_BALANCE" ], + "type" : "string" + }, + "applicabilityConditions" : { + "description" : "Array of applicability conditions for a tier", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateConditionV2" + }, + "type" : "array" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate tier", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate tier", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "minimumValue", "name", "unitOfMeasure" ], + "type" : "object" + }, + "BankingProductRateConditionV2" : { + "description" : "Defines a condition for the applicability of a tiered rate", + "properties" : { + "rateApplicabilityType" : { + "description" : "Category of applicability condition associated with the rate. For more information refer to [Rate and Tier Applicability Types](#tocSbankingproductrateconditiondoc)", + "enum" : [ "DEPOSITS_MIN", "DEPOSITS_MIN_AMOUNT", "DEPOSIT_BALANCE_INCREASED", "EXISTING_CUST", "NEW_ACCOUNTS", "NEW_CUSTOMER", "NEW_CUSTOMER_TO_GROUP", "ONLINE_ONLY", "OTHER", "PURCHASES_MIN", "WITHDRAWALS_MAX", "WITHDRAWALS_MAX_AMOUNT" ], + "example" : "NEW_CUSTOMER", + "type" : "string" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the `rateApplicabilityType` specified. Whether mandatory or not is dependent on the value of [rateApplicabilityType](#tocSbankingproductrateconditiondoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the condition", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this condition", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "type" : "object", + "x-conditional" : [ "additionalValue", "additionalInfo" ] + }, + "BankingProductInstalments" : { + "properties" : { + "maximumPlanCount" : { + "description" : "Total number of plans that may be created", + "example" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "instalmentsLimit" : { + "description" : "Maximum combined limit of all instalment plans that may be created", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "minimumPlanValue" : { + "description" : "Minimum value that can be opened as an instalment plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "maximumPlanValue" : { + "description" : "Maximum value that can be opened as an instalment plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "minimumSplit" : { + "description" : "Minimum number of instalment payments a plan can be created with", + "example" : 4, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "maximumSplit" : { + "description" : "Maximum number of instalment payments a plan can be created with", + "example" : 4, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + } + }, + "required" : [ "instalmentsLimit", "maximumPlanCount", "maximumPlanValue", "maximumSplit", "minimumPlanValue", "minimumSplit" ], + "type" : "object" + }, + "ResponseBankingAccountListV3" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingAccountListV3_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "BankingAccountV3" : { + "properties" : { + "accountId" : { + "description" : "A unique ID of the account adhering to the standards for ID permanence", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "creationDate" : { + "description" : "Date that the account was created (if known)", + "type" : "string", + "x-cds-type" : "DateString" + }, + "displayName" : { + "description" : "The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the [MaskedAccountString](#common-field-types) common type.", + "type" : "string" + }, + "nickname" : { + "description" : "A customer supplied nick name for the account", + "type" : "string" + }, + "openStatus" : { + "default" : "OPEN", + "description" : "Open or closed status for the account. If not present then `OPEN` is assumed", + "enum" : [ "CLOSED", "OPEN" ], + "type" : "string" + }, + "isOwned" : { + "default" : true, + "description" : "Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then `true` is assumed", + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "accountOwnership" : { + "description" : "Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers", + "enum" : [ "UNKNOWN", "ONE_PARTY", "TWO_PARTY", "MANY_PARTY", "OTHER" ], + "type" : "string" + }, + "maskedNumber" : { + "description" : "A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number", + "type" : "string", + "x-cds-type" : "MaskedAccountString" + }, + "productCategory" : { + "$ref" : "#/components/schemas/BankingProductCategoryV2" + }, + "productName" : { + "description" : "The unique identifier of the account as defined by the data holder (akin to model number for the account)", + "type" : "string" + } + }, + "required" : [ "accountId", "accountOwnership", "displayName", "maskedNumber", "productCategory", "productName" ], + "type" : "object" + }, + "ResponseBankingAccountByIdV4" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/BankingAccountDetailV4" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links" ], + "type" : "object" + }, + "BankingAccountDetailV4" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingAccountV3" + }, { + "$ref" : "#/components/schemas/BankingAccountDetailV4_allOf" + } ] + }, + "BankingAccountInstalments" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingProductInstalments" + }, { + "$ref" : "#/components/schemas/BankingAccountInstalments_allOf" + } ], + "description" : "Details of instalment features on the account" + }, + "BankingInstalmentPlans" : { + "properties" : { + "planNickname" : { + "description" : "The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels", + "type" : "string" + }, + "creationDate" : { + "description" : "The date the plan was created", + "type" : "string", + "x-cds-type" : "DateString" + }, + "amount" : { + "description" : "The total amount of the plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "duration" : { + "description" : "The original expected repayment duration. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "instalmentInterval" : { + "description" : "The expected repayment interval. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "schedule" : { + "description" : "Array of expected repayment amounts and dates", + "items" : { + "$ref" : "#/components/schemas/BankingInstalmentPlanSchedule" + }, + "type" : "array" + } + }, + "required" : [ "amount", "creationDate", "duration", "instalmentInterval", "planNickname", "schedule" ], + "type" : "object" + }, + "BankingInstalmentPlanSchedule" : { + "properties" : { + "amountDue" : { + "description" : "Amount due with this repayment", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "dueDate" : { + "description" : "Date this repayment is due", + "type" : "string", + "x-cds-type" : "DateString" + } + }, + "required" : [ "amountDue", "dueDate" ], + "type" : "object" + }, + "BankingTermDepositAccountV2" : { + "properties" : { + "lodgementDate" : { + "description" : "The lodgement date of the original deposit", + "type" : "string", + "x-cds-type" : "DateString" + }, + "maturityDate" : { + "description" : "Maturity date for the term deposit", + "type" : "string", + "x-cds-type" : "DateString" + }, + "maturityAmount" : { + "description" : "Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "maturityCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "maturityInstructions" : { + "description" : "Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments", + "enum" : [ "HOLD_ON_MATURITY", "PAID_OUT_AT_MATURITY", "ROLLED_OVER" ], + "type" : "string" + }, + "depositRateDetail" : { + "$ref" : "#/components/schemas/BankingDepositRateDetail" + } + }, + "required" : [ "lodgementDate", "maturityDate", "maturityInstructions" ], + "type" : "object" + }, + "BankingDepositRateDetail" : { + "description" : "Detail about deposit rates and adjustments", + "properties" : { + "depositRateType" : { + "description" : "The type of rate", + "enum" : [ "FIXED", "FLOATING", "MARKET_LINKED", "VARIABLE" ], + "type" : "string" + }, + "referenceRate" : { + "description" : "Reference rate for this account type and terms", + "type" : "string", + "x-cds-type" : "RateString" + }, + "effectiveRate" : { + "description" : "Rate being paid for this deposit", + "type" : "string", + "x-cds-type" : "RateString" + }, + "calculationFrequency" : { + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "applicationType" : { + "description" : "The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`", + "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], + "example" : "PERIODIC", + "type" : "string" + }, + "applicationFrequency" : { + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "tiers" : { + "description" : "Rate tiers applicable for this rate", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateTierV4" + }, + "type" : "array" + }, + "applicabilityConditions" : { + "description" : "Array of applicability conditions for a rate", + "items" : { + "$ref" : "#/components/schemas/BankingProductRateConditionV2" + }, + "type" : "array" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate", + "type" : "string", + "x-cds-type" : "URIString" + }, + "adjustments" : { + "description" : "Adjustments applicable to the rate", + "items" : { + "$ref" : "#/components/schemas/BankingRateAdjustments" + }, + "type" : "array" + } + }, + "required" : [ "depositRateType", "effectiveRate", "referenceRate" ], + "type" : "object", + "x-conditional" : [ "additionalValue" ] + }, + "BankingRateAdjustments" : { + "description" : "Information about adjustments to an associated rate", + "properties" : { + "adjustmentType" : { + "description" : "The type of adjustment. For further details, refer to [Deposit Adjustment Rate Types](#tocSproductdepositadjustmentratetypedoc) and [Lending Adjustment Rate Types](#tocSproductlendingadjustmentratetypedoc)", + "enum" : [ "BONUS", "DISCOUNT", "PENALTY" ], + "type" : "string" + }, + "amount" : { + "description" : "Adjustment amount if not a rate", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "currency" : { + "description" : "Adjustment amount currency. If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "rate" : { + "description" : "Adjustment to an associated base rate. The impact to the base rate depends on the type of base (deposit or loan) and the `adjustmentType` (bonus, discount or penalty)", + "type" : "string", + "x-cds-type" : "RateString" + }, + "adjustmentBundle" : { + "description" : "The name of the bundle that makes the adjustment rate applicable", + "type" : "string" + }, + "adjustmentPeriod" : { + "description" : "The original or standard adjustment period after which the adjustment ends. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "adjustmentEndDate" : { + "description" : "Date the adjustment will cease to apply", + "type" : "string", + "x-cds-type" : "DateString" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the `adjustmentType` specified. Whether mandatory or not is dependent on the value of `adjustmentType`", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "adjustmentType" ], + "type" : "object", + "x-conditional" : [ "additionalValue" ] + }, + "BankingCreditCardAccountV2" : { + "properties" : { + "minPaymentAmount" : { + "description" : "The minimum payment amount due for the next card payment", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "paymentDueAmount" : { + "description" : "The amount due for the next card payment", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "paymentCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "paymentDueDate" : { + "description" : "Date that the next payment for the card is due", + "type" : "string", + "x-cds-type" : "DateString" + }, + "cardPlans" : { + "description" : "Card plans sorted in order of repayment allocation. Repayments are allocated to the first entry first.", + "items" : { + "$ref" : "#/components/schemas/BankingCreditCardPlan" + }, + "type" : "array" + } + }, + "required" : [ "cardPlans", "minPaymentAmount", "paymentDueAmount", "paymentDueDate" ], + "type" : "object" + }, + "BankingCreditCardPlan" : { + "properties" : { + "nickname" : { + "description" : "A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided", + "type" : "string" + }, + "planType" : { + "$ref" : "#/components/schemas/BankingCardPlanTypes" + }, + "atExpiryBalanceTransfersTo" : { + "$ref" : "#/components/schemas/BankingCardPlanTypes" + }, + "planCreationDate" : { + "description" : "Date this plan was created", + "type" : "string", + "x-cds-type" : "DateString" + }, + "planPeriod" : { + "description" : "Original duration for this plan. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "planEndDate" : { + "description" : "Date this plan is expected to end", + "type" : "string", + "x-cds-type" : "DateString" + }, + "planReferenceRate" : { + "description" : "Reference rate for this plan type", + "type" : "string", + "x-cds-type" : "RateString" + }, + "planEffectiveRate" : { + "description" : "Effective rate for this plan", + "type" : "string", + "x-cds-type" : "RateString" + }, + "minPaymentAmount" : { + "description" : "The minimum payment amount due for this plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "paymentDueAmount" : { + "description" : "The amount due for this plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "paymentCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "paymentDueDate" : { + "description" : "Date that the next payment for this plan is due", + "type" : "string", + "x-cds-type" : "DateString" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the plan", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this plan", + "type" : "string", + "x-cds-type" : "URIString" + }, + "interestFreePeriods" : { + "description" : "Defines when any current or future interest-free periods will be applicable to this plan. The interest-free period itself will be specified through an associated `INTEREST_FREE` plan feature.", + "items" : { + "$ref" : "#/components/schemas/BankingCreditCardPlan_interestFreePeriods" + }, + "type" : "array" + }, + "adjustments" : { + "description" : "Adjustments applicable to the plan rate", + "items" : { + "$ref" : "#/components/schemas/BankingRateAdjustments" + }, + "type" : "array" + }, + "planFeatures" : { + "description" : "Array of features available or applicable to this plan", + "items" : { + "$ref" : "#/components/schemas/BankingCardPlanFeatures" + }, + "type" : "array" + } + }, + "required" : [ "planEffectiveRate", "planReferenceRate", "planType" ], + "type" : "object" + }, + "BankingCardPlanTypes" : { + "enum" : [ "BALANCE_TRANSFER_PLAN", "CASH_ADVANCE_PLAN", "INSTALMENT_PLAN", "PURCHASE_PLAN" ], + "example" : "PURCHASE_PLAN", + "type" : "string" + }, + "BankingCardPlanFeatures" : { + "description" : "Features and limitations available or applicable to the associated plan", + "properties" : { + "planFeatureType" : { + "description" : "Type of feature or limitation. For details refer to [Plan Feature Types](#tocSbankingproductplanfeaturedoc).", + "enum" : [ "BALANCE_TRANSFER_ENDS_INTEREST_FREE", "INSTALMENTS", "INTEREST_FREE" ], + "type" : "string" + }, + "period" : { + "description" : "Original duration of the feature or limitation. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "endDate" : { + "description" : "Date that the feature or limitation will cease to apply", + "type" : "string", + "x-cds-type" : "DateString" + }, + "additionalValue" : { + "description" : "Detail associated with the planFeatureType. For details refer to [Plan Feature Types](#tocSbankingproductplanfeaturedoc).", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the plan feature", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this plan feature", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "planFeatureType" ], + "type" : "object", + "x-conditional" : [ "additionalValue" ] + }, + "BankingDepositAccount" : { + "properties" : { + "lodgementDate" : { + "description" : "The lodgement date of the deposit", + "type" : "string", + "x-cds-type" : "DateString" + }, + "nickname" : { + "description" : "A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided", + "type" : "string", + "x-cds-type" : "DateString" + }, + "depositRateDetail" : { + "$ref" : "#/components/schemas/BankingDepositRateDetail" + } + }, + "type" : "object" + }, + "BankingLoanAccountV3" : { + "properties" : { + "originalStartDate" : { + "description" : "Optional original start date for the loan", + "type" : "string", + "x-cds-type" : "DateString" + }, + "originalLoanAmount" : { + "description" : "Optional original loan value", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "originalLoanCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "loanEndDate" : { + "description" : "Date that the loan is due to be repaid in full", + "type" : "string", + "x-cds-type" : "DateString" + }, + "nextInstalmentDate" : { + "description" : "Next date that an instalment is required", + "type" : "string", + "x-cds-type" : "DateString" + }, + "minInstalmentAmount" : { + "description" : "Minimum amount of next instalment", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "minInstalmentCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "maxRedraw" : { + "description" : "Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "maxRedrawCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "minRedraw" : { + "description" : "Minimum redraw amount", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "minRedrawCurrency" : { + "description" : "If absent assumes `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "offsetAccountEnabled" : { + "description" : "Set to `true` if one or more offset accounts are configured for this loan account", + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "offsetAccountIds" : { + "description" : "The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that `offsetAccountEnabled` is set to `true` but the `offsetAccountIds` field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation", + "items" : { + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "type" : "array" + }, + "lendingRateDetail" : { + "description" : "Information about lending rates and adjustments", + "items" : { + "$ref" : "#/components/schemas/BankingLendingRateDetail" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "BankingLendingRateDetail" : { + "description" : "Information about lending rates and adjustments. Future-dated rates allow scheduled rate changes such as 'revert' rates to be specified.", + "properties" : { + "loanPurpose" : { + "description" : "The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes", + "enum" : [ "INVESTMENT", "OWNER_OCCUPIED" ], + "example" : "OWNER_OCCUPIED", + "type" : "string" + }, + "repaymentType" : { + "default" : "PRINCIPAL_AND_INTEREST", + "description" : "Options in place for repayments. If absent defaults to `PRINCIPAL_AND_INTEREST`", + "enum" : [ "INTEREST_ONLY", "PRINCIPAL_AND_FEE", "PRINCIPAL_AND_INTEREST" ], + "example" : "PRINCIPAL_AND_INTEREST", + "type" : "string" + }, + "rateStartDate" : { + "description" : "Date this rate will begin to apply. If not specified, the rate is currently applicable to the account.", + "type" : "string", + "x-cds-type" : "DateString" + }, + "rateEndDate" : { + "description" : "Date this rate will cease to apply. If not specified, the rate on the account is not scheduled to change or 'revert' to a different rate setting.", + "type" : "string", + "x-cds-type" : "DateString" + }, + "revertProductId" : { + "description" : "The `productId` of the product that this account will revert to at the specified `rateEndDate`", + "type" : "string" + }, + "repaymentUType" : { + "description" : "The type of structure to present account specific fields", + "enum" : [ "fixedRate", "variableRate", "feeAmount" ], + "type" : "string" + }, + "fixedRate" : { + "$ref" : "#/components/schemas/BankingLendingRateFixed" + }, + "variableRate" : { + "$ref" : "#/components/schemas/BankingLendingRateVariable" + }, + "feeAmount" : { + "$ref" : "#/components/schemas/BankingLendingFee" + }, + "adjustments" : { + "description" : "Adjustments applicable to the rate or fee", + "items" : { + "$ref" : "#/components/schemas/BankingRateAdjustments" + }, + "type" : "array" + } + }, + "required" : [ "loanCostType", "repaymentUType" ], + "type" : "object" + }, + "BankingLendingRateFixed" : { + "properties" : { + "fixedPeriod" : { + "description" : "The period of time for the fixed rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "referenceRate" : { + "description" : "Reference rate for this account type and terms", + "type" : "string", + "x-cds-type" : "RateString" + }, + "effectiveRate" : { + "description" : "The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call", + "type" : "string", + "x-cds-type" : "RateString" + }, + "calculationFrequency" : { + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "applicationType" : { + "description" : "The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`", + "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], + "example" : "PERIODIC", + "type" : "string" + }, + "applicationFrequency" : { + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "interestPaymentDue" : { + "description" : "When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered", + "enum" : [ "IN_ADVANCE", "IN_ARREARS" ], + "type" : "string" + }, + "repaymentFrequency" : { + "description" : "The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "effectiveRate", "referenceRate" ], + "type" : "object" + }, + "BankingLendingRateVariable" : { + "properties" : { + "variableRateType" : { + "description" : "The type of variable rate", + "enum" : [ "FLOATING", "MARKET_LINKED", "VARIABLE" ], + "type" : "string" + }, + "referenceRate" : { + "description" : "Reference rate for this account type and terms", + "type" : "string", + "x-cds-type" : "RateString" + }, + "effectiveRate" : { + "description" : "The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call", + "type" : "string", + "x-cds-type" : "RateString" + }, + "calculationFrequency" : { + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "applicationType" : { + "description" : "The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`", + "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], + "example" : "PERIODIC", + "type" : "string" + }, + "applicationFrequency" : { + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "interestPaymentDue" : { + "description" : "When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered", + "enum" : [ "IN_ADVANCE", "IN_ARREARS" ], + "type" : "string" + }, + "repaymentFrequency" : { + "description" : "The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "additionalValue" : { + "description" : "Generic field containing additional information relevant to the [variableRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [variableRateType](#tocSproductlendingratetypedoc)", + "type" : "string" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the rate", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this rate", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "effectiveRate", "referenceRate", "variableRateType" ], + "type" : "object", + "x-conditional" : [ "additionalValue" ] + }, + "BankingLendingFee" : { + "properties" : { + "amount" : { + "description" : "Minimum payment due at specified `repaymentFrequency`", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "currency" : { + "description" : "Currency of the fee. `AUD` assumed if not present", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "repaymentDue" : { + "description" : "When loan payments are due to be paid within each period", + "enum" : [ "IN_ADVANCE", "IN_ARREARS" ], + "type" : "string" + }, + "repaymentFrequency" : { + "description" : "The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "additionalInfo" : { + "description" : "Display text providing more information on the fee", + "type" : "string" + }, + "additionalInfoUri" : { + "description" : "Link to a web page with more information on this fee", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "amount" ], + "type" : "object" + }, + "ResponseBankingTransactionList" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingTransactionList_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginatedTransaction" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "BankingTransaction" : { + "properties" : { + "accountId" : { + "description" : "ID of the account for which transactions are provided", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "transactionId" : { + "description" : "A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if `isDetailAvailable` is set to true.", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "isDetailAvailable" : { + "description" : "`true` if extended information is available using the transaction detail endpoint. `false` if extended data is not available", + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "type" : { + "description" : "The type of the transaction", + "enum" : [ "DIRECT_DEBIT", "FEE", "INTEREST_CHARGED", "INTEREST_PAID", "OTHER", "PAYMENT", "TRANSFER_INCOMING", "TRANSFER_OUTGOING" ], + "type" : "string" + }, + "status" : { + "description" : "Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction", + "enum" : [ "PENDING", "POSTED" ], + "type" : "string" + }, + "description" : { + "description" : "The transaction description as applied by the financial institution", + "type" : "string" + }, + "postingDateTime" : { + "description" : "The time the transaction was posted. This field is Mandatory if the transaction has status `POSTED`. This is the time that appears on a standard statement", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "valueDateTime" : { + "description" : "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "executionDateTime" : { + "description" : "The time the transaction was executed by the originating customer, if available", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "amount" : { + "description" : "The value of the transaction. Negative values mean money was outgoing from the account", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "currency" : { + "description" : "The currency for the transaction amount. `AUD` assumed if not present", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "reference" : { + "description" : "The reference for the transaction provided by the originating institution. Empty string if no data provided", + "type" : "string" + }, + "merchantName" : { + "description" : "Name of the merchant for an outgoing payment to a merchant", + "type" : "string" + }, + "merchantCategoryCode" : { + "description" : "The merchant category code (or MCC) for an outgoing payment to a merchant", + "type" : "string" + }, + "billerCode" : { + "description" : "BPAY Biller Code for the transaction (if available)", + "type" : "string" + }, + "billerName" : { + "description" : "Name of the BPAY biller for the transaction (if available)", + "type" : "string" + }, + "crn" : { + "description" : "BPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.", + "type" : "string" + }, + "apcaNumber" : { + "description" : "6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.", + "type" : "string" + } + }, + "required" : [ "accountId", "amount", "description", "isDetailAvailable", "reference", "status", "type" ], + "type" : "object", + "x-conditional" : [ "transactionId", "postingDateTime", "crn" ] + }, + "ResponseBankingTransactionById" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/BankingTransactionDetail" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links" ], + "type" : "object" + }, + "BankingTransactionDetail" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingTransaction" + }, { + "$ref" : "#/components/schemas/BankingTransactionDetail_allOf" + } ] + }, + "ResponseBankingAccountsBalanceList" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "ResponseBankingAccountsBalanceById" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/BankingBalance" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links" ], + "type" : "object" + }, + "BankingBalance" : { + "properties" : { + "accountId" : { + "description" : "A unique ID of the account adhering to the standards for ID permanence", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "currentBalance" : { + "description" : "The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "availableBalance" : { + "description" : "Balance representing the amount of funds available for transfer. Assumed to be zero or positive", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "creditLimit" : { + "description" : "Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "amortisedLimit" : { + "description" : "Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "currency" : { + "description" : "The currency for the balance amounts. If absent assumed to be `AUD`", + "type" : "string", + "x-cds-type" : "CurrencyString" + }, + "purses" : { + "description" : "Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards", + "items" : { + "$ref" : "#/components/schemas/BankingBalancePurse" + }, + "type" : "array" + } + }, + "required" : [ "accountId", "availableBalance", "currentBalance" ], + "type" : "object" + }, + "BankingBalancePurse" : { + "properties" : { + "amount" : { + "description" : "The balance available for this additional currency purse", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "currency" : { + "description" : "The currency for the purse", + "type" : "string", + "x-cds-type" : "CurrencyString" + } + }, + "required" : [ "amount" ], + "type" : "object" + }, + "ResponseBankingPayeeListV2" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingPayeeListV2_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "ResponseBankingPayeeByIdV2" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/BankingPayeeDetailV2" + }, + "links" : { + "$ref" : "#/components/schemas/Links" + }, + "meta" : { + "$ref" : "#/components/schemas/Meta" + } + }, + "required" : [ "data", "links" ], + "type" : "object" + }, + "BankingPayeeV2" : { + "properties" : { + "payeeId" : { + "description" : "ID of the payee adhering to the rules of ID permanence", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "nickname" : { + "description" : "The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels", + "type" : "string" + }, + "description" : { + "description" : "A description of the payee provided by the customer", + "type" : "string" + }, + "type" : { + "description" : "The type of payee.", + "enum" : [ "BILLER", "DIGITAL_WALLET", "DOMESTIC", "INTERNATIONAL" ], + "type" : "string" + }, + "creationDate" : { + "description" : "The date the payee was created by the customer", + "type" : "string", + "x-cds-type" : "DateString" + } + }, + "required" : [ "nickname", "payeeId", "type" ], + "type" : "object" + }, + "BankingPayeeDetailV2" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingPayeeV2" + }, { + "$ref" : "#/components/schemas/BankingPayeeDetailV2_allOf" + } ] + }, + "BankingDomesticPayee" : { + "properties" : { + "payeeAccountUType" : { + "description" : "Type of account object included. Valid values are: ", + "enum" : [ "account", "card", "payId" ], + "type" : "string" + }, + "account" : { + "$ref" : "#/components/schemas/BankingDomesticPayeeAccount" + }, + "card" : { + "$ref" : "#/components/schemas/BankingDomesticPayeeCard" + }, + "payId" : { + "$ref" : "#/components/schemas/BankingDomesticPayeePayId" + } + }, + "required" : [ "payeeAccountUType" ], + "type" : "object", + "x-conditional" : [ "account", "card", "payId" ] + }, + "BankingDomesticPayeeAccount" : { + "properties" : { + "accountName" : { + "description" : "Name of the account to pay to", + "type" : "string" + }, + "bsb" : { + "description" : "BSB of the account to pay to", + "type" : "string" + }, + "accountNumber" : { + "description" : "Number of the account to pay to", + "type" : "string" + } + }, + "required" : [ "accountNumber", "bsb" ], + "type" : "object" + }, + "BankingDomesticPayeeCard" : { + "properties" : { + "cardNumber" : { + "description" : "Name of the account to pay to", + "type" : "string", + "x-cds-type" : "MaskedPANString" + } + }, + "required" : [ "cardNumber" ], + "type" : "object" + }, + "BankingDomesticPayeePayId" : { + "properties" : { + "name" : { + "description" : "The name assigned to the PayID by the owner of the PayID", + "type" : "string" + }, + "identifier" : { + "description" : "The identifier of the PayID (dependent on type)", + "type" : "string" + }, + "type" : { + "description" : "The type of the PayID", + "enum" : [ "ABN", "EMAIL", "ORG_IDENTIFIER", "TELEPHONE" ], + "type" : "string" + } + }, + "required" : [ "identifier", "type" ], + "type" : "object" + }, + "BankingBillerPayee" : { + "properties" : { + "billerCode" : { + "description" : "BPAY Biller Code of the Biller", + "type" : "string" + }, + "crn" : { + "description" : "BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.", + "type" : "string" + }, + "billerName" : { + "description" : "Name of the Biller", + "type" : "string" + } + }, + "required" : [ "billerCode", "billerName" ], + "type" : "object", + "x-conditional" : [ "crn" ] + }, + "BankingInternationalPayee" : { + "properties" : { + "beneficiaryDetails" : { + "$ref" : "#/components/schemas/BankingInternationalPayee_beneficiaryDetails" + }, + "bankDetails" : { + "$ref" : "#/components/schemas/BankingInternationalPayee_bankDetails" + } + }, + "required" : [ "bankDetails", "beneficiaryDetails" ], + "type" : "object" + }, + "BankingDigitalWalletPayee" : { + "properties" : { + "name" : { + "description" : "The display name of the wallet as given by the customer, else a default value defined by the data holder", + "type" : "string" + }, + "identifier" : { + "description" : "The identifier of the digital wallet (dependent on type)", + "type" : "string" + }, + "type" : { + "description" : "The type of the digital wallet identifier", + "enum" : [ "EMAIL", "CONTACT_NAME", "TELEPHONE" ], + "type" : "string" + }, + "provider" : { + "description" : "The provider of the digital wallet", + "enum" : [ "PAYPAL_AU", "OTHER" ], + "type" : "string" + } + }, + "required" : [ "identifier", "name", "provider", "type" ], + "type" : "object" + }, + "ResponseBankingDirectDebitAuthorisationList" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "BankingDirectDebit" : { + "properties" : { + "accountId" : { + "description" : "A unique ID of the account adhering to the standards for ID permanence.", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "authorisedEntity" : { + "$ref" : "#/components/schemas/BankingAuthorisedEntity" + }, + "lastDebitDateTime" : { + "description" : "The date and time of the last debit executed under this authorisation", + "type" : "string", + "x-cds-type" : "DateTimeString" + }, + "lastDebitAmount" : { + "description" : "The amount of the last debit executed under this authorisation", + "type" : "string", + "x-cds-type" : "AmountString" + } + }, + "required" : [ "accountId", "authorisedEntity" ], + "type" : "object" + }, + "BankingAuthorisedEntity" : { + "properties" : { + "description" : { + "description" : "Description of the authorised entity derived from previously executed direct debits", + "type" : "string" + }, + "financialInstitution" : { + "description" : "Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme", + "type" : "string" + }, + "abn" : { + "description" : "Australian Business Number for the authorised entity", + "type" : "string" + }, + "acn" : { + "description" : "Australian Company Number for the authorised entity", + "type" : "string" + }, + "arbn" : { + "description" : "Australian Registered Body Number for the authorised entity", + "type" : "string" + } + }, + "type" : "object", + "x-conditional" : [ "financialInstitution" ] + }, + "ResponseBankingScheduledPaymentsListV2" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2_data" + }, + "links" : { + "$ref" : "#/components/schemas/LinksPaginated" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaPaginated" + } + }, + "required" : [ "data", "links", "meta" ], + "type" : "object" + }, + "BankingScheduledPaymentV2" : { + "properties" : { + "scheduledPaymentId" : { + "description" : "A unique ID of the scheduled payment adhering to the standards for ID permanence", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "nickname" : { + "description" : "The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels", + "type" : "string" + }, + "payerReference" : { + "description" : "The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided", + "type" : "string" + }, + "payeeReference" : { + "description" : "The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided", + "type" : "string" + }, + "status" : { + "description" : "Indicates whether the schedule is currently active. The value `SKIP` is equivalent to `ACTIVE` except that the customer has requested the next normal occurrence to be skipped.", + "enum" : [ "ACTIVE", "INACTIVE", "SKIP" ], + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentFrom" + }, + "paymentSet" : { + "items" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentSetV2" + }, + "type" : "array" + }, + "recurrence" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrence" + } + }, + "required" : [ "from", "payerReference", "paymentSet", "recurrence", "scheduledPaymentId", "status" ], + "type" : "object", + "x-conditional" : [ "payeeReference" ] + }, + "BankingScheduledPaymentSetV2" : { + "description" : "The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry", + "properties" : { + "to" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentToV2" + }, + "isAmountCalculated" : { + "description" : "Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed", + "type" : "boolean", + "x-cds-type" : "Boolean" + }, + "amount" : { + "description" : "The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "currency" : { + "description" : "The currency for the payment. `AUD` assumed if not present", + "type" : "string", + "x-cds-type" : "CurrencyString" + } + }, + "required" : [ "to" ], + "type" : "object", + "x-conditional" : [ "amount" ] + }, + "BankingScheduledPaymentToV2" : { + "description" : "Object containing details of the destination of the payment. Used to specify a variety of payment destination types", + "properties" : { + "toUType" : { + "description" : "The type of object provided that specifies the destination of the funds for the payment.", + "enum" : [ "accountId", "biller", "digitalWallet", "domestic", "international", "payeeId" ], + "type" : "string" + }, + "accountId" : { + "description" : "Present if `toUType` is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "payeeId" : { + "description" : "Present if `toUType` is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a `payeeId` should not be provided and the full payee details should be provided instead", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "nickname" : { + "description" : "The short display name of the payee as provided by the customer unless `toUType` is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels", + "type" : "string" + }, + "payeeReference" : { + "description" : "The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.", + "type" : "string" + }, + "digitalWallet" : { + "$ref" : "#/components/schemas/BankingDigitalWalletPayee" + }, + "domestic" : { + "$ref" : "#/components/schemas/BankingDomesticPayee" + }, + "biller" : { + "$ref" : "#/components/schemas/BankingBillerPayee" + }, + "international" : { + "$ref" : "#/components/schemas/BankingInternationalPayee" + } + }, + "required" : [ "toUType" ], + "type" : "object", + "x-conditional" : [ "accountId", "payeeId", "digitalWallet", "domestic", "biller", "international", "nickname", "payeeReference" ] + }, + "BankingScheduledPaymentFrom" : { + "description" : "Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object", + "properties" : { + "accountId" : { + "description" : "ID of the account that is the source of funds for the payment", + "type" : "string", + "x-cds-type" : "ASCIIString" + } + }, + "required" : [ "accountId" ], + "type" : "object" + }, + "BankingScheduledPaymentRecurrence" : { + "description" : "Object containing the detail of the schedule for the payment", + "properties" : { + "nextPaymentDate" : { + "description" : "The date of the next payment under the recurrence schedule", + "type" : "string", + "x-cds-type" : "DateString" + }, + "recurrenceUType" : { + "description" : "The type of recurrence used to define the schedule", + "enum" : [ "eventBased", "intervalSchedule", "lastWeekDay", "onceOff" ], + "type" : "string" + }, + "onceOff" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceOnceOff" + }, + "intervalSchedule" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceIntervalSchedule" + }, + "lastWeekDay" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekday" + }, + "eventBased" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceEventBased" + } + }, + "required" : [ "recurrenceUType" ], + "type" : "object", + "x-conditional" : [ "onceOff", "intervalSchedule", "lastWeekDay", "eventBased" ] + }, + "BankingScheduledPaymentRecurrenceOnceOff" : { + "description" : "Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff", + "properties" : { + "paymentDate" : { + "description" : "The scheduled date for the once off payment", + "type" : "string", + "x-cds-type" : "DateString" + } + }, + "required" : [ "paymentDate" ], + "type" : "object" + }, + "BankingScheduledPaymentRecurrenceIntervalSchedule" : { + "description" : "Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule", + "properties" : { + "finalPaymentDate" : { + "description" : "The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely", + "type" : "string", + "x-cds-type" : "DateString" + }, + "paymentsRemaining" : { + "description" : "Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely", + "example" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "nonBusinessDayTreatment" : { + "default" : "ON", + "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored", + "enum" : [ "AFTER", "BEFORE", "ON", "ONLY" ], + "type" : "string" + }, + "intervals" : { + "description" : "An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry", + "items" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentInterval" + }, + "type" : "array" + } + }, + "required" : [ "intervals" ], + "type" : "object" + }, + "BankingScheduledPaymentInterval" : { + "properties" : { + "interval" : { + "description" : "An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "dayInInterval" : { + "description" : "Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.", + "type" : "string", + "x-cds-type" : "ExternalRef" + } + }, + "required" : [ "interval" ], + "type" : "object" + }, + "BankingScheduledPaymentRecurrenceLastWeekday" : { + "description" : "Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay", + "properties" : { + "finalPaymentDate" : { + "description" : "The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely", + "type" : "string", + "x-cds-type" : "DateString" + }, + "paymentsRemaining" : { + "description" : "Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely", + "example" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "interval" : { + "description" : "The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "lastWeekDay" : { + "description" : "The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.", + "enum" : [ "FRI", "MON", "SAT", "SUN", "THU", "TUE", "WED" ], + "type" : "string" + }, + "nonBusinessDayTreatment" : { + "default" : "ON", + "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored", + "enum" : [ "AFTER", "BEFORE", "ON", "ONLY" ], + "type" : "string" + } + }, + "required" : [ "interval", "lastWeekDay" ], + "type" : "object" + }, + "BankingScheduledPaymentRecurrenceEventBased" : { + "description" : "Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased", + "properties" : { + "description" : { + "description" : "Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer", + "type" : "string" + } + }, + "required" : [ "description" ], + "type" : "object" + }, + "CommonPhysicalAddress" : { + "properties" : { + "addressUType" : { + "description" : "The type of address object present", + "enum" : [ "paf", "simple" ], + "type" : "string" + }, + "simple" : { + "$ref" : "#/components/schemas/CommonSimpleAddress" + }, + "paf" : { + "$ref" : "#/components/schemas/CommonPAFAddress" + } + }, + "required" : [ "addressUType" ], + "type" : "object", + "x-conditional" : [ "simple", "paf" ] + }, + "CommonSimpleAddress" : { + "properties" : { + "mailingName" : { + "description" : "Name of the individual or business formatted for inclusion in an address used for physical mail", + "type" : "string" + }, + "addressLine1" : { + "description" : "First line of the standard address object", + "type" : "string" + }, + "addressLine2" : { + "description" : "Second line of the standard address object", + "type" : "string" + }, + "addressLine3" : { + "description" : "Third line of the standard address object", + "type" : "string" + }, + "postcode" : { + "description" : "Mandatory for Australian addresses", + "type" : "string" + }, + "city" : { + "description" : "Name of the city or locality", + "type" : "string" + }, + "state" : { + "description" : "Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT", + "type" : "string" + }, + "country" : { + "default" : "AUS", + "description" : "A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present.", + "type" : "string", + "x-cds-type" : "ExternalRef" + } + }, + "required" : [ "addressLine1", "city", "state" ], + "type" : "object", + "x-conditional" : [ "postcode" ] + }, + "CommonPAFAddress" : { + "description" : "Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)", + "properties" : { + "dpid" : { + "description" : "Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier", + "type" : "string" + }, + "thoroughfareNumber1" : { + "description" : "Thoroughfare number for a property (first number in a property ranged address)", + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "thoroughfareNumber1Suffix" : { + "description" : "Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated", + "type" : "string" + }, + "thoroughfareNumber2" : { + "description" : "Second thoroughfare number (only used if the property has a ranged address eg 23-25)", + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "thoroughfareNumber2Suffix" : { + "description" : "Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated", + "type" : "string" + }, + "flatUnitType" : { + "description" : "Type of flat or unit for the address", + "type" : "string" + }, + "flatUnitNumber" : { + "description" : "Unit number (including suffix, if applicable)", + "type" : "string" + }, + "floorLevelType" : { + "description" : "Type of floor or level for the address", + "type" : "string" + }, + "floorLevelNumber" : { + "description" : "Floor or level number (including alpha characters)", + "type" : "string" + }, + "lotNumber" : { + "description" : "Allotment number for the address", + "type" : "string" + }, + "buildingName1" : { + "description" : "Building/Property name 1", + "type" : "string" + }, + "buildingName2" : { + "description" : "Building/Property name 2", + "type" : "string" + }, + "streetName" : { + "description" : "The name of the street", + "type" : "string" + }, + "streetType" : { + "description" : "The street type. Valid enumeration defined by Australia Post PAF code file", + "type" : "string" + }, + "streetSuffix" : { + "description" : "The street type suffix. Valid enumeration defined by Australia Post PAF code file", + "type" : "string" + }, + "postalDeliveryType" : { + "description" : "Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file", + "type" : "string" + }, + "postalDeliveryNumber" : { + "description" : "Postal delivery number if the address is a postal delivery type", + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "postalDeliveryNumberPrefix" : { + "description" : "Postal delivery number prefix related to the postal delivery number", + "type" : "string" + }, + "postalDeliveryNumberSuffix" : { + "description" : "Postal delivery number suffix related to the postal delivery number", + "type" : "string" + }, + "localityName" : { + "description" : "Full name of locality", + "type" : "string" + }, + "postcode" : { + "description" : "Postcode for the locality", + "type" : "string" + }, + "state" : { + "description" : "State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT", + "type" : "string" + } + }, + "required" : [ "localityName", "postcode", "state" ], + "type" : "object" + }, + "Links" : { + "properties" : { + "self" : { + "description" : "Fully qualified link that generated the current response document", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "self" ], + "type" : "object" + }, + "Meta" : { + "type" : "object" + }, + "LinksPaginated" : { + "properties" : { + "self" : { + "description" : "Fully qualified link that generated the current response document", + "type" : "string", + "x-cds-type" : "URIString" + }, + "first" : { + "description" : "URI to the first page of this set. Mandatory if this response is not the first page", + "type" : "string", + "x-cds-type" : "URIString" + }, + "prev" : { + "description" : "URI to the previous page of this set. Mandatory if this response is not the first page", + "type" : "string", + "x-cds-type" : "URIString" + }, + "next" : { + "description" : "URI to the next page of this set. Mandatory if this response is not the last page", + "type" : "string", + "x-cds-type" : "URIString" + }, + "last" : { + "description" : "URI to the last page of this set. Mandatory if this response is not the last page", + "type" : "string", + "x-cds-type" : "URIString" + } + }, + "required" : [ "self" ], + "type" : "object", + "x-conditional" : [ "prev", "next", "first", "last" ] + }, + "MetaPaginated" : { + "properties" : { + "totalRecords" : { + "description" : "The total number of records in the full set. See [pagination](#pagination).", + "type" : "integer", + "x-cds-type" : "NaturalNumber" + }, + "totalPages" : { + "description" : "The total number of pages in the full set. See [pagination](#pagination).", + "type" : "integer", + "x-cds-type" : "NaturalNumber" + } + }, + "required" : [ "totalPages", "totalRecords" ], + "type" : "object" + }, + "MetaPaginatedTransaction" : { + "allOf" : [ { + "$ref" : "#/components/schemas/MetaPaginated" + }, { + "$ref" : "#/components/schemas/MetaPaginatedTransaction_allOf" + } ] + }, + "MetaError" : { + "description" : "Additional data for customised error codes", + "properties" : { + "urn" : { + "description" : "The CDR error code URN which the application-specific error code extends. Mandatory if the error `code` is an application-specific error rather than a standardised error code.", + "type" : "string" + } + }, + "type" : "object", + "x-conditional" : [ "urn" ] + }, + "ResponseErrorListV2" : { + "properties" : { + "errors" : { + "items" : { + "$ref" : "#/components/schemas/ResponseErrorListV2_errors" + }, + "type" : "array" + } + }, + "required" : [ "errors" ], + "type" : "object", + "x-conditional" : [ "meta" ] + }, + "BankingProductCategoryV2" : { + "description" : "The category to which a product or account belongs. See [here](#product-categories) for more details", + "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" ], + "type" : "string" + }, + "RequestAccountIds_data" : { + "properties" : { + "accountIds" : { + "items" : { + "description" : "Array of specific accountIds to obtain authorisations for", + "type" : "string", + "x-cds-type" : "ASCIIString" + }, + "type" : "array" + } + }, + "required" : [ "accountIds" ], + "type" : "object" + }, + "ResponseBankingProductListV3_data" : { + "properties" : { + "products" : { + "description" : "The list of products returned. If the filter results in an empty set then this array may have no records", + "items" : { + "$ref" : "#/components/schemas/BankingProductV5" + }, + "type" : "array" + } + }, + "required" : [ "products" ], + "type" : "object" + }, + "BankingProductDetailV5_allOf" : { + "properties" : { + "bundles" : { + "description" : "An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also", + "items" : { + "$ref" : "#/components/schemas/BankingProductBundle" + }, + "type" : "array" + }, + "features" : { + "description" : "Array of features and limitations of the product", + "items" : { + "$ref" : "#/components/schemas/BankingProductFeatureV3" + }, + "type" : "array" + }, + "constraints" : { + "description" : "Constraints on the application for the product such as minimum balances or limit thresholds", + "items" : { + "$ref" : "#/components/schemas/BankingProductConstraintV2" + }, + "type" : "array" + }, + "eligibility" : { + "description" : "Eligibility criteria for the product", + "items" : { + "$ref" : "#/components/schemas/BankingProductEligibility" + }, + "type" : "array" + }, + "fees" : { + "description" : "Fees applicable to the product", + "items" : { + "$ref" : "#/components/schemas/BankingProductFeeV2" + }, + "type" : "array" + }, + "depositRates" : { + "description" : "Interest rates available for deposits", + "items" : { + "$ref" : "#/components/schemas/BankingProductDepositRateV2" + }, + "type" : "array" + }, + "lendingRates" : { + "description" : "Interest rates charged against lending balances", + "items" : { + "$ref" : "#/components/schemas/BankingProductLendingRateV3" + }, + "type" : "array" + }, + "instalments" : { + "$ref" : "#/components/schemas/BankingProductInstalments" + } + }, + "type" : "object" + }, + "ResponseBankingAccountListV3_data" : { + "properties" : { + "accounts" : { + "description" : "The list of accounts returned. If the filter results in an empty set then this array may have no records", + "items" : { + "$ref" : "#/components/schemas/BankingAccountV3" + }, + "type" : "array" + } + }, + "required" : [ "accounts" ], + "type" : "object" + }, + "BankingAccountDetailV4_allOf" : { + "properties" : { + "bsb" : { + "description" : "The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces", + "type" : "string" + }, + "accountNumber" : { + "description" : "The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces", + "type" : "string" + }, + "bundleName" : { + "description" : "Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer", + "type" : "string" + }, + "cardOption" : { + "$ref" : "#/components/schemas/BankingProductCardOption" + }, + "instalments" : { + "$ref" : "#/components/schemas/BankingAccountInstalments" + }, + "termDeposit" : { + "description" : "A structure suited to accounts that have term deposit-like features", + "items" : { + "$ref" : "#/components/schemas/BankingTermDepositAccountV2" + }, + "type" : "array" + }, + "creditCard" : { + "$ref" : "#/components/schemas/BankingCreditCardAccountV2" + }, + "loan" : { + "$ref" : "#/components/schemas/BankingLoanAccountV3" + }, + "deposit" : { + "$ref" : "#/components/schemas/BankingDepositAccount" + }, + "features" : { + "description" : "Array of features of the account based on the equivalent structure in Product Reference with the following additional field", + "items" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingProductFeatureV3" + }, { + "properties" : { + "isActivated" : { + "description" : "(Note this is an additional field appended to the feature object defined in the Product Reference payload.)", + "type" : "boolean", + "x-cds-type" : "Boolean" + } + }, + "type" : "object" + } ], + "type" : "object" + }, + "type" : "array" + }, + "fees" : { + "description" : "Fees and charges applicable to the account based on the equivalent structure in Product Reference", + "items" : { + "$ref" : "#/components/schemas/BankingProductFeeV2" + }, + "type" : "array" + }, + "addresses" : { + "description" : "The addresses for the account to be used for correspondence", + "items" : { + "$ref" : "#/components/schemas/CommonPhysicalAddress" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "BankingAccountInstalments_allOf" : { + "properties" : { + "plans" : { + "description" : "Array of instalment plans", + "items" : { + "$ref" : "#/components/schemas/BankingInstalmentPlans" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "BankingCreditCardPlan_interestFreePeriods" : { + "properties" : { + "from" : { + "description" : "The date any associated interest-free period will be available for the plan", + "type" : "string", + "x-cds-type" : "DateString" + }, + "to" : { + "description" : "The date any associated interest-free period will no longer be available", + "type" : "string", + "x-cds-type" : "DateString" + } + }, + "required" : [ "to" ], + "type" : "object" + }, + "ResponseBankingTransactionList_data" : { + "properties" : { + "transactions" : { + "items" : { + "$ref" : "#/components/schemas/BankingTransaction" + }, + "type" : "array" + } + }, + "required" : [ "transactions" ], + "type" : "object" + }, + "BankingTransactionDetail_allOf_extendedData_x2p101Payload" : { + "properties" : { + "extendedDescription" : { + "description" : "An extended string description. Required if the extensionUType field is `x2p101Payload`", + "type" : "string" + }, + "endToEndId" : { + "description" : "An end to end ID for the payment created at initiation", + "type" : "string" + }, + "purposeCode" : { + "description" : "Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service", + "type" : "string" + } + }, + "type" : "object", + "x-conditional" : [ "extendedDescription" ] + }, + "BankingTransactionDetail_allOf_extendedData" : { + "properties" : { + "payer" : { + "description" : "Label of the originating payer. Mandatory for inbound payment", + "type" : "string" + }, + "payee" : { + "description" : "Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)", + "type" : "string" + }, + "extensionUType" : { + "description" : "Optional extended data specific to transactions originated via NPP", + "enum" : [ "x2p101Payload" ], + "type" : "string" + }, + "x2p101Payload" : { + "$ref" : "#/components/schemas/BankingTransactionDetail_allOf_extendedData_x2p101Payload" + }, + "service" : { + "description" : "Identifier of the applicable overlay service. Valid values are: `X2P1.01`", + "enum" : [ "X2P1.01" ], + "type" : "string" + } + }, + "required" : [ "service" ], + "type" : "object", + "x-conditional" : [ "payer", "payee", "x2p101Payload" ] + }, + "BankingTransactionDetail_allOf" : { + "properties" : { + "extendedData" : { + "$ref" : "#/components/schemas/BankingTransactionDetail_allOf_extendedData" + } + }, + "required" : [ "extendedData" ], + "type" : "object" + }, + "ResponseBankingAccountsBalanceList_data" : { + "properties" : { + "balances" : { + "description" : "The list of balances returned", + "items" : { + "$ref" : "#/components/schemas/BankingBalance" + }, + "type" : "array" + } + }, + "required" : [ "balances" ], + "type" : "object" + }, + "ResponseBankingPayeeListV2_data" : { + "properties" : { + "payees" : { + "description" : "The list of payees returned", + "items" : { + "$ref" : "#/components/schemas/BankingPayeeV2" + }, + "type" : "array" + } + }, + "required" : [ "payees" ], + "type" : "object" + }, + "BankingPayeeDetailV2_allOf" : { + "properties" : { + "payeeUType" : { + "description" : "Type of object included that describes the payee in detail", + "enum" : [ "biller", "digitalWallet", "domestic", "international" ], + "type" : "string" + }, + "biller" : { + "$ref" : "#/components/schemas/BankingBillerPayee" + }, + "domestic" : { + "$ref" : "#/components/schemas/BankingDomesticPayee" + }, + "digitalWallet" : { + "$ref" : "#/components/schemas/BankingDigitalWalletPayee" + }, + "international" : { + "$ref" : "#/components/schemas/BankingInternationalPayee" + } + }, + "required" : [ "payeeUType" ], + "type" : "object", + "x-conditional" : [ "biller", "digitalWallet", "domestic", "international" ] + }, + "BankingInternationalPayee_beneficiaryDetails" : { + "properties" : { + "name" : { + "description" : "Name of the beneficiary", + "type" : "string" + }, + "country" : { + "description" : "Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "message" : { + "description" : "Response message for the payment", + "type" : "string" + } + }, + "required" : [ "country" ], + "type" : "object" + }, + "BankingInternationalPayee_bankDetails_bankAddress" : { + "properties" : { + "name" : { + "description" : "Name of the recipient Bank", + "type" : "string" + }, + "address" : { + "description" : "Address of the recipient Bank", + "type" : "string" + } + }, + "required" : [ "address", "name" ], + "type" : "object" + }, + "BankingInternationalPayee_bankDetails" : { + "properties" : { + "country" : { + "description" : "Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "accountNumber" : { + "description" : "Account Targeted for payment", + "type" : "string" + }, + "bankAddress" : { + "$ref" : "#/components/schemas/BankingInternationalPayee_bankDetails_bankAddress" + }, + "beneficiaryBankBIC" : { + "description" : "Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "fedWireNumber" : { + "description" : "Number for Fedwire payment (Federal Reserve Wire Network)", + "type" : "string" + }, + "sortCode" : { + "description" : "Sort code used for account identification in some jurisdictions", + "type" : "string" + }, + "chipNumber" : { + "description" : "Number for the Clearing House Interbank Payments System", + "type" : "string" + }, + "routingNumber" : { + "description" : "International bank routing number", + "type" : "string" + }, + "legalEntityIdentifier" : { + "description" : "The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)", + "type" : "string", + "x-cds-type" : "ExternalRef" + } + }, + "required" : [ "accountNumber", "country" ], + "type" : "object" + }, + "ResponseBankingDirectDebitAuthorisationList_data" : { + "properties" : { + "directDebitAuthorisations" : { + "description" : "The list of authorisations returned", + "items" : { + "$ref" : "#/components/schemas/BankingDirectDebit" + }, + "type" : "array" + } + }, + "required" : [ "directDebitAuthorisations" ], + "type" : "object" + }, + "ResponseBankingScheduledPaymentsListV2_data" : { + "properties" : { + "scheduledPayments" : { + "description" : "The list of scheduled payments to return", + "items" : { + "$ref" : "#/components/schemas/BankingScheduledPaymentV2" + }, + "type" : "array" + } + }, + "required" : [ "scheduledPayments" ], + "type" : "object" + }, + "MetaPaginatedTransaction_allOf" : { + "properties" : { + "isQueryParamUnsupported" : { + "default" : false, + "description" : "**true** if *\"text\"* query parameter is not supported", + "type" : "boolean", + "x-cds-type" : "Boolean" + } + }, + "type" : "object" + }, + "ResponseErrorListV2_errors" : { + "properties" : { + "code" : { + "description" : "The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.", + "type" : "string" + }, + "title" : { + "description" : "A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.", + "type" : "string" + }, + "detail" : { + "description" : "A human-readable explanation specific to this occurrence of the problem.", + "type" : "string" + }, + "meta" : { + "$ref" : "#/components/schemas/MetaError" + } + }, + "required" : [ "code", "detail", "title" ], + "type" : "object" + } + } + } +} \ No newline at end of file diff --git a/docs/includes/swagger/cds_banking_dp306.yaml b/docs/includes/swagger/cds_banking_dp306.yaml new file mode 100644 index 00000000..c2d3cfd2 --- /dev/null +++ b/docs/includes/swagger/cds_banking_dp306.yaml @@ -0,0 +1,8681 @@ +openapi: 3.0.3 +info: + contact: + email: contact@consumerdatastandards.gov.au + name: Consumer Data Standards + url: https://consumerdatastandards.gov.au + description: Consumer Data Standards APIs created by the Data Standards Body (DSB), + with the Data Standards Chair as the decision maker to meet the needs of the Consumer + Data Right + license: + name: MIT License + url: https://opensource.org/licenses/MIT + title: CDR Banking API + version: 1.28.0 +servers: +- url: https://data.holder.com.au/cds-au/v1 +paths: + /banking/accounts: + get: + description: |- + Obtain a list of accounts. + + Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html), [v2](../../../../includes/obsolete/get-accounts-v2.html) + operationId: listAccounts + parameters: + - description: 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.) + explode: true + in: query + name: product-category + required: false + schema: + 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 + type: string + style: form + - description: Used to filter results according to open/closed status. Values + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed + explode: true + in: query + name: open-status + required: false + schema: + default: ALL + enum: + - ALL + - CLOSED + - OPEN + type: string + style: form + - description: Filters accounts based on whether they are owned by the authorised + customer. True for owned accounts, false for unowned accounts and absent + for all accounts + explode: true + in: query + name: is-owned + required: false + schema: + type: boolean + x-cds-type: Boolean + style: form + x-cds-type: Boolean + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingAccountListV3' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Accounts + tags: + - Banking + - Accounts + x-scopes: + - bank:accounts.basic:read + x-version: "3" + /banking/accounts/balances: + get: + description: |- + Obtain balances for multiple, filtered accounts + + Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-balances-v1.html) + operationId: listBalancesBulk + parameters: + - description: 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. + explode: true + in: query + name: product-category + required: false + schema: + 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 + type: string + style: form + - description: Used to filter results according to open/closed status. Values + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed + explode: true + in: query + name: open-status + required: false + schema: + default: ALL + enum: + - ALL + - CLOSED + - OPEN + type: string + style: form + - description: Filters accounts based on whether they are owned by the authorised + customer. True for owned accounts, false for unowned accounts and absent + for all accounts + explode: true + in: query + name: is-owned + required: false + schema: + type: boolean + x-cds-type: Boolean + style: form + x-cds-type: Boolean + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingAccountsBalanceList' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Bulk Balances + tags: + - Banking + - Accounts + x-scopes: + - bank:accounts.basic:read + x-version: "2" + post: + description: Obtain balances for a specified list of accounts + operationId: listBalancesSpecificAccounts + parameters: + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestAccountIds' + description: The list of account IDs to obtain balances for + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingAccountsBalanceList' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Balances For Specific Accounts + tags: + - Banking + - Accounts + x-scopes: + - bank:accounts.basic:read + x-version: "1" + x-codegen-request-body-name: accountIds + /banking/accounts/{accountId}/balance: + get: + description: Obtain the balance for a single specified account + operationId: getBalance + parameters: + - description: ID of the specific account requested + explode: false + in: path + name: accountId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingAccountsBalanceById' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Account Balance + tags: + - Banking + - Accounts + x-scopes: + - bank:accounts.basic:read + x-version: "1" + /banking/accounts/{accountId}: + get: + description: |- + Obtain detailed information on a single account. + + Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html), [v3](../../../../includes/obsolete/get-account-detail-v3.html) + operationId: getAccountDetail + parameters: + - description: A tokenised identifier for the account which is unique but not + shareable + explode: false + in: path + name: accountId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingAccountByIdV4' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Account Detail + tags: + - Banking + - Accounts + x-scopes: + - bank:accounts.detail:read + x-version: "4" + /banking/accounts/{accountId}/transactions: + get: + description: |- + Obtain transactions for a specific account. + + Some general notes that apply to all endpoints that retrieve transactions: + + - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order + - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as: + - Posted date/time if available, then + - Execution date/time if available, then + - A reasonable date/time nominated by the data holder using internal data structures + - For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account + - For aggregated transactions (ie. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information across the subsidiary transactions as possible, is required to be shared + operationId: getTransactions + parameters: + - description: ID of the account to get transactions for. Must have previously + been returned by one of the account list endpoints. + explode: false + in: path + name: accountId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Constrain the transaction history request to transactions with + effective time at or after this date/time. If absent defaults to newest-time + minus 90 days. Format is aligned to DateTimeString common type + explode: true + in: query + name: oldest-time + required: false + schema: + type: string + x-cds-type: DateTimeString + style: form + x-cds-type: DateTimeString + - description: Constrain the transaction history request to transactions with + effective time at or before this date/time. If absent defaults to today. Format + is aligned to DateTimeString common type + explode: true + in: query + name: newest-time + required: false + schema: + type: string + x-cds-type: DateTimeString + style: form + x-cds-type: DateTimeString + - description: Filter transactions to only transactions with amounts higher + than or equal to this amount + explode: true + in: query + name: min-amount + required: false + schema: + type: string + x-cds-type: AmountString + style: form + x-cds-type: AmountString + - description: Filter transactions to only transactions with amounts less than + or equal to this amount + explode: true + in: query + name: max-amount + required: false + schema: + type: string + x-cds-type: AmountString + style: form + x-cds-type: AmountString + - description: Filter transactions to only transactions where this string value + is found as a substring of either the reference or description fields. Format + is arbitrary ASCII string. This parameter is optionally implemented by data + holders. If it is not implemented then a response should be provided as + normal without text filtering applied and an additional boolean field named + isQueryParamUnsupported should be included in the meta object and set to + true (whether the text parameter is supplied or not) + explode: true + in: query + name: text + required: false + schema: + type: string + style: form + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingTransactionList' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Transactions For Account + tags: + - Banking + - Accounts + x-scopes: + - bank:transactions:read + x-version: "1" + /banking/accounts/{accountId}/transactions/{transactionId}: + get: + description: Obtain detailed information on a transaction for a specific account + operationId: getTransactionDetail + parameters: + - description: ID of the account to get transactions for. Must have previously + been returned by one of the account list endpoints + explode: false + in: path + name: accountId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: ID of the transaction obtained from a previous call to one of + the other transaction endpoints + explode: false + in: path + name: transactionId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingTransactionById' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Transaction Detail + tags: + - Banking + - Accounts + x-scopes: + - bank:transactions:read + x-version: "1" + /banking/accounts/{accountId}/direct-debits: + get: + description: Obtain direct debit authorisations for a specific account + operationId: listDirectDebits + parameters: + - description: ID of the account to get direct debit authorisations for. Must + have previously been returned by one of the account list endpoints. + explode: false + in: path + name: accountId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Direct Debits For Account + tags: + - Banking + - Direct Debits + x-scopes: + - bank:regular_payments:read + x-version: "1" + /banking/accounts/direct-debits: + get: + description: |- + Obtain direct debit authorisations for multiple, filtered accounts + + Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-direct-debits-v1.html) + operationId: listDirectDebitsBulk + parameters: + - description: 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. + explode: true + in: query + name: product-category + required: false + schema: + 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 + type: string + style: form + - description: Used to filter results according to open/closed status. Values + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed + explode: true + in: query + name: open-status + required: false + schema: + default: ALL + enum: + - ALL + - CLOSED + - OPEN + type: string + style: form + - description: Filters accounts based on whether they are owned by the authorised + customer. True for owned accounts, false for unowned accounts and absent + for all accounts + explode: true + in: query + name: is-owned + required: false + schema: + type: boolean + x-cds-type: Boolean + style: form + x-cds-type: Boolean + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Bulk Direct Debits + tags: + - Banking + - Direct Debits + x-scopes: + - bank:regular_payments:read + x-version: "2" + post: + description: Obtain direct debit authorisations for a specified list of accounts + operationId: listDirectDebitsSpecificAccounts + parameters: + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestAccountIds' + description: Array of specific accountIds to obtain authorisations for + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Direct Debits For Specific Accounts + tags: + - Banking + - Direct Debits + x-scopes: + - bank:regular_payments:read + x-version: "1" + x-codegen-request-body-name: accountIds + /banking/accounts/{accountId}/payments/scheduled: + get: + description: |- + Obtain scheduled, outgoing payments for a specific account + + Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-account-v1.html) + operationId: listScheduledPayments + parameters: + - description: ID of the account to get scheduled payments for. Must have previously + been returned by one of the account list endpoints. The account specified + is the source account for the payment + explode: false + in: path + name: accountId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingScheduledPaymentsListV2' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Scheduled Payments for Account + tags: + - Banking + - Scheduled Payments + x-scopes: + - bank:regular_payments:read + x-version: "2" + /banking/payments/scheduled: + get: + description: |- + Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments + + Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](../../../../includes/obsolete/get-scheduled-payments-bulk-v2.html) + operationId: listScheduledPaymentsBulk + parameters: + - description: 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. + explode: true + in: query + name: product-category + required: false + schema: + 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 + type: string + style: form + - description: Used to filter results according to open/closed status. Values + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed + explode: true + in: query + name: open-status + required: false + schema: + default: ALL + enum: + - ALL + - CLOSED + - OPEN + type: string + style: form + - description: Filters accounts based on whether they are owned by the authorised + customer. True for owned accounts, false for unowned accounts and absent + for all accounts + explode: true + in: query + name: is-owned + required: false + schema: + type: boolean + x-cds-type: Boolean + style: form + x-cds-type: Boolean + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingScheduledPaymentsListV2' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Scheduled Payments Bulk + tags: + - Banking + - Scheduled Payments + x-scopes: + - bank:regular_payments:read + x-version: "3" + post: + description: |- + Obtain scheduled payments for a specified list of accounts + + Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html) + operationId: listScheduledPaymentsSpecificAccounts + parameters: + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestAccountIds' + description: Array of specific accountIds to obtain scheduled payments for. The + accounts specified are the source of funds for the payments returned + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingScheduledPaymentsListV2' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Scheduled Payments For Specific Accounts + tags: + - Banking + - Scheduled Payments + x-scopes: + - bank:regular_payments:read + x-version: "2" + x-codegen-request-body-name: accountIds + /banking/payees: + get: + description: |- + Obtain a list of pre-registered payees. + + Obsolete versions: [v1](../../../../includes/obsolete/get-payees-v1.html) + operationId: listPayees + parameters: + - description: Filter on the payee type field. In addition to normal type field + values, ALL can be specified to retrieve all payees. If absent the assumed + value is ALL + explode: true + in: query + name: type + required: false + schema: + default: ALL + enum: + - ALL + - BILLER + - DIGITAL_WALLET + - DOMESTIC + - INTERNATIONAL + type: string + style: form + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingPayeeListV2' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Payees + tags: + - Banking + - Payees + x-scopes: + - bank:payees:read + x-version: "2" + /banking/payees/{payeeId}: + get: + description: |- + Obtain detailed information on a single payee. + + Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient. + + Obsolete versions: [v1](../../../../includes/obsolete/get-payee-detail-v1.html) + operationId: getPayeeDetail + parameters: + - description: The ID used to locate the details of a particular payee + explode: false + in: path + name: payeeId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + - description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + - description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + - description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + - description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingPayeeByIdV2' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ headers: + x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation + id. If provided, the data holder must play back this value in the + x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** + UUID value is required to be provided in the response header to track + the interaction. + explode: false + schema: + type: string + style: simple + summary: Get Payee Detail + tags: + - Banking + - Payees + x-scopes: + - bank:payees:read + x-version: "2" + /banking/products: + get: + description: |- + Obtain a list of products that are currently openly offered to the market + + Note that the results returned by this endpoint are expected to be ordered in descending order according to `lastUpdated`. + + ### Conventions + In the product reference payloads there are a number of recurring conventions that are explained here, in one place. + + #### Arrays Of Features + + In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows: + + - Each element in an array has the same structure so that clients can reliably interpret the payloads + - Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees. + - Each element has a field name [additionalValue](#productfeaturetypedoc). 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 actually has been instantiated and created along with the associated decisions inherent in that process. + + #### Dates + It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a `lastUpdated` field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the `updated-since` query parameter. + + In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely. + + Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html), [v2](../../../../includes/obsolete/get-products-v2.html), [v3](../../../../includes/obsolete/get-products-v3.html) + operationId: listProducts + parameters: + - description: Allows for the filtering of products based on whether the current + time is within the period of time defined as effective by the effectiveFrom + and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. + If absent defaults to `CURRENT` + explode: true + in: query + name: effective + required: false + schema: + default: CURRENT + enum: + - ALL + - CURRENT + - FUTURE + type: string + style: form + - description: Only include products that have been updated after the specified + date and time. If absent defaults to include all products + explode: true + in: query + name: updated-since + required: false + schema: + type: string + x-cds-type: DateTimeString + style: form + x-cds-type: DateTimeString + - description: Filter results based on a specific brand + explode: true + in: query + name: brand + required: false + schema: + type: string + style: form + - description: 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. + explode: true + in: query + name: product-category + required: false + schema: + 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 + type: string + style: form + - description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingProductListV3' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ "422": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ summary: Get Products + tags: + - Banking + - Products + x-version: "4" + /banking/products/{productId}: + get: + description: |- + Obtain detailed information on a single product offered openly to the market. + + Obsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html), [v2](../../../../includes/obsolete/get-product-detail-v2.html), [v3](../../../../includes/obsolete/get-product-detail-v3.html), [v4](../../../../includes/obsolete/get-product-detail-v4.html) + operationId: getProductDetail + parameters: + - description: ID of the specific product requested + explode: false + in: path + name: productId + required: true + schema: + type: string + x-cds-type: ASCIIString + style: simple + x-cds-type: ASCIIString + - description: Version of the API endpoint requested by the client. Must be + set to a positive integer. The data holder should respond with the highest + supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If the value of [x-min-v](#request-headers) is equal to or higher than the + value of [x-v](#request-headers) then the [x-min-v](#request-headers) header + should be treated as absent. If all versions requested are not supported + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + - description: Minimum version of the API endpoint requested by the client. + Must be set to a positive integer if provided. The data holder should respond + with the highest supported version between [x-min-v](#request-headers) and + [x-v](#request-headers). If all versions requested are not supported then + the data holder must respond with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseBankingProductByIdV5' + description: Success + headers: + x-v: + description: The [version](#response-headers) of the API endpoint that + the data holder has responded with. + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ "406": + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseErrorListV2' + description: The following error codes MUST be supported:
+ summary: Get Product Detail + tags: + - Banking + - Products + x-version: "5" +components: + parameters: + RequestHeader_x-v: + description: Version of the API endpoint requested by the client. Must be set + to a positive integer. The data holder should respond with the highest supported + version between [x-min-v](#request-headers) and [x-v](#request-headers). If + the value of [x-min-v](#request-headers) is equal to or higher than the value + of [x-v](#request-headers) then the [x-min-v](#request-headers) header should + be treated as absent. If all versions requested are not supported then the + data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers) + explode: false + in: header + name: x-v + required: true + schema: + type: string + style: simple + RequestHeader_x-min-v: + description: Minimum version of the API endpoint requested by the client. Must + be set to a positive integer if provided. The data holder should respond with + the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). + If all versions requested are not supported then the data holder must respond + with a `406 Not Acceptable`. + explode: false + in: header + name: x-min-v + required: false + schema: + type: string + style: simple + RequestHeader_x-fapi-interaction-id: + description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. + If provided, the data holder must play back this value in the x-fapi-interaction-id + response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value + is required to be provided in the response header to track the interaction. + explode: false + in: header + name: x-fapi-interaction-id + required: false + schema: + type: string + style: simple + RequestHeader_x-fapi-auth-date: + description: The time when the customer last logged in to the Data Recipient + Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required + for all resource calls (customer present and unattended). Not required for + unauthenticated calls. + explode: false + in: header + name: x-fapi-auth-date + required: false + schema: + type: string + x-conditional: true + style: simple + x-conditional: true + RequestHeader_x-fapi-customer-ip-address: + description: 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. + explode: false + in: header + name: x-fapi-customer-ip-address + required: false + schema: + type: string + style: simple + RequestHeader_x-cds-client-headers: + description: The customer's original standard http headers [Base64](#common-field-types) + 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. + explode: false + in: header + name: x-cds-client-headers + required: false + schema: + type: string + x-conditional: true + x-cds-type: Base64 + style: simple + x-conditional: true + x-cds-type: Base64 + ParamAccountOpenStatus: + description: Used to filter results according to open/closed status. Values + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed + explode: true + in: query + name: open-status + required: false + schema: + default: ALL + enum: + - ALL + - CLOSED + - OPEN + type: string + style: form + ParamProductCategory: + description: 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. + explode: true + in: query + name: product-category + required: false + schema: + 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 + type: string + style: form + ParamAccountIsOwned: + description: Filters accounts based on whether they are owned by the authorised + customer. True for owned accounts, false for unowned accounts and absent + for all accounts + explode: true + in: query + name: is-owned + required: false + schema: + type: boolean + x-cds-type: Boolean + style: form + x-cds-type: Boolean + ParamPage: + description: Page of results to request (standard pagination) + explode: true + in: query + name: page + required: false + schema: + default: 1 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + ParamPageSize: + description: Page size to request. Default is 25 (standard pagination) + explode: true + in: query + name: page-size + required: false + schema: + default: 25 + type: integer + x-cds-type: PositiveInteger + style: form + x-cds-type: PositiveInteger + ParamTransactionNewestTime: + description: Constrain the transaction history request to transactions with + effective time at or before this date/time. If absent defaults to today. Format + is aligned to DateTimeString common type + explode: true + in: query + name: newest-time + required: false + schema: + type: string + x-cds-type: DateTimeString + style: form + x-cds-type: DateTimeString + ParamTransactionOldestTime: + description: Constrain the transaction history request to transactions with + effective time at or after this date/time. If absent defaults to newest-time + minus 90 days. Format is aligned to DateTimeString common type + explode: true + in: query + name: oldest-time + required: false + schema: + type: string + x-cds-type: DateTimeString + style: form + x-cds-type: DateTimeString + ParamTransactionMinAmount: + description: Filter transactions to only transactions with amounts higher than + or equal to this amount + explode: true + in: query + name: min-amount + required: false + schema: + type: string + x-cds-type: AmountString + style: form + x-cds-type: AmountString + ParamTransactionMaxAmount: + description: Filter transactions to only transactions with amounts less than + or equal to this amount + explode: true + in: query + name: max-amount + required: false + schema: + type: string + x-cds-type: AmountString + style: form + x-cds-type: AmountString + ParamTransactionText: + description: Filter transactions to only transactions where this string value + is found as a substring of either the reference or description fields. Format + is arbitrary ASCII string. This parameter is optionally implemented by data + holders. If it is not implemented then a response should be provided as normal + without text filtering applied and an additional boolean field named isQueryParamUnsupported + should be included in the meta object and set to true (whether the text parameter + is supplied or not) + explode: true + in: query + name: text + required: false + schema: + type: string + style: form + schemas: + RequestAccountIds: + example: + data: + accountIds: + - accountIds + - accountIds + meta: '{}' + properties: + data: + $ref: '#/components/schemas/RequestAccountIds_data' + meta: + type: object + required: + - data + type: object + ResponseBankingProductListV3: + example: + data: + products: + - additionalInformation: + eligibilityUri: eligibilityUri + additionalFeesAndPricingUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalTermsUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + bundleUri: bundleUri + feesAndPricingUri: feesAndPricingUri + additionalBundleUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalEligibilityUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalOverviewUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + termsUri: termsUri + overviewUri: overviewUri + brandName: brandName + productId: productId + description: description + effectiveTo: effectiveTo + lastUpdated: lastUpdated + isTailored: true + name: name + applicationUri: applicationUri + cardOption: + cardImages: + - imageUri: imageUri + title: title + - imageUri: imageUri + title: title + cardScheme: AMEX + cardType: CHARGE + effectiveFrom: effectiveFrom + brand: brand + - additionalInformation: + eligibilityUri: eligibilityUri + additionalFeesAndPricingUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalTermsUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + bundleUri: bundleUri + feesAndPricingUri: feesAndPricingUri + additionalBundleUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalEligibilityUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalOverviewUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + termsUri: termsUri + overviewUri: overviewUri + brandName: brandName + productId: productId + description: description + effectiveTo: effectiveTo + lastUpdated: lastUpdated + isTailored: true + name: name + applicationUri: applicationUri + cardOption: + cardImages: + - imageUri: imageUri + title: title + - imageUri: imageUri + title: title + cardScheme: AMEX + cardType: CHARGE + effectiveFrom: effectiveFrom + brand: brand + meta: + totalRecords: 0 + totalPages: 6 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingProductListV3_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + BankingProductV5: + example: + additionalInformation: + eligibilityUri: eligibilityUri + additionalFeesAndPricingUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalTermsUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + bundleUri: bundleUri + feesAndPricingUri: feesAndPricingUri + additionalBundleUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalEligibilityUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalOverviewUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + termsUri: termsUri + overviewUri: overviewUri + brandName: brandName + productId: productId + description: description + effectiveTo: effectiveTo + lastUpdated: lastUpdated + isTailored: true + name: name + applicationUri: applicationUri + cardOption: + cardImages: + - imageUri: imageUri + title: title + - imageUri: imageUri + title: title + cardScheme: AMEX + cardType: CHARGE + effectiveFrom: effectiveFrom + brand: brand + properties: + productId: + description: A data holder specific unique identifier for this product. + This identifier must be unique to a product but does not otherwise need + to adhere to ID permanence guidelines. + type: string + x-cds-type: ASCIIString + effectiveFrom: + description: The date and time from which this product is effective (ie. + is available for origination). Used to enable the articulation of products + to the regime before they are available for customers to originate + type: string + x-cds-type: DateTimeString + effectiveTo: + description: The date and time at which this product will be retired and + will no longer be offered. Used to enable the managed deprecation of + products + type: string + x-cds-type: DateTimeString + lastUpdated: + description: The last date and time that the information for this product + was changed (or the creation date for the product if it has never been + altered) + type: string + x-cds-type: DateTimeString + productCategory: + $ref: '#/components/schemas/BankingProductCategoryV2' + name: + description: The display name of the product + type: string + description: + description: A description of the product + type: string + brand: + description: A label of the brand for the product. Able to be used for filtering. + For data holders with single brands this value is still required + type: string + brandName: + description: An optional display name of the brand + type: string + applicationUri: + description: A link to an application web page where this product can be + applied for. + type: string + x-cds-type: URIString + isTailored: + description: Indicates whether the product is specifically tailored to a + circumstance. In this case fees and prices are significantly negotiated + depending on context. While all products are open to a degree of tailoring + this flag indicates that tailoring is expected and thus that the provision + of specific fees and rates is not applicable + type: boolean + x-cds-type: Boolean + additionalInformation: + $ref: '#/components/schemas/BankingProductAdditionalInformationV2' + cardOption: + $ref: '#/components/schemas/BankingProductCardOption' + required: + - brand + - description + - isTailored + - lastUpdated + - name + - productCategory + - productId + type: object + BankingProductCardOption: + description: Information about the type of card available with the account + example: + cardImages: + - imageUri: imageUri + title: title + - imageUri: imageUri + title: title + cardScheme: AMEX + cardType: CHARGE + properties: + cardScheme: + description: Card scheme available with the account + enum: + - AMEX + - DINERS + - EFTPOS + - MASTERCARD + - VISA + - OTHER + type: string + cardType: + description: Card type available with the account + enum: + - CHARGE + - CREDIT + - DEBIT + type: string + cardImages: + description: An array of card art images + items: + $ref: '#/components/schemas/BankingProductCardOption_cardImages' + type: array + required: + - cardScheme + - cardType + type: object + BankingProductCardOption_cardImages: + example: + imageUri: imageUri + title: title + properties: + title: + description: Display label for the specific image + type: string + imageUri: + description: URI reference to a PNG, JPG or GIF image with proportions defined + by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference + may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)** + type: string + x-cds-type: URIString + required: + - imageUri + type: object + BankingProductAdditionalInformationV2: + description: Object that contains links to additional information on specific + topics + example: + eligibilityUri: eligibilityUri + additionalFeesAndPricingUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalTermsUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + bundleUri: bundleUri + feesAndPricingUri: feesAndPricingUri + additionalBundleUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalEligibilityUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalOverviewUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + termsUri: termsUri + overviewUri: overviewUri + properties: + overviewUri: + description: General overview of the product. Mandatory if `additionalOverviewUris` + includes one or more supporting documents. + type: string + x-cds-type: URIString + termsUri: + description: Terms and conditions for the product. Mandatory if `additionalTermsUris` + includes one or more supporting documents. + type: string + x-cds-type: URIString + eligibilityUri: + description: Eligibility rules and criteria for the product. Mandatory if + `additionalEligibilityUris` includes one or more supporting documents. + type: string + x-cds-type: URIString + feesAndPricingUri: + description: Description of fees, pricing, discounts, exemptions and bonuses + for the product. Mandatory if `additionalFeesAndPricingUris` includes + one or more supporting documents. + type: string + x-cds-type: URIString + bundleUri: + description: Description of a bundle that this product can be part of. Mandatory + if `additionalBundleUris` includes one or more supporting documents. + type: string + x-cds-type: URIString + additionalOverviewUris: + description: An array of additional general overviews for the product or + features of the product, if applicable. To be treated as secondary documents + to the `overviewUri`. Only to be used if there is a primary `overviewUri`. + items: + $ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris' + type: array + additionalTermsUris: + description: An array of additional terms and conditions for the product, + if applicable. To be treated as secondary documents to the `termsUri`. + Only to be used if there is a primary `termsUri`. + items: + $ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris' + type: array + additionalEligibilityUris: + description: An array of additional eligibility rules and criteria for the + product, if applicable. To be treated as secondary documents to the `eligibilityUri`. + Only to be used if there is a primary `eligibilityUri`. + items: + $ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris' + type: array + additionalFeesAndPricingUris: + description: An array of additional fees, pricing, discounts, exemptions + and bonuses for the product, if applicable. To be treated as secondary + documents to the `feesAndPricingUri`. Only to be used if there is a primary + `feesAndPricingUri`. + items: + $ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris' + type: array + additionalBundleUris: + description: An array of additional bundles for the product, if applicable. + To be treated as secondary documents to the `bundleUri`. Only to be used + if there is a primary `bundleUri`. + items: + $ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris' + type: array + type: object + x-conditional: + - overviewUri + - termsUri + - eligibilityUri + - feesAndPricingUri + - bundleUri + BankingProductAdditionalInformationV2_additionalInformationUris: + example: + additionalInfoUri: additionalInfoUri + description: description + properties: + description: + description: Display text providing more information about the document + URI + type: string + additionalInfoUri: + description: The URI describing the additional information + type: string + x-cds-type: URIString + required: + - additionalInfoUri + type: object + ResponseBankingProductByIdV5: + example: + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/BankingProductDetailV5' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + type: object + BankingProductDetailV5: + allOf: + - $ref: '#/components/schemas/BankingProductV5' + - $ref: '#/components/schemas/BankingProductDetailV5_allOf' + BankingProductBundle: + properties: + name: + description: Name of the bundle + type: string + description: + description: Description of the bundle + type: string + additionalInfo: + description: Display text providing more information on the bundle + type: string + additionalInfoUri: + description: Link to a web page with more information on the bundle criteria + and benefits + type: string + x-cds-type: URIString + productIds: + description: Array of product IDs for products included in the bundle that + are available via the product endpoints. Note that this array is not + intended to represent a comprehensive model of the products included in + the bundle and some products available for the bundle may not be available + via the product reference endpoints + items: + type: string + x-cds-type: ASCIIString + type: array + required: + - description + - name + type: object + BankingProductFeatureV3: + description: Array of features and limitations of the product + properties: + featureType: + description: The type of feature described. For further details, refer to + [Product Feature Types](#tocSproductfeaturetypedoc) + enum: + - ADDITIONAL_CARDS + - BALANCE_TRANSFERS + - BILL_PAYMENT + - BONUS_REWARDS + - CARD_ACCESS + - CASHBACK_OFFER + - COMPLEMENTARY_PRODUCT_DISCOUNTS + - EXTRA_DOWN_PAYMENT + - DIGITAL_BANKING + - DIGITAL_WALLET + - DONATE_INTEREST + - EXTRA_REPAYMENTS + - FRAUD_PROTECTION + - FREE_TXNS + - FREE_TXNS_ALLOWANCE + - FUNDS_AVAILABLE_AFTER + - GUARANTOR + - INSTALMENT_PLAN + - INSURANCE + - INTEREST_FREE + - INTEREST_FREE_TRANSFERS + - LOYALTY_PROGRAM + - MAX_BALANCE + - MAX_LIMIT + - MAX_TXNS + - MIN_BALANCE + - MIN_LIMIT + - NOTIFICATIONS + - NPP_ENABLED + - NPP_PAYID + - OFFSET + - OTHER + - OVERDRAFT + - REDRAW + - RELATIONSHIP_MANAGEMENT + - UNLIMITED_TXNS + type: string + additionalValue: + description: Generic field containing additional information relevant to + the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory + or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc) + type: string + additionalInfo: + description: Display text providing more information on the feature. Mandatory + if the [feature type](#tocSproductfeaturetypedoc) is set to `OTHER` + type: string + additionalInfoUri: + description: Link to a web page with more information on this feature + type: string + x-cds-type: URIString + required: + - featureType + type: object + x-conditional: + - additionalValue + - additionalInfo + BankingProductConstraintV2: + properties: + constraintType: + description: The type of constraint described. For further details, refer + to [Product Constraint Types](#tocSproductconstrainttypedoc) + enum: + - MAX_BALANCE + - MAX_LIMIT + - MIN_BALANCE + - MIN_LIMIT + - OPENING_BALANCE + - OTHER + type: string + additionalValue: + description: Generic field containing additional information relevant to + the [constraintType](#tocSproductconstrainttypedoc) specified. Whether + mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc) + type: string + additionalInfo: + description: Display text providing more information on the constraint. + Mandatory if the [constraint type](#tocSproductconstrainttypedoc) is set + to `OTHER` + type: string + additionalInfoUri: + description: Link to a web page with more information on the constraint + type: string + x-cds-type: URIString + required: + - constraintType + type: object + x-conditional: + - additionalValue + - additionalInfo + BankingProductEligibility: + properties: + eligibilityType: + description: The type of eligibility criteria described. For further details, + refer to [Product Eligibility Types](#tocSproducteligibilitytypedoc) + enum: + - BUSINESS + - EMPLOYMENT_STATUS + - MAX_AGE + - MIN_AGE + - MIN_INCOME + - MIN_TURNOVER + - NATURAL_PERSON + - OTHER + - PENSION_RECIPIENT + - RESIDENCY_STATUS + - STAFF + - STUDENT + type: string + additionalValue: + description: Generic field containing additional information relevant to + the [eligibilityType](#tocSproducteligibilitytypedoc) specified. Whether + mandatory or not is dependent on the value of [eligibilityType](#tocSproducteligibilitytypedoc) + type: string + additionalInfo: + description: Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) + criteria. Mandatory if the field is set to `OTHER` + type: string + additionalInfoUri: + description: Link to a web page with more information on this eligibility + criteria + type: string + x-cds-type: URIString + required: + - eligibilityType + type: object + x-conditional: + - additionalValue + - additionalInfo + BankingProductFeeV2: + properties: + name: + description: Name of the fee + type: string + feeCategory: + description: The category of fee, used to group `feeType` values. For further + details, refer to [Product Fee Categories](#tocSproductfeecategorydoc). + enum: + - APPLICATION + - ATM + - BRANCH + - BUY_NOW_PAY_LATER + - CARD + - CHEQUE + - CLOSURE + - CORRESPONDENCE + - FOREIGN_EXCHANGE + - OTHER + - POS + - SERVICE + - TELEGRAPHIC_TRANSFER + - TELEPHONE_BANKING + - TERMS_CONDITIONS + - THIRD_PARTY + - TRANSACTION + example: CARD + type: string + feeType: + description: The type of fee. For further details, refer to [Product Fee + Types](#tocSproductfeetypedoc). + enum: + - CASH_ADVANCE + - DEPOSIT + - DISHONOUR + - ENQUIRY + - EVENT + - EXIT + - OTHER + - PAYMENT + - PAYMENT_LATE + - PERIODIC + - PURCHASE + - REPLACEMENT + - TRANSACTION + - UPFRONT + - UPFRONT_PER_PLAN + - VARIATION + - WITHDRAWAL + example: CASH_ADVANCE + type: string + feeMethodUType: + description: The fee charge method + enum: + - fixedAmount + - rateBased + - variable + type: string + fixedAmount: + $ref: '#/components/schemas/BankingFeeAmount' + rateBased: + $ref: '#/components/schemas/BankingFeeRate' + variable: + $ref: '#/components/schemas/BankingFeeRange' + feeCap: + description: The cap amount if multiple occurrences of the fee are capped + to a limit + type: string + x-cds-type: AmountString + feeCapPeriod: + description: Specifies a duration over which multiple occurrences of the + fee will be capped. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + currency: + description: The currency the fee will be charged in. Assumes `AUD` if absent + type: string + x-cds-type: CurrencyString + additionalValue: + description: Generic field containing additional information relevant to + the [feeType](#tocSproductfeetypedoc) specified. Whether mandatory or + not is dependent on the value of [feeType](#tocSproductfeetypedoc) + type: string + additionalInfo: + description: Display text providing more information on the fee + type: string + additionalInfoUri: + description: Link to a web page with more information on this fee + type: string + x-cds-type: URIString + discounts: + description: An optional list of discounts to this fee that may be available + items: + $ref: '#/components/schemas/BankingProductDiscount' + type: array + required: + - feeCategory + - feeMethodUType + - feeType + - name + type: object + x-conditional: + - fixedAmount + - rateBased + - variable + - additionalValue + - additionalInfo + BankingFeeAmount: + properties: + amount: + description: The specific amount charged for the fee each time it is incurred + type: string + x-cds-type: AmountString + required: + - amount + type: object + BankingFeeRate: + properties: + balanceRate: + description: A fee rate calculated based on a proportion of the balance. + One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory + type: string + x-cds-type: RateString + transactionRate: + description: A fee rate calculated based on a proportion of a transaction. + One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory + type: string + x-cds-type: RateString + accruedRate: + description: A fee rate calculated based on a proportion of the calculated + interest accrued on the account. One of `balanceRate`, `transactionRate` + and `accruedRate` is mandatory + type: string + x-cds-type: RateString + accrualFrequency: + description: The indicative frequency with which the fee is calculated on + the account. Only applies if `balanceRate` or `accruedRate` is also present. + Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + amountRange: + $ref: '#/components/schemas/BankingFeeRange' + type: object + x-conditional: + - balanceRate + - transactionRate + - accruedRate + BankingFeeRange: + description: A minimum or maximum fee amount where a specific fixed amount is + not known until the fee is incurred + properties: + feeMinimum: + description: The minimum fee that will be charged per occurrence + type: string + x-cds-type: AmountString + feeMaximum: + description: The maximum fee that will be charged per occurrence + type: string + x-cds-type: AmountString + type: object + BankingProductDiscount: + properties: + description: + description: Description of the discount + type: string + discountType: + description: The type of discount. For further details, refer to [Product + Discount Types](#tocSproductdiscounttypedoc) + enum: + - BALANCE + - DEPOSITS + - ELIGIBILITY_ONLY + - FEE_CAP + - PAYMENTS + type: string + amount: + description: Dollar value of the discount. One of `amount`, `balanceRate`, + `transactionRate`, `accruedRate` and `feeRate` is mandatory. + type: string + x-cds-type: AmountString + balanceRate: + description: A discount rate calculated based on a proportion of the balance. + Note that the currency of the fee discount is expected to be the same + as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, + `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, + assumes the application and calculation frequency are the same as the + corresponding fee + type: string + x-cds-type: RateString + transactionRate: + description: A discount rate calculated based on a proportion of a transaction. + Note that the currency of the fee discount is expected to be the same + as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, + `accruedRate` and `feeRate` is mandatory. + type: string + x-cds-type: RateString + accruedRate: + description: A discount rate calculated based on a proportion of the calculated + interest accrued on the account. Note that the currency of the fee discount + is expected to be the same as the currency of the fee itself. One of `amount`, + `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. + Unless noted in `additionalInfo`, assumes the application and calculation + frequency are the same as the corresponding fee + type: string + x-cds-type: RateString + feeRate: + description: A discount rate calculated based on a proportion of the fee + to which this discount is attached. Note that the currency of the fee + discount is expected to be the same as the currency of the fee itself. + One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` + is mandatory. Unless noted in `additionalInfo`, assumes the application + and calculation frequency are the same as the corresponding fee + type: string + x-cds-type: RateString + additionalValue: + description: Generic field containing additional information relevant to + the [discountType](#tocSproductdiscounttypedoc) specified. Whether mandatory + or not is dependent on the value of [discountType](#tocSproductdiscounttypedoc) + type: string + additionalInfo: + description: Display text providing more information on the discount + type: string + additionalInfoUri: + description: Link to a web page with more information on this discount + type: string + x-cds-type: URIString + eligibility: + description: Eligibility constraints that apply to this discount. Mandatory + if `discountType` is `ELIGIBILITY_ONLY`. + items: + $ref: '#/components/schemas/BankingProductDiscountEligibility' + type: array + required: + - description + - discountType + type: object + x-conditional: + - accruedRate + - additionalValue + - amount + - balanceRate + - eligibility + - feeRate + - transactionRate + BankingProductDiscountEligibility: + properties: + discountEligibilityType: + description: The type of the specific eligibility constraint for a discount. + For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc) + enum: + - BUSINESS + - EMPLOYMENT_STATUS + - INTRODUCTORY + - MAX_AGE + - MIN_AGE + - MIN_INCOME + - MIN_TURNOVER + - NATURAL_PERSON + - OTHER + - PENSION_RECIPIENT + - RESIDENCY_STATUS + - STAFF + - STUDENT + type: string + additionalValue: + description: Generic field containing additional information relevant to + the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified. + Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc) + type: string + additionalInfo: + description: Display text providing more information on this eligibility + constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc) + type: string + additionalInfoUri: + description: Link to a web page with more information on this eligibility + constraint + type: string + x-cds-type: URIString + required: + - discountEligibilityType + type: object + x-conditional: + - additionalInfo + - additionalValue + BankingProductDepositRateV2: + properties: + depositRateType: + description: The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc). For further + details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc) + enum: + - BONUS + - FIXED + - FLOATING + - MARKET_LINKED + - VARIABLE + example: VARIABLE + type: string + rate: + description: The rate to be applied + type: string + x-cds-type: RateString + adjustmentToBase: + description: For an adjustment `depositRateType`, the base rate that the + adjustment value will apply to. The value of the `additionalValue` field + may be used to further qualify the corresponding base. + enum: + - FIXED + - FLOATING + - MARKET_LINKED + - VARIABLE + example: FIXED + type: string + adjustmentBundle: + description: The name of the bundle that makes the adjustment rate applicable + type: string + calculationFrequency: + description: The period after which the rate is applied to the balance to + calculate the amount due for the period. Calculation of the amount is + often daily (as balances may change) but accumulated until the total amount + is 'applied' to the account (see `applicationFrequency`). Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + applicationType: + description: The type of approach used to apply the rate to the account. + An `applicationFrequency` value is only expected when the approach is + `PERIODIC` + enum: + - MATURITY + - PERIODIC + - UPFRONT + example: PERIODIC + type: string + applicationFrequency: + description: The period after which the calculated amount(s) (see `calculationFrequency`) + are 'applied' (i.e. debited or credited) to the account. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + tiers: + description: Rate tiers applicable for this rate + items: + $ref: '#/components/schemas/BankingProductRateTierV4' + type: array + applicabilityConditions: + description: Array of applicability conditions for a rate + items: + $ref: '#/components/schemas/BankingProductRateConditionV2' + type: array + additionalValue: + description: Generic field containing additional information relevant to + the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether + mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc) + type: string + additionalInfo: + description: Display text providing more information on the rate + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate + type: string + x-cds-type: URIString + required: + - depositRateType + - rate + type: object + x-conditional: + - additionalValue + BankingProductLendingRateV3: + properties: + lendingRateType: + description: The type of rate (fixed, variable, etc). For further details, + refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc) + enum: + - BALANCE_TRANSFER + - CASH_ADVANCE + - DISCOUNT + - FEE + - FIXED + - FLOATING + - MARKET_LINKED + - PENALTY + - PURCHASE + - VARIABLE + example: DISCOUNT + type: string + rate: + description: The rate to be applied. Mandatory unless the `lendingRateType` + `FEE` is supplied + type: string + x-cds-type: RateString + referenceRate: + description: The reference or index rate for this account option, or variant + type: string + x-cds-type: RateString + comparisonRate: + description: A comparison rate equivalent for this rate. The comparison + rate associated with an 'adjustment' [lendingRateType](#tocSproductlendingratetypedoc) + is the full comparison rate assuming the adjusted rate is available for + origination. + type: string + x-cds-type: RateString + revertRate: + description: The revert rate applicable after the respective rate expires. + For example, `FIXED`, or `INTEREST_ONLY` rates may revert to a different + rate when those terms expire. Expected where this product will continue + to operate with a new 'revert' rate. + type: string + x-cds-type: RateString + revertProductId: + description: A reference to a `productId` that the associated product will + revert to after the respective rate terms expire. For example, `FIXED`, + or `INTEREST_ONLY` rates may revert to a different rate when those terms + expire. Expected if the product will change when the rate reverts to different + terms. + type: string + adjustmentToBase: + description: For an adjustment `lendingRateType`, the base rate that the + adjustment value will apply to. The values of the `repaymentType`, `loanPurpose` + and `additionalValue` fields may be used to further qualify the corresponding + base. + enum: + - BALANCE_TRANSFER + - CASH_ADVANCE + - FEE + - FIXED + - FLOATING + - MARKET_LINKED + - PURCHASE + - VARIABLE + example: BALANCE_TRANSFER + type: string + adjustmentBundle: + description: The name of the bundle that makes the adjustment rate applicable + type: string + calculationFrequency: + description: The period after which the rate is applied to the balance to + calculate the amount due for the period. Calculation of the amount is + often daily (as balances may change) but accumulated until the total amount + is 'applied' to the account (see `applicationFrequency`). Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + applicationType: + description: The type of approach used to apply the rate to the account. + An `applicationFrequency` value is only expected when the approach is + `PERIODIC` + enum: + - MATURITY + - PERIODIC + - UPFRONT + example: PERIODIC + type: string + applicationFrequency: + description: The period after which the calculated amount(s) (see `calculationFrequency`) + are 'applied' (i.e. debited or credited) to the account. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + interestPaymentDue: + description: When loan payments are due to be paid within each period. The + investment benefit of earlier payments affect the rate that can be offered + enum: + - IN_ADVANCE + - IN_ARREARS + type: string + repaymentType: + description: Options in place for repayments. If absent, the lending rate + is applicable to all repayment types + enum: + - INTEREST_ONLY + - PRINCIPAL_AND_FEE + - PRINCIPAL_AND_INTEREST + type: string + loanPurpose: + description: The reason for taking out the loan. If absent, the lending + rate is applicable to all loan purposes + enum: + - INVESTMENT + - OWNER_OCCUPIED + type: string + tiers: + description: Rate tiers applicable for this rate + items: + $ref: '#/components/schemas/BankingProductRateTierV4' + type: array + applicabilityConditions: + description: Array of applicability conditions for a rate + items: + $ref: '#/components/schemas/BankingProductRateConditionV2' + type: array + additionalValue: + description: Generic field containing additional information relevant to + the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether + mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc) + type: string + additionalInfo: + description: Display text providing more information on the rate + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate + type: string + x-cds-type: URIString + required: + - lendingRateType + type: object + x-conditional: + - additionalValue + - rate + BankingProductRateTierV4: + description: Defines the criteria and conditions for which a rate applies + properties: + name: + description: A display name for the tier + type: string + unitOfMeasure: + description: The unit of measure that applies to the `minimumValue` and + `maximumValue` values, e.g.: + enum: + - DAY + - DOLLAR + - MONTH + - PERCENT + type: string + minimumValue: + description: The number of `unitOfMeasure` units that form the lower bound + of the tier. The tier should be inclusive of this value + type: string + maximumValue: + description: 'The number of `unitOfMeasure` units that form the upper bound + of the tier or band. For a tier with a discrete value (as opposed to a + range of values e.g. 1 month) this must be the same as `minimumValue`. + Where this is the same as the `minimumValue` value of the next-higher + tier the referenced tier should be exclusive of this value. For example + a term deposit of 2 months falls into the upper tier of the following + tiers: (1 – 2 months, 2 – 3 months). If absent the tier''s range has no + upper bound.' + type: string + rateApplicationMethod: + description: The method used to calculate the amount to be applied using + one or more tiers. A single rate may be applied to the entire balance + or each applicable tier rate is applied to the portion of the balance + that falls into that tier (referred to as 'bands' or 'steps') + enum: + - PER_TIER + - WHOLE_BALANCE + type: string + applicabilityConditions: + description: Array of applicability conditions for a tier + items: + $ref: '#/components/schemas/BankingProductRateConditionV2' + type: array + additionalInfo: + description: Display text providing more information on the rate tier + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate tier + type: string + x-cds-type: URIString + required: + - minimumValue + - name + - unitOfMeasure + type: object + BankingProductRateConditionV2: + description: Defines a condition for the applicability of a tiered rate + properties: + rateApplicabilityType: + description: Category of applicability condition associated with the rate. + For more information refer to [Rate and Tier Applicability Types](#tocSbankingproductrateconditiondoc) + enum: + - DEPOSITS_MIN + - DEPOSITS_MIN_AMOUNT + - DEPOSIT_BALANCE_INCREASED + - EXISTING_CUST + - NEW_ACCOUNTS + - NEW_CUSTOMER + - NEW_CUSTOMER_TO_GROUP + - ONLINE_ONLY + - OTHER + - PURCHASES_MIN + - WITHDRAWALS_MAX + - WITHDRAWALS_MAX_AMOUNT + example: NEW_CUSTOMER + type: string + additionalValue: + description: Generic field containing additional information relevant to + the `rateApplicabilityType` specified. Whether mandatory or not is dependent + on the value of [rateApplicabilityType](#tocSbankingproductrateconditiondoc) + type: string + additionalInfo: + description: Display text providing more information on the condition + type: string + additionalInfoUri: + description: Link to a web page with more information on this condition + type: string + x-cds-type: URIString + type: object + x-conditional: + - additionalValue + - additionalInfo + BankingProductInstalments: + properties: + maximumPlanCount: + description: Total number of plans that may be created + example: 1 + type: integer + x-cds-type: PositiveInteger + instalmentsLimit: + description: Maximum combined limit of all instalment plans that may be + created + type: string + x-cds-type: AmountString + minimumPlanValue: + description: Minimum value that can be opened as an instalment plan + type: string + x-cds-type: AmountString + maximumPlanValue: + description: Maximum value that can be opened as an instalment plan + type: string + x-cds-type: AmountString + minimumSplit: + description: Minimum number of instalment payments a plan can be created + with + example: 4 + type: integer + x-cds-type: PositiveInteger + maximumSplit: + description: Maximum number of instalment payments a plan can be created + with + example: 4 + type: integer + x-cds-type: PositiveInteger + required: + - instalmentsLimit + - maximumPlanCount + - maximumPlanValue + - maximumSplit + - minimumPlanValue + - minimumSplit + type: object + ResponseBankingAccountListV3: + example: + data: + accounts: + - accountId: accountId + maskedNumber: maskedNumber + openStatus: OPEN + displayName: displayName + isOwned: true + nickname: nickname + creationDate: creationDate + productName: productName + accountOwnership: UNKNOWN + - accountId: accountId + maskedNumber: maskedNumber + openStatus: OPEN + displayName: displayName + isOwned: true + nickname: nickname + creationDate: creationDate + productName: productName + accountOwnership: UNKNOWN + meta: + totalRecords: 0 + totalPages: 6 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingAccountListV3_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + BankingAccountV3: + example: + accountId: accountId + maskedNumber: maskedNumber + openStatus: OPEN + displayName: displayName + isOwned: true + nickname: nickname + creationDate: creationDate + productName: productName + accountOwnership: UNKNOWN + properties: + accountId: + description: A unique ID of the account adhering to the standards for ID + permanence + type: string + x-cds-type: ASCIIString + creationDate: + description: Date that the account was created (if known) + type: string + x-cds-type: DateString + displayName: + description: The display name of the account as defined by the bank. This + should not incorporate account numbers or PANs. If it does the values + should be masked according to the rules of the [MaskedAccountString](#common-field-types) + common type. + type: string + nickname: + description: A customer supplied nick name for the account + type: string + openStatus: + default: OPEN + description: Open or closed status for the account. If not present then + `OPEN` is assumed + enum: + - CLOSED + - OPEN + type: string + isOwned: + default: true + description: Flag indicating that the customer associated with the authorisation + is an owner of the account. Does not indicate sole ownership, however. + If not present then `true` is assumed + type: boolean + x-cds-type: Boolean + accountOwnership: + description: Value indicating the number of customers that have ownership + of the account, according to the data holder's definition of account ownership. + Does not indicate that all account owners are eligible consumers + enum: + - UNKNOWN + - ONE_PARTY + - TWO_PARTY + - MANY_PARTY + - OTHER + type: string + maskedNumber: + description: A masked version of the account. Whether BSB/Account Number, + Credit Card PAN or another number + type: string + x-cds-type: MaskedAccountString + productCategory: + $ref: '#/components/schemas/BankingProductCategoryV2' + productName: + description: The unique identifier of the account as defined by the data + holder (akin to model number for the account) + type: string + required: + - accountId + - accountOwnership + - displayName + - maskedNumber + - productCategory + - productName + type: object + ResponseBankingAccountByIdV4: + example: + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/BankingAccountDetailV4' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + type: object + BankingAccountDetailV4: + allOf: + - $ref: '#/components/schemas/BankingAccountV3' + - $ref: '#/components/schemas/BankingAccountDetailV4_allOf' + BankingAccountInstalments: + allOf: + - $ref: '#/components/schemas/BankingProductInstalments' + - $ref: '#/components/schemas/BankingAccountInstalments_allOf' + description: Details of instalment features on the account + BankingInstalmentPlans: + properties: + planNickname: + description: The short display name of the plan as provided by the customer. + Where a customer has not provided a nickname, a display name derived by + the data holder consistent with existing channels + type: string + creationDate: + description: The date the plan was created + type: string + x-cds-type: DateString + amount: + description: The total amount of the plan + type: string + x-cds-type: AmountString + duration: + description: The original expected repayment duration. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + instalmentInterval: + description: The expected repayment interval. Formatted according to [ISO + 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes + recurrence syntax) + type: string + x-cds-type: ExternalRef + schedule: + description: Array of expected repayment amounts and dates + items: + $ref: '#/components/schemas/BankingInstalmentPlanSchedule' + type: array + required: + - amount + - creationDate + - duration + - instalmentInterval + - planNickname + - schedule + type: object + BankingInstalmentPlanSchedule: + properties: + amountDue: + description: Amount due with this repayment + type: string + x-cds-type: AmountString + dueDate: + description: Date this repayment is due + type: string + x-cds-type: DateString + required: + - amountDue + - dueDate + type: object + BankingTermDepositAccountV2: + properties: + lodgementDate: + description: The lodgement date of the original deposit + type: string + x-cds-type: DateString + maturityDate: + description: Maturity date for the term deposit + type: string + x-cds-type: DateString + maturityAmount: + description: Amount to be paid upon maturity. If absent it implies the amount + to paid is variable and cannot currently be calculated + type: string + x-cds-type: AmountString + maturityCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + maturityInstructions: + description: Current instructions on action to be taken at maturity. This + includes default actions that may be specified in the terms and conditions + for the product e.g. roll-over to the same term and frequency of interest + payments + enum: + - HOLD_ON_MATURITY + - PAID_OUT_AT_MATURITY + - ROLLED_OVER + type: string + depositRateDetail: + $ref: '#/components/schemas/BankingDepositRateDetail' + required: + - lodgementDate + - maturityDate + - maturityInstructions + type: object + BankingDepositRateDetail: + description: Detail about deposit rates and adjustments + properties: + depositRateType: + description: The type of rate + enum: + - FIXED + - FLOATING + - MARKET_LINKED + - VARIABLE + type: string + referenceRate: + description: Reference rate for this account type and terms + type: string + x-cds-type: RateString + effectiveRate: + description: Rate being paid for this deposit + type: string + x-cds-type: RateString + calculationFrequency: + description: The period after which the rate is applied to the balance to + calculate the amount due for the period. Calculation of the amount is + often daily (as balances may change) but accumulated until the total amount + is 'applied' to the account (see `applicationFrequency`). Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + applicationType: + description: The type of approach used to apply the rate to the account. + An `applicationFrequency` value is only expected when the approach is + `PERIODIC` + enum: + - MATURITY + - PERIODIC + - UPFRONT + example: PERIODIC + type: string + applicationFrequency: + description: The period after which the calculated amount(s) (see `calculationFrequency`) + are 'applied' (i.e. debited or credited) to the account. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + tiers: + description: Rate tiers applicable for this rate + items: + $ref: '#/components/schemas/BankingProductRateTierV4' + type: array + applicabilityConditions: + description: Array of applicability conditions for a rate + items: + $ref: '#/components/schemas/BankingProductRateConditionV2' + type: array + additionalValue: + description: Generic field containing additional information relevant to + the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether + mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc) + type: string + additionalInfo: + description: Display text providing more information on the rate + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate + type: string + x-cds-type: URIString + adjustments: + description: Adjustments applicable to the rate + items: + $ref: '#/components/schemas/BankingRateAdjustments' + type: array + required: + - depositRateType + - effectiveRate + - referenceRate + type: object + x-conditional: + - additionalValue + BankingRateAdjustments: + description: Information about adjustments to an associated rate + properties: + adjustmentType: + description: The type of adjustment. For further details, refer to [Deposit + Adjustment Rate Types](#tocSproductdepositadjustmentratetypedoc) and [Lending + Adjustment Rate Types](#tocSproductlendingadjustmentratetypedoc) + enum: + - BONUS + - DISCOUNT + - PENALTY + type: string + amount: + description: Adjustment amount if not a rate + type: string + x-cds-type: AmountString + currency: + description: Adjustment amount currency. If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + rate: + description: Adjustment to an associated base rate. The impact to the base + rate depends on the type of base (deposit or loan) and the `adjustmentType` + (bonus, discount or penalty) + type: string + x-cds-type: RateString + adjustmentBundle: + description: The name of the bundle that makes the adjustment rate applicable + type: string + adjustmentPeriod: + description: The original or standard adjustment period after which the + adjustment ends. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + adjustmentEndDate: + description: Date the adjustment will cease to apply + type: string + x-cds-type: DateString + additionalValue: + description: Generic field containing additional information relevant to + the `adjustmentType` specified. Whether mandatory or not is dependent + on the value of `adjustmentType` + type: string + additionalInfo: + description: Display text providing more information on the rate + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate + type: string + x-cds-type: URIString + required: + - adjustmentType + type: object + x-conditional: + - additionalValue + BankingCreditCardAccountV2: + properties: + minPaymentAmount: + description: The minimum payment amount due for the next card payment + type: string + x-cds-type: AmountString + paymentDueAmount: + description: The amount due for the next card payment + type: string + x-cds-type: AmountString + paymentCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + paymentDueDate: + description: Date that the next payment for the card is due + type: string + x-cds-type: DateString + cardPlans: + description: Card plans sorted in order of repayment allocation. Repayments + are allocated to the first entry first. + items: + $ref: '#/components/schemas/BankingCreditCardPlan' + type: array + required: + - cardPlans + - minPaymentAmount + - paymentDueAmount + - paymentDueDate + type: object + BankingCreditCardPlan: + properties: + nickname: + description: A short display name of the deposit amount if provided by the + customer. Where a customer has not provided a nickname, a display name + derived by the bank consistent with existing digital banking channels + may be provided + type: string + planType: + $ref: '#/components/schemas/BankingCardPlanTypes' + atExpiryBalanceTransfersTo: + $ref: '#/components/schemas/BankingCardPlanTypes' + planCreationDate: + description: Date this plan was created + type: string + x-cds-type: DateString + planPeriod: + description: Original duration for this plan. Formatted according to [ISO + 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes + recurrence syntax) + type: string + x-cds-type: ExternalRef + planEndDate: + description: Date this plan is expected to end + type: string + x-cds-type: DateString + planReferenceRate: + description: Reference rate for this plan type + type: string + x-cds-type: RateString + planEffectiveRate: + description: Effective rate for this plan + type: string + x-cds-type: RateString + minPaymentAmount: + description: The minimum payment amount due for this plan + type: string + x-cds-type: AmountString + paymentDueAmount: + description: The amount due for this plan + type: string + x-cds-type: AmountString + paymentCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + paymentDueDate: + description: Date that the next payment for this plan is due + type: string + x-cds-type: DateString + additionalInfo: + description: Display text providing more information on the plan + type: string + additionalInfoUri: + description: Link to a web page with more information on this plan + type: string + x-cds-type: URIString + interestFreePeriods: + description: Defines when any current or future interest-free periods will + be applicable to this plan. The interest-free period itself will be specified + through an associated `INTEREST_FREE` plan feature. + items: + $ref: '#/components/schemas/BankingCreditCardPlan_interestFreePeriods' + type: array + adjustments: + description: Adjustments applicable to the plan rate + items: + $ref: '#/components/schemas/BankingRateAdjustments' + type: array + planFeatures: + description: Array of features available or applicable to this plan + items: + $ref: '#/components/schemas/BankingCardPlanFeatures' + type: array + required: + - planEffectiveRate + - planReferenceRate + - planType + type: object + BankingCardPlanTypes: + enum: + - BALANCE_TRANSFER_PLAN + - CASH_ADVANCE_PLAN + - INSTALMENT_PLAN + - PURCHASE_PLAN + example: PURCHASE_PLAN + type: string + BankingCardPlanFeatures: + description: Features and limitations available or applicable to the associated + plan + properties: + planFeatureType: + description: Type of feature or limitation. For details refer to [Plan Feature + Types](#tocSbankingproductplanfeaturedoc). + enum: + - BALANCE_TRANSFER_ENDS_INTEREST_FREE + - INSTALMENTS + - INTEREST_FREE + type: string + period: + description: Original duration of the feature or limitation. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + endDate: + description: Date that the feature or limitation will cease to apply + type: string + x-cds-type: DateString + additionalValue: + description: Detail associated with the planFeatureType. For details refer + to [Plan Feature Types](#tocSbankingproductplanfeaturedoc). + type: string + additionalInfo: + description: Display text providing more information on the plan feature + type: string + additionalInfoUri: + description: Link to a web page with more information on this plan feature + type: string + x-cds-type: URIString + required: + - planFeatureType + type: object + x-conditional: + - additionalValue + BankingDepositAccount: + properties: + lodgementDate: + description: The lodgement date of the deposit + type: string + x-cds-type: DateString + nickname: + description: A short display name of the deposit amount if provided by the + customer. Where a customer has not provided a nickname, a display name + derived by the bank consistent with existing digital banking channels + may be provided + type: string + x-cds-type: DateString + depositRateDetail: + $ref: '#/components/schemas/BankingDepositRateDetail' + type: object + BankingLoanAccountV3: + properties: + originalStartDate: + description: Optional original start date for the loan + type: string + x-cds-type: DateString + originalLoanAmount: + description: Optional original loan value + type: string + x-cds-type: AmountString + originalLoanCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + loanEndDate: + description: Date that the loan is due to be repaid in full + type: string + x-cds-type: DateString + nextInstalmentDate: + description: Next date that an instalment is required + type: string + x-cds-type: DateString + minInstalmentAmount: + description: Minimum amount of next instalment + type: string + x-cds-type: AmountString + minInstalmentCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + maxRedraw: + description: Maximum amount of funds that can be redrawn. If not present + redraw is not available even if the feature exists for the account + type: string + x-cds-type: AmountString + maxRedrawCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + minRedraw: + description: Minimum redraw amount + type: string + x-cds-type: AmountString + minRedrawCurrency: + description: If absent assumes `AUD` + type: string + x-cds-type: CurrencyString + offsetAccountEnabled: + description: Set to `true` if one or more offset accounts are configured + for this loan account + type: boolean + x-cds-type: Boolean + offsetAccountIds: + description: The accountIDs of the configured offset accounts attached to + this loan. Only offset accounts that can be accessed under the current + authorisation should be included. It is expected behaviour that `offsetAccountEnabled` + is set to `true` but the `offsetAccountIds` field is absent or empty. + This represents a situation where an offset account exists but details + can not be accessed under the current authorisation + items: + type: string + x-cds-type: ASCIIString + type: array + lendingRateDetail: + description: Information about lending rates and adjustments + items: + $ref: '#/components/schemas/BankingLendingRateDetail' + type: array + type: object + BankingLendingRateDetail: + description: Information about lending rates and adjustments. Future-dated rates + allow scheduled rate changes such as 'revert' rates to be specified. + properties: + loanPurpose: + description: The reason for taking out the loan. If absent, the lending + rate is applicable to all loan purposes + enum: + - INVESTMENT + - OWNER_OCCUPIED + example: OWNER_OCCUPIED + type: string + repaymentType: + default: PRINCIPAL_AND_INTEREST + description: Options in place for repayments. If absent defaults to `PRINCIPAL_AND_INTEREST` + enum: + - INTEREST_ONLY + - PRINCIPAL_AND_FEE + - PRINCIPAL_AND_INTEREST + example: PRINCIPAL_AND_INTEREST + type: string + rateStartDate: + description: Date this rate will begin to apply. If not specified, the rate + is currently applicable to the account. + type: string + x-cds-type: DateString + rateEndDate: + description: Date this rate will cease to apply. If not specified, the rate + on the account is not scheduled to change or 'revert' to a different rate + setting. + type: string + x-cds-type: DateString + revertProductId: + description: The `productId` of the product that this account will revert + to at the specified `rateEndDate` + type: string + repaymentUType: + description: The type of structure to present account specific fields + enum: + - fixedRate + - variableRate + - feeAmount + type: string + fixedRate: + $ref: '#/components/schemas/BankingLendingRateFixed' + variableRate: + $ref: '#/components/schemas/BankingLendingRateVariable' + feeAmount: + $ref: '#/components/schemas/BankingLendingFee' + adjustments: + description: Adjustments applicable to the rate or fee + items: + $ref: '#/components/schemas/BankingRateAdjustments' + type: array + required: + - loanCostType + - repaymentUType + type: object + BankingLendingRateFixed: + properties: + fixedPeriod: + description: The period of time for the fixed rate. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + referenceRate: + description: Reference rate for this account type and terms + type: string + x-cds-type: RateString + effectiveRate: + description: The current rate to calculate interest payable being applied + to lending balances as it stands at the time of the API call + type: string + x-cds-type: RateString + calculationFrequency: + description: The period after which the rate is applied to the balance to + calculate the amount due for the period. Calculation of the amount is + often daily (as balances may change) but accumulated until the total amount + is 'applied' to the account (see `applicationFrequency`). Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + applicationType: + description: The type of approach used to apply the rate to the account. + An `applicationFrequency` value is only expected when the approach is + `PERIODIC` + enum: + - MATURITY + - PERIODIC + - UPFRONT + example: PERIODIC + type: string + applicationFrequency: + description: The period after which the calculated amount(s) (see `calculationFrequency`) + are 'applied' (i.e. debited or credited) to the account. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + interestPaymentDue: + description: When loan payments are due to be paid within each period. The + investment benefit of earlier payments affect the rate that can be offered + enum: + - IN_ADVANCE + - IN_ARREARS + type: string + repaymentFrequency: + description: The expected or required repayment frequency. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + additionalInfo: + description: Display text providing more information on the rate + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate + type: string + x-cds-type: URIString + required: + - effectiveRate + - referenceRate + type: object + BankingLendingRateVariable: + properties: + variableRateType: + description: The type of variable rate + enum: + - FLOATING + - MARKET_LINKED + - VARIABLE + type: string + referenceRate: + description: Reference rate for this account type and terms + type: string + x-cds-type: RateString + effectiveRate: + description: The current rate to calculate interest payable being applied + to lending balances as it stands at the time of the API call + type: string + x-cds-type: RateString + calculationFrequency: + description: The period after which the rate is applied to the balance to + calculate the amount due for the period. Calculation of the amount is + often daily (as balances may change) but accumulated until the total amount + is 'applied' to the account (see `applicationFrequency`). Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + applicationType: + description: The type of approach used to apply the rate to the account. + An `applicationFrequency` value is only expected when the approach is + `PERIODIC` + enum: + - MATURITY + - PERIODIC + - UPFRONT + example: PERIODIC + type: string + applicationFrequency: + description: The period after which the calculated amount(s) (see `calculationFrequency`) + are 'applied' (i.e. debited or credited) to the account. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + interestPaymentDue: + description: When loan payments are due to be paid within each period. The + investment benefit of earlier payments affect the rate that can be offered + enum: + - IN_ADVANCE + - IN_ARREARS + type: string + repaymentFrequency: + description: The expected or required repayment frequency. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + additionalValue: + description: Generic field containing additional information relevant to + the [variableRateType](#tocSproductlendingratetypedoc) specified. Whether + mandatory or not is dependent on the value of [variableRateType](#tocSproductlendingratetypedoc) + type: string + additionalInfo: + description: Display text providing more information on the rate + type: string + additionalInfoUri: + description: Link to a web page with more information on this rate + type: string + x-cds-type: URIString + required: + - effectiveRate + - referenceRate + - variableRateType + type: object + x-conditional: + - additionalValue + BankingLendingFee: + properties: + amount: + description: Minimum payment due at specified `repaymentFrequency` + type: string + x-cds-type: AmountString + currency: + description: Currency of the fee. `AUD` assumed if not present + type: string + x-cds-type: CurrencyString + repaymentDue: + description: When loan payments are due to be paid within each period + enum: + - IN_ADVANCE + - IN_ARREARS + type: string + repaymentFrequency: + description: The expected or required repayment frequency. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + additionalInfo: + description: Display text providing more information on the fee + type: string + additionalInfoUri: + description: Link to a web page with more information on this fee + type: string + x-cds-type: URIString + required: + - amount + type: object + ResponseBankingTransactionList: + example: + data: + transactions: + - postingDateTime: postingDateTime + amount: amount + apcaNumber: apcaNumber + isDetailAvailable: true + description: description + type: DIRECT_DEBIT + billerName: billerName + executionDateTime: executionDateTime + transactionId: transactionId + merchantName: merchantName + billerCode: billerCode + reference: reference + accountId: accountId + merchantCategoryCode: merchantCategoryCode + valueDateTime: valueDateTime + currency: currency + crn: crn + status: PENDING + - postingDateTime: postingDateTime + amount: amount + apcaNumber: apcaNumber + isDetailAvailable: true + description: description + type: DIRECT_DEBIT + billerName: billerName + executionDateTime: executionDateTime + transactionId: transactionId + merchantName: merchantName + billerCode: billerCode + reference: reference + accountId: accountId + merchantCategoryCode: merchantCategoryCode + valueDateTime: valueDateTime + currency: currency + crn: crn + status: PENDING + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingTransactionList_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginatedTransaction' + required: + - data + - links + - meta + type: object + BankingTransaction: + example: + postingDateTime: postingDateTime + amount: amount + apcaNumber: apcaNumber + isDetailAvailable: true + description: description + type: DIRECT_DEBIT + billerName: billerName + executionDateTime: executionDateTime + transactionId: transactionId + merchantName: merchantName + billerCode: billerCode + reference: reference + accountId: accountId + merchantCategoryCode: merchantCategoryCode + valueDateTime: valueDateTime + currency: currency + crn: crn + status: PENDING + properties: + accountId: + description: ID of the account for which transactions are provided + type: string + x-cds-type: ASCIIString + transactionId: + description: A unique ID of the transaction adhering to the standards for + ID permanence. This is mandatory (through hashing if necessary) unless + there are specific and justifiable technical reasons why a transaction + cannot be uniquely identified for a particular account type. It is mandatory + if `isDetailAvailable` is set to true. + type: string + x-cds-type: ASCIIString + isDetailAvailable: + description: '`true` if extended information is available using the transaction + detail endpoint. `false` if extended data is not available' + type: boolean + x-cds-type: Boolean + type: + description: The type of the transaction + enum: + - DIRECT_DEBIT + - FEE + - INTEREST_CHARGED + - INTEREST_PAID + - OTHER + - PAYMENT + - TRANSFER_INCOMING + - TRANSFER_OUTGOING + type: string + status: + description: Status of the transaction whether pending or posted. Note that + there is currently no provision in the standards to guarantee the ability + to correlate a pending transaction with an associated posted transaction + enum: + - PENDING + - POSTED + type: string + description: + description: The transaction description as applied by the financial institution + type: string + postingDateTime: + description: The time the transaction was posted. This field is Mandatory + if the transaction has status `POSTED`. This is the time that appears + on a standard statement + type: string + x-cds-type: DateTimeString + valueDateTime: + description: Date and time at which assets become available to the account + owner in case of a credit entry, or cease to be available to the account + owner in case of a debit transaction entry + type: string + x-cds-type: DateTimeString + executionDateTime: + description: The time the transaction was executed by the originating customer, + if available + type: string + x-cds-type: DateTimeString + amount: + description: The value of the transaction. Negative values mean money was + outgoing from the account + type: string + x-cds-type: AmountString + currency: + description: The currency for the transaction amount. `AUD` assumed if not + present + type: string + x-cds-type: CurrencyString + reference: + description: The reference for the transaction provided by the originating + institution. Empty string if no data provided + type: string + merchantName: + description: Name of the merchant for an outgoing payment to a merchant + type: string + merchantCategoryCode: + description: The merchant category code (or MCC) for an outgoing payment + to a merchant + type: string + billerCode: + description: BPAY Biller Code for the transaction (if available) + type: string + billerName: + description: Name of the BPAY biller for the transaction (if available) + type: string + crn: + description: BPAY CRN for the transaction (if available).
Where the + CRN contains sensitive information, it should be masked in line with how + the Data Holder currently displays account identifiers in their existing + online banking channels. If the contents of the CRN match the format of + a Credit Card PAN they should be masked according to the rules applicable + for [MaskedPANString](#common-field-types). If the contents are otherwise + sensitive, then it should be masked using the rules applicable for the + [MaskedAccountString](#common-field-types) common type. + type: string + apcaNumber: + description: 6 Digit APCA number for the initiating institution. The field + is fixed-width and padded with leading zeros if applicable. + type: string + required: + - accountId + - amount + - description + - isDetailAvailable + - reference + - status + - type + type: object + x-conditional: + - transactionId + - postingDateTime + - crn + ResponseBankingTransactionById: + example: + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/BankingTransactionDetail' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + type: object + BankingTransactionDetail: + allOf: + - $ref: '#/components/schemas/BankingTransaction' + - $ref: '#/components/schemas/BankingTransactionDetail_allOf' + ResponseBankingAccountsBalanceList: + example: + data: + balances: + - accountId: accountId + purses: + - amount: amount + currency: currency + - amount: amount + currency: currency + amortisedLimit: amortisedLimit + currentBalance: currentBalance + creditLimit: creditLimit + currency: currency + availableBalance: availableBalance + - accountId: accountId + purses: + - amount: amount + currency: currency + - amount: amount + currency: currency + amortisedLimit: amortisedLimit + currentBalance: currentBalance + creditLimit: creditLimit + currency: currency + availableBalance: availableBalance + meta: + totalRecords: 0 + totalPages: 6 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingAccountsBalanceList_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + ResponseBankingAccountsBalanceById: + example: + data: + accountId: accountId + purses: + - amount: amount + currency: currency + - amount: amount + currency: currency + amortisedLimit: amortisedLimit + currentBalance: currentBalance + creditLimit: creditLimit + currency: currency + availableBalance: availableBalance + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/BankingBalance' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + type: object + BankingBalance: + example: + accountId: accountId + purses: + - amount: amount + currency: currency + - amount: amount + currency: currency + amortisedLimit: amortisedLimit + currentBalance: currentBalance + creditLimit: creditLimit + currency: currency + availableBalance: availableBalance + properties: + accountId: + description: A unique ID of the account adhering to the standards for ID + permanence + type: string + x-cds-type: ASCIIString + currentBalance: + description: The balance of the account at this time. Should align to the + balance available via other channels such as Internet Banking. Assumed + to be negative if the customer has money owing + type: string + x-cds-type: AmountString + availableBalance: + description: Balance representing the amount of funds available for transfer. + Assumed to be zero or positive + type: string + x-cds-type: AmountString + creditLimit: + description: Object representing the maximum amount of credit that is available + for this account. Assumed to be zero if absent + type: string + x-cds-type: AmountString + amortisedLimit: + description: Object representing the available limit amortised according + to payment schedule. Assumed to be zero if absent + type: string + x-cds-type: AmountString + currency: + description: The currency for the balance amounts. If absent assumed to + be `AUD` + type: string + x-cds-type: CurrencyString + purses: + description: Optional array of balances for the account in other currencies. + Included to support accounts that support multi-currency purses such as + Travel Cards + items: + $ref: '#/components/schemas/BankingBalancePurse' + type: array + required: + - accountId + - availableBalance + - currentBalance + type: object + BankingBalancePurse: + example: + amount: amount + currency: currency + properties: + amount: + description: The balance available for this additional currency purse + type: string + x-cds-type: AmountString + currency: + description: The currency for the purse + type: string + x-cds-type: CurrencyString + required: + - amount + type: object + ResponseBankingPayeeListV2: + example: + data: + payees: + - nickname: nickname + description: description + payeeId: payeeId + type: BILLER + creationDate: creationDate + - nickname: nickname + description: description + payeeId: payeeId + type: BILLER + creationDate: creationDate + meta: + totalRecords: 0 + totalPages: 6 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingPayeeListV2_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + ResponseBankingPayeeByIdV2: + example: + meta: '{}' + links: + self: self + properties: + data: + $ref: '#/components/schemas/BankingPayeeDetailV2' + links: + $ref: '#/components/schemas/Links' + meta: + type: object + required: + - data + - links + type: object + BankingPayeeV2: + example: + nickname: nickname + description: description + payeeId: payeeId + type: BILLER + creationDate: creationDate + properties: + payeeId: + description: ID of the payee adhering to the rules of ID permanence + type: string + x-cds-type: ASCIIString + nickname: + description: The short display name of the payee as provided by the customer. + Where a customer has not provided a nickname, a display name derived by + the bank for the payee consistent with existing digital banking channels + type: string + description: + description: A description of the payee provided by the customer + type: string + type: + description: The type of payee. + enum: + - BILLER + - DIGITAL_WALLET + - DOMESTIC + - INTERNATIONAL + type: string + creationDate: + description: The date the payee was created by the customer + type: string + x-cds-type: DateString + required: + - nickname + - payeeId + - type + type: object + BankingPayeeDetailV2: + allOf: + - $ref: '#/components/schemas/BankingPayeeV2' + - $ref: '#/components/schemas/BankingPayeeDetailV2_allOf' + BankingDomesticPayee: + example: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + properties: + payeeAccountUType: + description: 'Type of account object included. Valid values are: ' + enum: + - account + - card + - payId + type: string + account: + $ref: '#/components/schemas/BankingDomesticPayeeAccount' + card: + $ref: '#/components/schemas/BankingDomesticPayeeCard' + payId: + $ref: '#/components/schemas/BankingDomesticPayeePayId' + required: + - payeeAccountUType + type: object + x-conditional: + - account + - card + - payId + BankingDomesticPayeeAccount: + example: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + properties: + accountName: + description: Name of the account to pay to + type: string + bsb: + description: BSB of the account to pay to + type: string + accountNumber: + description: Number of the account to pay to + type: string + required: + - accountNumber + - bsb + type: object + BankingDomesticPayeeCard: + example: + cardNumber: cardNumber + properties: + cardNumber: + description: Name of the account to pay to + type: string + x-cds-type: MaskedPANString + required: + - cardNumber + type: object + BankingDomesticPayeePayId: + example: + identifier: identifier + name: name + type: ABN + properties: + name: + description: The name assigned to the PayID by the owner of the PayID + type: string + identifier: + description: The identifier of the PayID (dependent on type) + type: string + type: + description: The type of the PayID + enum: + - ABN + - EMAIL + - ORG_IDENTIFIER + - TELEPHONE + type: string + required: + - identifier + - type + type: object + BankingBillerPayee: + example: + billerName: billerName + crn: crn + billerCode: billerCode + properties: + billerCode: + description: BPAY Biller Code of the Biller + type: string + crn: + description: BPAY CRN of the Biller (if available).
Where the CRN contains + sensitive information, it should be masked in line with how the Data Holder + currently displays account identifiers in their existing online banking + channels. If the contents of the CRN match the format of a Credit Card + PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). + If the contents are otherwise sensitive, then it should be masked using + the rules applicable for the [MaskedAccountString](#common-field-types) + common type. + type: string + billerName: + description: Name of the Biller + type: string + required: + - billerCode + - billerName + type: object + x-conditional: + - crn + BankingInternationalPayee: + example: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + properties: + beneficiaryDetails: + $ref: '#/components/schemas/BankingInternationalPayee_beneficiaryDetails' + bankDetails: + $ref: '#/components/schemas/BankingInternationalPayee_bankDetails' + required: + - bankDetails + - beneficiaryDetails + type: object + BankingDigitalWalletPayee: + example: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + properties: + name: + description: The display name of the wallet as given by the customer, else + a default value defined by the data holder + type: string + identifier: + description: The identifier of the digital wallet (dependent on type) + type: string + type: + description: The type of the digital wallet identifier + enum: + - EMAIL + - CONTACT_NAME + - TELEPHONE + type: string + provider: + description: The provider of the digital wallet + enum: + - PAYPAL_AU + - OTHER + type: string + required: + - identifier + - name + - provider + - type + type: object + ResponseBankingDirectDebitAuthorisationList: + example: + data: + directDebitAuthorisations: + - lastDebitAmount: lastDebitAmount + accountId: accountId + lastDebitDateTime: lastDebitDateTime + authorisedEntity: + arbn: arbn + description: description + financialInstitution: financialInstitution + abn: abn + acn: acn + - lastDebitAmount: lastDebitAmount + accountId: accountId + lastDebitDateTime: lastDebitDateTime + authorisedEntity: + arbn: arbn + description: description + financialInstitution: financialInstitution + abn: abn + acn: acn + meta: + totalRecords: 0 + totalPages: 6 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + BankingDirectDebit: + example: + lastDebitAmount: lastDebitAmount + accountId: accountId + lastDebitDateTime: lastDebitDateTime + authorisedEntity: + arbn: arbn + description: description + financialInstitution: financialInstitution + abn: abn + acn: acn + properties: + accountId: + description: A unique ID of the account adhering to the standards for ID + permanence. + type: string + x-cds-type: ASCIIString + authorisedEntity: + $ref: '#/components/schemas/BankingAuthorisedEntity' + lastDebitDateTime: + description: The date and time of the last debit executed under this authorisation + type: string + x-cds-type: DateTimeString + lastDebitAmount: + description: The amount of the last debit executed under this authorisation + type: string + x-cds-type: AmountString + required: + - accountId + - authorisedEntity + type: object + BankingAuthorisedEntity: + example: + arbn: arbn + description: description + financialInstitution: financialInstitution + abn: abn + acn: acn + properties: + description: + description: Description of the authorised entity derived from previously + executed direct debits + type: string + financialInstitution: + description: Name of the financial institution through which the direct + debit will be executed. Is required unless the payment is made via a credit + card scheme + type: string + abn: + description: Australian Business Number for the authorised entity + type: string + acn: + description: Australian Company Number for the authorised entity + type: string + arbn: + description: Australian Registered Body Number for the authorised entity + type: string + type: object + x-conditional: + - financialInstitution + ResponseBankingScheduledPaymentsListV2: + example: + data: + scheduledPayments: + - recurrence: + nextPaymentDate: nextPaymentDate + eventBased: + description: description + onceOff: + paymentDate: paymentDate + recurrenceUType: eventBased + intervalSchedule: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + lastWeekDay: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + scheduledPaymentId: scheduledPaymentId + payeeReference: payeeReference + payerReference: payerReference + nickname: nickname + from: + accountId: accountId + paymentSet: + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + status: ACTIVE + - recurrence: + nextPaymentDate: nextPaymentDate + eventBased: + description: description + onceOff: + paymentDate: paymentDate + recurrenceUType: eventBased + intervalSchedule: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + lastWeekDay: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + scheduledPaymentId: scheduledPaymentId + payeeReference: payeeReference + payerReference: payerReference + nickname: nickname + from: + accountId: accountId + paymentSet: + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + status: ACTIVE + meta: + totalRecords: 0 + totalPages: 6 + links: + next: next + last: last + prev: prev + self: self + first: first + properties: + data: + $ref: '#/components/schemas/ResponseBankingScheduledPaymentsListV2_data' + links: + $ref: '#/components/schemas/LinksPaginated' + meta: + $ref: '#/components/schemas/MetaPaginated' + required: + - data + - links + - meta + type: object + BankingScheduledPaymentV2: + example: + recurrence: + nextPaymentDate: nextPaymentDate + eventBased: + description: description + onceOff: + paymentDate: paymentDate + recurrenceUType: eventBased + intervalSchedule: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + lastWeekDay: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + scheduledPaymentId: scheduledPaymentId + payeeReference: payeeReference + payerReference: payerReference + nickname: nickname + from: + accountId: accountId + paymentSet: + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + status: ACTIVE + properties: + scheduledPaymentId: + description: A unique ID of the scheduled payment adhering to the standards + for ID permanence + type: string + x-cds-type: ASCIIString + nickname: + description: The short display name of the scheduled payment as provided + by the customer if provided. Where a customer has not provided a nickname, + a display name derived by the bank for the scheduled payment should be + provided that is consistent with existing digital banking channels + type: string + payerReference: + description: The reference for the transaction that will be used by the + originating institution for the purposes of constructing a statement narrative + on the payer’s account. Empty string if no data provided + type: string + payeeReference: + description: The reference for the transaction, if applicable, that will + be provided by the originating institution for all payments in the payment + set. Empty string if no data provided + type: string + status: + description: Indicates whether the schedule is currently active. The value + `SKIP` is equivalent to `ACTIVE` except that the customer has requested + the next normal occurrence to be skipped. + enum: + - ACTIVE + - INACTIVE + - SKIP + type: string + from: + $ref: '#/components/schemas/BankingScheduledPaymentFrom' + paymentSet: + items: + $ref: '#/components/schemas/BankingScheduledPaymentSetV2' + type: array + recurrence: + $ref: '#/components/schemas/BankingScheduledPaymentRecurrence' + required: + - from + - payerReference + - paymentSet + - recurrence + - scheduledPaymentId + - status + type: object + x-conditional: + - payeeReference + BankingScheduledPaymentSetV2: + description: The set of payment amounts and destination accounts for this payment + accommodating multi-part payments. A single entry indicates a simple payment + with one destination account. Must have at least one entry + example: + isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + properties: + to: + $ref: '#/components/schemas/BankingScheduledPaymentToV2' + isAmountCalculated: + description: Flag indicating whether the amount of the payment is calculated + based on the context of the event. For instance a payment to reduce the + balance of a credit card to zero. If absent then false is assumed + type: boolean + x-cds-type: Boolean + amount: + description: The amount of the next payment if known. Mandatory unless the + isAmountCalculated field is set to true. Must be zero or positive if present + type: string + x-cds-type: AmountString + currency: + description: The currency for the payment. `AUD` assumed if not present + type: string + x-cds-type: CurrencyString + required: + - to + type: object + x-conditional: + - amount + BankingScheduledPaymentToV2: + description: Object containing details of the destination of the payment. Used + to specify a variety of payment destination types + example: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + properties: + toUType: + description: The type of object provided that specifies the destination + of the funds for the payment. + enum: + - accountId + - biller + - digitalWallet + - domestic + - international + - payeeId + type: string + accountId: + description: Present if `toUType` is set to `accountId`. Indicates that + the payment is to another account that is accessible under the current + consent + type: string + x-cds-type: ASCIIString + payeeId: + description: Present if `toUType` is set to `payeeId`. Indicates that the + payment is to registered payee that can be accessed using the payee endpoint. + If the Bank Payees scope has not been consented to then a `payeeId` should + not be provided and the full payee details should be provided instead + type: string + x-cds-type: ASCIIString + nickname: + description: The short display name of the payee as provided by the customer + unless `toUType` is set to `payeeId`. Where a customer has not provided + a nickname, a display name derived by the bank for payee should be provided + that is consistent with existing digital banking channels + type: string + payeeReference: + description: The reference for the transaction, if applicable, that will + be provided by the originating institution for the specific payment. If + not empty, it overrides the value provided at the BankingScheduledPayment + level. + type: string + digitalWallet: + $ref: '#/components/schemas/BankingDigitalWalletPayee' + domestic: + $ref: '#/components/schemas/BankingDomesticPayee' + biller: + $ref: '#/components/schemas/BankingBillerPayee' + international: + $ref: '#/components/schemas/BankingInternationalPayee' + required: + - toUType + type: object + x-conditional: + - accountId + - payeeId + - digitalWallet + - domestic + - biller + - international + - nickname + - payeeReference + BankingScheduledPaymentFrom: + description: Object containing details of the source of the payment. Currently + only specifies an account ID but provided as an object to facilitate future + extensibility and consistency with the to object + example: + accountId: accountId + properties: + accountId: + description: ID of the account that is the source of funds for the payment + type: string + x-cds-type: ASCIIString + required: + - accountId + type: object + BankingScheduledPaymentRecurrence: + description: Object containing the detail of the schedule for the payment + example: + nextPaymentDate: nextPaymentDate + eventBased: + description: description + onceOff: + paymentDate: paymentDate + recurrenceUType: eventBased + intervalSchedule: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + lastWeekDay: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + properties: + nextPaymentDate: + description: The date of the next payment under the recurrence schedule + type: string + x-cds-type: DateString + recurrenceUType: + description: The type of recurrence used to define the schedule + enum: + - eventBased + - intervalSchedule + - lastWeekDay + - onceOff + type: string + onceOff: + $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceOnceOff' + intervalSchedule: + $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceIntervalSchedule' + lastWeekDay: + $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekday' + eventBased: + $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceEventBased' + required: + - recurrenceUType + type: object + x-conditional: + - onceOff + - intervalSchedule + - lastWeekDay + - eventBased + BankingScheduledPaymentRecurrenceOnceOff: + description: Indicates that the payment is a once off payment on a specific + future date. Mandatory if recurrenceUType is set to onceOff + example: + paymentDate: paymentDate + properties: + paymentDate: + description: The scheduled date for the once off payment + type: string + x-cds-type: DateString + required: + - paymentDate + type: object + BankingScheduledPaymentRecurrenceIntervalSchedule: + description: Indicates that the schedule of payments is defined by a series + of intervals. Mandatory if recurrenceUType is set to intervalSchedule + example: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + properties: + finalPaymentDate: + description: The limit date after which no more payments should be made + using this schedule. If both finalPaymentDate and paymentsRemaining are + present then payments will stop according to the most constraining value. + If neither field is present the payments will continue indefinitely + type: string + x-cds-type: DateString + paymentsRemaining: + description: Indicates the number of payments remaining in the schedule. + If both finalPaymentDate and paymentsRemaining are present then payments + will stop according to the most constraining value, If neither field is + present the payments will continue indefinitely + example: 1 + type: integer + x-cds-type: PositiveInteger + nonBusinessDayTreatment: + default: "ON" + description: Enumerated field giving the treatment where a scheduled payment + date is not a business day. If absent assumed to be `ON`.
**AFTER** + - If a scheduled payment date is a non-business day the payment will be + made on the first business day after the scheduled payment date.
**BEFORE** + - If a scheduled payment date is a non-business day the payment will be + made on the first business day before the scheduled payment date.
**ON** + - If a scheduled payment date is a non-business day the payment will be + made on that day regardless.
**ONLY** - Payments only occur on business + days. If a scheduled payment date is a non-business day the payment will + be ignored + enum: + - AFTER + - BEFORE + - "ON" + - ONLY + type: string + intervals: + description: An array of interval objects defining the payment schedule. Each + entry in the array is additive, in that it adds payments to the overall + payment schedule. If multiple intervals result in a payment on the same + day then only one payment will be made. Must have at least one entry + items: + $ref: '#/components/schemas/BankingScheduledPaymentInterval' + type: array + required: + - intervals + type: object + BankingScheduledPaymentInterval: + example: + interval: interval + dayInInterval: dayInInterval + properties: + interval: + description: An interval for the payment. Formatted according to [ISO 8601 + Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes + recurrence syntax) with components less than a day in length ignored. + This duration defines the period between payments starting with nextPaymentDate + type: string + x-cds-type: ExternalRef + dayInInterval: + description: Uses an interval to define the ordinal day within the interval + defined by the interval field on which the payment occurs. If the resulting + duration is 0 days in length or larger than the number of days in the + interval then the payment will occur on the last day of the interval. + A duration of 1 day indicates the first day of the interval. If absent + the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) with components less than a day in length + ignored. The first day of a week is considered to be Monday. + type: string + x-cds-type: ExternalRef + required: + - interval + type: object + BankingScheduledPaymentRecurrenceLastWeekday: + description: Indicates that the schedule of payments is defined according to + the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType + is set to lastWeekDay + example: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + properties: + finalPaymentDate: + description: The limit date after which no more payments should be made + using this schedule. If both finalPaymentDate and paymentsRemaining are + present then payments will stop according to the most constraining value. + If neither field is present the payments will continue indefinitely + type: string + x-cds-type: DateString + paymentsRemaining: + description: Indicates the number of payments remaining in the schedule. + If both finalPaymentDate and paymentsRemaining are present then payments + will stop according to the most constraining value. If neither field is + present the payments will continue indefinitely + example: 1 + type: integer + x-cds-type: PositiveInteger + interval: + description: The interval for the payment. Formatted according to [ISO 8601 + Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes + recurrence syntax) with components less than a day in length ignored. + This duration defines the period between payments starting with nextPaymentDate + type: string + x-cds-type: ExternalRef + lastWeekDay: + description: The weekDay specified. The payment will occur on the last occurrence + of this weekday in the interval. + enum: + - FRI + - MON + - SAT + - SUN + - THU + - TUE + - WED + type: string + nonBusinessDayTreatment: + default: "ON" + description: Enumerated field giving the treatment where a scheduled payment + date is not a business day. If absent assumed to be `ON`.
**AFTER** + - If a scheduled payment date is a non-business day the payment will be + made on the first business day after the scheduled payment date.
**BEFORE** + - If a scheduled payment date is a non-business day the payment will be + made on the first business day before the scheduled payment date.
**ON** + - If a scheduled payment date is a non-business day the payment will be + made on that day regardless.
**ONLY** - Payments only occur on business + days. If a scheduled payment date is a non-business day the payment will + be ignored + enum: + - AFTER + - BEFORE + - "ON" + - ONLY + type: string + required: + - interval + - lastWeekDay + type: object + BankingScheduledPaymentRecurrenceEventBased: + description: Indicates that the schedule of payments is defined according to + an external event that cannot be predetermined. Mandatory if recurrenceUType + is set to eventBased + example: + description: description + properties: + description: + description: Description of the event and conditions that will result in + the payment. Expected to be formatted for display to a customer + type: string + required: + - description + type: object + CommonPhysicalAddress: + properties: + addressUType: + description: The type of address object present + enum: + - paf + - simple + type: string + simple: + $ref: '#/components/schemas/CommonSimpleAddress' + paf: + $ref: '#/components/schemas/CommonPAFAddress' + required: + - addressUType + type: object + x-conditional: + - simple + - paf + CommonSimpleAddress: + properties: + mailingName: + description: Name of the individual or business formatted for inclusion + in an address used for physical mail + type: string + addressLine1: + description: First line of the standard address object + type: string + addressLine2: + description: Second line of the standard address object + type: string + addressLine3: + description: Third line of the standard address object + type: string + postcode: + description: Mandatory for Australian addresses + type: string + city: + description: Name of the city or locality + type: string + state: + description: Free text if the country is not Australia. If country is Australia + then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) + in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + type: string + country: + default: AUS + description: A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) + country code. Australia (AUS) is assumed if country is not present. + type: string + x-cds-type: ExternalRef + required: + - addressLine1 + - city + - state + type: object + x-conditional: + - postcode + CommonPAFAddress: + description: Australian address formatted according to the file format defined + by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) + properties: + dpid: + description: Unique identifier for an address as defined by Australia Post. Also + known as Delivery Point Identifier + type: string + thoroughfareNumber1: + description: Thoroughfare number for a property (first number in a property + ranged address) + type: integer + x-cds-type: PositiveInteger + thoroughfareNumber1Suffix: + description: Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 + is populated + type: string + thoroughfareNumber2: + description: Second thoroughfare number (only used if the property has a + ranged address eg 23-25) + type: integer + x-cds-type: PositiveInteger + thoroughfareNumber2Suffix: + description: Suffix for the second thoroughfare number. Only relevant is + thoroughfareNumber2 is populated + type: string + flatUnitType: + description: Type of flat or unit for the address + type: string + flatUnitNumber: + description: Unit number (including suffix, if applicable) + type: string + floorLevelType: + description: Type of floor or level for the address + type: string + floorLevelNumber: + description: Floor or level number (including alpha characters) + type: string + lotNumber: + description: Allotment number for the address + type: string + buildingName1: + description: Building/Property name 1 + type: string + buildingName2: + description: Building/Property name 2 + type: string + streetName: + description: The name of the street + type: string + streetType: + description: The street type. Valid enumeration defined by Australia Post + PAF code file + type: string + streetSuffix: + description: The street type suffix. Valid enumeration defined by Australia + Post PAF code file + type: string + postalDeliveryType: + description: Postal delivery type. (eg. PO BOX). Valid enumeration defined + by Australia Post PAF code file + type: string + postalDeliveryNumber: + description: Postal delivery number if the address is a postal delivery + type + type: integer + x-cds-type: PositiveInteger + postalDeliveryNumberPrefix: + description: Postal delivery number prefix related to the postal delivery + number + type: string + postalDeliveryNumberSuffix: + description: Postal delivery number suffix related to the postal delivery + number + type: string + localityName: + description: Full name of locality + type: string + postcode: + description: Postcode for the locality + type: string + state: + description: State in which the address belongs. Valid enumeration defined + by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). + NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + type: string + required: + - localityName + - postcode + - state + type: object + Links: + example: + self: self + properties: + self: + description: Fully qualified link that generated the current response document + type: string + x-cds-type: URIString + required: + - self + type: object + Meta: + type: object + LinksPaginated: + example: + next: next + last: last + prev: prev + self: self + first: first + properties: + self: + description: Fully qualified link that generated the current response document + type: string + x-cds-type: URIString + first: + description: URI to the first page of this set. Mandatory if this response + is not the first page + type: string + x-cds-type: URIString + prev: + description: URI to the previous page of this set. Mandatory if this response + is not the first page + type: string + x-cds-type: URIString + next: + description: URI to the next page of this set. Mandatory if this response + is not the last page + type: string + x-cds-type: URIString + last: + description: URI to the last page of this set. Mandatory if this response + is not the last page + type: string + x-cds-type: URIString + required: + - self + type: object + x-conditional: + - prev + - next + - first + - last + MetaPaginated: + example: + totalRecords: 0 + totalPages: 6 + properties: + totalRecords: + description: The total number of records in the full set. See [pagination](#pagination). + type: integer + x-cds-type: NaturalNumber + totalPages: + description: The total number of pages in the full set. See [pagination](#pagination). + type: integer + x-cds-type: NaturalNumber + required: + - totalPages + - totalRecords + type: object + MetaPaginatedTransaction: + allOf: + - $ref: '#/components/schemas/MetaPaginated' + - $ref: '#/components/schemas/MetaPaginatedTransaction_allOf' + MetaError: + description: Additional data for customised error codes + properties: + urn: + description: The CDR error code URN which the application-specific error + code extends. Mandatory if the error `code` is an application-specific + error rather than a standardised error code. + type: string + type: object + x-conditional: + - urn + ResponseErrorListV2: + properties: + errors: + items: + $ref: '#/components/schemas/ResponseErrorListV2_errors' + type: array + required: + - errors + type: object + x-conditional: + - meta + BankingProductCategoryV2: + description: The category to which a product or account belongs. See [here](#product-categories) + for more details + 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 + type: string + RequestAccountIds_data: + example: + accountIds: + - accountIds + - accountIds + properties: + accountIds: + items: + description: Array of specific accountIds to obtain authorisations for + type: string + x-cds-type: ASCIIString + type: array + required: + - accountIds + type: object + ResponseBankingProductListV3_data: + example: + products: + - additionalInformation: + eligibilityUri: eligibilityUri + additionalFeesAndPricingUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalTermsUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + bundleUri: bundleUri + feesAndPricingUri: feesAndPricingUri + additionalBundleUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalEligibilityUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalOverviewUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + termsUri: termsUri + overviewUri: overviewUri + brandName: brandName + productId: productId + description: description + effectiveTo: effectiveTo + lastUpdated: lastUpdated + isTailored: true + name: name + applicationUri: applicationUri + cardOption: + cardImages: + - imageUri: imageUri + title: title + - imageUri: imageUri + title: title + cardScheme: AMEX + cardType: CHARGE + effectiveFrom: effectiveFrom + brand: brand + - additionalInformation: + eligibilityUri: eligibilityUri + additionalFeesAndPricingUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalTermsUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + bundleUri: bundleUri + feesAndPricingUri: feesAndPricingUri + additionalBundleUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalEligibilityUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + additionalOverviewUris: + - additionalInfoUri: additionalInfoUri + description: description + - additionalInfoUri: additionalInfoUri + description: description + termsUri: termsUri + overviewUri: overviewUri + brandName: brandName + productId: productId + description: description + effectiveTo: effectiveTo + lastUpdated: lastUpdated + isTailored: true + name: name + applicationUri: applicationUri + cardOption: + cardImages: + - imageUri: imageUri + title: title + - imageUri: imageUri + title: title + cardScheme: AMEX + cardType: CHARGE + effectiveFrom: effectiveFrom + brand: brand + properties: + products: + description: The list of products returned. If the filter results in an + empty set then this array may have no records + items: + $ref: '#/components/schemas/BankingProductV5' + type: array + required: + - products + type: object + BankingProductDetailV5_allOf: + properties: + bundles: + description: An array of bundles that this product participates in. Each + bundle is described by free form information but also by a list of product + IDs of the other products that are included in the bundle. It is assumed + that the current product is included in the bundle also + items: + $ref: '#/components/schemas/BankingProductBundle' + type: array + features: + description: Array of features and limitations of the product + items: + $ref: '#/components/schemas/BankingProductFeatureV3' + type: array + constraints: + description: Constraints on the application for the product such as minimum + balances or limit thresholds + items: + $ref: '#/components/schemas/BankingProductConstraintV2' + type: array + eligibility: + description: Eligibility criteria for the product + items: + $ref: '#/components/schemas/BankingProductEligibility' + type: array + fees: + description: Fees applicable to the product + items: + $ref: '#/components/schemas/BankingProductFeeV2' + type: array + depositRates: + description: Interest rates available for deposits + items: + $ref: '#/components/schemas/BankingProductDepositRateV2' + type: array + lendingRates: + description: Interest rates charged against lending balances + items: + $ref: '#/components/schemas/BankingProductLendingRateV3' + type: array + instalments: + $ref: '#/components/schemas/BankingProductInstalments' + type: object + ResponseBankingAccountListV3_data: + example: + accounts: + - accountId: accountId + maskedNumber: maskedNumber + openStatus: OPEN + displayName: displayName + isOwned: true + nickname: nickname + creationDate: creationDate + productName: productName + accountOwnership: UNKNOWN + - accountId: accountId + maskedNumber: maskedNumber + openStatus: OPEN + displayName: displayName + isOwned: true + nickname: nickname + creationDate: creationDate + productName: productName + accountOwnership: UNKNOWN + properties: + accounts: + description: The list of accounts returned. If the filter results in an + empty set then this array may have no records + items: + $ref: '#/components/schemas/BankingAccountV3' + type: array + required: + - accounts + type: object + BankingAccountDetailV4_allOf: + properties: + bsb: + description: The unmasked BSB for the account. Is expected to be formatted + as digits only with leading zeros included and no punctuation or spaces + type: string + accountNumber: + description: The unmasked account number for the account. Should not be + supplied if the account number is a PAN requiring PCI compliance. Is expected + to be formatted as digits only with leading zeros included and no punctuation + or spaces + type: string + bundleName: + description: Optional field to indicate if this account is part of a bundle + that is providing additional benefit to the customer + type: string + cardOption: + $ref: '#/components/schemas/BankingProductCardOption' + instalments: + $ref: '#/components/schemas/BankingAccountInstalments' + termDeposit: + description: A structure suited to accounts that have term deposit-like + features + items: + $ref: '#/components/schemas/BankingTermDepositAccountV2' + type: array + creditCard: + $ref: '#/components/schemas/BankingCreditCardAccountV2' + loan: + $ref: '#/components/schemas/BankingLoanAccountV3' + deposit: + $ref: '#/components/schemas/BankingDepositAccount' + features: + description: Array of features of the account based on the equivalent structure + in Product Reference with the following additional field + items: + allOf: + - $ref: '#/components/schemas/BankingProductFeatureV3' + - properties: + isActivated: + description: (Note this is + an additional field appended to the feature object defined in + the Product Reference payload.) + type: boolean + x-cds-type: Boolean + type: object + type: object + type: array + fees: + description: Fees and charges applicable to the account based on the equivalent + structure in Product Reference + items: + $ref: '#/components/schemas/BankingProductFeeV2' + type: array + addresses: + description: The addresses for the account to be used for correspondence + items: + $ref: '#/components/schemas/CommonPhysicalAddress' + type: array + type: object + BankingAccountInstalments_allOf: + properties: + plans: + description: Array of instalment plans + items: + $ref: '#/components/schemas/BankingInstalmentPlans' + type: array + type: object + BankingCreditCardPlan_interestFreePeriods: + properties: + from: + description: The date any associated interest-free period will be available + for the plan + type: string + x-cds-type: DateString + to: + description: The date any associated interest-free period will no longer + be available + type: string + x-cds-type: DateString + required: + - to + type: object + ResponseBankingTransactionList_data: + example: + transactions: + - postingDateTime: postingDateTime + amount: amount + apcaNumber: apcaNumber + isDetailAvailable: true + description: description + type: DIRECT_DEBIT + billerName: billerName + executionDateTime: executionDateTime + transactionId: transactionId + merchantName: merchantName + billerCode: billerCode + reference: reference + accountId: accountId + merchantCategoryCode: merchantCategoryCode + valueDateTime: valueDateTime + currency: currency + crn: crn + status: PENDING + - postingDateTime: postingDateTime + amount: amount + apcaNumber: apcaNumber + isDetailAvailable: true + description: description + type: DIRECT_DEBIT + billerName: billerName + executionDateTime: executionDateTime + transactionId: transactionId + merchantName: merchantName + billerCode: billerCode + reference: reference + accountId: accountId + merchantCategoryCode: merchantCategoryCode + valueDateTime: valueDateTime + currency: currency + crn: crn + status: PENDING + properties: + transactions: + items: + $ref: '#/components/schemas/BankingTransaction' + type: array + required: + - transactions + type: object + BankingTransactionDetail_allOf_extendedData_x2p101Payload: + properties: + extendedDescription: + description: An extended string description. Required if the extensionUType + field is `x2p101Payload` + type: string + endToEndId: + description: An end to end ID for the payment created at initiation + type: string + purposeCode: + description: Purpose of the payment. Format is defined by NPP standards + for the x2p1.01 overlay service + type: string + type: object + x-conditional: + - extendedDescription + BankingTransactionDetail_allOf_extendedData: + properties: + payer: + description: Label of the originating payer. Mandatory for inbound payment + type: string + payee: + description: Label of the target PayID. Mandatory for an outbound payment. + The name assigned to the BSB/Account Number or PayID (by the owner of + the PayID) + type: string + extensionUType: + description: Optional extended data specific to transactions originated + via NPP + enum: + - x2p101Payload + type: string + x2p101Payload: + $ref: '#/components/schemas/BankingTransactionDetail_allOf_extendedData_x2p101Payload' + service: + description: 'Identifier of the applicable overlay service. Valid values + are: `X2P1.01`' + enum: + - X2P1.01 + type: string + required: + - service + type: object + x-conditional: + - payer + - payee + - x2p101Payload + BankingTransactionDetail_allOf: + properties: + extendedData: + $ref: '#/components/schemas/BankingTransactionDetail_allOf_extendedData' + required: + - extendedData + type: object + ResponseBankingAccountsBalanceList_data: + example: + balances: + - accountId: accountId + purses: + - amount: amount + currency: currency + - amount: amount + currency: currency + amortisedLimit: amortisedLimit + currentBalance: currentBalance + creditLimit: creditLimit + currency: currency + availableBalance: availableBalance + - accountId: accountId + purses: + - amount: amount + currency: currency + - amount: amount + currency: currency + amortisedLimit: amortisedLimit + currentBalance: currentBalance + creditLimit: creditLimit + currency: currency + availableBalance: availableBalance + properties: + balances: + description: The list of balances returned + items: + $ref: '#/components/schemas/BankingBalance' + type: array + required: + - balances + type: object + ResponseBankingPayeeListV2_data: + example: + payees: + - nickname: nickname + description: description + payeeId: payeeId + type: BILLER + creationDate: creationDate + - nickname: nickname + description: description + payeeId: payeeId + type: BILLER + creationDate: creationDate + properties: + payees: + description: The list of payees returned + items: + $ref: '#/components/schemas/BankingPayeeV2' + type: array + required: + - payees + type: object + BankingPayeeDetailV2_allOf: + properties: + payeeUType: + description: Type of object included that describes the payee in detail + enum: + - biller + - digitalWallet + - domestic + - international + type: string + biller: + $ref: '#/components/schemas/BankingBillerPayee' + domestic: + $ref: '#/components/schemas/BankingDomesticPayee' + digitalWallet: + $ref: '#/components/schemas/BankingDigitalWalletPayee' + international: + $ref: '#/components/schemas/BankingInternationalPayee' + required: + - payeeUType + type: object + x-conditional: + - biller + - digitalWallet + - domestic + - international + BankingInternationalPayee_beneficiaryDetails: + example: + country: country + name: name + message: message + properties: + name: + description: Name of the beneficiary + type: string + country: + description: Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) + country code + type: string + x-cds-type: ExternalRef + message: + description: Response message for the payment + type: string + required: + - country + type: object + BankingInternationalPayee_bankDetails_bankAddress: + example: + address: address + name: name + properties: + name: + description: Name of the recipient Bank + type: string + address: + description: Address of the recipient Bank + type: string + required: + - address + - name + type: object + BankingInternationalPayee_bankDetails: + example: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + properties: + country: + description: Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) + country code + type: string + x-cds-type: ExternalRef + accountNumber: + description: Account Targeted for payment + type: string + bankAddress: + $ref: '#/components/schemas/BankingInternationalPayee_bankDetails_bankAddress' + beneficiaryBankBIC: + description: Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html) + type: string + x-cds-type: ExternalRef + fedWireNumber: + description: Number for Fedwire payment (Federal Reserve Wire Network) + type: string + sortCode: + description: Sort code used for account identification in some jurisdictions + type: string + chipNumber: + description: Number for the Clearing House Interbank Payments System + type: string + routingNumber: + description: International bank routing number + type: string + legalEntityIdentifier: + description: The legal entity identifier (LEI) for the beneficiary. Aligns + with [ISO 17442](https://www.iso.org/standard/59771.html) + type: string + x-cds-type: ExternalRef + required: + - accountNumber + - country + type: object + ResponseBankingDirectDebitAuthorisationList_data: + example: + directDebitAuthorisations: + - lastDebitAmount: lastDebitAmount + accountId: accountId + lastDebitDateTime: lastDebitDateTime + authorisedEntity: + arbn: arbn + description: description + financialInstitution: financialInstitution + abn: abn + acn: acn + - lastDebitAmount: lastDebitAmount + accountId: accountId + lastDebitDateTime: lastDebitDateTime + authorisedEntity: + arbn: arbn + description: description + financialInstitution: financialInstitution + abn: abn + acn: acn + properties: + directDebitAuthorisations: + description: The list of authorisations returned + items: + $ref: '#/components/schemas/BankingDirectDebit' + type: array + required: + - directDebitAuthorisations + type: object + ResponseBankingScheduledPaymentsListV2_data: + example: + scheduledPayments: + - recurrence: + nextPaymentDate: nextPaymentDate + eventBased: + description: description + onceOff: + paymentDate: paymentDate + recurrenceUType: eventBased + intervalSchedule: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + lastWeekDay: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + scheduledPaymentId: scheduledPaymentId + payeeReference: payeeReference + payerReference: payerReference + nickname: nickname + from: + accountId: accountId + paymentSet: + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + status: ACTIVE + - recurrence: + nextPaymentDate: nextPaymentDate + eventBased: + description: description + onceOff: + paymentDate: paymentDate + recurrenceUType: eventBased + intervalSchedule: + intervals: + - interval: interval + dayInInterval: dayInInterval + - interval: interval + dayInInterval: dayInInterval + paymentsRemaining: 1 + finalPaymentDate: finalPaymentDate + nonBusinessDayTreatment: "ON" + lastWeekDay: + paymentsRemaining: 1 + interval: interval + finalPaymentDate: finalPaymentDate + lastWeekDay: FRI + nonBusinessDayTreatment: "ON" + scheduledPaymentId: scheduledPaymentId + payeeReference: payeeReference + payerReference: payerReference + nickname: nickname + from: + accountId: accountId + paymentSet: + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + - isAmountCalculated: true + amount: amount + currency: currency + to: + domestic: + payeeAccountUType: account + payId: + identifier: identifier + name: name + type: ABN + account: + bsb: bsb + accountName: accountName + accountNumber: accountNumber + card: + cardNumber: cardNumber + accountId: accountId + biller: + billerName: billerName + crn: crn + billerCode: billerCode + digitalWallet: + identifier: identifier + provider: PAYPAL_AU + name: name + type: EMAIL + payeeReference: payeeReference + toUType: accountId + nickname: nickname + payeeId: payeeId + international: + bankDetails: + country: country + routingNumber: routingNumber + fedWireNumber: fedWireNumber + chipNumber: chipNumber + legalEntityIdentifier: legalEntityIdentifier + accountNumber: accountNumber + bankAddress: + address: address + name: name + sortCode: sortCode + beneficiaryBankBIC: beneficiaryBankBIC + beneficiaryDetails: + country: country + name: name + message: message + status: ACTIVE + properties: + scheduledPayments: + description: The list of scheduled payments to return + items: + $ref: '#/components/schemas/BankingScheduledPaymentV2' + type: array + required: + - scheduledPayments + type: object + MetaPaginatedTransaction_allOf: + properties: + isQueryParamUnsupported: + default: false + description: '**true** if *"text"* query parameter is not supported' + type: boolean + x-cds-type: Boolean + type: object + ResponseErrorListV2_errors: + properties: + code: + description: The code of the error encountered. Where the error is specific + to the respondent, an application-specific error code, expressed as a + string value. If the error is application-specific, the URN code that + the specific error extends must be provided in the meta object. Otherwise, + the value is the error code URN. + type: string + title: + description: A short, human-readable summary of the problem that MUST NOT + change from occurrence to occurrence of the problem represented by the + error code. + type: string + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string + meta: + $ref: '#/components/schemas/MetaError' + required: + - code + - detail + - title + type: object diff --git a/docs/includes/swagger/cds_banking_non_bank_lending.json b/docs/includes/swagger/cds_banking_non_bank_lending.json index 55199d26..c9ad4a1d 100644 --- a/docs/includes/swagger/cds_banking_non_bank_lending.json +++ b/docs/includes/swagger/cds_banking_non_bank_lending.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Banking API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" @@ -20,10 +20,10 @@ "paths" : { "/banking/accounts" : { "get" : { - "description" : "Obtain a list of accounts.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html)", + "description" : "Obtain a list of accounts.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html), [v2](../../../../includes/obsolete/get-accounts-v2.html)", "operationId" : "listAccounts", "parameters" : [ { - "description" : "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.)", + "description" : "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.)", "explode" : true, "in" : "query", "name" : "product-category", @@ -34,7 +34,7 @@ }, "style" : "form" }, { - "description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", "explode" : true, "in" : "query", "name" : "open-status", @@ -84,7 +84,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -94,7 +94,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -155,14 +155,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ResponseBankingAccountListV2" + "$ref" : "#/components/schemas/ResponseBankingAccountListV3" } } }, "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -243,15 +243,15 @@ "summary" : "Get Accounts", "tags" : [ "Banking", "Accounts" ], "x-scopes" : [ "bank:accounts.basic:read" ], - "x-version" : "2" + "x-version" : "3" } }, "/banking/accounts/balances" : { "get" : { - "description" : "Obtain balances for multiple, filtered accounts", + "description" : "Obtain balances for multiple, filtered accounts\n\nObsolete versions: [v1](../../../../includes/obsolete/get-bulk-balances-v1.html)", "operationId" : "listBalancesBulk", "parameters" : [ { - "description" : "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.", + "description" : "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.", "explode" : true, "in" : "query", "name" : "product-category", @@ -262,7 +262,7 @@ }, "style" : "form" }, { - "description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", "explode" : true, "in" : "query", "name" : "open-status", @@ -312,7 +312,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -322,7 +322,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -390,7 +390,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -471,7 +471,7 @@ "summary" : "Get Bulk Balances", "tags" : [ "Banking", "Accounts" ], "x-scopes" : [ "bank:accounts.basic:read" ], - "x-version" : "1" + "x-version" : "2" }, "post" : { "description" : "Obtain balances for a specified list of accounts", @@ -503,7 +503,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -513,7 +513,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -592,7 +592,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -694,7 +694,7 @@ "style" : "simple", "x-cds-type" : "ASCIIString" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -704,7 +704,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -772,7 +772,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -858,7 +858,7 @@ }, "/banking/accounts/{accountId}" : { "get" : { - "description" : "Obtain detailed information on a single account.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html)", + "description" : "Obtain detailed information on a single account.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html), [v3](../../../../includes/obsolete/get-account-detail-v3.html)", "operationId" : "getAccountDetail", "parameters" : [ { "description" : "A tokenised identifier for the account which is unique but not shareable", @@ -873,7 +873,7 @@ "style" : "simple", "x-cds-type" : "ASCIIString" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -883,7 +883,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -944,14 +944,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ResponseBankingAccountByIdV3" + "$ref" : "#/components/schemas/ResponseBankingAccountByIdV4" } } }, "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -1032,15 +1032,15 @@ "summary" : "Get Account Detail", "tags" : [ "Banking", "Accounts" ], "x-scopes" : [ "bank:accounts.detail:read" ], - "x-version" : "3" + "x-version" : "4" } }, "/banking/accounts/{accountId}/transactions" : { "get" : { - "description" : "Obtain transactions for a specific account.\n\nSome general notes that apply to all end points that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- 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:\n - Posted date/time if available, then\n - Execution date/time if available, then\n - A reasonable date/time nominated by the data holder using internal data structures\n- 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\n- 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", + "description" : "Obtain transactions for a specific account.\n\nSome general notes that apply to all endpoints that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- 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:\n - Posted date/time if available, then\n - Execution date/time if available, then\n - A reasonable date/time nominated by the data holder using internal data structures\n- 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\n- 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", "operationId" : "getTransactions", "parameters" : [ { - "description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list end points.", + "description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", @@ -1136,7 +1136,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -1146,7 +1146,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -1214,7 +1214,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -1323,7 +1323,7 @@ "description" : "Obtain detailed information on a transaction for a specific account", "operationId" : "getTransactionDetail", "parameters" : [ { - "description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list end points", + "description" : "ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints", "explode" : false, "in" : "path", "name" : "accountId", @@ -1335,7 +1335,7 @@ "style" : "simple", "x-cds-type" : "ASCIIString" }, { - "description" : "ID of the transaction obtained from a previous call to one of the other transaction end points", + "description" : "ID of the transaction obtained from a previous call to one of the other transaction endpoints", "explode" : false, "in" : "path", "name" : "transactionId", @@ -1347,7 +1347,7 @@ "style" : "simple", "x-cds-type" : "ASCIIString" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -1357,7 +1357,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -1425,7 +1425,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -1514,7 +1514,7 @@ "description" : "Obtain direct debit authorisations for a specific account", "operationId" : "listDirectDebits", "parameters" : [ { - "description" : "ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points.", + "description" : "ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", @@ -1552,7 +1552,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -1562,7 +1562,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -1630,7 +1630,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -1736,10 +1736,10 @@ }, "/banking/accounts/direct-debits" : { "get" : { - "description" : "Obtain direct debit authorisations for multiple, filtered accounts", + "description" : "Obtain direct debit authorisations for multiple, filtered accounts\n\nObsolete versions: [v1](../../../../includes/obsolete/get-bulk-direct-debits-v1.html)", "operationId" : "listDirectDebitsBulk", "parameters" : [ { - "description" : "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.", + "description" : "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.", "explode" : true, "in" : "query", "name" : "product-category", @@ -1750,7 +1750,7 @@ }, "style" : "form" }, { - "description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", "explode" : true, "in" : "query", "name" : "open-status", @@ -1800,7 +1800,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -1810,7 +1810,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -1878,7 +1878,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -1959,7 +1959,7 @@ "summary" : "Get Bulk Direct Debits", "tags" : [ "Banking", "Direct Debits" ], "x-scopes" : [ "bank:regular_payments:read" ], - "x-version" : "1" + "x-version" : "2" }, "post" : { "description" : "Obtain direct debit authorisations for a specified list of accounts", @@ -1991,7 +1991,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -2001,7 +2001,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -2080,7 +2080,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -2170,7 +2170,7 @@ "description" : "Obtain scheduled, outgoing payments for a specific account\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-account-v1.html)", "operationId" : "listScheduledPayments", "parameters" : [ { - "description" : "ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment", + "description" : "ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment", "explode" : false, "in" : "path", "name" : "accountId", @@ -2208,7 +2208,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -2218,7 +2218,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -2286,7 +2286,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -2392,10 +2392,10 @@ }, "/banking/payments/scheduled" : { "get" : { - "description" : "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html)", + "description" : "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](../../../../includes/obsolete/get-scheduled-payments-bulk-v2.html)", "operationId" : "listScheduledPaymentsBulk", "parameters" : [ { - "description" : "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.", + "description" : "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.", "explode" : true, "in" : "query", "name" : "product-category", @@ -2406,7 +2406,7 @@ }, "style" : "form" }, { - "description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", "explode" : true, "in" : "query", "name" : "open-status", @@ -2456,7 +2456,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -2466,7 +2466,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -2534,7 +2534,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -2615,7 +2615,7 @@ "summary" : "Get Scheduled Payments Bulk", "tags" : [ "Banking", "Scheduled Payments" ], "x-scopes" : [ "bank:regular_payments:read" ], - "x-version" : "2" + "x-version" : "3" }, "post" : { "description" : "Obtain scheduled payments for a specified list of accounts\n\nObsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html)", @@ -2647,7 +2647,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -2657,7 +2657,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -2736,7 +2736,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -2864,7 +2864,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -2874,7 +2874,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -2942,7 +2942,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -3043,7 +3043,7 @@ "style" : "simple", "x-cds-type" : "ASCIIString" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -3053,7 +3053,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -3121,7 +3121,7 @@ "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -3227,10 +3227,10 @@ }, "/banking/products" : { "get" : { - "description" : "Obtain a list of products that are currently openly offered to the market\n\nNote that the results returned by this end point are expected to be ordered in descending order according to ``lastUpdated``.\n\n### Conventions\nIn the product reference payloads there are a number of recurring conventions that are explained here, in one place.\n\n#### Arrays Of Features\n\nIn the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:\n\n- Each element in an array has the same structure so that clients can reliably interpret the payloads\n- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.\n- Each element has a field name [additionalValue](#productfeaturetypedoc). 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.\n- 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.\n- 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.\n- Depending on the type of data being represented there may be additional specific fields.\n\n#### URIs To More Information\n\nAs 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.\n\nThese 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.\n\n#### Linkage To Accounts\nFrom 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.\n\nFor 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.\n\nSimilarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process.\n\n#### Dates\nIt 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.\n\nIn 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.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html) [v2](../../../../includes/obsolete/get-products-v2.html)", + "description" : "Obtain a list of products that are currently openly offered to the market\n\nNote that the results returned by this endpoint are expected to be ordered in descending order according to `lastUpdated`.\n\n### Conventions\nIn the product reference payloads there are a number of recurring conventions that are explained here, in one place.\n\n#### Arrays Of Features\n\nIn the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:\n\n- Each element in an array has the same structure so that clients can reliably interpret the payloads\n- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.\n- Each element has a field name [additionalValue](#productfeaturetypedoc). 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.\n- 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.\n- 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.\n- Depending on the type of data being represented there may be additional specific fields.\n\n#### URIs To More Information\n\nAs 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.\n\nThese 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.\n\n#### Linkage To Accounts\nFrom 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.\n\nFor 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.\n\nSimilarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process.\n\n#### Dates\nIt 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.\n\nIn 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.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html), [v2](../../../../includes/obsolete/get-products-v2.html), [v3](../../../../includes/obsolete/get-products-v3.html)", "operationId" : "listProducts", "parameters" : [ { - "description" : "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'", + "description" : "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`", "explode" : true, "in" : "query", "name" : "effective", @@ -3264,7 +3264,7 @@ }, "style" : "form" }, { - "description" : "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.", + "description" : "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.", "explode" : true, "in" : "query", "name" : "product-category", @@ -3301,7 +3301,7 @@ "style" : "form", "x-cds-type" : "PositiveInteger" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -3311,7 +3311,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -3326,14 +3326,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ResponseBankingProductListV2" + "$ref" : "#/components/schemas/ResponseBankingProductListV3" } } }, "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -3375,12 +3375,12 @@ }, "summary" : "Get Products", "tags" : [ "Banking", "Products" ], - "x-version" : "3" + "x-version" : "4" } }, "/banking/products/{productId}" : { "get" : { - "description" : "Obtain detailed information on a single product offered openly to the market.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html) [v2](../../../../includes/obsolete/get-product-detail-v2.html) [v3](../../../../includes/obsolete/get-product-detail-v3.html)", + "description" : "Obtain detailed information on a single product offered openly to the market.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html), [v2](../../../../includes/obsolete/get-product-detail-v2.html), [v3](../../../../includes/obsolete/get-product-detail-v3.html), [v4](../../../../includes/obsolete/get-product-detail-v4.html)", "operationId" : "getProductDetail", "parameters" : [ { "description" : "ID of the specific product requested", @@ -3395,7 +3395,7 @@ "style" : "simple", "x-cds-type" : "ASCIIString" }, { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -3405,7 +3405,7 @@ }, "style" : "simple" }, { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -3420,14 +3420,14 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ResponseBankingProductByIdV4" + "$ref" : "#/components/schemas/ResponseBankingProductByIdV5" } } }, "description" : "Success", "headers" : { "x-v" : { - "description" : "The [version](#response-headers) of the API end point that the data holder has responded with.", + "description" : "The [version](#response-headers) of the API endpoint that the data holder has responded with.", "explode" : false, "schema" : { "type" : "string" @@ -3469,14 +3469,14 @@ }, "summary" : "Get Product Detail", "tags" : [ "Banking", "Products" ], - "x-version" : "4" + "x-version" : "5" } } }, "components" : { "parameters" : { "RequestHeader_x-v" : { - "description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", + "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)", "explode" : false, "in" : "header", "name" : "x-v", @@ -3487,7 +3487,7 @@ "style" : "simple" }, "RequestHeader_x-min-v" : { - "description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", + "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", @@ -3548,7 +3548,7 @@ "x-cds-type" : "Base64" }, "ParamAccountOpenStatus" : { - "description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", + "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed", "explode" : true, "in" : "query", "name" : "open-status", @@ -3561,7 +3561,7 @@ "style" : "form" }, "ParamProductCategory" : { - "description" : "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.", + "description" : "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.", "explode" : true, "in" : "query", "name" : "product-category", @@ -3690,10 +3690,10 @@ "required" : [ "data" ], "type" : "object" }, - "ResponseBankingProductListV2" : { + "ResponseBankingProductListV3" : { "properties" : { "data" : { - "$ref" : "#/components/schemas/ResponseBankingProductListV2_data" + "$ref" : "#/components/schemas/ResponseBankingProductListV3_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" @@ -3705,7 +3705,7 @@ "required" : [ "data", "links", "meta" ], "type" : "object" }, - "BankingProductV4" : { + "BankingProductV5" : { "properties" : { "productId" : { "description" : "A data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.", @@ -3728,7 +3728,7 @@ "x-cds-type" : "DateTimeString" }, "productCategory" : { - "$ref" : "#/components/schemas/BankingProductCategory" + "$ref" : "#/components/schemas/BankingProductCategoryV2" }, "name" : { "description" : "The display name of the product", @@ -3762,7 +3762,7 @@ "cardArt" : { "description" : "An array of card art images", "items" : { - "$ref" : "#/components/schemas/BankingProductV4_cardArt" + "$ref" : "#/components/schemas/BankingProductV5_cardArt" }, "type" : "array" } @@ -3852,10 +3852,10 @@ "required" : [ "additionalInfoUri" ], "type" : "object" }, - "ResponseBankingProductByIdV4" : { + "ResponseBankingProductByIdV5" : { "properties" : { "data" : { - "$ref" : "#/components/schemas/BankingProductDetailV4" + "$ref" : "#/components/schemas/BankingProductDetailV5" }, "links" : { "$ref" : "#/components/schemas/Links" @@ -3867,11 +3867,11 @@ "required" : [ "data", "links" ], "type" : "object" }, - "BankingProductDetailV4" : { + "BankingProductDetailV5" : { "allOf" : [ { - "$ref" : "#/components/schemas/BankingProductV4" + "$ref" : "#/components/schemas/BankingProductV5" }, { - "$ref" : "#/components/schemas/BankingProductDetailV4_allOf" + "$ref" : "#/components/schemas/BankingProductDetailV5_allOf" } ] }, "BankingProductBundle" : { @@ -3894,7 +3894,7 @@ "x-cds-type" : "URIString" }, "productIds" : { - "description" : "Array of product IDs for products included in the bundle that are available via the product end points. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points", + "description" : "Array of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints", "items" : { "type" : "string", "x-cds-type" : "ASCIIString" @@ -3905,11 +3905,11 @@ "required" : [ "description", "name" ], "type" : "object" }, - "BankingProductFeatureV2" : { + "BankingProductFeatureV3" : { "properties" : { "featureType" : { - "description" : "The type of feature described", - "enum" : [ "ADDITIONAL_CARDS", "BALANCE_TRANSFERS", "BILL_PAYMENT", "BONUS_REWARDS", "CARD_ACCESS", "CASHBACK_OFFER", "COMPLEMENTARY_PRODUCT_DISCOUNTS", "DIGITAL_BANKING", "DIGITAL_WALLET", "DONATE_INTEREST", "EXTRA_REPAYMENTS", "FRAUD_PROTECTION", "FREE_TXNS", "FREE_TXNS_ALLOWANCE", "GUARANTOR", "INSURANCE", "INSTALMENT_PLAN", "INTEREST_FREE", "INTEREST_FREE_TRANSFERS", "LOYALTY_PROGRAM", "NOTIFICATIONS", "NPP_ENABLED", "NPP_PAYID", "OFFSET", "OTHER", "OVERDRAFT", "REDRAW", "RELATIONSHIP_MANAGEMENT", "UNLIMITED_TXNS" ], + "description" : "The type of feature described. For further details, refer to [featureType](#tocSproductfeaturetypedoc)", + "enum" : [ "ADDITIONAL_CARDS", "BALANCE_TRANSFERS", "BILL_PAYMENT", "BONUS_REWARDS", "CARD_ACCESS", "CASHBACK_OFFER", "COMPLEMENTARY_PRODUCT_DISCOUNTS", "EXTRA_DOWN_PAYMENT", "DIGITAL_BANKING", "DIGITAL_WALLET", "DONATE_INTEREST", "EXTRA_REPAYMENTS", "FRAUD_PROTECTION", "FREE_TXNS", "FREE_TXNS_ALLOWANCE", "GUARANTOR", "INSURANCE", "INSTALMENT_PLAN", "INTEREST_FREE", "INTEREST_FREE_TRANSFERS", "LOYALTY_PROGRAM", "NOTIFICATIONS", "NPP_ENABLED", "NPP_PAYID", "OFFSET", "OTHER", "OVERDRAFT", "REDRAW", "RELATIONSHIP_MANAGEMENT", "UNLIMITED_TXNS" ], "type" : "string" }, "additionalValue" : { @@ -3917,7 +3917,7 @@ "type" : "string" }, "additionalInfo" : { - "description" : "Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to OTHER", + "description" : "Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to `OTHER`", "type" : "string" }, "additionalInfoUri" : { @@ -3933,7 +3933,7 @@ "BankingProductConstraint" : { "properties" : { "constraintType" : { - "description" : "The type of constraint described. See the next section for an overview of valid values and their meaning", + "description" : "The type of constraint described. See the next section for an overview of valid values and their meaning", "enum" : [ "MAX_BALANCE", "MAX_LIMIT", "MIN_BALANCE", "MIN_LIMIT", "OPENING_BALANCE" ], "type" : "string" }, @@ -3942,7 +3942,7 @@ "type" : "string" }, "additionalInfo" : { - "description" : "Display text providing more information the constraint", + "description" : "Display text providing more information on the constraint", "type" : "string" }, "additionalInfoUri" : { @@ -3967,7 +3967,7 @@ "type" : "string" }, "additionalInfo" : { - "description" : "Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) criteria. Mandatory if the field is set to OTHER", + "description" : "Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) criteria. Mandatory if the field is set to `OTHER`", "type" : "string" }, "additionalInfoUri" : { @@ -3987,7 +3987,7 @@ "type" : "string" }, "feeType" : { - "description" : "The type of fee", + "description" : "The type of fee. For details refer to [Product Fee Types](#tocSproductfeetypedoc).", "enum" : [ "DEPOSIT", "EVENT", "EXIT", "PAYMENT", "PAYMENT_LATE", "PERIODIC", "PURCHASE", "TRANSACTION", "UPFRONT", "UPFRONT_PER_PLAN", "VARIABLE", "WITHDRAWAL" ], "type" : "string" }, @@ -4145,12 +4145,12 @@ "x-cds-type" : "RateString" }, "calculationFrequency" : { - "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", "type" : "string", "x-cds-type" : "ExternalRef" }, "applicationFrequency" : { - "description" : "The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", "type" : "string", "x-cds-type" : "ExternalRef" }, @@ -4197,12 +4197,12 @@ "x-cds-type" : "RateString" }, "calculationFrequency" : { - "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "description" : "The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", "type" : "string", "x-cds-type" : "ExternalRef" }, "applicationFrequency" : { - "description" : "The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "description" : "The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", "type" : "string", "x-cds-type" : "ExternalRef" }, @@ -4233,7 +4233,7 @@ "type" : "string" }, "additionalInfo" : { - "description" : "Display text providing more information on the rate.", + "description" : "Display text providing more information on the rate", "type" : "string" }, "additionalInfoUri" : { @@ -4254,17 +4254,17 @@ "type" : "string" }, "unitOfMeasure" : { - "description" : "The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers)", + "description" : "The unit of measure that applies to the `minimumValue` and `maximumValue` values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers)", "enum" : [ "DAY", "DOLLAR", "MONTH", "PERCENT" ], "type" : "string" }, "minimumValue" : { - "description" : "The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value", + "description" : "The number of `unitOfMeasure` units that form the lower bound of the tier. The tier should be inclusive of this value", "type" : "number", "x-cds-type" : "Number" }, "maximumValue" : { - "description" : "The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.", + "description" : "The number of `unitOfMeasure` units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as `minimumValue`. Where this is the same as the `minimumValue` value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.", "type" : "number", "x-cds-type" : "Number" }, @@ -4277,7 +4277,7 @@ "$ref" : "#/components/schemas/BankingProductRateCondition" }, "additionalInfo" : { - "description" : "Display text providing more information on the rate tier.", + "description" : "Display text providing more information on the rate tier", "type" : "string" }, "additionalInfoUri" : { @@ -4304,10 +4304,49 @@ }, "type" : "object" }, - "ResponseBankingAccountListV2" : { + "BankingProductInstalments" : { + "properties" : { + "maximumPlanCount" : { + "description" : "Total number of plans that may be created", + "example" : 1, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "instalmentsLimit" : { + "description" : "Maximum combined limit of all instalment plans that may be created", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "minimumPlanValue" : { + "description" : "Minimum value that can be opened as an instalment plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "maximumPlanValue" : { + "description" : "Maximum value that can be opened as an instalment plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "minimumSplit" : { + "description" : "Minimum number of instalment payments a plan can be created with", + "example" : 4, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + }, + "maximumSplit" : { + "description" : "Maximum number of instalment payments a plan can be created with", + "example" : 4, + "type" : "integer", + "x-cds-type" : "PositiveInteger" + } + }, + "required" : [ "instalmentsLimit", "maximumPlanCount", "maximumPlanValue", "maximumSplit", "minimumPlanValue", "minimumSplit" ], + "type" : "object" + }, + "ResponseBankingAccountListV3" : { "properties" : { "data" : { - "$ref" : "#/components/schemas/ResponseBankingAccountListV2_data" + "$ref" : "#/components/schemas/ResponseBankingAccountListV3_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" @@ -4319,7 +4358,7 @@ "required" : [ "data", "links", "meta" ], "type" : "object" }, - "BankingAccountV2" : { + "BankingAccountV3" : { "properties" : { "accountId" : { "description" : "A unique ID of the account adhering to the standards for ID permanence", @@ -4341,7 +4380,7 @@ }, "openStatus" : { "default" : "OPEN", - "description" : "Open or closed status for the account. If not present then OPEN is assumed", + "description" : "Open or closed status for the account. If not present then `OPEN` is assumed", "enum" : [ "CLOSED", "OPEN" ], "type" : "string" }, @@ -4362,7 +4401,7 @@ "x-cds-type" : "MaskedAccountString" }, "productCategory" : { - "$ref" : "#/components/schemas/BankingProductCategory" + "$ref" : "#/components/schemas/BankingProductCategoryV2" }, "productName" : { "description" : "The unique identifier of the account as defined by the data holder (akin to model number for the account)", @@ -4372,10 +4411,10 @@ "required" : [ "accountId", "accountOwnership", "displayName", "maskedNumber", "productCategory", "productName" ], "type" : "object" }, - "ResponseBankingAccountByIdV3" : { + "ResponseBankingAccountByIdV4" : { "properties" : { "data" : { - "$ref" : "#/components/schemas/BankingAccountDetailV3" + "$ref" : "#/components/schemas/BankingAccountDetailV4" }, "links" : { "$ref" : "#/components/schemas/Links" @@ -4387,13 +4426,74 @@ "required" : [ "data", "links" ], "type" : "object" }, - "BankingAccountDetailV3" : { + "BankingAccountDetailV4" : { "allOf" : [ { - "$ref" : "#/components/schemas/BankingAccountV2" + "$ref" : "#/components/schemas/BankingAccountV3" }, { - "$ref" : "#/components/schemas/BankingAccountDetailV3_allOf" + "$ref" : "#/components/schemas/BankingAccountDetailV4_allOf" } ] }, + "BankingAccountInstalments" : { + "allOf" : [ { + "$ref" : "#/components/schemas/BankingProductInstalments" + }, { + "$ref" : "#/components/schemas/BankingAccountInstalments_allOf" + } ], + "description" : "Details of instalment features on the account" + }, + "BankingInstalmentPlans" : { + "properties" : { + "planNickname" : { + "description" : "The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels", + "type" : "string" + }, + "creationDate" : { + "description" : "The date the plan was created", + "type" : "string", + "x-cds-type" : "DateString" + }, + "amount" : { + "description" : "The total amount of the plan", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "duration" : { + "description" : "The original expected repayment duration. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "instalmentInterval" : { + "description" : "The expected repayment interval. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)", + "type" : "string", + "x-cds-type" : "ExternalRef" + }, + "schedule" : { + "description" : "Array of expected repayment amounts and dates", + "items" : { + "$ref" : "#/components/schemas/BankingInstalmentPlanSchedule" + }, + "type" : "array" + } + }, + "required" : [ "amount", "creationDate", "duration", "instalmentInterval", "planNickname", "schedule" ], + "type" : "object" + }, + "BankingInstalmentPlanSchedule" : { + "properties" : { + "amountDue" : { + "description" : "Amount due with this repayment", + "type" : "string", + "x-cds-type" : "AmountString" + }, + "dueDate" : { + "description" : "Date this repayment is due", + "type" : "string", + "x-cds-type" : "DateString" + } + }, + "required" : [ "amountDue", "dueDate" ], + "type" : "object" + }, "BankingTermDepositAccount" : { "properties" : { "lodgementDate" : { @@ -4563,7 +4663,7 @@ "x-cds-type" : "ASCIIString" }, "isDetailAvailable" : { - "description" : "True if extended information is available using the transaction detail end point. False if extended data is not available", + "description" : "True if extended information is available using the transaction detail endpoint. False if extended data is not available", "type" : "boolean", "x-cds-type" : "Boolean" }, @@ -5096,17 +5196,17 @@ "type" : "string" }, "accountId" : { - "description" : "Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent", + "description" : "Present if `toUType` is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent", "type" : "string", "x-cds-type" : "ASCIIString" }, "payeeId" : { - "description" : "Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead", + "description" : "Present if `toUType` is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a `payeeId` should not be provided and the full payee details should be provided instead", "type" : "string", "x-cds-type" : "ASCIIString" }, "nickname" : { - "description" : "The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels", + "description" : "The short display name of the payee as provided by the customer unless `toUType` is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels", "type" : "string" }, "payeeReference" : { @@ -5200,7 +5300,7 @@ }, "nonBusinessDayTreatment" : { "default" : "ON", - "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored", + "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored", "enum" : [ "AFTER", "BEFORE", "ON", "ONLY" ], "type" : "string" }, @@ -5257,7 +5357,7 @@ }, "nonBusinessDayTreatment" : { "default" : "ON", - "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored", + "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored", "enum" : [ "AFTER", "BEFORE", "ON", "ONLY" ], "type" : "string" } @@ -5526,7 +5626,7 @@ "type" : "object", "x-conditional" : [ "meta" ] }, - "BankingProductCategory" : { + "BankingProductCategoryV2" : { "description" : "The category to which a product or account belongs. See [here](#product-categories) for more details", "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" ], "type" : "string" @@ -5545,12 +5645,12 @@ "required" : [ "accountIds" ], "type" : "object" }, - "ResponseBankingProductListV2_data" : { + "ResponseBankingProductListV3_data" : { "properties" : { "products" : { "description" : "The list of products returned. If the filter results in an empty set then this array may have no records", "items" : { - "$ref" : "#/components/schemas/BankingProductV4" + "$ref" : "#/components/schemas/BankingProductV5" }, "type" : "array" } @@ -5558,7 +5658,7 @@ "required" : [ "products" ], "type" : "object" }, - "BankingProductV4_cardArt" : { + "BankingProductV5_cardArt" : { "properties" : { "title" : { "description" : "Display label for the specific image", @@ -5573,7 +5673,7 @@ "required" : [ "imageUri" ], "type" : "object" }, - "BankingProductDetailV4_allOf" : { + "BankingProductDetailV5_allOf" : { "properties" : { "bundles" : { "description" : "An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also", @@ -5585,7 +5685,7 @@ "features" : { "description" : "Array of features available for the product", "items" : { - "$ref" : "#/components/schemas/BankingProductFeatureV2" + "$ref" : "#/components/schemas/BankingProductFeatureV3" }, "type" : "array" }, @@ -5604,7 +5704,7 @@ "type" : "array" }, "fees" : { - "description" : "Fees applicable for the product", + "description" : "Fees applicable to the product", "items" : { "$ref" : "#/components/schemas/BankingProductFee" }, @@ -5623,16 +5723,19 @@ "$ref" : "#/components/schemas/BankingProductLendingRateV2" }, "type" : "array" + }, + "instalments" : { + "$ref" : "#/components/schemas/BankingProductInstalments" } }, "type" : "object" }, - "ResponseBankingAccountListV2_data" : { + "ResponseBankingAccountListV3_data" : { "properties" : { "accounts" : { "description" : "The list of accounts returned. If the filter results in an empty set then this array may have no records", "items" : { - "$ref" : "#/components/schemas/BankingAccountV2" + "$ref" : "#/components/schemas/BankingAccountV3" }, "type" : "array" } @@ -5640,7 +5743,7 @@ "required" : [ "accounts" ], "type" : "object" }, - "BankingAccountDetailV3_allOf" : { + "BankingAccountDetailV4_allOf" : { "properties" : { "bsb" : { "description" : "The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces", @@ -5654,6 +5757,9 @@ "description" : "Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer", "type" : "string" }, + "instalments" : { + "$ref" : "#/components/schemas/BankingAccountInstalments" + }, "specificAccountUType" : { "description" : "The type of structure to present account specific fields.", "enum" : [ "creditCard", "loan", "termDeposit" ], @@ -5699,7 +5805,7 @@ "description" : "Array of features of the account based on the equivalent structure in Product Reference with the following additional field", "items" : { "allOf" : [ { - "$ref" : "#/components/schemas/BankingProductFeatureV2" + "$ref" : "#/components/schemas/BankingProductFeatureV3" }, { "properties" : { "isActivated" : { @@ -5733,6 +5839,18 @@ "type" : "object", "x-conditional" : [ "termDeposit", "creditCard", "loan" ] }, + "BankingAccountInstalments_allOf" : { + "properties" : { + "plans" : { + "description" : "Array of instalment plans", + "items" : { + "$ref" : "#/components/schemas/BankingInstalmentPlans" + }, + "type" : "array" + } + }, + "type" : "object" + }, "ResponseBankingTransactionList_data" : { "properties" : { "transactions" : { @@ -5956,7 +6074,7 @@ "MetaPaginatedTransaction_allOf" : { "properties" : { "isQueryParamUnsupported" : { - "default" : true, + "default" : false, "description" : "**true** if *\"text\"* query parameter is not supported", "type" : "boolean", "x-cds-type" : "Boolean" diff --git a/docs/includes/swagger/cds_banking_non_bank_lending.yaml b/docs/includes/swagger/cds_banking_non_bank_lending.yaml index dea912a5..79219b36 100644 --- a/docs/includes/swagger/cds_banking_non_bank_lending.yaml +++ b/docs/includes/swagger/cds_banking_non_bank_lending.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Banking API - version: 1.27.0 + version: 1.28.0 servers: - url: https://data.holder.com.au/cds-au/v1 paths: @@ -20,10 +20,10 @@ paths: description: |- Obtain a list of accounts. - Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html) + Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html), [v2](../../../../includes/obsolete/get-accounts-v2.html) operationId: listAccounts parameters: - - description: Used to filter results on the productCategory field applicable + - description: 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.) explode: true @@ -48,7 +48,7 @@ paths: type: string style: form - description: Used to filter results according to open/closed status. Values - can be OPEN, CLOSED or ALL. If absent then ALL is assumed + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed explode: true in: query name: open-status @@ -95,13 +95,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -109,11 +110,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -176,11 +177,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResponseBankingAccountListV2' + $ref: '#/components/schemas/ResponseBankingAccountListV3' description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -258,13 +259,16 @@ paths: - Accounts x-scopes: - bank:accounts.basic:read - x-version: "2" + x-version: "3" /banking/accounts/balances: get: - description: Obtain balances for multiple, filtered accounts + description: |- + Obtain balances for multiple, filtered accounts + + Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-balances-v1.html) operationId: listBalancesBulk parameters: - - description: Used to filter results on the productCategory field applicable + - description: 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. explode: true @@ -289,7 +293,7 @@ paths: type: string style: form - description: Used to filter results according to open/closed status. Values - can be OPEN, CLOSED or ALL. If absent then ALL is assumed + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed explode: true in: query name: open-status @@ -336,13 +340,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -350,11 +355,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -421,7 +426,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -499,7 +504,7 @@ paths: - Accounts x-scopes: - bank:accounts.basic:read - x-version: "1" + x-version: "2" post: description: Obtain balances for a specified list of accounts operationId: listBalancesSpecificAccounts @@ -526,13 +531,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -540,11 +546,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -618,7 +624,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -715,13 +721,14 @@ paths: x-cds-type: ASCIIString style: simple x-cds-type: ASCIIString - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -729,11 +736,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -800,7 +807,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -884,7 +891,7 @@ paths: description: |- Obtain detailed information on a single account. - Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html) + Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html), [v3](../../../../includes/obsolete/get-account-detail-v3.html) operationId: getAccountDetail parameters: - description: A tokenised identifier for the account which is unique but not @@ -898,13 +905,14 @@ paths: x-cds-type: ASCIIString style: simple x-cds-type: ASCIIString - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -912,11 +920,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -979,11 +987,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResponseBankingAccountByIdV3' + $ref: '#/components/schemas/ResponseBankingAccountByIdV4' description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -1061,13 +1069,13 @@ paths: - Accounts x-scopes: - bank:accounts.detail:read - x-version: "3" + x-version: "4" /banking/accounts/{accountId}/transactions: get: description: |- Obtain transactions for a specific account. - Some general notes that apply to all end points that retrieve transactions: + Some general notes that apply to all endpoints that retrieve transactions: - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as: @@ -1079,7 +1087,7 @@ paths: operationId: getTransactions parameters: - description: ID of the account to get transactions for. Must have previously - been returned by one of the account list end points. + been returned by one of the account list endpoints. explode: false in: path name: accountId @@ -1171,13 +1179,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -1185,11 +1194,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -1256,7 +1265,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -1361,7 +1370,7 @@ paths: operationId: getTransactionDetail parameters: - description: ID of the account to get transactions for. Must have previously - been returned by one of the account list end points + been returned by one of the account list endpoints explode: false in: path name: accountId @@ -1372,7 +1381,7 @@ paths: style: simple x-cds-type: ASCIIString - description: ID of the transaction obtained from a previous call to one of - the other transaction end points + the other transaction endpoints explode: false in: path name: transactionId @@ -1382,13 +1391,14 @@ paths: x-cds-type: ASCIIString style: simple x-cds-type: ASCIIString - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -1396,11 +1406,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -1467,7 +1477,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -1555,7 +1565,7 @@ paths: operationId: listDirectDebits parameters: - description: ID of the account to get direct debit authorisations for. Must - have previously been returned by one of the account list end points. + have previously been returned by one of the account list endpoints. explode: false in: path name: accountId @@ -1587,13 +1597,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -1601,11 +1612,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -1672,7 +1683,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -1772,10 +1783,13 @@ paths: x-version: "1" /banking/accounts/direct-debits: get: - description: Obtain direct debit authorisations for multiple, filtered accounts + description: |- + Obtain direct debit authorisations for multiple, filtered accounts + + Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-direct-debits-v1.html) operationId: listDirectDebitsBulk parameters: - - description: Used to filter results on the productCategory field applicable + - description: 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. explode: true @@ -1800,7 +1814,7 @@ paths: type: string style: form - description: Used to filter results according to open/closed status. Values - can be OPEN, CLOSED or ALL. If absent then ALL is assumed + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed explode: true in: query name: open-status @@ -1847,13 +1861,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -1861,11 +1876,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -1932,7 +1947,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -2010,7 +2025,7 @@ paths: - Direct Debits x-scopes: - bank:regular_payments:read - x-version: "1" + x-version: "2" post: description: Obtain direct debit authorisations for a specified list of accounts operationId: listDirectDebitsSpecificAccounts @@ -2037,13 +2052,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -2051,11 +2067,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -2129,7 +2145,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -2220,7 +2236,7 @@ paths: operationId: listScheduledPayments parameters: - description: ID of the account to get scheduled payments for. Must have previously - been returned by one of the account list end points. The account specified + been returned by one of the account list endpoints. The account specified is the source account for the payment explode: false in: path @@ -2253,13 +2269,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -2267,11 +2284,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -2338,7 +2355,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -2441,10 +2458,10 @@ paths: description: |- Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments - Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html) + Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](../../../../includes/obsolete/get-scheduled-payments-bulk-v2.html) operationId: listScheduledPaymentsBulk parameters: - - description: Used to filter results on the productCategory field applicable + - description: 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. explode: true @@ -2469,7 +2486,7 @@ paths: type: string style: form - description: Used to filter results according to open/closed status. Values - can be OPEN, CLOSED or ALL. If absent then ALL is assumed + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed explode: true in: query name: open-status @@ -2516,13 +2533,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -2530,11 +2548,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -2601,7 +2619,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -2679,7 +2697,7 @@ paths: - Scheduled Payments x-scopes: - bank:regular_payments:read - x-version: "2" + x-version: "3" post: description: |- Obtain scheduled payments for a specified list of accounts @@ -2709,13 +2727,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -2723,11 +2742,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -2802,7 +2821,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -2931,13 +2950,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -2945,11 +2965,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -3016,7 +3036,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -3115,13 +3135,14 @@ paths: x-cds-type: ASCIIString style: simple x-cds-type: ASCIIString - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -3129,11 +3150,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -3200,7 +3221,7 @@ paths: description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -3303,7 +3324,7 @@ paths: description: |- Obtain a list of products that are currently openly offered to the market - Note that the results returned by this end point are expected to be ordered in descending order according to ``lastUpdated``. + Note that the results returned by this endpoint are expected to be ordered in descending order according to `lastUpdated`. ### Conventions In the product reference payloads there are a number of recurring conventions that are explained here, in one place. @@ -3314,9 +3335,9 @@ paths: - 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](#productfeaturetypedoc). 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. + - Each element has a field name [additionalValue](#productfeaturetypedoc). 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. + - 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 @@ -3328,22 +3349,22 @@ paths: #### 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. + For this reason, while `productCategory` is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime. Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process. #### Dates - It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter. + 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. - Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html) [v2](../../../../includes/obsolete/get-products-v2.html) + Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html), [v2](../../../../includes/obsolete/get-products-v2.html), [v3](../../../../includes/obsolete/get-products-v3.html) operationId: listProducts parameters: - description: Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom - and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. - If absent defaults to 'CURRENT' + and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. + If absent defaults to `CURRENT` explode: true in: query name: effective @@ -3375,7 +3396,7 @@ paths: schema: type: string style: form - - description: Used to filter results on the productCategory field applicable + - description: 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. explode: true @@ -3421,13 +3442,14 @@ paths: x-cds-type: PositiveInteger style: form x-cds-type: PositiveInteger - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -3435,11 +3457,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -3452,11 +3474,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResponseBankingProductListV2' + $ref: '#/components/schemas/ResponseBankingProductListV3' description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -3490,13 +3512,13 @@ paths: tags: - Banking - Products - x-version: "3" + x-version: "4" /banking/products/{productId}: get: description: |- Obtain detailed information on a single product offered openly to the market. - Obsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html) [v2](../../../../includes/obsolete/get-product-detail-v2.html) [v3](../../../../includes/obsolete/get-product-detail-v3.html) + Obsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html), [v2](../../../../includes/obsolete/get-product-detail-v2.html), [v3](../../../../includes/obsolete/get-product-detail-v3.html), [v4](../../../../includes/obsolete/get-product-detail-v4.html) operationId: getProductDetail parameters: - description: ID of the specific product requested @@ -3509,13 +3531,14 @@ paths: x-cds-type: ASCIIString style: simple x-cds-type: ASCIIString - - description: Version of the API end point requested by the client. Must be + - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported - then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + then the data holder must respond with a `406 Not Acceptable`. See [HTTP + Headers](#request-headers) explode: false in: header name: x-v @@ -3523,11 +3546,11 @@ paths: schema: type: string style: simple - - description: Minimum version of the API end point requested by the client. + - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then - the data holder must respond with a 406 Not Acceptable. + the data holder must respond with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -3540,11 +3563,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResponseBankingProductByIdV4' + $ref: '#/components/schemas/ResponseBankingProductByIdV5' description: Success headers: x-v: - description: The [version](#response-headers) of the API end point that + description: The [version](#response-headers) of the API endpoint that the data holder has responded with. explode: false schema: @@ -3577,17 +3600,17 @@ paths: tags: - Banking - Products - x-version: "4" + x-version: "5" components: parameters: RequestHeader_x-v: - description: Version of the API end point requested by the client. Must be set + description: Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the - data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) + data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers) explode: false in: header name: x-v @@ -3596,11 +3619,11 @@ components: type: string style: simple RequestHeader_x-min-v: - description: Minimum version of the API end point requested by the client. Must + description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond - with a 406 Not Acceptable. + with a `406 Not Acceptable`. explode: false in: header name: x-min-v @@ -3664,7 +3687,7 @@ components: x-cds-type: Base64 ParamAccountOpenStatus: description: Used to filter results according to open/closed status. Values - can be OPEN, CLOSED or ALL. If absent then ALL is assumed + can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed explode: true in: query name: open-status @@ -3678,7 +3701,7 @@ components: type: string style: form ParamProductCategory: - description: Used to filter results on the productCategory field applicable + description: 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. explode: true @@ -3820,7 +3843,7 @@ components: required: - data type: object - ResponseBankingProductListV2: + ResponseBankingProductListV3: example: data: products: @@ -3927,7 +3950,7 @@ components: first: first properties: data: - $ref: '#/components/schemas/ResponseBankingProductListV2_data' + $ref: '#/components/schemas/ResponseBankingProductListV3_data' links: $ref: '#/components/schemas/LinksPaginated' meta: @@ -3937,7 +3960,7 @@ components: - links - meta type: object - BankingProductV4: + BankingProductV5: example: additionalInformation: eligibilityUri: eligibilityUri @@ -4011,7 +4034,7 @@ components: type: string x-cds-type: DateTimeString productCategory: - $ref: '#/components/schemas/BankingProductCategory' + $ref: '#/components/schemas/BankingProductCategoryV2' name: description: The display name of the product type: string @@ -4043,7 +4066,7 @@ components: cardArt: description: An array of card art images items: - $ref: '#/components/schemas/BankingProductV4_cardArt' + $ref: '#/components/schemas/BankingProductV5_cardArt' type: array required: - brand @@ -4174,14 +4197,14 @@ components: required: - additionalInfoUri type: object - ResponseBankingProductByIdV4: + ResponseBankingProductByIdV5: example: meta: '{}' links: self: self properties: data: - $ref: '#/components/schemas/BankingProductDetailV4' + $ref: '#/components/schemas/BankingProductDetailV5' links: $ref: '#/components/schemas/Links' meta: @@ -4190,10 +4213,10 @@ components: - data - links type: object - BankingProductDetailV4: + BankingProductDetailV5: allOf: - - $ref: '#/components/schemas/BankingProductV4' - - $ref: '#/components/schemas/BankingProductDetailV4_allOf' + - $ref: '#/components/schemas/BankingProductV5' + - $ref: '#/components/schemas/BankingProductDetailV5_allOf' BankingProductBundle: properties: name: @@ -4212,10 +4235,10 @@ components: x-cds-type: URIString productIds: description: Array of product IDs for products included in the bundle that - are available via the product end points. Note that this array is not + are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available - via the product reference end points + via the product reference endpoints items: type: string x-cds-type: ASCIIString @@ -4224,10 +4247,11 @@ components: - description - name type: object - BankingProductFeatureV2: + BankingProductFeatureV3: properties: featureType: - description: The type of feature described + description: The type of feature described. For further details, refer to + [featureType](#tocSproductfeaturetypedoc) enum: - ADDITIONAL_CARDS - BALANCE_TRANSFERS @@ -4236,6 +4260,7 @@ components: - CARD_ACCESS - CASHBACK_OFFER - COMPLEMENTARY_PRODUCT_DISCOUNTS + - EXTRA_DOWN_PAYMENT - DIGITAL_BANKING - DIGITAL_WALLET - DONATE_INTEREST @@ -4266,7 +4291,7 @@ components: type: string additionalInfo: description: Display text providing more information on the feature. Mandatory - if the [feature type](#tocSproductfeaturetypedoc) is set to OTHER + if the [feature type](#tocSproductfeaturetypedoc) is set to `OTHER` type: string additionalInfoUri: description: Link to a web page with more information on this feature @@ -4281,7 +4306,7 @@ components: BankingProductConstraint: properties: constraintType: - description: The type of constraint described. See the next section for + description: The type of constraint described. See the next section for an overview of valid values and their meaning enum: - MAX_BALANCE @@ -4296,7 +4321,7 @@ components: mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc) type: string additionalInfo: - description: Display text providing more information the constraint + description: Display text providing more information on the constraint type: string additionalInfoUri: description: Link to a web page with more information on the constraint @@ -4333,7 +4358,7 @@ components: type: string additionalInfo: description: Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) - criteria. Mandatory if the field is set to OTHER + criteria. Mandatory if the field is set to `OTHER` type: string additionalInfoUri: description: Link to a web page with more information on this eligibility @@ -4352,7 +4377,7 @@ components: description: Name of the fee type: string feeType: - description: The type of fee + description: The type of fee. For details refer to [Product Fee Types](#tocSproductfeetypedoc). enum: - DEPOSIT - EVENT @@ -4574,13 +4599,13 @@ components: description: The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount - is 'applied' to the account (see applicationFrequency). Formatted according + is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) type: string x-cds-type: ExternalRef applicationFrequency: - description: The period after which the calculated amount(s) (see calculationFrequency) + description: The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) @@ -4639,13 +4664,13 @@ components: description: The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount - is 'applied' to the account (see applicationFrequency). Formatted according + is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) type: string x-cds-type: ExternalRef applicationFrequency: - description: The period after which the calculated amount(s) (see calculationFrequency) + description: The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) @@ -4683,7 +4708,7 @@ components: mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc) type: string additionalInfo: - description: Display text providing more information on the rate. + description: Display text providing more information on the rate type: string additionalInfoUri: description: Link to a web page with more information on this rate @@ -4702,9 +4727,9 @@ components: description: A display name for the tier type: string unitOfMeasure: - description: The unit of measure that applies to the tierValueMinimum and - tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the - case of loan-to-value ratio or LVR). Tier term period representing a discrete + description: The unit of measure that applies to the `minimumValue` and + `maximumValue` values e.g. a **DOLLAR** amount. **PERCENT** (in the case + of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers) enum: - DAY @@ -4713,15 +4738,15 @@ components: - PERCENT type: string minimumValue: - description: The number of tierUnitOfMeasure units that form the lower bound + description: The number of `unitOfMeasure` units that form the lower bound of the tier. The tier should be inclusive of this value type: number x-cds-type: Number maximumValue: - description: 'The number of tierUnitOfMeasure units that form the upper - bound of the tier or band. For a tier with a discrete value (as opposed - to a range of values e.g. 1 month) this must be the same as tierValueMinimum. - Where this is the same as the tierValueMinimum value of the next-higher + description: 'The number of `unitOfMeasure` units that form the upper bound + of the tier or band. For a tier with a discrete value (as opposed to a + range of values e.g. 1 month) this must be the same as `minimumValue`. + Where this is the same as the `minimumValue` value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier''s range has no @@ -4740,7 +4765,7 @@ components: applicabilityConditions: $ref: '#/components/schemas/BankingProductRateCondition' additionalInfo: - description: Display text providing more information on the rate tier. + description: Display text providing more information on the rate tier type: string additionalInfoUri: description: Link to a web page with more information on this rate tier @@ -4762,7 +4787,47 @@ components: type: string x-cds-type: URIString type: object - ResponseBankingAccountListV2: + BankingProductInstalments: + properties: + maximumPlanCount: + description: Total number of plans that may be created + example: 1 + type: integer + x-cds-type: PositiveInteger + instalmentsLimit: + description: Maximum combined limit of all instalment plans that may be + created + type: string + x-cds-type: AmountString + minimumPlanValue: + description: Minimum value that can be opened as an instalment plan + type: string + x-cds-type: AmountString + maximumPlanValue: + description: Maximum value that can be opened as an instalment plan + type: string + x-cds-type: AmountString + minimumSplit: + description: Minimum number of instalment payments a plan can be created + with + example: 4 + type: integer + x-cds-type: PositiveInteger + maximumSplit: + description: Maximum number of instalment payments a plan can be created + with + example: 4 + type: integer + x-cds-type: PositiveInteger + required: + - instalmentsLimit + - maximumPlanCount + - maximumPlanValue + - maximumSplit + - minimumPlanValue + - minimumSplit + type: object + ResponseBankingAccountListV3: example: data: accounts: @@ -4795,7 +4860,7 @@ components: first: first properties: data: - $ref: '#/components/schemas/ResponseBankingAccountListV2_data' + $ref: '#/components/schemas/ResponseBankingAccountListV3_data' links: $ref: '#/components/schemas/LinksPaginated' meta: @@ -4805,7 +4870,7 @@ components: - links - meta type: object - BankingAccountV2: + BankingAccountV3: example: accountId: accountId maskedNumber: maskedNumber @@ -4838,7 +4903,7 @@ components: openStatus: default: OPEN description: Open or closed status for the account. If not present then - OPEN is assumed + `OPEN` is assumed enum: - CLOSED - OPEN @@ -4867,7 +4932,7 @@ components: type: string x-cds-type: MaskedAccountString productCategory: - $ref: '#/components/schemas/BankingProductCategory' + $ref: '#/components/schemas/BankingProductCategoryV2' productName: description: The unique identifier of the account as defined by the data holder (akin to model number for the account) @@ -4880,14 +4945,14 @@ components: - productCategory - productName type: object - ResponseBankingAccountByIdV3: + ResponseBankingAccountByIdV4: example: meta: '{}' links: self: self properties: data: - $ref: '#/components/schemas/BankingAccountDetailV3' + $ref: '#/components/schemas/BankingAccountDetailV4' links: $ref: '#/components/schemas/Links' meta: @@ -4896,10 +4961,69 @@ components: - data - links type: object - BankingAccountDetailV3: + BankingAccountDetailV4: allOf: - - $ref: '#/components/schemas/BankingAccountV2' - - $ref: '#/components/schemas/BankingAccountDetailV3_allOf' + - $ref: '#/components/schemas/BankingAccountV3' + - $ref: '#/components/schemas/BankingAccountDetailV4_allOf' + BankingAccountInstalments: + allOf: + - $ref: '#/components/schemas/BankingProductInstalments' + - $ref: '#/components/schemas/BankingAccountInstalments_allOf' + description: Details of instalment features on the account + BankingInstalmentPlans: + properties: + planNickname: + description: The short display name of the plan as provided by the customer. + Where a customer has not provided a nickname, a display name derived by + the data holder consistent with existing channels + type: string + creationDate: + description: The date the plan was created + type: string + x-cds-type: DateString + amount: + description: The total amount of the plan + type: string + x-cds-type: AmountString + duration: + description: The original expected repayment duration. Formatted according + to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + (excludes recurrence syntax) + type: string + x-cds-type: ExternalRef + instalmentInterval: + description: The expected repayment interval. Formatted according to [ISO + 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes + recurrence syntax) + type: string + x-cds-type: ExternalRef + schedule: + description: Array of expected repayment amounts and dates + items: + $ref: '#/components/schemas/BankingInstalmentPlanSchedule' + type: array + required: + - amount + - creationDate + - duration + - instalmentInterval + - planNickname + - schedule + type: object + BankingInstalmentPlanSchedule: + properties: + amountDue: + description: Amount due with this repayment + type: string + x-cds-type: AmountString + dueDate: + description: Date this repayment is due + type: string + x-cds-type: DateString + required: + - amountDue + - dueDate + type: object BankingTermDepositAccount: properties: lodgementDate: @@ -5127,7 +5251,7 @@ components: x-cds-type: ASCIIString isDetailAvailable: description: True if extended information is available using the transaction - detail end point. False if extended data is not available + detail endpoint. False if extended data is not available type: boolean x-cds-type: Boolean type: @@ -6352,21 +6476,22 @@ components: - payeeId type: string accountId: - description: Present if toUType is set to accountId. Indicates that the - payment is to another account that is accessible under the current consent + description: Present if `toUType` is set to `accountId`. Indicates that + the payment is to another account that is accessible under the current + consent type: string x-cds-type: ASCIIString payeeId: - description: Present if toUType is set to payeeId. Indicates that the payment - is to registered payee that can be accessed using the payee end point. - If the Bank Payees scope has not been consented to then a payeeId should + description: Present if `toUType` is set to `payeeId`. Indicates that the + payment is to registered payee that can be accessed using the payee endpoint. + If the Bank Payees scope has not been consented to then a `payeeId` should not be provided and the full payee details should be provided instead type: string x-cds-type: ASCIIString nickname: description: The short display name of the payee as provided by the customer - unless toUType is set to payeeId. Where a customer has not provided a - nickname, a display name derived by the bank for payee should be provided + unless `toUType` is set to `payeeId`. Where a customer has not provided + a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels type: string payeeReference: @@ -6506,7 +6631,7 @@ components: nonBusinessDayTreatment: default: "ON" description: Enumerated field giving the treatment where a scheduled payment - date is not a business day. If absent assumed to be ON.
**AFTER** + date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be @@ -6606,7 +6731,7 @@ components: nonBusinessDayTreatment: default: "ON" description: Enumerated field giving the treatment where a scheduled payment - date is not a business day. If absent assumed to be ON.
**AFTER** + date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be @@ -6883,7 +7008,7 @@ components: type: object x-conditional: - meta - BankingProductCategory: + BankingProductCategoryV2: description: The category to which a product or account belongs. See [here](#product-categories) for more details enum: @@ -6916,7 +7041,7 @@ components: required: - accountIds type: object - ResponseBankingProductListV2_data: + ResponseBankingProductListV3_data: example: products: - additionalInformation: @@ -7016,12 +7141,12 @@ components: description: The list of products returned. If the filter results in an empty set then this array may have no records items: - $ref: '#/components/schemas/BankingProductV4' + $ref: '#/components/schemas/BankingProductV5' type: array required: - products type: object - BankingProductV4_cardArt: + BankingProductV5_cardArt: example: imageUri: imageUri title: title @@ -7038,7 +7163,7 @@ components: required: - imageUri type: object - BankingProductDetailV4_allOf: + BankingProductDetailV5_allOf: properties: bundles: description: An array of bundles that this product participates in. Each @@ -7051,7 +7176,7 @@ components: features: description: Array of features available for the product items: - $ref: '#/components/schemas/BankingProductFeatureV2' + $ref: '#/components/schemas/BankingProductFeatureV3' type: array constraints: description: Constraints on the application for or operation of the product @@ -7065,7 +7190,7 @@ components: $ref: '#/components/schemas/BankingProductEligibility' type: array fees: - description: Fees applicable for the product + description: Fees applicable to the product items: $ref: '#/components/schemas/BankingProductFee' type: array @@ -7079,8 +7204,10 @@ components: items: $ref: '#/components/schemas/BankingProductLendingRateV2' type: array + instalments: + $ref: '#/components/schemas/BankingProductInstalments' type: object - ResponseBankingAccountListV2_data: + ResponseBankingAccountListV3_data: example: accounts: - accountId: accountId @@ -7106,12 +7233,12 @@ components: description: The list of accounts returned. If the filter results in an empty set then this array may have no records items: - $ref: '#/components/schemas/BankingAccountV2' + $ref: '#/components/schemas/BankingAccountV3' type: array required: - accounts type: object - BankingAccountDetailV3_allOf: + BankingAccountDetailV4_allOf: properties: bsb: description: The unmasked BSB for the account. Is expected to be formatted @@ -7127,6 +7254,8 @@ components: description: Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer type: string + instalments: + $ref: '#/components/schemas/BankingAccountInstalments' specificAccountUType: description: The type of structure to present account specific fields. enum: @@ -7169,7 +7298,7 @@ components: in Product Reference with the following additional field items: allOf: - - $ref: '#/components/schemas/BankingProductFeatureV2' + - $ref: '#/components/schemas/BankingProductFeatureV3' - properties: isActivated: default: true @@ -7198,6 +7327,14 @@ components: - termDeposit - creditCard - loan + BankingAccountInstalments_allOf: + properties: + plans: + description: Array of instalment plans + items: + $ref: '#/components/schemas/BankingInstalmentPlans' + type: array + type: object ResponseBankingTransactionList_data: example: transactions: @@ -7758,7 +7895,7 @@ components: MetaPaginatedTransaction_allOf: properties: isQueryParamUnsupported: - default: true + default: false description: '**true** if *"text"* query parameter is not supported' type: boolean x-cds-type: Boolean diff --git a/docs/includes/swagger/cds_common.json b/docs/includes/swagger/cds_common.json index 4913197a..b39d1dc5 100644 --- a/docs/includes/swagger/cds_common.json +++ b/docs/includes/swagger/cds_common.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Common API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_common.yaml b/docs/includes/swagger/cds_common.yaml index c5905858..7bc49911 100644 --- a/docs/includes/swagger/cds_common.yaml +++ b/docs/includes/swagger/cds_common.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Common API - version: 1.27.0 + version: 1.28.0 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/includes/swagger/cds_dcr.json b/docs/includes/swagger/cds_dcr.json index fd75ff4a..b210a359 100644 --- a/docs/includes/swagger/cds_dcr.json +++ b/docs/includes/swagger/cds_dcr.json @@ -3,7 +3,7 @@ "info" : { "description" : "This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints.", "title" : "CDR Dynamic Client Registration API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https://data.holder.com.au/" diff --git a/docs/includes/swagger/cds_dcr.yaml b/docs/includes/swagger/cds_dcr.yaml index 582232b6..a5e69c94 100644 --- a/docs/includes/swagger/cds_dcr.yaml +++ b/docs/includes/swagger/cds_dcr.yaml @@ -3,7 +3,7 @@ info: description: This specification defines the APIs for Data Holders exposing Dynamic Client Registration endpoints. title: CDR Dynamic Client Registration API - version: 1.27.0 + version: 1.28.0 servers: - url: https://data.holder.com.au/ paths: diff --git a/docs/includes/swagger/cds_energy.json b/docs/includes/swagger/cds_energy.json index 3687c905..11984b91 100644 --- a/docs/includes/swagger/cds_energy.json +++ b/docs/includes/swagger/cds_energy.json @@ -3,7 +3,7 @@ "info" : { "description" : "Consumer Data Right end points and payloads for the Energy sector", "title" : "CDR Energy API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "/" diff --git a/docs/includes/swagger/cds_energy.yaml b/docs/includes/swagger/cds_energy.yaml index ec1d6fd4..958451f2 100644 --- a/docs/includes/swagger/cds_energy.yaml +++ b/docs/includes/swagger/cds_energy.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: description: Consumer Data Right end points and payloads for the Energy sector title: CDR Energy API - version: 1.27.0 + version: 1.28.0 servers: - url: / paths: diff --git a/docs/includes/swagger/cds_energy_sdh.json b/docs/includes/swagger/cds_energy_sdh.json index 6a0a91f1..ad383064 100644 --- a/docs/includes/swagger/cds_energy_sdh.json +++ b/docs/includes/swagger/cds_energy_sdh.json @@ -3,7 +3,7 @@ "info" : { "description" : "Consumer Data Right end points and payloads for Secondary Data Holder for the Energy sector", "title" : "CDR Energy Secondary Data Holder API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "/" diff --git a/docs/includes/swagger/cds_energy_sdh.yaml b/docs/includes/swagger/cds_energy_sdh.yaml index 2aacd6c0..5b4ec29a 100644 --- a/docs/includes/swagger/cds_energy_sdh.yaml +++ b/docs/includes/swagger/cds_energy_sdh.yaml @@ -3,7 +3,7 @@ info: description: Consumer Data Right end points and payloads for Secondary Data Holder for the Energy sector title: CDR Energy Secondary Data Holder API - version: 1.27.0 + version: 1.28.0 servers: - url: / paths: diff --git a/docs/includes/swagger/cds_register.json b/docs/includes/swagger/cds_register.json index 65f14ada..8f290647 100644 --- a/docs/includes/swagger/cds_register.json +++ b/docs/includes/swagger/cds_register.json @@ -2,7 +2,7 @@ "openapi" : "3.0.3", "info" : { "title" : "CDR Participant Discovery API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https:///" diff --git a/docs/includes/swagger/cds_register.yaml b/docs/includes/swagger/cds_register.yaml index 94279329..a9ec29fe 100644 --- a/docs/includes/swagger/cds_register.yaml +++ b/docs/includes/swagger/cds_register.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: CDR Participant Discovery API - version: 1.27.0 + version: 1.28.0 servers: - url: https:/// paths: diff --git a/docs/includes/swagger/cds_register_banking_non_bank_lending.json b/docs/includes/swagger/cds_register_banking_non_bank_lending.json index dd2b3594..89e42e9d 100644 --- a/docs/includes/swagger/cds_register_banking_non_bank_lending.json +++ b/docs/includes/swagger/cds_register_banking_non_bank_lending.json @@ -2,7 +2,7 @@ "openapi" : "3.0.3", "info" : { "title" : "CDR Participant Discovery API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https:///" @@ -10,7 +10,7 @@ "paths" : { "/cdr-register/v1/{industry}/data-holders/brands" : { "get" : { - "description" : "Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-data-holder-brands-v1.html)", + "description" : "Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem.\n\nObsolete versions: [v1](../../../../includes/obsolete/get-data-holder-brands-v1.html), [v2](../../../../includes/obsolete/get-data-holder-brands-v2.html)", "operationId" : "GetDataHolderBrands", "parameters" : [ { "description" : "The industry the participant is retrieving data for (Banking, etc)", @@ -146,13 +146,13 @@ }, "summary" : "Get Data Holder Brands", "tags" : [ "Register" ], - "x-version" : "2", + "x-version" : "3", "x-scopes" : [ "cdr-register:read" ] } }, "/cdr-register/v1/{industry}/data-holders/brands/summary" : { "get" : { - "description" : "Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register", + "description" : "Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register\n\nObsolete versions: [v1](../../../../includes/obsolete/get-data-holder-brands-summary-v1.html)", "operationId" : "GetDataHolderBrandsSummary", "parameters" : [ { "description" : "The industry the participant is retrieving data for (Banking, etc)", @@ -275,12 +275,12 @@ }, "summary" : "Get Data Holder Brands Summary", "tags" : [ "Register" ], - "x-version" : "1" + "x-version" : "2" } }, "/cdr-register/v1/{industry}/data-holders/status" : { "get" : { - "description" : "Endpoint used by participants to discover the statuses for Data Holders from the CDR Register", + "description" : "Endpoint used by participants to discover the statuses for Data Holders from the CDR Register\n\nObsolete versions: [v1](../../../../includes/obsolete/get-data-holder-statuses-v1.html)", "operationId" : "GetDataHolderStatuses", "parameters" : [ { "description" : "The industry the participant is retrieving data for (Banking, etc)", @@ -394,7 +394,7 @@ }, "summary" : "Get Data Holder Statuses", "tags" : [ "Register" ], - "x-version" : "1" + "x-version" : "2" } } }, diff --git a/docs/includes/swagger/cds_register_banking_non_bank_lending.yaml b/docs/includes/swagger/cds_register_banking_non_bank_lending.yaml index 00f78b80..bed4b45b 100644 --- a/docs/includes/swagger/cds_register_banking_non_bank_lending.yaml +++ b/docs/includes/swagger/cds_register_banking_non_bank_lending.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: CDR Participant Discovery API - version: 1.27.0 + version: 1.28.0 servers: - url: https:/// paths: @@ -10,7 +10,7 @@ paths: description: |- Allows Data Recipients to discover Data Holder Brands available in the CDR ecosystem. - Obsolete versions: [v1](../../../../includes/obsolete/get-data-holder-brands-v1.html) + Obsolete versions: [v1](../../../../includes/obsolete/get-data-holder-brands-v1.html), [v2](../../../../includes/obsolete/get-data-holder-brands-v2.html) operationId: GetDataHolderBrands parameters: - description: The industry the participant is retrieving data for (Banking, @@ -125,13 +125,15 @@ paths: summary: Get Data Holder Brands tags: - Register - x-version: "2" + x-version: "3" x-scopes: - cdr-register:read /cdr-register/v1/{industry}/data-holders/brands/summary: get: - description: Endpoint used by participants to discover public details of Data - Holder Brands from the CDR Register + description: |- + Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register + + Obsolete versions: [v1](../../../../includes/obsolete/get-data-holder-brands-summary-v1.html) operationId: GetDataHolderBrandsSummary parameters: - description: The industry the participant is retrieving data for (Banking, @@ -234,11 +236,13 @@ paths: summary: Get Data Holder Brands Summary tags: - Register - x-version: "1" + x-version: "2" /cdr-register/v1/{industry}/data-holders/status: get: - description: Endpoint used by participants to discover the statuses for Data - Holders from the CDR Register + description: |- + Endpoint used by participants to discover the statuses for Data Holders from the CDR Register + + Obsolete versions: [v1](../../../../includes/obsolete/get-data-holder-statuses-v1.html) operationId: GetDataHolderStatuses parameters: - description: The industry the participant is retrieving data for (Banking, @@ -338,7 +342,7 @@ paths: summary: Get Data Holder Statuses tags: - Register - x-version: "1" + x-version: "2" components: parameters: Authorization: diff --git a/docs/includes/swagger/cds_telco.json b/docs/includes/swagger/cds_telco.json index d1046860..237a68de 100644 --- a/docs/includes/swagger/cds_telco.json +++ b/docs/includes/swagger/cds_telco.json @@ -12,7 +12,7 @@ "url" : "https://opensource.org/licenses/MIT" }, "title" : "CDR Telco API", - "version" : "1.27.0" + "version" : "1.28.0" }, "servers" : [ { "url" : "https://data.holder.com.au/cds-au/v1" diff --git a/docs/includes/swagger/cds_telco.yaml b/docs/includes/swagger/cds_telco.yaml index a83cc516..b8ad75c1 100644 --- a/docs/includes/swagger/cds_telco.yaml +++ b/docs/includes/swagger/cds_telco.yaml @@ -11,7 +11,7 @@ info: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Telco API - version: 1.27.0 + version: 1.28.0 servers: - url: https://data.holder.com.au/cds-au/v1 paths: diff --git a/docs/index.html b/docs/index.html index 39f3e9da..f88306ab 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1424,7 +1424,6 @@

Introduction

This text is an example of text removed from the standards: - Old text removed Note: changes to request and response payloads are listed at the beginning of the relevant API section due to the documentation being auto generated from OpenAPI specification files. -
Improved line wrapping and removed horizontal scrollbars in the 'Non-normative Examples' and 'Version Delta' tab column.

These standards have been developed as part of the Australian Government's introduction of the Consumer Data Right legislation to give Australians greater control over their data.

@@ -1444,7 +1443,7 @@

Introduction

Version

-

These standards represent version 1.27.0 of the high level standards. See the versioning section for more information on how versions are managed in the standard.

+

These standards represent version 1.28.0 of the high level standards. See the versioning section for more information on how versions are managed in the standard.

Interpretation

@@ -1456,9 +1455,6 @@

Future Dated Obligations

The table below highlights these areas of the standards.

-
Added clarification for 'Get Energy Account Detail V2' for Data Holders going live on, or after, November 1st 2023
-
- @@ -1764,8 +1760,8 @@

Normative References

Section
-

Informative References

Changed the link to the CDR website to be HTTPS with www.
-
+

Informative References

+ @@ -1820,7 +1816,7 @@

Normative References

-
Reference [X.1254] X.1254 - Entity authentication assurance framework: https://www.itu.int/rec/T-REC-X1254-201209-I/en

+

High Level Standards

This section contains components of the standards that are foundational and generally applicable.

@@ -2570,7 +2566,8 @@

Normative references

The only exception to this, unless explicitly stated, is normative standards. The requirements for expressing arrays within those normative standards apply per the normative references.

-

Common Field Types

+

Common Field Types

Properties defined in response schemas with enumerated values will now correctly show the type as 'Enum' instead of 'string'
+

The following table outlines the common data types for fields used in the standard.

@@ -4652,8 +4649,7 @@

Data Recipients calling the CD

Client Registration

Dynamic Client Registration

Data Recipients register with Data Holders according to [DCR] to obtain client credentials used to retrieve consumer data on behalf of a consumer.

-

Software Statement Assertion (SSA)

Updated encoded and decoded example SSAs to include energy scopes and minor updates for clarity and consistency
-
+

Software Statement Assertion (SSA)

As per [DCR], a Software Statement is defined in as: A digitally signed JSON Web Token (JWT) created in accordance with [JWT] that asserts metadata values about the client software

@@ -4737,8 +4733,7 @@

SSA Definition

The SSA will conform to the requirements of [DCR] with the following clarifications:

-
Corrected typo in the description of the software_roles field
-
+
@@ -4972,7 +4967,6 @@

Registration Request using JWT

}{ "signature":... } -
Updated link to section 8.6 of FAPI Advanced

To register with a Data Holder, the Data Recipient sends an HTTP POST to the Data Holder registration endpoint.

@@ -6232,13 +6226,12 @@

Data Recipient Software Products

Security Endpoints

-

OpenID Provider Configuration End Point

Updated the 'code_challenge_methods_supported' property of the OpenID Provider Configuration to be an array
+
OpenID Provider Configuration End Point

 
-Updated [FAPI-RW-Draft] to refer to [FAPI-1.0-Advanced]
-

Non-Normative Example

+ 
## Request
 
 GET /.well-known/openid-configuration HTTP/1.1
@@ -6286,6 +6279,7 @@ 
OpenID Provider Configuration E
   "cdr_arrangement_revocation_endpoint": "https://data.holder.com.au/arrangements/revoke"
 }
+
Client Metadata
@@ -6381,6 +6375,7 @@

OpenID Provider Configuration E

+

Authorisation End Point

@@ -7155,7 +7150,6 @@

Register Endpoints

<InfoSecBaseUri>/.well-known/openid-configuration
 
-
Updated the description of the PublicBaseUri field to clarify requirements for the Energy sector

Participants will be required to register base URIs against each of their brands to facilitate the implementation of the Consumer Data Standards

@@ -7225,9 +7219,7 @@

DCR APIs

Description
DCR OpenAPI Specification (JSON)
DCR OpenAPI Specification (YAML)

-
Updated 'Non-normative Examples' to include JWT Body parameter for POST and PUT
-
Corrected typo in the description of the software_roles field
-
+

Register Data Recipient oAuth Client

@@ -8126,13 +8118,13 @@

RegistrationProperties grant_types -[string] +[Enum] mandatory Array of OAuth 2.0 grant type strings that the client can use at the token endpoint response_types -[string] +[Enum] mandatory Array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint.

Response type value code is required for Authorization Code Flow. Response type value code id_token is required for OIDC Hybrid Flow. @@ -8162,19 +8154,19 @@

RegistrationProperties authorization_signed_response_alg -string +Enum optional The JWS alg algorithm required for signing authorization responses. If this is specified, the response will be signed using JWS and the configured algorithm. The algorithm “none” is not allowed.

Required if response_type of “code” is registered by the client. authorization_encrypted_response_alg -string +Enum optional The JWE alg algorithm required for encrypting authorization responses. If unspecified, the default is that no encryption is performed.

Required if “authorization_encrypted_response_enc” is included. authorization_encrypted_response_enc -string +Enum optional The JWE enc algorithm required for encrypting authorization responses. If “authorization_encrypted_response_alg” is specified, the default for this value is “A128CBC-HS256”. @@ -8483,11 +8475,7 @@

Register APIs

Data Holders and Data Recipient Software Products are required to call these endpoints to obtain metadata that enables connection and registration between participants as well as obtaining the status of participants in the CDR. These statuses are provided authoritatively by the Register to allow participants to determine whether a connecting third-party is permitted to perform registration requests or data sharing requests. -
Corrected typo in description of registeredCountry property
 
-Changed the x-v header from optional to mandatory and removed the default x-v in 'Get Data Holder Brands', 'Get Software Statement Assertion', 'Get Software Products Statues', 'Get Data Recipients Statues', 'Get Data Recipients'.
-Updated the x-v and x-min-v descriptions to align to other endpoints.
-


@@ -10840,7 +10828,7 @@

RegisterDataHolderBrand<

- + @@ -11028,7 +11016,7 @@

DataHolderBrandSummary

- + @@ -12656,9 +12644,7 @@

Banking APIs

Register OpenAPI Specification (JSON)
industries[string][Enum] mandatory The industries the Data Holder Brand belongs to
industries[string][Enum] mandatory The industries the Data Holder Brand belongs to
Banking OpenAPI Specification (JSON)
Banking OpenAPI Specification (YAML)

-
Added MetaPaginatedTransaction schema to 'Get Transactions For Account' to include the isQueryParamUnsupported property
-
Removed duplicate '400 - Invalid Version' error codes
-
+

Get Accounts

@@ -19358,7 +19344,7 @@

BankingProductFeatureV2< featureType -string +Enum mandatory The type of feature described @@ -19527,7 +19513,7 @@

BankingProductConstrain constraintType -string +Enum mandatory The type of constraint described. See the next section for an overview of valid values and their meaning @@ -19600,7 +19586,7 @@

BankingProductEligibil eligibilityType -string +Enum mandatory The type of eligibility criteria described. See the next section for an overview of valid values and their meaning @@ -19736,7 +19722,7 @@

BankingProductFee

feeType -string +Enum mandatory The type of fee @@ -19891,7 +19877,7 @@

BankingProductDiscount discountType -string +Enum mandatory The type of discount. See the next section for an overview of valid values and their meaning @@ -20000,7 +19986,7 @@

BankingProduct discountEligibilityType -string +Enum mandatory The type of the specific eligibility constraint for a discount @@ -20123,7 +20109,7 @@

BankingProductDepositR depositRateType -string +Enum mandatory The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning @@ -20250,7 +20236,7 @@

BankingProductLendin lendingRateType -string +Enum mandatory The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning @@ -20280,19 +20266,19 @@

BankingProductLendin interestPaymentDue -string +Enum optional When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered repaymentType -string +Enum optional Options in place for repayments. If absent, the lending rate is applicable to all repayment types loanPurpose -string +Enum optional The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes @@ -20437,7 +20423,7 @@

Properties

unitOfMeasure -string +Enum mandatory The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers) @@ -20455,7 +20441,7 @@

Properties

rateApplicationMethod -string +Enum optional The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps') @@ -20670,7 +20656,7 @@

BankingAccountV2

openStatus -string +Enum optional Open or closed status for the account. If not present then OPEN is assumed @@ -20682,7 +20668,7 @@

BankingAccountV2

accountOwnership -string +Enum mandatory Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers @@ -21226,7 +21212,7 @@

BankingAccountDetailV3 » specificAccountUType -string +Enum optional The type of structure to present account specific fields. @@ -21412,7 +21398,7 @@

BankingTermDepositAcco maturityInstructions -string +Enum mandatory Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments @@ -21595,7 +21581,7 @@

BankingLoanAccountV2

repaymentType -string +Enum optional Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST @@ -21753,13 +21739,13 @@

BankingTransaction

type -string +Enum mandatory The type of the transaction status -string +Enum mandatory Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction @@ -22051,7 +22037,7 @@

BankingTransactionDetai »» extensionUType -string +Enum optional Optional extended data specific to transactions originated via NPP @@ -22081,7 +22067,7 @@

BankingTransactionDetai »» service -string +Enum mandatory Identifier of the applicable overlay service. Valid values are: X2P1.01 @@ -22526,7 +22512,7 @@

BankingPayeeV2

type -string +Enum mandatory The type of payee.
DOMESTIC means a registered payee for domestic payments including NPP.
INTERNATIONAL means a registered payee for international payments.
BILLER means a registered payee for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital wallet @@ -22659,7 +22645,7 @@

BankingPayeeDetailV2

» payeeUType -string +Enum mandatory Type of object included that describes the payee in detail @@ -22744,7 +22730,7 @@

BankingDomesticPayee

payeeAccountUType -string +Enum mandatory Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number. card A credit or charge card to pay to (note that PANs are masked). payId A PayID recognised by NPP @@ -22882,7 +22868,7 @@

BankingDomesticPayeePa type -string +Enum mandatory The type of the PayID @@ -23115,13 +23101,13 @@

BankingDigitalWalletPa type -string +Enum mandatory The type of the digital wallet identifier provider -string +Enum mandatory The provider of the digital wallet @@ -23621,7 +23607,7 @@

BankingScheduledPaymen status -string +Enum mandatory Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped. @@ -23845,7 +23831,7 @@

Properties

toUType -string +Enum mandatory The type of object provided that specifies the destination of the funds for the payment. @@ -24018,7 +24004,7 @@

Properties

recurrenceUType -string +Enum mandatory The type of recurrence used to define the schedule @@ -24148,7 +24134,7 @@

Properties

nonBusinessDayTreatment -string +Enum optional Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored @@ -24263,13 +24249,13 @@

Properties

lastWeekDay -string +Enum mandatory The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval. nonBusinessDayTreatment -string +Enum optional Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored @@ -24412,7 +24398,7 @@

CommonPhysicalAddress

addressUType -string +Enum mandatory The type of address object present @@ -24971,7 +24957,7 @@

Properties

anonymous -string +Enum mandatory The category to which a product or account belongs. See here for more details @@ -25746,9 +25732,7 @@

Energy APIs

Energy OpenAPI Specification (JSON) Energy OpenAPI Specification (YAML) -
Corrected descriptions mentioning electricity in the EnergyInvoiceGasUsageCharges schema
-
Added missing '400 - Invalid Date' error codes that MUST be supported by endpoints with date parameters
-
+

Get Generic Plans

@@ -35737,13 +35721,13 @@

EnergyPlan

type -string +Enum mandatory The type of the plan fuelType -string +Enum mandatory The fuel types covered by the plan @@ -35803,7 +35787,7 @@

EnergyPlan

customerType -string +Enum optional The type of customer that the plan is offered to. If absent then the plan is available to all customers @@ -36719,13 +36703,13 @@

EnergyPlanContractV2

pricingModel -string +Enum mandatory The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:
  • SINGLE_RATE - all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a ‘block’ or ‘step’ tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.
  • SINGLE_RATE_CONT_LOAD - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
  • TIME_OF_USE - energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumed
  • TIME_OF_USE_CONT_LOAD - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
  • FLEXIBLE - energy usage is charged at unit rates that vary based on external factors
  • FLEXIBLE_CONT_LOAD - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
  • QUOTA - all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage
timeZone -string +Enum conditional Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent @@ -36749,7 +36733,7 @@

EnergyPlanContractV2

paymentOption -[string] +[Enum] mandatory Payment options for this contract @@ -37155,7 +37139,7 @@

EnergyPlanContractFullV » termType -string +Enum optional The term for the contract. If absent assumes no specified term @@ -37299,7 +37283,7 @@

Properties

rateBlockUType -string +Enum mandatory Specifies the type of controlloed load rate @@ -37353,7 +37337,7 @@

Properties

»» measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -37401,7 +37385,7 @@

Properties

»» measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -37419,7 +37403,7 @@

Properties

»» days -[string] +[Enum] optional The days that the rate applies to @@ -37449,7 +37433,7 @@

Properties

» type -string +Enum mandatory The type of usage that the rate applies to @@ -37626,7 +37610,7 @@

Properties

category -string +Enum mandatory The type of the incentive @@ -37716,13 +37700,13 @@

Properties

type -string +Enum mandatory The type of the discount category -string +Enum optional The type of the discount. Mandatory if the discount type is CONDITIONAL @@ -37734,7 +37718,7 @@

Properties

methodUType -string +Enum mandatory The method of calculation of the discount @@ -37896,13 +37880,13 @@

Properties

scheme -string +Enum mandatory The applicable green power scheme type -string +Enum mandatory The type of charge @@ -38002,7 +37986,7 @@

Properties

type -string +Enum mandatory The type of the eligibility restriction.
The CONTINGENT_PLAN value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up) @@ -38144,13 +38128,13 @@

Properties

type -string +Enum mandatory The type of the fee term -string +Enum mandatory The term of the fee @@ -38384,19 +38368,19 @@

Properties

scheme -string +Enum mandatory The applicable scheme payerType -string +Enum mandatory The type of the payer tariffUType -string +Enum mandatory The type of the payer @@ -38420,7 +38404,7 @@

Properties

»» measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -38438,7 +38422,7 @@

Properties

» type -string +Enum optional The type of the charging time period. If absent applies to all periods @@ -38456,7 +38440,7 @@

Properties

»» measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -38474,7 +38458,7 @@

Properties

»» days -[string] +[Enum] mandatory The days that the tariff applies to. At least one entry required @@ -38719,7 +38703,7 @@

Properties

type -string +Enum optional Type of charge. Assumed to be other if absent @@ -38749,13 +38733,13 @@

Properties

timeZone -string +Enum optional Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed. rateBlockUType -string +Enum mandatory Specifies the type of rate applicable to this tariff period @@ -38797,7 +38781,7 @@

Properties

»» measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -38845,7 +38829,7 @@

Properties

»» measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -38863,7 +38847,7 @@

Properties

»» days -[string] +[Enum] mandatory The days that the rate applies to @@ -38881,7 +38865,7 @@

Properties

» type -string +Enum mandatory The type of usage that the rate applies to @@ -38911,7 +38895,7 @@

Properties

» measureUnit -string +Enum optional The measurement unit of charge amount. Assumed to be KWH if absent @@ -38929,7 +38913,7 @@

Properties

» days -[string] +[Enum] optional The days that the demand tariff applies to @@ -38947,13 +38931,13 @@

Properties

» measurementPeriod -string +Enum mandatory Application period for the demand tariff » chargePeriod -string +Enum mandatory Charge period for the demand tariff @@ -39263,19 +39247,19 @@

EnergyServicePoint

servicePointClassification -string +Enum mandatory The classification of the service point as defined in MSATS procedures servicePointStatus -string +Enum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
  • ACTIVE - An active, energised, service point
  • DE_ENERGISED - The service point exists but is deenergised
  • EXTINCT - The service point has been permanently decommissioned
  • GREENFIELD - Applies to a service point that has never been energised
  • OFF_MARKET - Applies when the service point is no longer settled in the NEM
jurisdictionCode -string +Enum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
  • ALL - All Jurisdictions
  • ACT - Australian Capital Territory
  • NEM - National Electricity Market
  • NSW - New South Wales
  • QLD - Queensland
  • SA - South Australia
  • TAS - Tasmania
  • VIC - Victoria
@@ -39305,13 +39289,13 @@

EnergyServicePoint

» classification -string +Enum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments » threshold -any +Enum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
  • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
  • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
  • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
@@ -39545,19 +39529,19 @@

EnergyServicePointDetai servicePointClassification -string +Enum mandatory The classification of the service point as defined in MSATS procedures servicePointStatus -string +Enum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
  • ACTIVE - An active, energised, service point
  • DE_ENERGISED - The service point exists but is deenergised
  • EXTINCT - The service point has been permanently decommissioned
  • GREENFIELD - Applies to a service point that has never been energised
  • OFF_MARKET - Applies when the service point is no longer settled in the NEM
jurisdictionCode -string +Enum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
  • ALL - All Jurisdictions
  • ACT - Australian Capital Territory
  • NEM - National Electricity Market
  • NSW - New South Wales
  • QLD - Queensland
  • SA - South Australia
  • TAS - Tasmania
  • VIC - Victoria
@@ -39587,13 +39571,13 @@

EnergyServicePointDetai » classification -string +Enum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments » threshold -any +Enum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
  • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
  • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
  • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
@@ -39635,7 +39619,7 @@

EnergyServicePointDetai » role -string +Enum mandatory The role performed by this participant in relation to the service point. Note the details of enumeration values below:
  • FRMP - Financially Responsible Market Participant
  • LNSP - Local Network Service Provider or Embedded Network Manager for child connection points
  • DRSP - wholesale Demand Response and/or market ancillary Service Provider and note that where it is not relevant for a NMI it will not be included
@@ -39665,13 +39649,13 @@

EnergyServicePointDetai »» status -string +Enum mandatory A code to denote the status of the meter. Note the details of enumeration values below:
  • CURRENT -Applies when a meter is current and not disconnected
  • DISCONNECTED - Applies when a meter is present but has been remotely disconnected
»» installationType -string +Enum mandatory The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
  • BASIC - Accumulation Meter – Type 6
  • COMMS1 - Interval Meter with communications – Type 1
  • COMMS2 - Interval Meter with communications – Type 2
  • COMMS3 - Interval Meter with communications – Type 3
  • COMMS4 - Interval Meter with communications – Type 4
  • COMMS4C - CT connected metering installation that meets the minimum services specifications
  • COMMS4D - Whole current metering installation that meets the minimum services specifications
  • MRAM - Small customer metering installation – Type 4A
  • MRIM - Manually Read Interval Meter – Type 5
  • UMCP - Unmetered Supply – Type 7
  • VICAMI - A relevant metering installation as defined in clause 9.9C of the NER
  • NCONUML - Non-contestable unmeter load - Introduced as part of Global Settlement
@@ -39725,7 +39709,7 @@

EnergyServicePointDetai »» registerConsumptionType -string +Enum mandatory Indicates the consumption type of register @@ -39743,7 +39727,7 @@

EnergyServicePointDetai »» timeOfDay -string +Enum optional Code to identify the time validity of register contents @@ -39761,7 +39745,7 @@

EnergyServicePointDetai »» consumptionType -string +Enum optional Actual/Subtractive Indicator. Note the details of enumeration values below:
  • ACTUAL implies volume of energy actually metered between two dates
  • CUMULATIVE indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates
@@ -40119,7 +40103,7 @@

EnergyUsageRead

readUType -string +Enum mandatory Specify the type of the meter read data @@ -40131,7 +40115,7 @@

EnergyUsageRead

» quality -string +Enum optional The quality of the read taken. If absent then assumed to be ACTUAL @@ -40185,7 +40169,7 @@

EnergyUsageRead

»» quality -string +Enum mandatory The quality of the read taken @@ -40443,7 +40427,7 @@

EnergyDerRecord

» equipmentType -string +Enum optional Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g. rotating machine). If absent, assume equipment type to be “OTHER”. @@ -40473,7 +40457,7 @@

EnergyDerRecord

» status -string +Enum mandatory Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned @@ -40515,13 +40499,13 @@

EnergyDerRecord

»» status -string +Enum optional Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned »» type -string +Enum mandatory Used to indicate the primary technology used in the DER device @@ -40657,7 +40641,7 @@

EnergyAccountBaseV2

openStatus -string +Enum optional Open or closed status for the account. If not present then OPEN is assumed @@ -41323,7 +41307,7 @@

EnergyAccountDetailV3

»»» fuelType -string +Enum mandatory The fuel types covered by the plan @@ -41487,7 +41471,7 @@

EnergyPaymentSchedule

paymentScheduleUType -string +Enum mandatory The type of object present in this response @@ -41499,7 +41483,7 @@

EnergyPaymentSchedule

» cardScheme -string +Enum mandatory The type of credit card held on file @@ -41511,7 +41495,7 @@

EnergyPaymentSchedule

» calculationType -string +Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
  • STATIC - Indicates a consistent, static amount, per payment
  • BALANCE - Indicates that the outstanding balance for the account is paid per period
  • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
@@ -41547,7 +41531,7 @@

EnergyPaymentSchedule

» calculationType -string +Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
  • STATIC - Indicates a consistent, static amount, per payment
  • BALANCE - Indicates that the outstanding balance for the account is paid per period
  • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
@@ -41571,13 +41555,13 @@

EnergyPaymentSchedule

» type -string +Enum mandatory The type of the digital wallet identifier » provider -string +Enum mandatory The provider of the digital wallet @@ -41589,7 +41573,7 @@

EnergyPaymentSchedule

» calculationType -string +Enum mandatory The mechanism by which the payment amount is calculated. Explanation of values are as follows:
  • STATIC - Indicates a consistent, static amount, per payment
  • BALANCE - Indicates that the outstanding balance for the account is paid per period
  • CALCULATED - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
@@ -41740,7 +41724,7 @@

EnergyConcession

type -string +Enum mandatory Indicator of the method of concession calculation @@ -41794,7 +41778,7 @@

EnergyConcession

appliedTo -[string] +[Enum] optional Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed @@ -42014,7 +41998,7 @@

EnergyInvoice

paymentStatus -string +Enum mandatory Indicator of the payment status for the invoice @@ -42099,7 +42083,7 @@

EnergyInvoiceGasUsa » type -string +Enum optional Type of charge. Assumed to be other if absent @@ -42218,7 +42202,7 @@

EnergyInvoi » type -string +Enum optional Type of charge. Assumed to be other if absent @@ -42439,7 +42423,7 @@

EnergyBillingTransact transactionUType -string +Enum mandatory Indicator of the type of transaction object present in this record @@ -42554,7 +42538,7 @@

EnergyBillingUsa timeOfUseType -string +Enum mandatory The time of use type that the transaction applies to @@ -42584,7 +42568,7 @@

EnergyBillingUsa measureUnit -string +Enum optional The measurement unit of rate. Assumed to be KWH if absent @@ -42614,7 +42598,7 @@

EnergyBillingUsa » type -string +Enum mandatory The type of the calculation factor @@ -42776,7 +42760,7 @@

EnergyBillingDe timeOfUseType -string +Enum mandatory The time of use type that the transaction applies to @@ -42830,7 +42814,7 @@

EnergyBillingDe » type -string +Enum mandatory The type of the calculation factor @@ -43019,7 +43003,7 @@

EnergyBillingOther type -string +Enum optional Type of charge. Assumed to be other if absent @@ -43049,7 +43033,7 @@

EnergyBillingOther » type -string +Enum mandatory The type of the calculation factor @@ -43142,7 +43126,7 @@

EnergyBillingPay method -string +Enum mandatory The method of payment @@ -43236,7 +43220,7 @@

CommonPhysicalAddress

addressUType -string +Enum mandatory The type of address object present @@ -44686,7 +44670,7 @@

ResponseCommonDisc » status -string +Enum mandatory Enumeration with values. OK (implementation is fully functional). PARTIAL_FAILURE (one or more end points are unexpectedly unavailable). UNAVAILABLE (the full implementation is unexpectedly unavailable). SCHEDULED_OUTAGE (an advertised outage is in effect) @@ -44911,7 +44895,7 @@

ResponseCommonCustomer » customerUType -string +Enum mandatory The type of customer object that is present @@ -45114,7 +45098,7 @@

ResponseCommonCus » customerUType -string +Enum mandatory The type of customer object that is present @@ -45229,7 +45213,7 @@

CommonPerson

occupationCodeVersion -string +Enum conditional The applicable [ANZSCO] release version of the occupation code provided. Mandatory if an occupationCode is supplied. If occupationCode is supplied but occupationCodeVersion is absent, default is ANZSCO_1220.0_2013_V1.2 @@ -45486,13 +45470,13 @@

CommonOrganisation

industryCodeVersion -string +Enum conditional The applicable ANZSIC release version of the industry code provided. Should only be supplied if industryCode is also supplied. If industryCode is supplied but industryCodeVersion is absent, default is ANZSIC_1292.0_2006_V2.0 organisationType -string +Enum mandatory Legal organisation type @@ -45684,7 +45668,7 @@

CommonPhoneNumber

purpose -string +Enum mandatory The purpose of the number as specified by the customer @@ -45778,7 +45762,7 @@

CommonEmailAddress

purpose -string +Enum mandatory The purpose for the email, as specified by the customer (Enumeration) @@ -45893,7 +45877,7 @@

CommonPhysicalA » purpose -string +Enum mandatory Enumeration of values indicating the purpose of the physical address @@ -45979,7 +45963,7 @@

CommonPhysicalAddress

addressUType -string +Enum mandatory The type of address object present @@ -46389,14 +46373,7 @@

Admin APIs

Admin OpenAPI Specification (JSON) Admin OpenAPI Specification (YAML)

-
Changed to a non-breaking space between the indent chevron and property name in all schema Properties tables to prevent line wrapping
 
-Resolved documentation rendering bug causing incorrect indent level to be displayed for some properties
-
-Added statement to clarify that aggregate performance metrics exclude Secondary Data Holder performance
-
-Corrected the requirement for the authorisations property of Get Metrics v4 and v5 to be mandatory
-

Metadata Update

@@ -47255,7 +47232,7 @@

RequestMetaDataUpdate

» action -string +Enum mandatory The action to take for the meta data. At the moment the only option is REFRESH which requires the data holder to call the ACCC to refresh meta data as soon as practicable @@ -49969,8 +49946,7 @@

Energy Secondary DH APIs

Energy Secondary Data Holder OpenAPI Specification (JSON) Energy Secondary Data Holder OpenAPI Specification (YAML) -
Added missing '400 - Invalid Date' error codes that MUST be supported by endpoints with date parameters
-
+

Get Service Points (SR)

@@ -52331,19 +52307,19 @@

EnergyServicePoint

servicePointClassification -string +Enum mandatory The classification of the service point as defined in MSATS procedures servicePointStatus -string +Enum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
  • ACTIVE - An active, energised, service point
  • DE_ENERGISED - The service point exists but is deenergised
  • EXTINCT - The service point has been permanently decommissioned
  • GREENFIELD - Applies to a service point that has never been energised
  • OFF_MARKET - Applies when the service point is no longer settled in the NEM
jurisdictionCode -string +Enum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
  • ALL - All Jurisdictions
  • ACT - Australian Capital Territory
  • NEM - National Electricity Market
  • NSW - New South Wales
  • QLD - Queensland
  • SA - South Australia
  • TAS - Tasmania
  • VIC - Victoria
@@ -52373,13 +52349,13 @@

EnergyServicePoint

» classification -string +Enum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments » threshold -any +Enum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
  • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
  • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
  • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
@@ -52613,19 +52589,19 @@

EnergyServicePointDetai servicePointClassification -string +Enum mandatory The classification of the service point as defined in MSATS procedures servicePointStatus -string +Enum mandatory Code used to indicate the status of the service point. Note the details for the enumeration values below:
  • ACTIVE - An active, energised, service point
  • DE_ENERGISED - The service point exists but is deenergised
  • EXTINCT - The service point has been permanently decommissioned
  • GREENFIELD - Applies to a service point that has never been energised
  • OFF_MARKET - Applies when the service point is no longer settled in the NEM
jurisdictionCode -string +Enum mandatory Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below:
  • ALL - All Jurisdictions
  • ACT - Australian Capital Territory
  • NEM - National Electricity Market
  • NSW - New South Wales
  • QLD - Queensland
  • SA - South Australia
  • TAS - Tasmania
  • VIC - Victoria
@@ -52655,13 +52631,13 @@

EnergyServicePointDetai » classification -string +Enum optional A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments » threshold -any +Enum optional A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below:
  • LOW - Consumption is less than the ‘lower consumption threshold’ as defined in the National Energy Retail Regulations
  • MEDIUM - Consumption is equal to or greater than the ‘lower consumption threshold’, but less than the ‘upper consumption threshold’, as defined in the National Energy Retail Regulations
  • HIGH - Consumption is equal to or greater than the ‘upper consumption threshold’ as defined in the National Energy Retail Regulations
@@ -52703,7 +52679,7 @@

EnergyServicePointDetai » role -string +Enum mandatory The role performed by this participant in relation to the service point. Note the details of enumeration values below:
  • FRMP - Financially Responsible Market Participant
  • LNSP - Local Network Service Provider or Embedded Network Manager for child connection points
  • DRSP - wholesale Demand Response and/or market ancillary Service Provider and note that where it is not relevant for a NMI it will not be included
@@ -52733,13 +52709,13 @@

EnergyServicePointDetai »» status -string +Enum mandatory A code to denote the status of the meter. Note the details of enumeration values below:
  • CURRENT -Applies when a meter is current and not disconnected
  • DISCONNECTED - Applies when a meter is present but has been remotely disconnected
»» installationType -string +Enum mandatory The metering Installation type code indicates whether the metering installation has to be manually read. Note the details of enumeration values below:
  • BASIC - Accumulation Meter – Type 6
  • COMMS1 - Interval Meter with communications – Type 1
  • COMMS2 - Interval Meter with communications – Type 2
  • COMMS3 - Interval Meter with communications – Type 3
  • COMMS4 - Interval Meter with communications – Type 4
  • COMMS4C - CT connected metering installation that meets the minimum services specifications
  • COMMS4D - Whole current metering installation that meets the minimum services specifications
  • MRAM - Small customer metering installation – Type 4A
  • MRIM - Manually Read Interval Meter – Type 5
  • UMCP - Unmetered Supply – Type 7
  • VICAMI - A relevant metering installation as defined in clause 9.9C of the NER
  • NCONUML - Non-contestable unmeter load - Introduced as part of Global Settlement
@@ -52793,7 +52769,7 @@

EnergyServicePointDetai »» registerConsumptionType -string +Enum mandatory Indicates the consumption type of register @@ -52811,7 +52787,7 @@

EnergyServicePointDetai »» timeOfDay -string +Enum optional Code to identify the time validity of register contents @@ -52829,7 +52805,7 @@

EnergyServicePointDetai »» consumptionType -string +Enum optional Actual/Subtractive Indicator. Note the details of enumeration values below:
  • ACTUAL implies volume of energy actually metered between two dates
  • CUMULATIVE indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates
@@ -53187,7 +53163,7 @@

EnergyUsageRead

readUType -string +Enum mandatory Specify the type of the meter read data @@ -53199,7 +53175,7 @@

EnergyUsageRead

» quality -string +Enum optional The quality of the read taken. If absent then assumed to be ACTUAL @@ -53253,7 +53229,7 @@

EnergyUsageRead

»» quality -string +Enum mandatory The quality of the read taken @@ -53511,7 +53487,7 @@

EnergyDerRecord

» equipmentType -string +Enum optional Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g. rotating machine). If absent, assume equipment type to be “OTHER”. @@ -53541,7 +53517,7 @@

EnergyDerRecord

» status -string +Enum mandatory Code used to indicate the status of the Inverter. This will be used to identify if an inverter is active or inactive or decommissioned @@ -53583,13 +53559,13 @@

EnergyDerRecord

»» status -string +Enum optional Code used to indicate the status of the device. This will be used to identify if an inverter is active or inactive or decommissioned »» type -string +Enum mandatory Used to indicate the primary technology used in the DER device @@ -53737,7 +53713,7 @@

CommonPhysicalAddress

addressUType -string +Enum mandatory The type of address object present @@ -54187,7 +54163,9 @@

MetaPaginated

-

Additional Standards

+

Additional Standards

Added Candidate Standards for Banking Decision Proposal 306
+Updated the Draft Standards for the Banking and Non-Bank Lending sector (related to Decision Proposal 318)
+

The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations.

These standards fall into three categories:

@@ -54202,11 +54180,11 @@

Candidate Standards

Draft Standards

The Consumer Data Standards currently include the following Draft Standards:

-
Added Draft Standards for non-bank lending
-
+ @@ -54278,8 +54256,7 @@

Standardise Register API Error Cod 404:
Invalid Industry -

Change Log

Updated release notes for version 1.25.0 to include references to three maintenance issues that were part of the release but not previously noted
-
+

Change Log

The following table lists the changes made to these standards in reverse date order (most recent change is at the top).

@@ -54291,6 +54268,12 @@

Change Log

Up
+ + + + + + @@ -54758,6 +54741,11 @@

Archives

 + + + + + diff --git a/slate/source/includes/_admin.md.erb b/slate/source/includes/_admin.md.erb index 9605e9c5..5b6e6560 100644 --- a/slate/source/includes/_admin.md.erb +++ b/slate/source/includes/_admin.md.erb @@ -9,14 +9,4 @@ This provides an overview of CDS Administration Endpoints. Please note this API
10/11/20231.28.0Candidate standards arising from Decision 306 and updated draft non-bank lending standardsSee release notes and Decision 306 for details.
10/10/2023 1.27.0 Changes arising from Decision 313 (Maintenance Iteration 16)
10/10/20231.27.0Changes arising from Decision 313 (Maintenance Iteration 16)
24/08/2023 1.26.0 Changes to obligations for the implementation of Get Metrics
Admin OpenAPI Specification (YAML)
-```diff -Changed to a non-breaking space between the indent chevron and property name in all schema Properties tables to prevent line wrapping - -Resolved documentation rendering bug causing incorrect indent level to be displayed for some properties - -Added statement to clarify that aggregate performance metrics exclude Secondary Data Holder performance - -Corrected the requirement for the authorisations property of Get Metrics v4 and v5 to be mandatory -``` - <%= partial "includes/cds_admin.md" %> diff --git a/slate/source/includes/_banking_apis.md.erb b/slate/source/includes/_banking_apis.md.erb index 8f1175e6..6ffeea82 100644 --- a/slate/source/includes/_banking_apis.md.erb +++ b/slate/source/includes/_banking_apis.md.erb @@ -10,14 +10,6 @@ This specification defines the APIs for Data Holders exposing Banking endpoints. Banking OpenAPI Specification (YAML) -```diff -Added MetaPaginatedTransaction schema to 'Get Transactions For Account' to include the isQueryParamUnsupported property -``` - -```diff -Removed duplicate '400 - Invalid Version' error codes -``` - <%= partial "includes/cds_banking.md" %> <%= partial "includes/banking/_product_categories.md" %> <%= partial "includes/banking/_product_components.md" %> diff --git a/slate/source/includes/_dcr_apis.md.erb b/slate/source/includes/_dcr_apis.md.erb index 07d0eaca..6fd40a8d 100644 --- a/slate/source/includes/_dcr_apis.md.erb +++ b/slate/source/includes/_dcr_apis.md.erb @@ -9,12 +9,4 @@ This specification defines the APIs for Data Holders exposing Dynamic Client Reg DCR OpenAPI Specification (YAML) -```diff -Updated 'Non-normative Examples' to include JWT Body parameter for POST and PUT -``` - -```diff -Corrected typo in the description of the software_roles field -``` - <%= partial "includes/cds_dcr.md" %> diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb index 591cf48d..223aa56a 100644 --- a/slate/source/includes/_energy_apis.md.erb +++ b/slate/source/includes/_energy_apis.md.erb @@ -8,14 +8,4 @@ This specification defines the APIs for Data Holders exposing Energy endpoints. Energy OpenAPI Specification (YAML) - - -```diff -Corrected descriptions mentioning electricity in the EnergyInvoiceGasUsageCharges schema -``` - -```diff -Added missing '400 - Invalid Date' error codes that MUST be supported by endpoints with date parameters -``` - <%= partial "includes/cds_energy.md" %> diff --git a/slate/source/includes/_energy_apis_sdh.md.erb b/slate/source/includes/_energy_apis_sdh.md.erb index cde4e065..e1722f70 100644 --- a/slate/source/includes/_energy_apis_sdh.md.erb +++ b/slate/source/includes/_energy_apis_sdh.md.erb @@ -8,10 +8,4 @@ This specification defines the APIs for Data Holders exposing Energy Secondary D Energy Secondary Data Holder OpenAPI Specification (YAML) - - -```diff -Added missing '400 - Invalid Date' error codes that MUST be supported by endpoints with date parameters -``` - <%= partial "includes/cds_energy_sdh.md" %> diff --git a/slate/source/includes/_register.md.erb b/slate/source/includes/_register.md.erb index 38ae725d..e339033f 100644 --- a/slate/source/includes/_register.md.erb +++ b/slate/source/includes/_register.md.erb @@ -10,12 +10,6 @@ These endpoints are exposed by the Register and consumed by Data Holders and Dat -``` diff -Corrected typo in description of registeredCountry property - -Changed the x-v header from optional to mandatory and removed the default x-v in 'Get Data Holder Brands', 'Get Software Statement Assertion', 'Get Software Products Statues', 'Get Data Recipients Statues', 'Get Data Recipients'. -Updated the x-v and x-min-v descriptions to align to other endpoints. -```
diff --git a/slate/source/includes/additional.md b/slate/source/includes/additional.md index 570500cf..9c1e498a 100644 --- a/slate/source/includes/additional.md +++ b/slate/source/includes/additional.md @@ -1,5 +1,10 @@ # Additional Standards +```diff +Added Candidate Standards for Banking Decision Proposal 306 +Updated the Draft Standards for the Banking and Non-Bank Lending sector (related to Decision Proposal 318) +``` + The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations. These standards fall into three categories: @@ -13,15 +18,12 @@ These standards fall into three categories: The Consumer Data Standards currently include the following Candidate Standards: - [Candidate Standards for the Telecommunications sector](./includes/additional/candidates/telco.html) +- [Candidate Standards for Banking Decision Proposal 306](./includes/additional/candidates/dp306/banking-dp306.html) ## Draft Standards The Consumer Data Standards currently include the following Draft Standards: -```diff -Added Draft Standards for non-bank lending -``` - - [Draft Standards for the Banking and Non-Bank Lending sector](./includes/additional/drafts/non-bank-lending/banking-non-bank-lending.html) ## Experimental Standards diff --git a/slate/source/includes/additional/candidates/dp306/_product_categories-dp306.md b/slate/source/includes/additional/candidates/dp306/_product_categories-dp306.md new file mode 100644 index 00000000..c00946b5 --- /dev/null +++ b/slate/source/includes/additional/candidates/dp306/_product_categories-dp306.md @@ -0,0 +1,28 @@ +## Product Categories + + + +The [Product Category enumeration](#tocSbankingproductcategory) lists the available product categories for categorising products and accounts. These are explained in the following tables: + +**Deposit Products** + +|Enum|Description| +|----|-----------| +|REGULATED_TRUST_ACCOUNTS|This grouping of products includes accounts where funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers.| +|TERM_DEPOSITS|This grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds.| +|TRANS_AND_SAVINGS_ACCOUNTS|This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc...| +|TRAVEL_CARDS|This grouping of products includes prepaid cards with multi-currency capabilities.| + + **Lending Products** + +|Enum|Description| +|----|-----------| +|BUSINESS_LOANS|This grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease.| +|BUY_NOW_PAY_LATER|This grouping of products includes 'Buy Now, Pay Later' products that are used to purchase and immediately receive goods or services after an initial down-payment instalment. A predefined or agreed schedule of a number of interest-free instalment payments is made against the remaining balance over time.| +|CRED_AND_CHRG_CARDS|This grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards.| +|LEASES|This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc...| +|MARGIN_LOANS|This grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds.| +|OVERDRAFTS|This grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements.| +|PERS_LOANS|This grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans.| +|RESIDENTIAL_MORTGAGES|This grouping of products includes all lending products that are available for the primary purpose of borrowing for the purpose of purchasing or renovating residential property, where a residential property will be used as security. This group will include both fixed, variable & secured overdraft types of product and may include both owner-occupied and investment purpose borrowing.| +|TRADE_FINANCE|This grouping of products includes specialised lending products specifically designed to facilitate domestic & international trade. This includes the issuance of letters of credit, factoring, export credit.| diff --git a/slate/source/includes/additional/candidates/dp306/_product_components-dp306.md b/slate/source/includes/additional/candidates/dp306/_product_components-dp306.md new file mode 100644 index 00000000..bce782c8 --- /dev/null +++ b/slate/source/includes/additional/candidates/dp306/_product_components-dp306.md @@ -0,0 +1,292 @@ +## Product & Account Components + + +

Product Feature Types

+ +Description of the usage of the `featureType` field as it applies to products. + + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|ADDITIONAL_CARDS|Additional cards can be requested|The maximum number of additional cards. If no maximum then should be set to null| +|BALANCE_TRANSFERS|Balance transfers can be made to the account (eg. for credit cards)|NA| +|BILL_PAYMENT|The product can be attached to an automatic budgeting and bill payment service|Optional name of the service| +|BONUS_REWARDS|Bonus loyalty rewards points are available|Number of points available| +|CARD_ACCESS|A card is available for the product to access funds|Text describing list of card types that this product can be linked to| +|CASHBACK_OFFER | Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. | The amount of the cashback offer (in AUD) | +|COMPLEMENTARY_PRODUCT_DISCOUNTS|Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available|Description of the complementary offering| +|EXTRA_DOWN_PAYMENT|An ability to make a larger than usual down-payment to reduce a repayment amount outstanding. This may enable a purchase that would otherwise have been rejected due to exceeding a credit limit|NA| +|DIGITAL_BANKING|Access is available to online banking features for the product|NA| +|DIGITAL_WALLET|A Digital wallet can be attached to the product|The name or brand of the wallet| +|DONATE_INTEREST|Indicates that interest generated from the product can be automatically donated to a charity or community group|NA| +|EXTRA_REPAYMENTS|Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis).|NA| +|FRAUD_PROTECTION | The product includes fraud protection features. | NA | +|FREE_TXNS|A set number of free transactions available per month|The number of free transactions| +|FREE_TXNS_ALLOWANCE|A set amount of transaction fee value that is discounted per month|The amount of transaction fee discounted (in AUD)| +|FUNDS_AVAILABLE_AFTER|Deposited funds are available after a specified time period. This is distinct from a term deposit duration | The specified time period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|GUARANTOR | Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. | NA | +|INSTALMENT_PLAN | The product has the option to pay for eligible purchases over time with a set number of payments. | NA | +|INSURANCE|Insurance is provided as an additional feature of the product|Text description of the type of insurance (e.g. Travel Insurance)| +|INTEREST_FREE|Interest free period for purchases|Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|INTEREST_FREE_TRANSFERS|Interest free period for balance transfers|Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|LOYALTY_PROGRAM|A points based loyalty program is available|Name of the loyalty program| +|MAX_BALANCE|A maximum balance is defined for the product | The maximum balance in AmountString format| +|MAX_LIMIT|A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit) | The maximum limit in AmountString format| +|MAX_TXNS|A maximum number of transactions per month is defined for the product | The maximum number of transactions| +|MIN_BALANCE|A minimum balance is required for the product | The minimum balance in AmountString format| +|MIN_LIMIT|A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit) | The minimum limit in AmountString format| +|NOTIFICATIONS|Advanced notifications are available for the product|Description of the notification capability| +|NPP_ENABLED|An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment|NA| +|NPP_PAYID|An account of this product type can be used as the target of an NPP PayID|NA| +|OFFSET|An offset account can be connected to the product|NA| +|OTHER|Another feature that can not be included in any of the other categories. The `additionalInfo` field is mandatory for this type|NA| +|OVERDRAFT|An overdraft can be applied for|NA| +|REDRAW|Redraw of repaid principal above minimum required is available|NA| +|RELATIONSHIP_MANAGEMENT | Relationship management is available for eligible customers. | NA | +|UNLIMITED_TXNS|Unlimited free transactions available|NA| + + + + +

Product Constraint Types

+ +Description of the usage of the `constraintType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|MAX_BALANCE|A maximum balance is required for the product|The maximum balance in AmountString format| +|MAX_LIMIT|A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)|The maximum limit in AmountString format| +|MIN_BALANCE|A minimum balance is required for the product|The minimum balance in AmountString format| +|MIN_LIMIT|A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)|The minimum limit in AmountString format| +|OPENING_BALANCE|An opening balance is required for the product|The minimum opening balance in AmountString format| +|OTHER|Another constraint that can not be included in any of the other categories. The `additionalInfo` field is mandatory for this type|NA| + + + + +

Product Eligibility Types

+ +Description of the usage of the `eligibilityType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|BUSINESS|Only business may apply for the account|NA| +|EMPLOYMENT_STATUS|An eligibility constraint based on employment status applies|A description of the status required| +|MAX_AGE|Only customers younger than a maximum age may apply|The maximum age in years| +|MIN_AGE|Only customers older than a minimum age may apply|The minimum age in years| +|MIN_INCOME|The customer must have an income greater than a specified threshold to obtain the product|Minimum income in AmountString format| +|MIN_TURNOVER|Only a business with greater than a minimum turnover may apply|Minimum turnover in AmountString format| +|NATURAL_PERSON|The customer must be a natural person rather than another legal entity|NA| +|OTHER|Another eligibility criteria exists as described in the `additionalInfo` field (if this option is specified then the `additionalInfo` field is mandatory)|NA| +|PENSION_RECIPIENT|Only a recipient of a government pension may apply for the product|Optional. If present, MUST contain a description of which pensions qualify.| +|RESIDENCY_STATUS|An eligibility constraint based on residency status applies|A description of the status required| +|STAFF|Only a staff member of the provider may apply|NA| +|STUDENT|Only students may apply for the product|Optional. If present, MUST contain a description of who qualifies as a student, e.g. do apprentices qualify?.| + + + + +

Product Fee Categories

+ +Description of the usage of the `feeCategory` field as it applies to products. Used to classify Product Fee Types. + +|Value|Description| +|-----|-----------| +| APPLICATION | Fees associated with the application or origination of a product | +| ATM | Fees associated with the usage of ATMs | +| BRANCH | Fees associated with in-branch or over-the-counter interactions | +| BUY_NOW_PAY_LATER | Fees associated with a Buy Now, Pay Later product or feature | +| CARD | Fees associated with the usage of cards | +| CHEQUE | Fees associated with cheques or cheque books | +| CLOSURE | Fees associated with the closure of an account or service | +| CORRESPONDENCE | Fees associated with correspondence, including paper statements or other types of document requests | +| FOREIGN_EXCHANGE | Fees associated with foreign currency exchange services | +| OTHER | Another fee category that can not be included in any of the other categories. The `additionalInfo` field is mandatory for this type | +| POS | Fees associated with value-added Point-Of-Sale (POS) services | +| SERVICE | Fees associated with general product or account service and maintenance requests | +| TELEGRAPHIC_TRANSFER | Fees associated with SWIFT or 'Telegraphic Transfer' transactions | +| TELEPHONE_BANKING | Fees associated with services available via telephone banking | +| TERMS_CONDITIONS | Fees associated with breaches or requests for variations to contracts or other product terms and conditions | +| THIRD_PARTY | Fees associated with services that incur third-party costs | +| TRANSACTION | Fees associated with making transactions that are not aligned to other more specific categories | + + + + +

Product Fee Types

+ +Description of the usage of the `feeType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|CASH_ADVANCE|A fee associated with a cash advance |NA| +|DEPOSIT|A fee associated with making a deposit|NA| +|DISHONOUR|A fee associated with a dishonour |NA| +|ENQUIRY|A fee associated with an enquiry, including a balance enquiry |NA| +|EVENT|A fee in relation to a particular event (e.g. ordering a new card, viewing a balance or stopping a cheque)|NA| +|EXIT|A fee for closing the product|NA| +|OTHER|Another fee that can not be included in any of the other categories. The `additionalInfo` field is mandatory for this type |NA| +|PAYMENT|A fee associated with making a payment|NA| +|PAYMENT_LATE|A fee associated with making a payment after a due date|Number of days late, after which the associated fee will be applied | +|PERIODIC|A periodic fee such as a monthly account servicing fee|The period of charge. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|PURCHASE|A fee associated with making a purchase at a merchant|NA| +|REPLACEMENT|A fee associated with a receiving a replacement, including cards, cheques, statements, security tokens |NA| +|TRANSACTION|A fee associated with any transaction (incorporates `WITHDRAWAL`, `DEPOSIT`, `PAYMENT` and `PURCHASE`)|NA| +|UPFRONT|A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee|NA| +|UPFRONT_PER_PLAN|A fee paid at the creation of a new payment plan, such as an instalment plan|NA| +|VARIATION|A fee associated with a request for a variation, including to an existing process, instruction or terms |NA| +|WITHDRAWAL|A fee associated with making a withdrawal|NA| + + + + +

Product Discount Types

+ +Description of the usage of the `discountType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|BALANCE|Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee|The minimum balance in AmountString format| +|DEPOSITS|Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee|The minimum deposit amount in AmountString format| +|ELIGIBILITY_ONLY|Discount applies based on customer eligibility (eligibility array must be populated)|N/A| +|FEE_CAP|The `amount`, `balanceRate`, `transactionRate`, `accruedRate` or `feeRate` fields of the discount represent the maximum amount charged in a time period|The time period for which the fee cap applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|PAYMENTS|Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee|The payment threshold amount in AmountString format| + + + + +

Product Discount Eligibility Types

+ +Description of the usage of the `discountEligibilityType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|BUSINESS|A business or other non-person legal entity|NA| +|EMPLOYMENT_STATUS|An eligibility constraint based on employment status applies|A description of the status required| +|INTRODUCTORY|The discount is only available during an introductory period|The period of time for the introductory discount. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|MAX_AGE|Only customers younger than a maximum age receive the discount|The maximum age in years +|MIN_AGE|Only customers older than a minimum age receive the discount|The minimum age in years| +|MIN_INCOME|The customer must have an income greater than a specified threshold to obtain the discount|Minimum income in AmountString format| +|MIN_TURNOVER|Only a business with greater than a minimum turnover is eligible|Minimum turnover in AmountString format| +|NATURAL_PERSON|The customer must be a natural person rather than another legal entity|NA| +|OTHER|Another eligibility criteria exists as described in the `additionalInfo` field (if this option is specified then the `additionalInfo` field is mandatory)|NA| +|PENSION_RECIPIENT|Only a recipient of a government pension may receive the discount|Optional. If present, MUST contain a description of which pensions qualify.| +|RESIDENCY_STATUS|An eligibility constraint based on residency status applies|A description of the status required| +|STAFF|Only a staff member of the provider may receive the discount|NA| +|STUDENT|Only students may receive the discount|Optional. If present, MUST contain a description of who qualifies as a student, e.g. do apprentices qualify?.| + + + + +

Product Deposit Rate Types

+ +Description of the usage of the `depositRateType` field as it applies to products. + + +
  • Deposit Base Rate Types
+ +A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate `tiers` and `additionalValue`, where applicable. + +Value | Description | Use of additionalValue Field +-- | -- | -- +FIXED | Fixed rate for a period of time | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) +FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances | Details of the float parameters +MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class | Details of the market linkage +VARIABLE | A variable base rate for the product | NA + + + +
  • Deposit Adjustment Rate Types
+ +A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate. + +Value | Description | Use of additionalValue Field +-- | -- | -- +BONUS | A bonus rate available by meeting specific criteria. A description of the bonus rate, including criteria to obtain the bonus is to be provided in the `additionalInfo` field, or `applicabilityConditions` where relevant. If the bonus is obtained by originating or maintaining a bundle instead of a standalone product, the bundle name is specified in the associated `adjustmentBundle` field. | The period of time for the bonus rate if applicable. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + + + + +

Product Lending Rate Types

+ +Description of the usage of the `lendingRateType` field as it applies to products. + + + +
  • Lending Base Rate Types
+ +A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate `tiers` and `additionalValue`, where applicable. + +Card products may have two or more base rates, including `CASH_ADVANCE` and `PURCHASE` as they may apply to different transaction types within an account. The `PURCHASE` lendingRateType is considered the rate commonly applicable to a card. + +Value | Description | Use of additionalValue Field +-- | -- | -- +BALANCE_TRANSFER | Specific rate applied to balance transfers to the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA +CASH_ADVANCE | Specific rate applied to cash advances from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA +FEE | A fee-based amount rather than a rate applies to the account | NA +FIXED | Fixed rate for a period of time | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) +FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances | Details of the float parameters +MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class | Details of the market linkage +PURCHASE | Specific rate applied to purchases from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA +VARIABLE | A variable base rate for the product | NA + + + + +
  • Lending Adjustment Rate Types
+ +A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate. + +Value | Description | Use of additionalValue Field +-- | -- | -- +DISCOUNT | A discount rate reduces the interest payable. A description of the discount rate is to be provided in the `additionalInfo` field. Where applicable, the discount is applied to the rate specified in the `adjustmentToBase` field. If the discount is obtained by originating or maintaining a bundle instead of a standalone product, the bundle name is specified in the associated `adjustmentBundle` field. | The period of time for the discounted rate if applicable. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) +PENALTY | A penalty rate increases the interest payable. A description of the penalty rate is to be provided in the `additionalInfo` field. Where applicable, the penalty is applied to the rate specified in the `adjustmentToBase` field. | The period of time for the penalty rate if applicable. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + + + + +

Banking Term Deposit Account Types

+ +Description of the usage of the `maturityInstructions` field as it applies to accounts. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|HOLD_ON_MATURITY|Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer|NA| +|PAID_OUT_AT_MATURITY|Funds are to be paid out at maturity|NA| +|ROLLED_OVER|Funds are to be rolled over at maturity|NA| + + + + +

Rate and Tier Applicability Types

+ +Description of the usage of the `rateApplicabilityType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +| DEPOSITS_MIN | When a minimum number of deposits is made in a month, or the month prior | Minimum number of deposits | +| DEPOSITS_MIN_AMOUNT | When a minimum deposit amount is made in a month, or the month prior | Minimum deposit in AmountString format | +| DEPOSIT_BALANCE_INCREASED | When the overall balance of the account, excluding interest, has increased over the month prior | Minimum amount in AmountString format | +| EXISTING_CUST | Applicable to existing customers of the brand | NA | +| NEW_ACCOUNTS | Applicable to new accounts | NA | +| NEW_CUSTOMER | Applicable to new customers to the brand | NA | +| NEW_CUSTOMER_TO_GROUP | Applicable to new customers to a group of brands | NA | +| ONLINE_ONLY | Applicable to accounts originated online | NA | +| OTHER | Applicable under other conditions. The `additionalInfo` field is mandatory for this type | NA | +| PURCHASES_MIN | When a minimum number of purchases is made and settled in a month, or the month prior | Minimum number of purchases | +| WITHDRAWALS_MAX | Applicable up to a maximum number of withdrawals in a month, or the month prior | Maximum number of withdrawals | +| WITHDRAWALS_MAX_AMOUNT | Applicable up to a maximum amount withdrawn in a month, or the month prior | Maximum withdrawn in AmountString format | + + + + +

Plan Feature Types

+ +Description of the usage of the `planFeatureType` field as it applies to card plans. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +| BALANCE_TRANSFER_ENDS_INTEREST_FREE | A balance transfer will end any existing interest-free period on the plan | NA | +| INSTALMENTS | The plan supports converting purchases into instalments | NA | +| INTEREST_FREE | The plan offers an interest-free period | Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) | + diff --git a/slate/source/includes/additional/candidates/dp306/banking-dp306.html.md b/slate/source/includes/additional/candidates/dp306/banking-dp306.html.md new file mode 100644 index 00000000..53ead91b --- /dev/null +++ b/slate/source/includes/additional/candidates/dp306/banking-dp306.html.md @@ -0,0 +1,18 @@ +--- +title: DSB Candidate Standard - Banking Decision Proposal 306 + +language_tabs: + - examples: Non-normative Examples + - diff: Version Delta + +toc_footers: + - Consumer Data Standards + +includes: + - additional/candidates/dp306/banking-dp306_apis + - cds_banking_dp306 + - additional/candidates/dp306/_product_categories-dp306 + - additional/candidates/dp306/_product_components-dp306 + +search: true +--- diff --git a/slate/source/includes/additional/candidates/dp306/banking-dp306_apis.md.erb b/slate/source/includes/additional/candidates/dp306/banking-dp306_apis.md.erb new file mode 100644 index 00000000..a8050437 --- /dev/null +++ b/slate/source/includes/additional/candidates/dp306/banking-dp306_apis.md.erb @@ -0,0 +1,70 @@ +# Banking APIs + +<%= partial "includes/additional/candidates/candidate_header.md" %> + +This specification defines the APIs for Data Holders exposing Banking endpoints. + +
+ + +
Banking OpenAPI Specification (JSON)
Banking OpenAPI Specification (YAML)
+ +```diff +Changed the `cardArt` array to a `cardOption` object to provide additional card details in 'Get Products', 'Get Product Detail' and 'Get Account Detail'. + +Added the `FEE` `lendingRateType` value to support lending products that have a fee-based rather than rate-based cost. This type may be expected to align to the new `PRINCIPAL_AND_FEE` `repaymentType`. + +Added the `BALANCE_TRANSFER` `lendingRateType` value to extend support for credit card plan detail. + +Updated the `creditCard` schema in 'Get Account Detail' to allow an array of plan types, each with specific rates, repayments, adjustments and features. + +Added `revertRate`, `revertProductId`, `rateStartDate` and `rateEndDate` fields to respective lending rate schemas to support 'revert' rate details. + +Added `referenceRate` to multiple lending and deposit rate schemas. + +Added `adjustmentToBase` and `adjustmentBundle` fields to the 'BankingProductLendingRate' and 'BankingProductDepositRate' schemas. The `adjustmentToBase` field is provided to allow an adjustment rate type to specify which base rate type the adjustment applies to, where many may be offered for a product. + +Updated and added the `applicabilityConditions` field in the 'BankingProductLendingRate', 'BankingProductDepositRate' and 'BankingProductRateTier' schemas. + +Added the `applicationType` field to clarify whether an associated `applicationFrequency` value is to be expected. + +Updated the description of the `features` property of 'Get Product Detail' and 'Get Account Detail' to clarify that the schema also supports providing details of any key operational product limitations. + +Updated the description of the `constraints` property of 'Get Product Detail' to clarify that the schema is only intended to provide details of constraints on application for the product. + +Added new `featureType` values to support operational limitations and the `OTHER` `constraintType` to allow additional detail to be provided. + +Added new `feeCategory` field and new `feeType` values to improve classification and comparison of fees. + +Updated the 'BankingProductFee' schema to separate different fee types by UType and added minimum and maximum fee details and `feeCap` fields. + +Incorporated rate detail into the 'Get Account Detail' schemas to provide specific rate fields separated from the generic Product Reference rate objects. + +Extended the `termDeposit` schema in 'Get Account Detail' to allow each deposit to be specified with specific rates and terms. + +Updated the 'adjustment' rate type values to remove the `INTRODUCTORY`, `BUNDLE_BONUS`, `BUNDLE_DISCOUNT_FIXED`, `BUNDLE_DISCOUNT_VARIABLE` options. Time and bundle-based rate detail will be supported through new fields to capture that detail: `adjustmentBundle`, `adjustmentPeriod` and `adjustmentEndDate`, leaving the `additionalValue` field available for other detail where necessary. + +Added a `deposit` schema in 'Get Account Detail' to provide rate detail for general deposit structures without term deposit maturity detail. + +Removed the `specificAccountUType` field in 'Get Account Detail' to clarify that multiple types may be present in a single account. + +Updated the 'Use of additionalValue Field' descriptions for the `PENSION_RECIPIENT` and `STUDENT` 'Product Eligibility' and 'Product Discount Eligibility' types. + +Updated the description of the `comparisonRate` field to clarify how it could be interpreted when associated with an adjustment rate type. + +Updated the description of the rate tier `unitOfMeasure` field to clarify the format of the associated values, including specifying `PERCENT` values as a RateString. + +This candidate incorporates the latest Non-Bank Lending (NBL) Draft changes including the `BUY_NOW_PAY_LATER` product category value, the `instalments` object, and related feature and fee types. The endpoint versions incremented due to changes related to the NBL Draft only, are: + - Get Accounts (v3) + - Get Bulk Balances (v2) + - Get Bulk Direct Debits (v2) + - Get Scheduled Payments Bulk (v3). + - Other NBL changes affecting the Register APIs are only shown in the NBL Draft. + +The endpoint versions incremented primarily for Decision Proposal 306, but also including NBL detail are: + - Get Account Detail (v4) + - Get Products (v4) + - Get Product Detail (v5). + +Corrected minor typos and updated documentation formatting. +``` diff --git a/slate/source/includes/additional/candidates/telco.html.md b/slate/source/includes/additional/candidates/telco.html.md index f3cad12f..93103bd6 100644 --- a/slate/source/includes/additional/candidates/telco.html.md +++ b/slate/source/includes/additional/candidates/telco.html.md @@ -18,6 +18,3 @@ search: true # Telco APIs -```diff -Removed references to 'Other Versions' in 'Get Telco Accounts' and 'Get Telco Account Detail' -``` diff --git a/slate/source/includes/additional/drafts/non-bank-lending/_cx_standards_nbl.md.erb b/slate/source/includes/additional/drafts/non-bank-lending/_cx_standards_nbl.md.erb new file mode 100644 index 00000000..bfc453bf --- /dev/null +++ b/slate/source/includes/additional/drafts/non-bank-lending/_cx_standards_nbl.md.erb @@ -0,0 +1,33 @@ +## Banking Language + +### Banking Accounts +See below for the data language standards for the banking account scopes: + +|Data cluster language|
Permission language
|Authorisation Scopes| +|----------------------|------------------------------|-------------------| +|**Account name, type and balance**|Name of account;
Type of account;
Account balance;|bank:accounts.basic:read| +|**Account numbers and features**|Account number;
Interest rates;
Fees;
Discounts;
Account terms;
Account mail address;|bank:accounts.detail:read| +|**Account balance and details‡**|Name of account;
Type of account;
Account balance;
Account number;
Interest rates;
Fees;
Discounts;
Account terms;
Account mail address;|bank:accounts.detail:read| + +### Transactions +See below for the data language standards for the banking transactions scope: + +|Data cluster language|Permission language|Authorisation Scopes| +|----------------------|------------------------------|-------------------| +|**Transaction details**|Incoming and outgoing transactions;
Amounts;
Dates;
Descriptions of transactions;
Who you have sent money to and received money from; *(e.g. their name)†*|bank:transactions:read| + +### Regular Payments +See below for the data language standards for the regular payments scope: + +|Data cluster language|
Permission language
|Authorisation Scopes| +|----------------------|------------------------------|-------------------| +|**Direct debits and scheduled payments**|Direct debits;
Scheduled payments;|bank:regular_payments:read| + +### Payees +See below for the data language standards for the payees scope: + +|Data cluster language|Permission language|Authorisation Scopes| +|----------------------|------------------------------|-------------------| +|**Saved payees**|Names and details of accounts you have saved; *(e.g. their BSB and Account Number, BPAY CRN and Biller code, or NPP PayID)†*|bank:payees:read| + +
diff --git a/slate/source/includes/additional/drafts/non-bank-lending/_product_categories_nbl.md b/slate/source/includes/additional/drafts/non-bank-lending/_product_categories_nbl.md new file mode 100644 index 00000000..c00946b5 --- /dev/null +++ b/slate/source/includes/additional/drafts/non-bank-lending/_product_categories_nbl.md @@ -0,0 +1,28 @@ +## Product Categories + + + +The [Product Category enumeration](#tocSbankingproductcategory) lists the available product categories for categorising products and accounts. These are explained in the following tables: + +**Deposit Products** + +|Enum|Description| +|----|-----------| +|REGULATED_TRUST_ACCOUNTS|This grouping of products includes accounts where funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers.| +|TERM_DEPOSITS|This grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds.| +|TRANS_AND_SAVINGS_ACCOUNTS|This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc...| +|TRAVEL_CARDS|This grouping of products includes prepaid cards with multi-currency capabilities.| + + **Lending Products** + +|Enum|Description| +|----|-----------| +|BUSINESS_LOANS|This grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease.| +|BUY_NOW_PAY_LATER|This grouping of products includes 'Buy Now, Pay Later' products that are used to purchase and immediately receive goods or services after an initial down-payment instalment. A predefined or agreed schedule of a number of interest-free instalment payments is made against the remaining balance over time.| +|CRED_AND_CHRG_CARDS|This grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards.| +|LEASES|This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc...| +|MARGIN_LOANS|This grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds.| +|OVERDRAFTS|This grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements.| +|PERS_LOANS|This grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans.| +|RESIDENTIAL_MORTGAGES|This grouping of products includes all lending products that are available for the primary purpose of borrowing for the purpose of purchasing or renovating residential property, where a residential property will be used as security. This group will include both fixed, variable & secured overdraft types of product and may include both owner-occupied and investment purpose borrowing.| +|TRADE_FINANCE|This grouping of products includes specialised lending products specifically designed to facilitate domestic & international trade. This includes the issuance of letters of credit, factoring, export credit.| diff --git a/slate/source/includes/additional/drafts/non-bank-lending/_product_components_nbl.md b/slate/source/includes/additional/drafts/non-bank-lending/_product_components_nbl.md new file mode 100644 index 00000000..7f80174b --- /dev/null +++ b/slate/source/includes/additional/drafts/non-bank-lending/_product_components_nbl.md @@ -0,0 +1,220 @@ +## Product & Account Components + + +

Product Feature Types

+ +Description of the usage of the `featureType` field as it applies to products. + + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|ADDITIONAL_CARDS|Additional cards can be requested|The maximum number of additional cards. If no maximum then should be set to null| +|BALANCE_TRANSFERS|Balance transfers can be made to the account (eg. for credit cards)|NA| +|BILL_PAYMENT|The product can be attached to an automatic budgeting and bill payment service|Optional name of the service| +|BONUS_REWARDS|Bonus loyalty rewards points are available|Number of points available| +|CARD_ACCESS|A card is available for the product to access funds|Text describing list of card types that this product can be linked to| +|CASHBACK_OFFER | Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. | The amount of the cashback offer (in AUD) | +|COMPLEMENTARY_PRODUCT_DISCOUNTS|Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available|Description of the complementary offering| +|EXTRA_DOWN_PAYMENT|An ability to make a larger than usual down-payment to reduce a repayment amount outstanding. This may enable a purchase that would otherwise have been rejected due to exceeding a credit limit|NA| +|DIGITAL_BANKING|Access is available to online banking features for the product|NA| +|DIGITAL_WALLET|A Digital wallet can be attached to the product|The name or brand of the wallet| +|DONATE_INTEREST|Indicates that interest generated from the product can be automatically donated to a charity or community group|NA| +|EXTRA_REPAYMENTS|Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis).|NA| +|FRAUD_PROTECTION | The product includes fraud protection features. | NA | +|FREE_TXNS|A set number of free transactions available per month|The number of free transactions| +|FREE_TXNS_ALLOWANCE|A set amount of transaction fee value that is discounted per month|The amount of transaction fee discounted (in AUD)| +|GUARANTOR | Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. | NA | +|INSTALMENT_PLAN | The product has the option to pay for eligible purchases over time with a set number of payments. | NA | +|INSURANCE|Insurance is provided as an additional feature of the product|Text description of the type of insurance (e.g. Travel Insurance)| +|INTEREST_FREE|Interest free period for purchases|Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|INTEREST_FREE_TRANSFERS|Interest free period for balance transfers|Interest free period. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|LOYALTY_PROGRAM|A points based loyalty program is available|Name of the loyalty program| +|NOTIFICATIONS|Advanced notifications are available for the product|Description of the notification capability| +|NPP_ENABLED|An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment|NA| +|NPP_PAYID|An account of this product type can be used as the target of an NPP PayID|NA| +|OFFSET|An offset account can be connected to the product|NA| +|OTHER|Another feature that can not be included in any of the other categories. The `additionalInfo` field is mandatory for this type|NA| +|OVERDRAFT|An overdraft can be applied for|NA| +|REDRAW|Redraw of repaid principal above minimum required is available|NA| +|RELATIONSHIP_MANAGEMENT | Relationship management is available for eligible customers. | NA | +|UNLIMITED_TXNS|Unlimited free transactions available|NA| + + + + +

Product Constraint Types

+ +Description of the usage of the `constraintType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|MAX_BALANCE|A maximum balance is required for the product|The maximum balance in AmountString format| +|MAX_LIMIT|A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit)|The maximum limit in AmountString format| +|MIN_BALANCE|A minimum balance is required for the product|The minimum balance in AmountString format| +|MIN_LIMIT|A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit)|The minimum limit in AmountString format| +|OPENING_BALANCE|An opening balance is required for the product|The minimum opening balance in AmountString format| + + + + +

Product Eligibility Types

+ +Description of the usage of the `eligibilityType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|BUSINESS|Only business may apply for the account|NA| +|EMPLOYMENT_STATUS|An eligibility constraint based on employment status applies|A description of the status required| +|MAX_AGE|Only customers younger than a maximum age may apply|The maximum age in years| +|MIN_AGE|Only customers older than a minimum age may apply|The minimum age in years| +|MIN_INCOME|The customer must have an income greater than a specified threshold to obtain the product|Minimum income in AmountString format| +|MIN_TURNOVER|Only a business with greater than a minimum turnover may apply|Minimum turnover in AmountString format| +|NATURAL_PERSON|The customer must be a natural person rather than another legal entity|NA| +|OTHER|Another eligibility criteria exists as described in the `additionalInfo` field (if this option is specified then the additionalInfo field is mandatory)|NA| +|PENSION_RECIPIENT|Only a recipient of a government pension may apply for the product|NA| +|RESIDENCY_STATUS|An eligibility constraint based on residency status applies|A description of the status required| +|STAFF|Only a staff member of the provider may apply|NA| +|STUDENT|Only students may apply for the product|NA| + + + + +

Product Fee Types

+ +Description of the usage of the `feeType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|DEPOSIT|A fee associated with making a deposit|NA| +|EVENT|A fee in relation to a particular event (e.g. ordering a new card, viewing a balance or stopping a cheque)|NA| +|EXIT|A fee for closing the product|NA| +|PAYMENT|A fee associated with making a payment|NA| +|PAYMENT_LATE|A fee associated with making a payment after a due date|Number of days late, after which the associated fee will be applied | +|PERIODIC|A periodic fee such as a monthly account servicing fee|The period of charge. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|PURCHASE|A fee associated with making a purchase at a merchant|NA| +|TRANSACTION|A fee associated with any transaction (incorporates `WITHDRAWAL`, `DEPOSIT`, `PAYMENT` and `PURCHASE`)|NA| +|UPFRONT|A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee|NA| +|UPFRONT_PER_PLAN|A fee paid at the creation of a new payment plan, such as an instalment plan|NA| +|VARIABLE|An at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customer|NA| +|WITHDRAWAL|A fee associated with making a withdrawal|NA| + + + + +

Product Discount Types

+ +Description of the usage of the `discountType` field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|BALANCE|Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee|The minimum balance in AmountString format| +|DEPOSITS|Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee|The minimum deposit amount in AmountString format| +|ELIGIBILITY_ONLY|Discount applies based on customer eligibility (eligibility array must be populated)|N/A| +|FEE_CAP|The amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time period|The time period for which the fee cap applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|PAYMENTS|Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee|The payment threshold amount in AmountString format| + + + + +

Product Discount Eligibility Types

+ +Description of the usage of the discountEligibilityType field as it applies to products. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|BUSINESS|A business or other non-person legal entity|NA| +|EMPLOYMENT_STATUS|An eligibility constraint based on employment status applies|A description of the status required| +|INTRODUCTORY|The discount is only available during an introductory period|The period of time for the introductory discount. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)| +|MAX_AGE|Only customers younger than a maximum age receive the discount|The maximum age in years +|MIN_AGE|Only customers older than a minimum age receive the discount|The minimum age in years| +|MIN_INCOME|The customer must have an income greater than a specified threshold to obtain the discount|Minimum income in AmountString format| +|MIN_TURNOVER|Only a business with greater than a minimum turnover is eligible|Minimum turnover in AmountString format| +|NATURAL_PERSON|The customer must be a natural person rather than another legal entity|NA| +|OTHER|Another eligibility criteria exists as described in the `additionalInfo` field (if this option is specified then the `additionalInfo` field is mandatory)|NA| +|PENSION_RECIPIENT|Only a recipient of a government pension may receive the discount|Optional. Should contain a description of which pensions qualify| +|RESIDENCY_STATUS|An eligibility constraint based on residency status applies|A description of the status required| +|STAFF|Only a staff member of the provider may receive the discount|NA| +|STUDENT|Only students may receive the discount|Optional. Should contain a description of who qualifies as a student, e.g. do apprentices qualify?| + + + + + +

Product Deposit Rate Types

+ +Description of the usage of the `depositRateType` field as it applies to products. + + +
  • Deposit Base Rate Types
+ +A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate `tiers` and `additionalValue`, where applicable. + +Value | Description | Use of additionalValue Field +-- | -- | -- +FIXED | Fixed rate for a period of time | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) +FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances | Details of the float parameters +MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class | Details of the market linkage +VARIABLE | A variable base rate for the product | NA + + + +
  • Deposit Adjustment Rate Types
+ +A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate. + +Value | Description | Use of additionalValue Field +-- | -- | -- +BONUS | A bonus rate available by meeting a specific criteria | A description of the criteria to obtain the bonus +BUNDLE_BONUS | A bonus rate obtained by originating a bundle instead of a standalone product | The name of the bundle +INTRODUCTORY | An introductory bonus that will expire after a set period | The period of time for the introductory rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) + + + + +

Product Lending Rate Types

+ +Description of the usage of the `lendingRateType` field as it applies to products. + + + +
  • Lending Base Rate Types
+ +A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate `tiers` and `additionalValue`, where applicable. + +Card products may have two or more base rates, including `CASH_ADVANCE` and `PURCHASE` as they may apply to different transaction types within an account. The `PURCHASE` lendingRateType is considered the rate commonly applicable to a card. + +Value | Description | Use of additionalValue Field +-- | -- | -- +CASH_ADVANCE | Specific rate applied to cash advances from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA +FIXED | Fixed rate for a period of time | The period of time fixed. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) +FLOATING | A floating rate is relatively fixed but still adjusts under specific circumstances | Details of the float parameters +MARKET_LINKED | A rate that is linked to a specific market, commodity or asset class | Details of the market linkage +PURCHASE | Specific rate applied to purchases from the account. This is expected to apply to products in the `CRED_AND_CHRG_CARDS` category only | NA +VARIABLE | A variable base rate for the product | NA + + + + +
  • Lending Adjustment Rate Types
+ +A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate. + +Value | Description | Use of additionalValue Field +-- | -- | -- +BUNDLE_DISCOUNT_FIXED | A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product | The name of the bundle +BUNDLE_DISCOUNT_VARIABLE | A discount rate off the variable rate obtained by originating a bundle instead of a standalone product | The name of the bundle +DISCOUNT | A specific discount rate that may be applied. A discount rate reduces the interest payable | Description of the discount rate that is applicable +INTRODUCTORY | An introductory discount that will expire after a set period | The period of time for the introductory rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) +PENALTY | A specific penalty rate that may be applied. A penalty rate increases the interest payable | Description of the penalty rate that is applicable + + + +

Banking Term Deposit Account Types

+ +Description of the usage of the `maturityInstructions` field as it applies to accounts. + +|Value|Description|Use of additionalValue Field| +|-----|-----------|----------------------------| +|HOLD_ON_MATURITY|Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer|NA| +|PAID_OUT_AT_MATURITY|Funds are to be paid out at maturity|NA| +|ROLLED_OVER|Funds are to be rolled over at maturity|NA| diff --git a/slate/source/includes/additional/drafts/non-bank-lending/_register_banking_non_bank_lending.md.erb b/slate/source/includes/additional/drafts/non-bank-lending/_register_banking_non_bank_lending.md.erb index b4b67b44..b28a003b 100644 --- a/slate/source/includes/additional/drafts/non-bank-lending/_register_banking_non_bank_lending.md.erb +++ b/slate/source/includes/additional/drafts/non-bank-lending/_register_banking_non_bank_lending.md.erb @@ -16,5 +16,15 @@ These endpoints are exposed by the Register and consumed by Data Holders and Dat Register OpenAPI Specification (YAML) +```diff +Updated Register endpoint versions affected by the addition of the `non-bank-lending` value in the `industry` query and `industries` response field. + +The endpoint versions incremented due to these changes are: + - Get Data Holder Brands (v3) + - Get Data Holder Brands Summary (v2) + - Get Data Holder Statuses (v2). + +Previous Register endpoint versions are available through the respective 'Obsolete versions' links. +``` <%= partial "includes/cds_register_banking_non_bank_lending.md" %> diff --git a/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending.html.md b/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending.html.md index af05b9b1..f8e4f832 100644 --- a/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending.html.md +++ b/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending.html.md @@ -11,10 +11,15 @@ toc_footers: includes: - additional/drafts/non-bank-lending/_standards_banking_non_bank_lending - separator + - additional/drafts/non-bank-lending/cx_nbl + - additional/drafts/non-bank-lending/cx_standards_nbl + - separator - additional/drafts/non-bank-lending/_register_banking_non_bank_lending - separator - additional/drafts/non-bank-lending/banking-non-bank-lending_apis - cds_banking_non_bank_lending + - additional/drafts/non-bank-lending/_product_categories_nbl + - additional/drafts/non-bank-lending/_product_components_nbl search: true --- diff --git a/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis.md.erb b/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis.md.erb index c843e16f..f6778bfe 100644 --- a/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis.md.erb +++ b/slate/source/includes/additional/drafts/non-bank-lending/banking-non-bank-lending_apis.md.erb @@ -7,3 +7,27 @@ This specification defines the APIs for Data Holders exposing Banking endpoints. Banking OpenAPI Specification (YAML) +```diff +Updated Banking endpoint versions affected by the addition of the `BUY_NOW_PAY_LATER` value in the `product-category` query. + +Added `instalments` object in 'Get Product Detail' and 'Get Account Detail' endpoints. + +Added `EXTRA_DOWN_PAYMENT` `featureType` to support 'Buy Now, Pay Later' or similar products where a variable down-payment may be made. + +Added the 'Product Categories' section to include a general description of the `BUY_NOW_PAY_LATER` category. + +Added the 'Product & Account Components' section to include descriptions of the previously included `PAYMENT_LATE` and `UPFRONT_PER_PLAN` `feeType` values. + +The endpoint versions incremented due to these changes are: + - Get Accounts (v3) + - Get Bulk Balances (v2) + - Get Account Detail (v4) + - Get Bulk Direct Debits (v2) + - Get Scheduled Payments Bulk (v3) + - Get Products (v4) + - Get Product Detail (v5). + +Previous Banking endpoint versions are available through the respective 'Obsolete versions' links. + +Corrected minor typos and updated documentation formatting. +``` diff --git a/slate/source/includes/additional/drafts/non-bank-lending/cx_nbl.md b/slate/source/includes/additional/drafts/non-bank-lending/cx_nbl.md new file mode 100644 index 00000000..1f295305 --- /dev/null +++ b/slate/source/includes/additional/drafts/non-bank-lending/cx_nbl.md @@ -0,0 +1,7 @@ +# Consumer Experience + +```diff +Added Consumer Experience section with Banking Language for reference only +``` + +**Note:** The Draft Consumer Experience (CX) Standards for Non-Bank Lending reflect the existing Banking Language Standards. Other sections of the CX Standards relating to data language not explicitly included on the Draft Standards page including the [common data language standards](https://consumerdatastandardsaustralia.github.io/standards/#data-language-standards-common), [customer data language](https://consumerdatastandardsaustralia.github.io/standards/#customer-language-common), and [profile scopes](https://consumerdatastandardsaustralia.github.io/standards/#profile-scope-and-standard-claims-common), apply regardless of the sector. diff --git a/slate/source/includes/archives.md b/slate/source/includes/archives.md index a726f080..5e64f0bf 100644 --- a/slate/source/includes/archives.md +++ b/slate/source/includes/archives.md @@ -4,6 +4,7 @@ The following table lists archived versions of the Consumer Data Standards. The |Releases Date|Version|Description| |-------------|-------|-----------| +|10/10/2023 | 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | |24/08/2023 | 1.26.0 | Changes to obligations for the implementation of Get Metrics | |08/07/2023|1.25.0|Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs)| |07/05/2023|1.24.0|Changes arising from Decision 281 (Maintenance iteration 14)| diff --git a/slate/source/includes/cds_admin.md b/slate/source/includes/cds_admin.md index 55819d00..38c56857 100644 --- a/slate/source/includes/cds_admin.md +++ b/slate/source/includes/cds_admin.md @@ -705,7 +705,7 @@ This operation may only be called by the CDR Register |Name|Type|Required|Description| |---|---|---|---| |data|object|mandatory|none| -|» action|string|mandatory|The action to take for the meta data. At the moment the only option is REFRESH which requires the data holder to call the ACCC to refresh meta data as soon as practicable| +|» action|[Enum](#common-field-types)|mandatory|The action to take for the meta data. At the moment the only option is REFRESH which requires the data holder to call the ACCC to refresh meta data as soon as practicable| |meta|[Meta](#schemacdr-admin-apimeta)|optional|none| #### Enumerated Values diff --git a/slate/source/includes/cds_banking.md b/slate/source/includes/cds_banking.md index ad62a3fc..8a05f8e7 100644 --- a/slate/source/includes/cds_banking.md +++ b/slate/source/includes/cds_banking.md @@ -3937,7 +3937,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|featureType|string|mandatory|The type of feature described| +|featureType|[Enum](#common-field-types)|mandatory|The type of feature described| |additionalValue|string|conditional|Generic field containing additional information relevant to the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc)| |additionalInfo|string|conditional|Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to OTHER| |additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this feature| @@ -3994,7 +3994,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|constraintType|string|mandatory|The type of constraint described. See the next section for an overview of valid values and their meaning| +|constraintType|[Enum](#common-field-types)|mandatory|The type of constraint described. See the next section for an overview of valid values and their meaning| |additionalValue|string|conditional|Generic field containing additional information relevant to the [constraintType](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc)| |additionalInfo|string|optional|Display text providing more information the constraint| |additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on the constraint| @@ -4027,7 +4027,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|eligibilityType|string|mandatory|The type of eligibility criteria described. See the next section for an overview of valid values and their meaning| +|eligibilityType|[Enum](#common-field-types)|mandatory|The type of eligibility criteria described. See the next section for an overview of valid values and their meaning| |additionalValue|string|conditional|Generic field containing additional information relevant to the [eligibilityType](#tocSproducteligibilitytypedoc) specified. Whether mandatory or not is dependent on the value of [eligibilityType](#tocSproducteligibilitytypedoc)| |additionalInfo|string|conditional|Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) criteria. Mandatory if the field is set to OTHER| |additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this eligibility criteria| @@ -4097,7 +4097,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| |name|string|mandatory|Name of the fee| -|feeType|string|mandatory|The type of fee| +|feeType|[Enum](#common-field-types)|mandatory|The type of fee| |amount|[AmountString](#common-field-types)|conditional|The amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied| |balanceRate|[RateString](#common-field-types)|conditional|A fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied.| |transactionRate|[RateString](#common-field-types)|conditional|A fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied| @@ -4157,7 +4157,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| |description|string|mandatory|Description of the discount| -|discountType|string|mandatory|The type of discount. See the next section for an overview of valid values and their meaning| +|discountType|[Enum](#common-field-types)|mandatory|The type of discount. See the next section for an overview of valid values and their meaning| |amount|[AmountString](#common-field-types)|conditional|Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.| |balanceRate|[RateString](#common-field-types)|conditional|A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee| |transactionRate|[RateString](#common-field-types)|conditional|A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory| @@ -4196,7 +4196,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|discountEligibilityType|string|mandatory|The type of the specific eligibility constraint for a discount| +|discountEligibilityType|[Enum](#common-field-types)|mandatory|The type of the specific eligibility constraint for a discount| |additionalValue|string|conditional|Generic field containing additional information relevant to the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)| |additionalInfo|string|conditional|Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)| |additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this eligibility constraint| @@ -4255,7 +4255,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|depositRateType|string|mandatory|The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning| +|depositRateType|[Enum](#common-field-types)|mandatory|The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning| |rate|[RateString](#common-field-types)|mandatory|The rate to be applied| |calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| |applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| @@ -4316,14 +4316,14 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|lendingRateType|string|mandatory|The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning| +|lendingRateType|[Enum](#common-field-types)|mandatory|The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning| |rate|[RateString](#common-field-types)|mandatory|The rate to be applied| |comparisonRate|[RateString](#common-field-types)|optional|A comparison rate equivalent for this rate| |calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| |applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| -|interestPaymentDue|string|optional|When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered| -|repaymentType|string|optional|Options in place for repayments. If absent, the lending rate is applicable to all repayment types| -|loanPurpose|string|optional|The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes| +|interestPaymentDue|[Enum](#common-field-types)|optional|When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered| +|repaymentType|[Enum](#common-field-types)|optional|Options in place for repayments. If absent, the lending rate is applicable to all repayment types| +|loanPurpose|[Enum](#common-field-types)|optional|The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes| |tiers|[[BankingProductRateTierV3](#schemacdr-banking-apibankingproductratetierv3)]|optional|Rate tiers applicable for this rate| |additionalValue|string|conditional|Generic field containing additional information relevant to the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc)| |additionalInfo|string|optional|Display text providing more information on the rate.| @@ -4379,10 +4379,10 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| |name|string|mandatory|A display name for the tier| -|unitOfMeasure|string|mandatory|The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers)| +|unitOfMeasure|[Enum](#common-field-types)|mandatory|The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers)| |minimumValue|[Number](#common-field-types)|mandatory|The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value| |maximumValue|[Number](#common-field-types)|optional|The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.| -|rateApplicationMethod|string|optional|The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')| +|rateApplicationMethod|[Enum](#common-field-types)|optional|The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')| |applicabilityConditions|[BankingProductRateCondition](#schemacdr-banking-apibankingproductratecondition)|optional|Defines a condition for the applicability of a tiered rate| |additionalInfo|string|optional|Display text providing more information on the rate tier.| |additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate tier| @@ -4493,9 +4493,9 @@ This operation does not require authentication |creationDate|[DateString](#common-field-types)|optional|Date that the account was created (if known)| |displayName|string|mandatory|The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.| |nickname|string|optional|A customer supplied nick name for the account| -|openStatus|string|optional|Open or closed status for the account. If not present then OPEN is assumed| +|openStatus|[Enum](#common-field-types)|optional|Open or closed status for the account. If not present then OPEN is assumed| |isOwned|[Boolean](#common-field-types)|optional|Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed| -|accountOwnership|string|mandatory|Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers| +|accountOwnership|[Enum](#common-field-types)|mandatory|Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers| |maskedNumber|[MaskedAccountString](#common-field-types)|mandatory|A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number| |productCategory|[BankingProductCategory](#schemacdr-banking-apibankingproductcategory)|mandatory|The category to which a product or account belongs. See [here](#product-categories) for more details| |productName|string|mandatory|The unique identifier of the account as defined by the data holder (akin to model number for the account)| @@ -4944,7 +4944,7 @@ This operation does not require authentication |» bsb|string|optional|The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces| |» accountNumber|string|optional|The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces| |» bundleName|string|optional|Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer| -|» specificAccountUType|string|optional|The type of structure to present account specific fields.| +|» specificAccountUType|[Enum](#common-field-types)|optional|The type of structure to present account specific fields.| |» termDeposit|[[BankingTermDepositAccount](#schemacdr-banking-apibankingtermdepositaccount)]|conditional|none| |» creditCard|[BankingCreditCardAccount](#schemacdr-banking-apibankingcreditcardaccount)|conditional|none| |» loan|[BankingLoanAccountV2](#schemacdr-banking-apibankingloanaccountv2)|conditional|none| @@ -5005,7 +5005,7 @@ This operation does not require authentication |maturityDate|[DateString](#common-field-types)|mandatory|Maturity date for the term deposit| |maturityAmount|[AmountString](#common-field-types)|optional|Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated| |maturityCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes AUD| -|maturityInstructions|string|mandatory|Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments| +|maturityInstructions|[Enum](#common-field-types)|mandatory|Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments| #### Enumerated Values @@ -5082,7 +5082,7 @@ This operation does not require authentication |minRedrawCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes AUD| |offsetAccountEnabled|[Boolean](#common-field-types)|optional|Set to true if one or more offset accounts are configured for this loan account| |offsetAccountIds|[string]|optional|The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation| -|repaymentType|string|optional|Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST| +|repaymentType|[Enum](#common-field-types)|optional|Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST| |repaymentFrequency|[ExternalRef](#common-field-types)|optional|The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| #### Enumerated Values @@ -5182,8 +5182,8 @@ This operation does not require authentication |accountId|[ASCIIString](#common-field-types)|mandatory|ID of the account for which transactions are provided| |transactionId|[ASCIIString](#common-field-types)|conditional|A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if `isDetailAvailable` is set to true.| |isDetailAvailable|[Boolean](#common-field-types)|mandatory|True if extended information is available using the transaction detail end point. False if extended data is not available| -|type|string|mandatory|The type of the transaction| -|status|string|mandatory|Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction| +|type|[Enum](#common-field-types)|mandatory|The type of the transaction| +|status|[Enum](#common-field-types)|mandatory|Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction| |description|string|mandatory|The transaction description as applied by the financial institution| |postingDateTime|[DateTimeString](#common-field-types)|conditional|The time the transaction was posted. This field is Mandatory if the transaction has status POSTED. This is the time that appears on a standard statement| |valueDateTime|[DateTimeString](#common-field-types)|optional|Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry| @@ -5321,12 +5321,12 @@ This operation does not require authentication |» extendedData|object|mandatory|none| |»» payer|string|conditional|Label of the originating payer. Mandatory for inbound payment| |»» payee|string|conditional|Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)| -|»» extensionUType|string|optional|Optional extended data specific to transactions originated via NPP| +|»» extensionUType|[Enum](#common-field-types)|optional|Optional extended data specific to transactions originated via NPP| |»» x2p101Payload|object|conditional|none| |»»» extendedDescription|string|conditional|An extended string description. Required if the extensionUType field is `x2p101Payload`| |»»» endToEndId|string|optional|An end to end ID for the payment created at initiation| |»»» purposeCode|string|optional|Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service| -|»» service|string|mandatory|Identifier of the applicable overlay service. Valid values are: X2P1.01| +|»» service|[Enum](#common-field-types)|mandatory|Identifier of the applicable overlay service. Valid values are: X2P1.01| #### Enumerated Values @@ -5613,7 +5613,7 @@ This operation does not require authentication |payeeId|[ASCIIString](#common-field-types)|mandatory|ID of the payee adhering to the rules of ID permanence| |nickname|string|mandatory|The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels| |description|string|optional|A description of the payee provided by the customer| -|type|string|mandatory|The type of payee.
DOMESTIC means a registered payee for domestic payments including NPP.
INTERNATIONAL means a registered payee for international payments.
BILLER means a registered payee for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital wallet| +|type|[Enum](#common-field-types)|mandatory|The type of payee.
DOMESTIC means a registered payee for domestic payments including NPP.
INTERNATIONAL means a registered payee for international payments.
BILLER means a registered payee for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital wallet| |creationDate|[DateString](#common-field-types)|optional|The date the payee was created by the customer| #### Enumerated Values @@ -5702,7 +5702,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| |*anonymous*|object|mandatory|none| -|» payeeUType|string|mandatory|Type of object included that describes the payee in detail| +|» payeeUType|[Enum](#common-field-types)|mandatory|Type of object included that describes the payee in detail| |» biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none| |» domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none| |» digitalWallet|[BankingDigitalWalletPayee](#schemacdr-banking-apibankingdigitalwalletpayee)|conditional|none| @@ -5745,7 +5745,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|payeeAccountUType|string|mandatory|Type of account object included. Valid values are: **account** A standard Australian account defined by BSB/Account Number. **card** A credit or charge card to pay to (note that PANs are masked). **payId** A PayID recognised by NPP| +|payeeAccountUType|[Enum](#common-field-types)|mandatory|Type of account object included. Valid values are: **account** A standard Australian account defined by BSB/Account Number. **card** A credit or charge card to pay to (note that PANs are masked). **payId** A PayID recognised by NPP| |account|[BankingDomesticPayeeAccount](#schemacdr-banking-apibankingdomesticpayeeaccount)|conditional|none| |card|[BankingDomesticPayeeCard](#schemacdr-banking-apibankingdomesticpayeecard)|conditional|none| |payId|[BankingDomesticPayeePayId](#schemacdr-banking-apibankingdomesticpayeepayid)|conditional|none| @@ -5815,7 +5815,7 @@ This operation does not require authentication |---|---|---|---| |name|string|optional|The name assigned to the PayID by the owner of the PayID| |identifier|string|mandatory|The identifier of the PayID (dependent on type)| -|type|string|mandatory|The type of the PayID| +|type|[Enum](#common-field-types)|mandatory|The type of the PayID| #### Enumerated Values @@ -5917,8 +5917,8 @@ This operation does not require authentication |---|---|---|---| |name|string|mandatory|The display name of the wallet as given by the customer, else a default value defined by the data holder| |identifier|string|mandatory|The identifier of the digital wallet (dependent on type)| -|type|string|mandatory|The type of the digital wallet identifier| -|provider|string|mandatory|The provider of the digital wallet| +|type|[Enum](#common-field-types)|mandatory|The type of the digital wallet identifier| +|provider|[Enum](#common-field-types)|mandatory|The provider of the digital wallet| #### Enumerated Values @@ -6280,7 +6280,7 @@ This operation does not require authentication |nickname|string|optional|The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels| |payerReference|string|mandatory|The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided| |payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided| -|status|string|mandatory|Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.| +|status|[Enum](#common-field-types)|mandatory|Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.| |from|[BankingScheduledPaymentFrom](#schemacdr-banking-apibankingscheduledpaymentfrom)|mandatory|Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object| |paymentSet|[[BankingScheduledPaymentSetV2](#schemacdr-banking-apibankingscheduledpaymentsetv2)]|mandatory|[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]| |recurrence|[BankingScheduledPaymentRecurrence](#schemacdr-banking-apibankingscheduledpaymentrecurrence)|mandatory|Object containing the detail of the schedule for the payment| @@ -6441,7 +6441,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|toUType|string|mandatory|The type of object provided that specifies the destination of the funds for the payment.| +|toUType|[Enum](#common-field-types)|mandatory|The type of object provided that specifies the destination of the funds for the payment.| |accountId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent| |payeeId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead| |nickname|string|conditional|The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels| @@ -6524,7 +6524,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| |nextPaymentDate|[DateString](#common-field-types)|optional|The date of the next payment under the recurrence schedule| -|recurrenceUType|string|mandatory|The type of recurrence used to define the schedule| +|recurrenceUType|[Enum](#common-field-types)|mandatory|The type of recurrence used to define the schedule| |onceOff|[BankingScheduledPaymentRecurrenceOnceOff](#schemacdr-banking-apibankingscheduledpaymentrecurrenceonceoff)|conditional|Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff| |intervalSchedule|[BankingScheduledPaymentRecurrenceIntervalSchedule](#schemacdr-banking-apibankingscheduledpaymentrecurrenceintervalschedule)|conditional|Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule| |lastWeekDay|[BankingScheduledPaymentRecurrenceLastWeekday](#schemacdr-banking-apibankingscheduledpaymentrecurrencelastweekday)|conditional|Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay| @@ -6585,7 +6585,7 @@ This operation does not require authentication |---|---|---|---| |finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely| |paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely| -|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored| +|nonBusinessDayTreatment|[Enum](#common-field-types)|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored| |intervals|[[BankingScheduledPaymentInterval](#schemacdr-banking-apibankingscheduledpaymentinterval)]|mandatory|An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry| #### Enumerated Values @@ -6640,8 +6640,8 @@ This operation does not require authentication |finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely| |paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely| |interval|[ExternalRef](#common-field-types)|mandatory|The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate| -|lastWeekDay|string|mandatory|The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.| -|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored| +|lastWeekDay|[Enum](#common-field-types)|mandatory|The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.| +|nonBusinessDayTreatment|[Enum](#common-field-types)|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored| #### Enumerated Values @@ -6727,7 +6727,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|addressUType|string|mandatory|The type of address object present| +|addressUType|[Enum](#common-field-types)|mandatory|The type of address object present| |simple|[CommonSimpleAddress](#schemacdr-banking-apicommonsimpleaddress)|conditional|none| |paf|[CommonPAFAddress](#schemacdr-banking-apicommonpafaddress)|conditional|Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)| @@ -6996,7 +6996,7 @@ This operation does not require authentication |Name|Type|Required|Description| |---|---|---|---| -|*anonymous*|string|mandatory|The category to which a product or account belongs. See [here](#product-categories) for more details| +|*anonymous*|[Enum](#common-field-types)|mandatory|The category to which a product or account belongs. See [here](#product-categories) for more details| #### Enumerated Values diff --git a/slate/source/includes/cds_banking_dp306.md b/slate/source/includes/cds_banking_dp306.md new file mode 100644 index 00000000..fac69cb1 --- /dev/null +++ b/slate/source/includes/cds_banking_dp306.md @@ -0,0 +1,8925 @@ + + +## Get Accounts + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts` + +Obtain a list of accounts. + +Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html), [v2](../../../../includes/obsolete/get-accounts-v2.html) + +###Endpoint Version +| | | +|---|--| +|Version|**3** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.)| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| +|is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|product-category|BUSINESS_LOANS| +|product-category|BUY_NOW_PAY_LATER| +|product-category|CRED_AND_CHRG_CARDS| +|product-category|LEASES| +|product-category|MARGIN_LOANS| +|product-category|OVERDRAFTS| +|product-category|PERS_LOANS| +|product-category|REGULATED_TRUST_ACCOUNTS| +|product-category|RESIDENTIAL_MORTGAGES| +|product-category|TERM_DEPOSITS| +|product-category|TRADE_FINANCE| +|product-category|TRANS_AND_SAVINGS_ACCOUNTS| +|product-category|TRAVEL_CARDS| +|open-status|ALL| +|open-status|CLOSED| +|open-status|OPEN| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "accounts": [ + { + "accountId": "string", + "creationDate": "string", + "displayName": "string", + "nickname": "string", + "openStatus": "CLOSED", + "isOwned": true, + "accountOwnership": "UNKNOWN", + "maskedNumber": "string", + "productCategory": "BUSINESS_LOANS", + "productName": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountListV3](#schemacdr-banking-apiresponsebankingaccountlistv3)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Bulk Balances + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/balances` + +Obtain balances for multiple, filtered accounts + +Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-balances-v1.html) + +###Endpoint Version +| | | +|---|--| +|Version|**2** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| +|is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|product-category|BUSINESS_LOANS| +|product-category|BUY_NOW_PAY_LATER| +|product-category|CRED_AND_CHRG_CARDS| +|product-category|LEASES| +|product-category|MARGIN_LOANS| +|product-category|OVERDRAFTS| +|product-category|PERS_LOANS| +|product-category|REGULATED_TRUST_ACCOUNTS| +|product-category|RESIDENTIAL_MORTGAGES| +|product-category|TERM_DEPOSITS| +|product-category|TRADE_FINANCE| +|product-category|TRANS_AND_SAVINGS_ACCOUNTS| +|product-category|TRAVEL_CARDS| +|open-status|ALL| +|open-status|CLOSED| +|open-status|OPEN| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "balances": [ + { + "accountId": "string", + "currentBalance": "string", + "availableBalance": "string", + "creditLimit": "string", + "amortisedLimit": "string", + "currency": "string", + "purses": [ + { + "amount": "string", + "currency": "string" + } + ] + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountsBalanceList](#schemacdr-banking-apiresponsebankingaccountsbalancelist)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Balances For Specific Accounts + + + +> Code samples + +```http +POST https://data.holder.com.au/cds-au/v1/banking/accounts/balances HTTP/1.1 +Host: data.holder.com.au +Content-Type: application/json +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); +const inputBody = '{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +}'; +const headers = { + 'Content-Type':'application/json', + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances', +{ + method: 'POST', + body: inputBody, + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`POST /banking/accounts/balances` + +Obtain balances for a specified list of accounts + +> Body parameter + +```json +{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +} +``` + +###Endpoint Version +| | | +|---|--| +|Version|**1** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| +|body|body|[RequestAccountIds](#schemacdr-banking-apirequestaccountids)|mandatory|The list of account IDs to obtain balances for| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "balances": [ + { + "accountId": "string", + "currentBalance": "string", + "availableBalance": "string", + "creditLimit": "string", + "amortisedLimit": "string", + "currency": "string", + "purses": [ + { + "amount": "string", + "currency": "string" + } + ] + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountsBalanceList](#schemacdr-banking-apiresponsebankingaccountsbalancelist)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
  • [422 - Unavailable Banking Account](#error-422-authorisation-unavailable-banking-account)
  • [422 - Invalid Banking Account](#error-422-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Account Balance + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/balance', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/{accountId}/balance` + +Obtain the balance for a single specified account + +###Endpoint Version +| | | +|---|--| +|Version|**1** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the specific account requested| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "accountId": "string", + "currentBalance": "string", + "availableBalance": "string", + "creditLimit": "string", + "amortisedLimit": "string", + "currency": "string", + "purses": [ + { + "amount": "string", + "currency": "string" + } + ] + }, + "links": { + "self": "string" + }, + "meta": {} +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountsBalanceById](#schemacdr-banking-apiresponsebankingaccountsbalancebyid)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Account Detail + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId} HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/{accountId}` + +Obtain detailed information on a single account. + +Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html), [v3](../../../../includes/obsolete/get-account-detail-v3.html) + +###Endpoint Version +| | | +|---|--| +|Version|**4** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|A tokenised identifier for the account which is unique but not shareable| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "accountId": "string", + "creationDate": "string", + "displayName": "string", + "nickname": "string", + "openStatus": "CLOSED", + "isOwned": true, + "accountOwnership": "UNKNOWN", + "maskedNumber": "string", + "productCategory": "BUSINESS_LOANS", + "productName": "string", + "bsb": "string", + "accountNumber": "string", + "bundleName": "string", + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + }, + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4, + "plans": [ + { + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] + } + ] + }, + "termDeposit": [ + { + "lodgementDate": "string", + "maturityDate": "string", + "maturityAmount": "string", + "maturityCurrency": "string", + "maturityInstructions": "HOLD_ON_MATURITY", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + } + ], + "creditCard": { + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "cardPlans": [ + { + "nickname": "string", + "planType": "PURCHASE_PLAN", + "atExpiryBalanceTransfersTo": "PURCHASE_PLAN", + "planCreationDate": "string", + "planPeriod": "string", + "planEndDate": "string", + "planReferenceRate": "string", + "planEffectiveRate": "string", + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "interestFreePeriods": [ + { + "from": "string", + "to": "string" + } + ], + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "planFeatures": [ + { + "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE", + "period": "string", + "endDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + }, + "loan": { + "originalStartDate": "string", + "originalLoanAmount": "string", + "originalLoanCurrency": "string", + "loanEndDate": "string", + "nextInstalmentDate": "string", + "minInstalmentAmount": "string", + "minInstalmentCurrency": "string", + "maxRedraw": "string", + "maxRedrawCurrency": "string", + "minRedraw": "string", + "minRedrawCurrency": "string", + "offsetAccountEnabled": true, + "offsetAccountIds": [ + "string" + ], + "lendingRateDetail": [ + { + "loanPurpose": "OWNER_OCCUPIED", + "repaymentType": "PRINCIPAL_AND_INTEREST", + "rateStartDate": "string", + "rateEndDate": "string", + "revertProductId": "string", + "repaymentUType": "fixedRate", + "fixedRate": { + "fixedPeriod": "string", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "variableRate": { + "variableRateType": "FLOATING", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "feeAmount": { + "amount": "string", + "currency": "string", + "repaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + }, + "deposit": { + "lodgementDate": "string", + "nickname": "string", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + }, + "features": [ + { + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "isActivated": true + } + ], + "fees": [ + { + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + } + ], + "addresses": [ + { + "addressUType": "paf", + "simple": { + "mailingName": "string", + "addressLine1": "string", + "addressLine2": "string", + "addressLine3": "string", + "postcode": "string", + "city": "string", + "state": "string", + "country": "AUS" + }, + "paf": { + "dpid": "string", + "thoroughfareNumber1": 0, + "thoroughfareNumber1Suffix": "string", + "thoroughfareNumber2": 0, + "thoroughfareNumber2Suffix": "string", + "flatUnitType": "string", + "flatUnitNumber": "string", + "floorLevelType": "string", + "floorLevelNumber": "string", + "lotNumber": "string", + "buildingName1": "string", + "buildingName2": "string", + "streetName": "string", + "streetType": "string", + "streetSuffix": "string", + "postalDeliveryType": "string", + "postalDeliveryNumber": 0, + "postalDeliveryNumberPrefix": "string", + "postalDeliveryNumberSuffix": "string", + "localityName": "string", + "postcode": "string", + "state": "string" + } + } + ] + }, + "links": { + "self": "string" + }, + "meta": {} +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountByIdV4](#schemacdr-banking-apiresponsebankingaccountbyidv4)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Transactions For Account + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/{accountId}/transactions` + +Obtain transactions for a specific account. + +Some general notes that apply to all endpoints that retrieve transactions: + +- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order +- As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as: + - Posted date/time if available, then + - Execution date/time if available, then + - A reasonable date/time nominated by the data holder using internal data structures +- For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account +- For aggregated transactions (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 + +###Endpoint Version +| | | +|---|--| +|Version|**1** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.| +|oldest-time|query|[DateTimeString](#common-field-types)|optional|Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type| +|newest-time|query|[DateTimeString](#common-field-types)|optional|Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type| +|min-amount|query|[AmountString](#common-field-types)|optional|Filter transactions to only transactions with amounts higher than or equal to this amount| +|max-amount|query|[AmountString](#common-field-types)|optional|Filter transactions to only transactions with amounts less than or equal to this amount| +|text|query|string|optional|Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "transactions": [ + { + "accountId": "string", + "transactionId": "string", + "isDetailAvailable": true, + "type": "DIRECT_DEBIT", + "status": "PENDING", + "description": "string", + "postingDateTime": "string", + "valueDateTime": "string", + "executionDateTime": "string", + "amount": "string", + "currency": "string", + "reference": "string", + "merchantName": "string", + "merchantCategoryCode": "string", + "billerCode": "string", + "billerName": "string", + "crn": "string", + "apcaNumber": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0, + "isQueryParamUnsupported": false + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingTransactionList](#schemacdr-banking-apiresponsebankingtransactionlist)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
  • [400 - Invalid Date](#error-400-field-invalid-date-time)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Transaction Detail + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId} HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId}', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/{accountId}/transactions/{transactionId}` + +Obtain detailed information on a transaction for a specific account + +###Endpoint Version +| | | +|---|--| +|Version|**1** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints| +|transactionId|path|[ASCIIString](#common-field-types)|mandatory|ID of the transaction obtained from a previous call to one of the other transaction endpoints| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "accountId": "string", + "transactionId": "string", + "isDetailAvailable": true, + "type": "DIRECT_DEBIT", + "status": "PENDING", + "description": "string", + "postingDateTime": "string", + "valueDateTime": "string", + "executionDateTime": "string", + "amount": "string", + "currency": "string", + "reference": "string", + "merchantName": "string", + "merchantCategoryCode": "string", + "billerCode": "string", + "billerName": "string", + "crn": "string", + "apcaNumber": "string", + "extendedData": { + "payer": "string", + "payee": "string", + "extensionUType": "x2p101Payload", + "x2p101Payload": { + "extendedDescription": "string", + "endToEndId": "string", + "purposeCode": "string" + }, + "service": "X2P1.01" + } + }, + "links": { + "self": "string" + }, + "meta": {} +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingTransactionById](#schemacdr-banking-apiresponsebankingtransactionbyid)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Date](#error-400-field-invalid-date-time)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
  • [404 - Unavailable Resource](#error-404-resource-unavailable)
  • [404 - Invalid Resource](#error-404-resource-invalid)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Direct Debits For Account + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/{accountId}/direct-debits` + +Obtain direct debit authorisations for a specific account + +###Endpoint Version +| | | +|---|--| +|Version|**1** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "directDebitAuthorisations": [ + { + "accountId": "string", + "authorisedEntity": { + "description": "string", + "financialInstitution": "string", + "abn": "string", + "acn": "string", + "arbn": "string" + }, + "lastDebitDateTime": "string", + "lastDebitAmount": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingDirectDebitAuthorisationList](#schemacdr-banking-apiresponsebankingdirectdebitauthorisationlist)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Bulk Direct Debits + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/direct-debits` + +Obtain direct debit authorisations for multiple, filtered accounts + +Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-direct-debits-v1.html) + +###Endpoint Version +| | | +|---|--| +|Version|**2** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| +|is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|product-category|BUSINESS_LOANS| +|product-category|BUY_NOW_PAY_LATER| +|product-category|CRED_AND_CHRG_CARDS| +|product-category|LEASES| +|product-category|MARGIN_LOANS| +|product-category|OVERDRAFTS| +|product-category|PERS_LOANS| +|product-category|REGULATED_TRUST_ACCOUNTS| +|product-category|RESIDENTIAL_MORTGAGES| +|product-category|TERM_DEPOSITS| +|product-category|TRADE_FINANCE| +|product-category|TRANS_AND_SAVINGS_ACCOUNTS| +|product-category|TRAVEL_CARDS| +|open-status|ALL| +|open-status|CLOSED| +|open-status|OPEN| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "directDebitAuthorisations": [ + { + "accountId": "string", + "authorisedEntity": { + "description": "string", + "financialInstitution": "string", + "abn": "string", + "acn": "string", + "arbn": "string" + }, + "lastDebitDateTime": "string", + "lastDebitAmount": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingDirectDebitAuthorisationList](#schemacdr-banking-apiresponsebankingdirectdebitauthorisationlist)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Direct Debits For Specific Accounts + + + +> Code samples + +```http +POST https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits HTTP/1.1 +Host: data.holder.com.au +Content-Type: application/json +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); +const inputBody = '{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +}'; +const headers = { + 'Content-Type':'application/json', + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits', +{ + method: 'POST', + body: inputBody, + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`POST /banking/accounts/direct-debits` + +Obtain direct debit authorisations for a specified list of accounts + +> Body parameter + +```json +{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +} +``` + +###Endpoint Version +| | | +|---|--| +|Version|**1** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| +|body|body|[RequestAccountIds](#schemacdr-banking-apirequestaccountids)|mandatory|Array of specific accountIds to obtain authorisations for| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "directDebitAuthorisations": [ + { + "accountId": "string", + "authorisedEntity": { + "description": "string", + "financialInstitution": "string", + "abn": "string", + "acn": "string", + "arbn": "string" + }, + "lastDebitDateTime": "string", + "lastDebitAmount": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingDirectDebitAuthorisationList](#schemacdr-banking-apiresponsebankingdirectdebitauthorisationlist)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
  • [422 - Unavailable Banking Account](#error-422-authorisation-unavailable-banking-account)
  • [422 - Invalid Banking Account](#error-422-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Scheduled Payments for Account + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/accounts/{accountId}/payments/scheduled` + +Obtain scheduled, outgoing payments for a specific account + +Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-account-v1.html) + +###Endpoint Version +| | | +|---|--| +|Version|**2** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "scheduledPayments": [ + { + "scheduledPaymentId": "string", + "nickname": "string", + "payerReference": "string", + "payeeReference": "string", + "status": "ACTIVE", + "from": { + "accountId": "string" + }, + "paymentSet": [ + { + "to": { + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "isAmountCalculated": true, + "amount": "string", + "currency": "string" + } + ], + "recurrence": { + "nextPaymentDate": "string", + "recurrenceUType": "eventBased", + "onceOff": { + "paymentDate": "string" + }, + "intervalSchedule": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] + }, + "lastWeekDay": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" + }, + "eventBased": { + "description": "string" + } + } + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingScheduledPaymentsListV2](#schemacdr-banking-apiresponsebankingscheduledpaymentslistv2)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Scheduled Payments Bulk + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/payments/scheduled` + +Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments + +Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](../../../../includes/obsolete/get-scheduled-payments-bulk-v2.html) + +###Endpoint Version +| | | +|---|--| +|Version|**3** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| +|is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|product-category|BUSINESS_LOANS| +|product-category|BUY_NOW_PAY_LATER| +|product-category|CRED_AND_CHRG_CARDS| +|product-category|LEASES| +|product-category|MARGIN_LOANS| +|product-category|OVERDRAFTS| +|product-category|PERS_LOANS| +|product-category|REGULATED_TRUST_ACCOUNTS| +|product-category|RESIDENTIAL_MORTGAGES| +|product-category|TERM_DEPOSITS| +|product-category|TRADE_FINANCE| +|product-category|TRANS_AND_SAVINGS_ACCOUNTS| +|product-category|TRAVEL_CARDS| +|open-status|ALL| +|open-status|CLOSED| +|open-status|OPEN| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "scheduledPayments": [ + { + "scheduledPaymentId": "string", + "nickname": "string", + "payerReference": "string", + "payeeReference": "string", + "status": "ACTIVE", + "from": { + "accountId": "string" + }, + "paymentSet": [ + { + "to": { + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "isAmountCalculated": true, + "amount": "string", + "currency": "string" + } + ], + "recurrence": { + "nextPaymentDate": "string", + "recurrenceUType": "eventBased", + "onceOff": { + "paymentDate": "string" + }, + "intervalSchedule": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] + }, + "lastWeekDay": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" + }, + "eventBased": { + "description": "string" + } + } + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingScheduledPaymentsListV2](#schemacdr-banking-apiresponsebankingscheduledpaymentslistv2)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Scheduled Payments For Specific Accounts + + + +> Code samples + +```http +POST https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1 +Host: data.holder.com.au +Content-Type: application/json +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); +const inputBody = '{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +}'; +const headers = { + 'Content-Type':'application/json', + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled', +{ + method: 'POST', + body: inputBody, + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`POST /banking/payments/scheduled` + +Obtain scheduled payments for a specified list of accounts + +Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html) + +> Body parameter + +```json +{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +} +``` + +###Endpoint Version +| | | +|---|--| +|Version|**2** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| +|body|body|[RequestAccountIds](#schemacdr-banking-apirequestaccountids)|mandatory|Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "scheduledPayments": [ + { + "scheduledPaymentId": "string", + "nickname": "string", + "payerReference": "string", + "payeeReference": "string", + "status": "ACTIVE", + "from": { + "accountId": "string" + }, + "paymentSet": [ + { + "to": { + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "isAmountCalculated": true, + "amount": "string", + "currency": "string" + } + ], + "recurrence": { + "nextPaymentDate": "string", + "recurrenceUType": "eventBased", + "onceOff": { + "paymentDate": "string" + }, + "intervalSchedule": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] + }, + "lastWeekDay": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" + }, + "eventBased": { + "description": "string" + } + } + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingScheduledPaymentsListV2](#schemacdr-banking-apiresponsebankingscheduledpaymentslistv2)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
  • [422 - Unavailable Banking Account](#error-422-authorisation-unavailable-banking-account)
  • [422 - Invalid Banking Account](#error-422-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Payees + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/payees HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/payees', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/payees` + +Obtain a list of pre-registered payees. + +Obsolete versions: [v1](../../../../includes/obsolete/get-payees-v1.html) + +###Endpoint Version +| | | +|---|--| +|Version|**2** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|type|query|string|optional|Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|type|ALL| +|type|BILLER| +|type|DIGITAL_WALLET| +|type|DOMESTIC| +|type|INTERNATIONAL| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "payees": [ + { + "payeeId": "string", + "nickname": "string", + "description": "string", + "type": "BILLER", + "creationDate": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingPayeeListV2](#schemacdr-banking-apiresponsebankingpayeelistv2)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Payee Detail + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId} HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string +x-fapi-interaction-id: string +x-fapi-auth-date: string +x-fapi-customer-ip-address: string +x-cds-client-headers: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string', + 'x-fapi-interaction-id':'string', + 'x-fapi-auth-date':'string', + 'x-fapi-customer-ip-address':'string', + 'x-cds-client-headers':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/payees/{payeeId}', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/payees/{payeeId}` + +Obtain detailed information on a single payee. + +Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient. + +Obsolete versions: [v1](../../../../includes/obsolete/get-payee-detail-v1.html) + +###Endpoint Version +| | | +|---|--| +|Version|**2** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|payeeId|path|[ASCIIString](#common-field-types)|mandatory|The ID used to locate the details of a particular payee| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| +|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| +|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| +|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "payeeId": "string", + "nickname": "string", + "description": "string", + "type": "BILLER", + "creationDate": "string", + "payeeUType": "biller", + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "links": { + "self": "string" + }, + "meta": {} +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingPayeeByIdV2](#schemacdr-banking-apiresponsebankingpayeebyidv2)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Resource](#error-404-resource-unavailable)
  • [404 - Invalid Resource](#error-404-resource-invalid)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| +|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| +|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| + + + + + + + + +## Get Products + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/products HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/products', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/products` + +Obtain a list of products that are currently openly offered to the market + +Note that the results returned by this endpoint are expected to be ordered in descending order according to `lastUpdated`. + +### Conventions +In the product reference payloads there are a number of recurring conventions that are explained here, in one place. + +#### Arrays Of Features + +In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows: + +- Each element in an array has the same structure so that clients can reliably interpret the payloads +- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees. +- Each element has a field name [additionalValue](#productfeaturetypedoc). 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 actually has been instantiated and created along with the associated decisions inherent in that process. + +#### Dates +It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a `lastUpdated` field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the `updated-since` query parameter. + +In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely. + +Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html), [v2](../../../../includes/obsolete/get-products-v2.html), [v3](../../../../includes/obsolete/get-products-v3.html) + +###Endpoint Version +| | | +|---|--| +|Version|**4** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|effective|query|string|optional|Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`| +|updated-since|query|[DateTimeString](#common-field-types)|optional|Only include products that have been updated after the specified date and time. If absent defaults to include all products| +|brand|query|string|optional|Filter results based on a specific brand| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| +|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|effective|ALL| +|effective|CURRENT| +|effective|FUTURE| +|product-category|BUSINESS_LOANS| +|product-category|BUY_NOW_PAY_LATER| +|product-category|CRED_AND_CHRG_CARDS| +|product-category|LEASES| +|product-category|MARGIN_LOANS| +|product-category|OVERDRAFTS| +|product-category|PERS_LOANS| +|product-category|REGULATED_TRUST_ACCOUNTS| +|product-category|RESIDENTIAL_MORTGAGES| +|product-category|TERM_DEPOSITS| +|product-category|TRADE_FINANCE| +|product-category|TRANS_AND_SAVINGS_ACCOUNTS| +|product-category|TRAVEL_CARDS| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "products": [ + { + "productId": "string", + "effectiveFrom": "string", + "effectiveTo": "string", + "lastUpdated": "string", + "productCategory": "BUSINESS_LOANS", + "name": "string", + "description": "string", + "brand": "string", + "brandName": "string", + "applicationUri": "string", + "isTailored": true, + "additionalInformation": { + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] + }, + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + } + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingProductListV3](#schemacdr-banking-apiresponsebankingproductlistv3)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Date](#error-400-field-invalid-date-time)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| + + + + + + +## Get Product Detail + + + +> Code samples + +```http +GET https://data.holder.com.au/cds-au/v1/banking/products/{productId} HTTP/1.1 +Host: data.holder.com.au +Accept: application/json +x-v: string +x-min-v: string + +``` + +```javascript--nodejs +const fetch = require('node-fetch'); + +const headers = { + 'Accept':'application/json', + 'x-v':'string', + 'x-min-v':'string' + +}; + +fetch('https://data.holder.com.au/cds-au/v1/banking/products/{productId}', +{ + method: 'GET', + + headers: headers +}) +.then(function(res) { + return res.json(); +}).then(function(body) { + console.log(body); +}); + +``` + +`GET /banking/products/{productId}` + +Obtain detailed information on a single product offered openly to the market. + +Obsolete versions: [v1](../../../../includes/obsolete/get-product-detail-v1.html), [v2](../../../../includes/obsolete/get-product-detail-v2.html), [v3](../../../../includes/obsolete/get-product-detail-v3.html), [v4](../../../../includes/obsolete/get-product-detail-v4.html) + +###Endpoint Version +| | | +|---|--| +|Version|**5** + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|productId|path|[ASCIIString](#common-field-types)|mandatory|ID of the specific product requested| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| + +> Example responses + +> 200 Response + +```json +{ + "data": { + "productId": "string", + "effectiveFrom": "string", + "effectiveTo": "string", + "lastUpdated": "string", + "productCategory": "BUSINESS_LOANS", + "name": "string", + "description": "string", + "brand": "string", + "brandName": "string", + "applicationUri": "string", + "isTailored": true, + "additionalInformation": { + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] + }, + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + }, + "bundles": [ + { + "name": "string", + "description": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "productIds": [ + "string" + ] + } + ], + "features": [ + { + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "constraints": [ + { + "constraintType": "MAX_BALANCE", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "eligibility": [ + { + "eligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "fees": [ + { + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + } + ], + "depositRates": [ + { + "depositRateType": "VARIABLE", + "rate": "string", + "adjustmentToBase": "FIXED", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "lendingRates": [ + { + "lendingRateType": "DISCOUNT", + "rate": "string", + "referenceRate": "string", + "comparisonRate": "string", + "revertRate": "string", + "revertProductId": "string", + "adjustmentToBase": "BALANCE_TRANSFER", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentType": "INTEREST_ONLY", + "loanPurpose": "INVESTMENT", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4 + } + }, + "links": { + "self": "string" + }, + "meta": {} +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingProductByIdV5](#schemacdr-banking-apiresponsebankingproductbyidv5)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Resource](#error-404-resource-unavailable)
  • [404 - Invalid Resource](#error-404-resource-invalid)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| +|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| + +### Response Headers + +|Status|Header|Type|Format|Description| +|---|---|---|---|---| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| + + + + + + +

Schemas

+ + +

RequestAccountIds

+ + + +```json +{ + "data": { + "accountIds": [ + "string" + ] + }, + "meta": {} +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» accountIds|[string]|mandatory|none| +|meta|[Meta](#schemacdr-banking-apimeta)|optional|none| + +

ResponseBankingProductListV3

+ + + +```json +{ + "data": { + "products": [ + { + "productId": "string", + "effectiveFrom": "string", + "effectiveTo": "string", + "lastUpdated": "string", + "productCategory": "BUSINESS_LOANS", + "name": "string", + "description": "string", + "brand": "string", + "brandName": "string", + "applicationUri": "string", + "isTailored": true, + "additionalInformation": { + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] + }, + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + } + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» products|[[BankingProductV5](#schemacdr-banking-apibankingproductv5)]|mandatory|The list of products returned. If the filter results in an empty set then this array may have no records| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +

BankingProductV5

+ + + +```json +{ + "productId": "string", + "effectiveFrom": "string", + "effectiveTo": "string", + "lastUpdated": "string", + "productCategory": "BUSINESS_LOANS", + "name": "string", + "description": "string", + "brand": "string", + "brandName": "string", + "applicationUri": "string", + "isTailored": true, + "additionalInformation": { + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] + }, + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|productId|[ASCIIString](#common-field-types)|mandatory|A data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.| +|effectiveFrom|[DateTimeString](#common-field-types)|optional|The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate| +|effectiveTo|[DateTimeString](#common-field-types)|optional|The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products| +|lastUpdated|[DateTimeString](#common-field-types)|mandatory|The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered)| +|productCategory|[BankingProductCategoryV2](#schemacdr-banking-apibankingproductcategoryv2)|mandatory|The category to which a product or account belongs. See [here](#product-categories) for more details| +|name|string|mandatory|The display name of the product| +|description|string|mandatory|A description of the product| +|brand|string|mandatory|A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required| +|brandName|string|optional|An optional display name of the brand| +|applicationUri|[URIString](#common-field-types)|optional|A link to an application web page where this product can be applied for.| +|isTailored|[Boolean](#common-field-types)|mandatory|Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable| +|additionalInformation|[BankingProductAdditionalInformationV2](#schemacdr-banking-apibankingproductadditionalinformationv2)|optional|Object that contains links to additional information on specific topics| +|cardOption|[BankingProductCardOption](#schemacdr-banking-apibankingproductcardoption)|optional|Information about the type of card available with the account| + +

BankingProductCardOption

+ + + +```json +{ + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] +} + +``` + +*Information about the type of card available with the account* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|cardScheme|[Enum](#common-field-types)|mandatory|Card scheme available with the account| +|cardType|[Enum](#common-field-types)|mandatory|Card type available with the account| +|cardImages|[[BankingProductCardOption_cardImages](#schemacdr-banking-apibankingproductcardoption_cardimages)]|optional|An array of card art images| + +#### Enumerated Values + +|Property|Value| +|---|---| +|cardScheme|AMEX| +|cardScheme|DINERS| +|cardScheme|EFTPOS| +|cardScheme|MASTERCARD| +|cardScheme|VISA| +|cardScheme|OTHER| +|cardType|CHARGE| +|cardType|CREDIT| +|cardType|DEBIT| + +

BankingProductCardOption_cardImages

+ + + +```json +{ + "title": "string", + "imageUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|title|string|optional|Display label for the specific image| +|imageUri|[URIString](#common-field-types)|mandatory|URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)**| + +

BankingProductAdditionalInformationV2

+ + + +```json +{ + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] +} + +``` + +*Object that contains links to additional information on specific topics* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|overviewUri|[URIString](#common-field-types)|conditional|General overview of the product. Mandatory if `additionalOverviewUris` includes one or more supporting documents.| +|termsUri|[URIString](#common-field-types)|conditional|Terms and conditions for the product. Mandatory if `additionalTermsUris` includes one or more supporting documents.| +|eligibilityUri|[URIString](#common-field-types)|conditional|Eligibility rules and criteria for the product. Mandatory if `additionalEligibilityUris` includes one or more supporting documents.| +|feesAndPricingUri|[URIString](#common-field-types)|conditional|Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if `additionalFeesAndPricingUris` includes one or more supporting documents.| +|bundleUri|[URIString](#common-field-types)|conditional|Description of a bundle that this product can be part of. Mandatory if `additionalBundleUris` includes one or more supporting documents.| +|additionalOverviewUris|[[BankingProductAdditionalInformationV2_additionalInformationUris](#schemacdr-banking-apibankingproductadditionalinformationv2_additionalinformationuris)]|optional|An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the `overviewUri`. Only to be used if there is a primary `overviewUri`.| +|additionalTermsUris|[[BankingProductAdditionalInformationV2_additionalInformationUris](#schemacdr-banking-apibankingproductadditionalinformationv2_additionalinformationuris)]|optional|An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the `termsUri`. Only to be used if there is a primary `termsUri`.| +|additionalEligibilityUris|[[BankingProductAdditionalInformationV2_additionalInformationUris](#schemacdr-banking-apibankingproductadditionalinformationv2_additionalinformationuris)]|optional|An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the `eligibilityUri`. Only to be used if there is a primary `eligibilityUri`.| +|additionalFeesAndPricingUris|[[BankingProductAdditionalInformationV2_additionalInformationUris](#schemacdr-banking-apibankingproductadditionalinformationv2_additionalinformationuris)]|optional|An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the `feesAndPricingUri`. Only to be used if there is a primary `feesAndPricingUri`.| +|additionalBundleUris|[[BankingProductAdditionalInformationV2_additionalInformationUris](#schemacdr-banking-apibankingproductadditionalinformationv2_additionalinformationuris)]|optional|An array of additional bundles for the product, if applicable. To be treated as secondary documents to the `bundleUri`. Only to be used if there is a primary `bundleUri`.| + +

BankingProductAdditionalInformationV2_additionalInformationUris

+ + + +```json +{ + "description": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|description|string|optional|Display text providing more information about the document URI| +|additionalInfoUri|[URIString](#common-field-types)|mandatory|The URI describing the additional information| + +

ResponseBankingProductByIdV5

+ + + +```json +{ + "data": { + "productId": "string", + "effectiveFrom": "string", + "effectiveTo": "string", + "lastUpdated": "string", + "productCategory": "BUSINESS_LOANS", + "name": "string", + "description": "string", + "brand": "string", + "brandName": "string", + "applicationUri": "string", + "isTailored": true, + "additionalInformation": { + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] + }, + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + }, + "bundles": [ + { + "name": "string", + "description": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "productIds": [ + "string" + ] + } + ], + "features": [ + { + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "constraints": [ + { + "constraintType": "MAX_BALANCE", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "eligibility": [ + { + "eligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "fees": [ + { + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + } + ], + "depositRates": [ + { + "depositRateType": "VARIABLE", + "rate": "string", + "adjustmentToBase": "FIXED", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "lendingRates": [ + { + "lendingRateType": "DISCOUNT", + "rate": "string", + "referenceRate": "string", + "comparisonRate": "string", + "revertRate": "string", + "revertProductId": "string", + "adjustmentToBase": "BALANCE_TRANSFER", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentType": "INTEREST_ONLY", + "loanPurpose": "INVESTMENT", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4 + } + }, + "links": { + "self": "string" + }, + "meta": {} +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|[BankingProductDetailV5](#schemacdr-banking-apibankingproductdetailv5)|mandatory|none| +|links|[Links](#schemacdr-banking-apilinks)|mandatory|none| +|meta|[Meta](#schemacdr-banking-apimeta)|optional|none| + +

BankingProductDetailV5

+ + + +```json +{ + "productId": "string", + "effectiveFrom": "string", + "effectiveTo": "string", + "lastUpdated": "string", + "productCategory": "BUSINESS_LOANS", + "name": "string", + "description": "string", + "brand": "string", + "brandName": "string", + "applicationUri": "string", + "isTailored": true, + "additionalInformation": { + "overviewUri": "string", + "termsUri": "string", + "eligibilityUri": "string", + "feesAndPricingUri": "string", + "bundleUri": "string", + "additionalOverviewUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalTermsUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalEligibilityUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalFeesAndPricingUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ], + "additionalBundleUris": [ + { + "description": "string", + "additionalInfoUri": "string" + } + ] + }, + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + }, + "bundles": [ + { + "name": "string", + "description": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "productIds": [ + "string" + ] + } + ], + "features": [ + { + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "constraints": [ + { + "constraintType": "MAX_BALANCE", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "eligibility": [ + { + "eligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "fees": [ + { + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + } + ], + "depositRates": [ + { + "depositRateType": "VARIABLE", + "rate": "string", + "adjustmentToBase": "FIXED", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "lendingRates": [ + { + "lendingRateType": "DISCOUNT", + "rate": "string", + "referenceRate": "string", + "comparisonRate": "string", + "revertRate": "string", + "revertProductId": "string", + "adjustmentToBase": "BALANCE_TRANSFER", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentType": "INTEREST_ONLY", + "loanPurpose": "INVESTMENT", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4 + } +} + +``` + +### Properties + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[BankingProductV5](#schemacdr-banking-apibankingproductv5)|mandatory|none| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|object|mandatory|none| +|» bundles|[[BankingProductBundle](#schemacdr-banking-apibankingproductbundle)]|optional|An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also| +|» features|[[BankingProductFeatureV3](#schemacdr-banking-apibankingproductfeaturev3)]|optional|Array of features and limitations of the product| +|» constraints|[[BankingProductConstraintV2](#schemacdr-banking-apibankingproductconstraintv2)]|optional|Constraints on the application for the product such as minimum balances or limit thresholds| +|» eligibility|[[BankingProductEligibility](#schemacdr-banking-apibankingproducteligibility)]|optional|Eligibility criteria for the product| +|» fees|[[BankingProductFeeV2](#schemacdr-banking-apibankingproductfeev2)]|optional|Fees applicable to the product| +|» depositRates|[[BankingProductDepositRateV2](#schemacdr-banking-apibankingproductdepositratev2)]|optional|Interest rates available for deposits| +|» lendingRates|[[BankingProductLendingRateV3](#schemacdr-banking-apibankingproductlendingratev3)]|optional|Interest rates charged against lending balances| +|» instalments|[BankingProductInstalments](#schemacdr-banking-apibankingproductinstalments)|optional|Details of instalment features on the account| + +

BankingProductBundle

+ + + +```json +{ + "name": "string", + "description": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "productIds": [ + "string" + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|name|string|mandatory|Name of the bundle| +|description|string|mandatory|Description of the bundle| +|additionalInfo|string|optional|Display text providing more information on the bundle| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on the bundle criteria and benefits| +|productIds|[string]|optional|Array of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints| + +

BankingProductFeatureV3

+ + + +```json +{ + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +*Array of features and limitations of the product* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|featureType|[Enum](#common-field-types)|mandatory|The type of feature described. For further details, refer to [Product Feature Types](#tocSproductfeaturetypedoc)| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc)| +|additionalInfo|string|conditional|Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to `OTHER`| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this feature| + +#### Enumerated Values + +|Property|Value| +|---|---| +|featureType|ADDITIONAL_CARDS| +|featureType|BALANCE_TRANSFERS| +|featureType|BILL_PAYMENT| +|featureType|BONUS_REWARDS| +|featureType|CARD_ACCESS| +|featureType|CASHBACK_OFFER| +|featureType|COMPLEMENTARY_PRODUCT_DISCOUNTS| +|featureType|EXTRA_DOWN_PAYMENT| +|featureType|DIGITAL_BANKING| +|featureType|DIGITAL_WALLET| +|featureType|DONATE_INTEREST| +|featureType|EXTRA_REPAYMENTS| +|featureType|FRAUD_PROTECTION| +|featureType|FREE_TXNS| +|featureType|FREE_TXNS_ALLOWANCE| +|featureType|FUNDS_AVAILABLE_AFTER| +|featureType|GUARANTOR| +|featureType|INSTALMENT_PLAN| +|featureType|INSURANCE| +|featureType|INTEREST_FREE| +|featureType|INTEREST_FREE_TRANSFERS| +|featureType|LOYALTY_PROGRAM| +|featureType|MAX_BALANCE| +|featureType|MAX_LIMIT| +|featureType|MAX_TXNS| +|featureType|MIN_BALANCE| +|featureType|MIN_LIMIT| +|featureType|NOTIFICATIONS| +|featureType|NPP_ENABLED| +|featureType|NPP_PAYID| +|featureType|OFFSET| +|featureType|OTHER| +|featureType|OVERDRAFT| +|featureType|REDRAW| +|featureType|RELATIONSHIP_MANAGEMENT| +|featureType|UNLIMITED_TXNS| + +

BankingProductConstraintV2

+ + + +```json +{ + "constraintType": "MAX_BALANCE", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|constraintType|[Enum](#common-field-types)|mandatory|The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc)| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [constraintType](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc)| +|additionalInfo|string|conditional|Display text providing more information on the constraint. Mandatory if the [constraint type](#tocSproductconstrainttypedoc) is set to `OTHER`| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on the constraint| + +#### Enumerated Values + +|Property|Value| +|---|---| +|constraintType|MAX_BALANCE| +|constraintType|MAX_LIMIT| +|constraintType|MIN_BALANCE| +|constraintType|MIN_LIMIT| +|constraintType|OPENING_BALANCE| +|constraintType|OTHER| + +

BankingProductEligibility

+ + + +```json +{ + "eligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|eligibilityType|[Enum](#common-field-types)|mandatory|The type of eligibility criteria described. For further details, refer to [Product Eligibility Types](#tocSproducteligibilitytypedoc)| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [eligibilityType](#tocSproducteligibilitytypedoc) specified. Whether mandatory or not is dependent on the value of [eligibilityType](#tocSproducteligibilitytypedoc)| +|additionalInfo|string|conditional|Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) criteria. Mandatory if the field is set to `OTHER`| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this eligibility criteria| + +#### Enumerated Values + +|Property|Value| +|---|---| +|eligibilityType|BUSINESS| +|eligibilityType|EMPLOYMENT_STATUS| +|eligibilityType|MAX_AGE| +|eligibilityType|MIN_AGE| +|eligibilityType|MIN_INCOME| +|eligibilityType|MIN_TURNOVER| +|eligibilityType|NATURAL_PERSON| +|eligibilityType|OTHER| +|eligibilityType|PENSION_RECIPIENT| +|eligibilityType|RESIDENCY_STATUS| +|eligibilityType|STAFF| +|eligibilityType|STUDENT| + +

BankingProductFeeV2

+ + + +```json +{ + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|name|string|mandatory|Name of the fee| +|feeCategory|[Enum](#common-field-types)|mandatory|The category of fee, used to group `feeType` values. For further details, refer to [Product Fee Categories](#tocSproductfeecategorydoc).| +|feeType|[Enum](#common-field-types)|mandatory|The type of fee. For further details, refer to [Product Fee Types](#tocSproductfeetypedoc).| +|feeMethodUType|[Enum](#common-field-types)|mandatory|The fee charge method| +|fixedAmount|[BankingFeeAmount](#schemacdr-banking-apibankingfeeamount)|conditional|Present if `feeMethodUType` is set to `fixedAmount`. Where the fee is a specific amount| +|rateBased|[BankingFeeRate](#schemacdr-banking-apibankingfeerate)|conditional|Present if `feeMethodUType` is set to `rateBased`. Where the fee is based on a type of rate| +|variable|[BankingFeeRange](#schemacdr-banking-apibankingfeerange)|conditional|Present if `feeMethodUType` is set to `variable`. Where the amount or rate may not be known until the fee is incurred| +|feeCap|[AmountString](#common-field-types)|optional|The cap amount if multiple occurrences of the fee are capped to a limit| +|feeCapPeriod|[ExternalRef](#common-field-types)|optional|Specifies a duration over which multiple occurrences of the fee will be capped. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|currency|[CurrencyString](#common-field-types)|optional|The currency the fee will be charged in. Assumes `AUD` if absent| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [feeType](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [feeType](#tocSproductfeetypedoc)| +|additionalInfo|string|conditional|Display text providing more information on the fee| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this fee| +|discounts|[[BankingProductDiscount](#schemacdr-banking-apibankingproductdiscount)]|optional|An optional list of discounts to this fee that may be available| + +#### Enumerated Values + +|Property|Value| +|---|---| +|feeCategory|APPLICATION| +|feeCategory|ATM| +|feeCategory|BRANCH| +|feeCategory|BUY_NOW_PAY_LATER| +|feeCategory|CARD| +|feeCategory|CHEQUE| +|feeCategory|CLOSURE| +|feeCategory|CORRESPONDENCE| +|feeCategory|FOREIGN_EXCHANGE| +|feeCategory|OTHER| +|feeCategory|POS| +|feeCategory|SERVICE| +|feeCategory|TELEGRAPHIC_TRANSFER| +|feeCategory|TELEPHONE_BANKING| +|feeCategory|TERMS_CONDITIONS| +|feeCategory|THIRD_PARTY| +|feeCategory|TRANSACTION| +|feeType|CASH_ADVANCE| +|feeType|DEPOSIT| +|feeType|DISHONOUR| +|feeType|ENQUIRY| +|feeType|EVENT| +|feeType|EXIT| +|feeType|OTHER| +|feeType|PAYMENT| +|feeType|PAYMENT_LATE| +|feeType|PERIODIC| +|feeType|PURCHASE| +|feeType|REPLACEMENT| +|feeType|TRANSACTION| +|feeType|UPFRONT| +|feeType|UPFRONT_PER_PLAN| +|feeType|VARIATION| +|feeType|WITHDRAWAL| +|feeMethodUType|fixedAmount| +|feeMethodUType|rateBased| +|feeMethodUType|variable| + +

BankingFeeAmount

+ + + +```json +{ + "amount": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|amount|[AmountString](#common-field-types)|mandatory|The specific amount charged for the fee each time it is incurred| + +

BankingFeeRate

+ + + +```json +{ + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|balanceRate|[RateString](#common-field-types)|conditional|A fee rate calculated based on a proportion of the balance. One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory| +|transactionRate|[RateString](#common-field-types)|conditional|A fee rate calculated based on a proportion of a transaction. One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory| +|accruedRate|[RateString](#common-field-types)|conditional|A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of `balanceRate`, `transactionRate` and `accruedRate` is mandatory| +|accrualFrequency|[ExternalRef](#common-field-types)|optional|The indicative frequency with which the fee is calculated on the account. Only applies if `balanceRate` or `accruedRate` is also present. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|amountRange|[BankingFeeRange](#schemacdr-banking-apibankingfeerange)|optional|A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred| + +

BankingFeeRange

+ + + +```json +{ + "feeMinimum": "string", + "feeMaximum": "string" +} + +``` + +*A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|feeMinimum|[AmountString](#common-field-types)|optional|The minimum fee that will be charged per occurrence| +|feeMaximum|[AmountString](#common-field-types)|optional|The maximum fee that will be charged per occurrence| + +

BankingProductDiscount

+ + + +```json +{ + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|description|string|mandatory|Description of the discount| +|discountType|[Enum](#common-field-types)|mandatory|The type of discount. For further details, refer to [Product Discount Types](#tocSproductdiscounttypedoc)| +|amount|[AmountString](#common-field-types)|conditional|Dollar value of the discount. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory.| +|balanceRate|[RateString](#common-field-types)|conditional|A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, assumes the application and calculation frequency are the same as the corresponding fee| +|transactionRate|[RateString](#common-field-types)|conditional|A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory.| +|accruedRate|[RateString](#common-field-types)|conditional|A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, assumes the application and calculation frequency are the same as the corresponding fee| +|feeRate|[RateString](#common-field-types)|conditional|A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of `amount`, `balanceRate`, `transactionRate`, `accruedRate` and `feeRate` is mandatory. Unless noted in `additionalInfo`, assumes the application and calculation frequency are the same as the corresponding fee| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [discountType](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [discountType](#tocSproductdiscounttypedoc)| +|additionalInfo|string|optional|Display text providing more information on the discount| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this discount| +|eligibility|[[BankingProductDiscountEligibility](#schemacdr-banking-apibankingproductdiscounteligibility)]|conditional|Eligibility constraints that apply to this discount. Mandatory if `discountType` is `ELIGIBILITY_ONLY`.| + +#### Enumerated Values + +|Property|Value| +|---|---| +|discountType|BALANCE| +|discountType|DEPOSITS| +|discountType|ELIGIBILITY_ONLY| +|discountType|FEE_CAP| +|discountType|PAYMENTS| + +

BankingProductDiscountEligibility

+ + + +```json +{ + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|discountEligibilityType|[Enum](#common-field-types)|mandatory|The type of the specific eligibility constraint for a discount. For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc)| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)| +|additionalInfo|string|conditional|Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this eligibility constraint| + +#### Enumerated Values + +|Property|Value| +|---|---| +|discountEligibilityType|BUSINESS| +|discountEligibilityType|EMPLOYMENT_STATUS| +|discountEligibilityType|INTRODUCTORY| +|discountEligibilityType|MAX_AGE| +|discountEligibilityType|MIN_AGE| +|discountEligibilityType|MIN_INCOME| +|discountEligibilityType|MIN_TURNOVER| +|discountEligibilityType|NATURAL_PERSON| +|discountEligibilityType|OTHER| +|discountEligibilityType|PENSION_RECIPIENT| +|discountEligibilityType|RESIDENCY_STATUS| +|discountEligibilityType|STAFF| +|discountEligibilityType|STUDENT| + +

BankingProductDepositRateV2

+ + + +```json +{ + "depositRateType": "VARIABLE", + "rate": "string", + "adjustmentToBase": "FIXED", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|depositRateType|[Enum](#common-field-types)|mandatory|The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc). For further details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc)| +|rate|[RateString](#common-field-types)|mandatory|The rate to be applied| +|adjustmentToBase|[Enum](#common-field-types)|optional|For an adjustment `depositRateType`, the base rate that the adjustment value will apply to. The value of the `additionalValue` field may be used to further qualify the corresponding base.| +|adjustmentBundle|string|optional|The name of the bundle that makes the adjustment rate applicable| +|calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|applicationType|[Enum](#common-field-types)|optional|The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`| +|applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|tiers|[[BankingProductRateTierV4](#schemacdr-banking-apibankingproductratetierv4)]|optional|Rate tiers applicable for this rate| +|applicabilityConditions|[[BankingProductRateConditionV2](#schemacdr-banking-apibankingproductrateconditionv2)]|optional|Array of applicability conditions for a rate| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc)| +|additionalInfo|string|optional|Display text providing more information on the rate| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate| + +#### Enumerated Values + +|Property|Value| +|---|---| +|depositRateType|BONUS| +|depositRateType|FIXED| +|depositRateType|FLOATING| +|depositRateType|MARKET_LINKED| +|depositRateType|VARIABLE| +|adjustmentToBase|FIXED| +|adjustmentToBase|FLOATING| +|adjustmentToBase|MARKET_LINKED| +|adjustmentToBase|VARIABLE| +|applicationType|MATURITY| +|applicationType|PERIODIC| +|applicationType|UPFRONT| + +

BankingProductLendingRateV3

+ + + +```json +{ + "lendingRateType": "DISCOUNT", + "rate": "string", + "referenceRate": "string", + "comparisonRate": "string", + "revertRate": "string", + "revertProductId": "string", + "adjustmentToBase": "BALANCE_TRANSFER", + "adjustmentBundle": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentType": "INTEREST_ONLY", + "loanPurpose": "INVESTMENT", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|lendingRateType|[Enum](#common-field-types)|mandatory|The type of rate (fixed, variable, etc). For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc)| +|rate|[RateString](#common-field-types)|conditional|The rate to be applied. Mandatory unless the `lendingRateType` `FEE` is supplied| +|referenceRate|[RateString](#common-field-types)|optional|The reference or index rate for this account option, or variant| +|comparisonRate|[RateString](#common-field-types)|optional|A comparison rate equivalent for this rate. The comparison rate associated with an 'adjustment' [lendingRateType](#tocSproductlendingratetypedoc) is the full comparison rate assuming the adjusted rate is available for origination.| +|revertRate|[RateString](#common-field-types)|optional|The revert rate applicable after the respective rate expires. For example, `FIXED`, or `INTEREST_ONLY` rates may revert to a different rate when those terms expire. Expected where this product will continue to operate with a new 'revert' rate.| +|revertProductId|string|optional|A reference to a `productId` that the associated product will revert to after the respective rate terms expire. For example, `FIXED`, or `INTEREST_ONLY` rates may revert to a different rate when those terms expire. Expected if the product will change when the rate reverts to different terms.| +|adjustmentToBase|[Enum](#common-field-types)|optional|For an adjustment `lendingRateType`, the base rate that the adjustment value will apply to. The values of the `repaymentType`, `loanPurpose` and `additionalValue` fields may be used to further qualify the corresponding base.| +|adjustmentBundle|string|optional|The name of the bundle that makes the adjustment rate applicable| +|calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|applicationType|[Enum](#common-field-types)|optional|The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`| +|applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|interestPaymentDue|[Enum](#common-field-types)|optional|When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered| +|repaymentType|[Enum](#common-field-types)|optional|Options in place for repayments. If absent, the lending rate is applicable to all repayment types| +|loanPurpose|[Enum](#common-field-types)|optional|The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes| +|tiers|[[BankingProductRateTierV4](#schemacdr-banking-apibankingproductratetierv4)]|optional|Rate tiers applicable for this rate| +|applicabilityConditions|[[BankingProductRateConditionV2](#schemacdr-banking-apibankingproductrateconditionv2)]|optional|Array of applicability conditions for a rate| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc)| +|additionalInfo|string|optional|Display text providing more information on the rate| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate| + +#### Enumerated Values + +|Property|Value| +|---|---| +|lendingRateType|BALANCE_TRANSFER| +|lendingRateType|CASH_ADVANCE| +|lendingRateType|DISCOUNT| +|lendingRateType|FEE| +|lendingRateType|FIXED| +|lendingRateType|FLOATING| +|lendingRateType|MARKET_LINKED| +|lendingRateType|PENALTY| +|lendingRateType|PURCHASE| +|lendingRateType|VARIABLE| +|adjustmentToBase|BALANCE_TRANSFER| +|adjustmentToBase|CASH_ADVANCE| +|adjustmentToBase|FEE| +|adjustmentToBase|FIXED| +|adjustmentToBase|FLOATING| +|adjustmentToBase|MARKET_LINKED| +|adjustmentToBase|PURCHASE| +|adjustmentToBase|VARIABLE| +|applicationType|MATURITY| +|applicationType|PERIODIC| +|applicationType|UPFRONT| +|interestPaymentDue|IN_ADVANCE| +|interestPaymentDue|IN_ARREARS| +|repaymentType|INTEREST_ONLY| +|repaymentType|PRINCIPAL_AND_FEE| +|repaymentType|PRINCIPAL_AND_INTEREST| +|loanPurpose|INVESTMENT| +|loanPurpose|OWNER_OCCUPIED| + +

BankingProductRateTierV4

+ + + +```json +{ + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +*Defines the criteria and conditions for which a rate applies* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|name|string|mandatory|A display name for the tier| +|unitOfMeasure|[Enum](#common-field-types)|mandatory|The unit of measure that applies to the `minimumValue` and `maximumValue` values, e.g.:
  • `DOLLAR` for a dollar amount (with values in AmountString format)
  • `PERCENT` for Loan-to-Value Ratio or LVR (with values in RateString format)
  • `MONTH` or `DAY` for a period representing a discrete number of months or days for a fixed-term deposit or loan (with values as a string containing a positive integer)
| +|minimumValue|string|mandatory|The number of `unitOfMeasure` units that form the lower bound of the tier. The tier should be inclusive of this value| +|maximumValue|string|optional|The number of `unitOfMeasure` units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as `minimumValue`. Where this is the same as the `minimumValue` value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.| +|rateApplicationMethod|[Enum](#common-field-types)|optional|The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')| +|applicabilityConditions|[[BankingProductRateConditionV2](#schemacdr-banking-apibankingproductrateconditionv2)]|optional|Array of applicability conditions for a tier| +|additionalInfo|string|optional|Display text providing more information on the rate tier| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate tier| + +#### Enumerated Values + +|Property|Value| +|---|---| +|unitOfMeasure|DAY| +|unitOfMeasure|DOLLAR| +|unitOfMeasure|MONTH| +|unitOfMeasure|PERCENT| +|rateApplicationMethod|PER_TIER| +|rateApplicationMethod|WHOLE_BALANCE| + +

BankingProductRateConditionV2

+ + + +```json +{ + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +*Defines a condition for the applicability of a tiered rate* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|rateApplicabilityType|[Enum](#common-field-types)|optional|Category of applicability condition associated with the rate. For more information refer to [Rate and Tier Applicability Types](#tocSbankingproductrateconditiondoc)| +|additionalValue|string|conditional|Generic field containing additional information relevant to the `rateApplicabilityType` specified. Whether mandatory or not is dependent on the value of [rateApplicabilityType](#tocSbankingproductrateconditiondoc)| +|additionalInfo|string|conditional|Display text providing more information on the condition| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this condition| + +#### Enumerated Values + +|Property|Value| +|---|---| +|rateApplicabilityType|DEPOSITS_MIN| +|rateApplicabilityType|DEPOSITS_MIN_AMOUNT| +|rateApplicabilityType|DEPOSIT_BALANCE_INCREASED| +|rateApplicabilityType|EXISTING_CUST| +|rateApplicabilityType|NEW_ACCOUNTS| +|rateApplicabilityType|NEW_CUSTOMER| +|rateApplicabilityType|NEW_CUSTOMER_TO_GROUP| +|rateApplicabilityType|ONLINE_ONLY| +|rateApplicabilityType|OTHER| +|rateApplicabilityType|PURCHASES_MIN| +|rateApplicabilityType|WITHDRAWALS_MAX| +|rateApplicabilityType|WITHDRAWALS_MAX_AMOUNT| + +

BankingProductInstalments

+ + + +```json +{ + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4 +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|maximumPlanCount|[PositiveInteger](#common-field-types)|mandatory|Total number of plans that may be created| +|instalmentsLimit|[AmountString](#common-field-types)|mandatory|Maximum combined limit of all instalment plans that may be created| +|minimumPlanValue|[AmountString](#common-field-types)|mandatory|Minimum value that can be opened as an instalment plan| +|maximumPlanValue|[AmountString](#common-field-types)|mandatory|Maximum value that can be opened as an instalment plan| +|minimumSplit|[PositiveInteger](#common-field-types)|mandatory|Minimum number of instalment payments a plan can be created with| +|maximumSplit|[PositiveInteger](#common-field-types)|mandatory|Maximum number of instalment payments a plan can be created with| + +

ResponseBankingAccountListV3

+ + + +```json +{ + "data": { + "accounts": [ + { + "accountId": "string", + "creationDate": "string", + "displayName": "string", + "nickname": "string", + "openStatus": "CLOSED", + "isOwned": true, + "accountOwnership": "UNKNOWN", + "maskedNumber": "string", + "productCategory": "BUSINESS_LOANS", + "productName": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» accounts|[[BankingAccountV3](#schemacdr-banking-apibankingaccountv3)]|mandatory|The list of accounts returned. If the filter results in an empty set then this array may have no records| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +

BankingAccountV3

+ + + +```json +{ + "accountId": "string", + "creationDate": "string", + "displayName": "string", + "nickname": "string", + "openStatus": "CLOSED", + "isOwned": true, + "accountOwnership": "UNKNOWN", + "maskedNumber": "string", + "productCategory": "BUSINESS_LOANS", + "productName": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|accountId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the account adhering to the standards for ID permanence| +|creationDate|[DateString](#common-field-types)|optional|Date that the account was created (if known)| +|displayName|string|mandatory|The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the [MaskedAccountString](#common-field-types) common type.| +|nickname|string|optional|A customer supplied nick name for the account| +|openStatus|[Enum](#common-field-types)|optional|Open or closed status for the account. If not present then `OPEN` is assumed| +|isOwned|[Boolean](#common-field-types)|optional|Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then `true` is assumed| +|accountOwnership|[Enum](#common-field-types)|mandatory|Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers| +|maskedNumber|[MaskedAccountString](#common-field-types)|mandatory|A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number| +|productCategory|[BankingProductCategoryV2](#schemacdr-banking-apibankingproductcategoryv2)|mandatory|The category to which a product or account belongs. See [here](#product-categories) for more details| +|productName|string|mandatory|The unique identifier of the account as defined by the data holder (akin to model number for the account)| + +#### Enumerated Values + +|Property|Value| +|---|---| +|openStatus|CLOSED| +|openStatus|OPEN| +|accountOwnership|UNKNOWN| +|accountOwnership|ONE_PARTY| +|accountOwnership|TWO_PARTY| +|accountOwnership|MANY_PARTY| +|accountOwnership|OTHER| + +

ResponseBankingAccountByIdV4

+ + + +```json +{ + "data": { + "accountId": "string", + "creationDate": "string", + "displayName": "string", + "nickname": "string", + "openStatus": "CLOSED", + "isOwned": true, + "accountOwnership": "UNKNOWN", + "maskedNumber": "string", + "productCategory": "BUSINESS_LOANS", + "productName": "string", + "bsb": "string", + "accountNumber": "string", + "bundleName": "string", + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + }, + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4, + "plans": [ + { + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] + } + ] + }, + "termDeposit": [ + { + "lodgementDate": "string", + "maturityDate": "string", + "maturityAmount": "string", + "maturityCurrency": "string", + "maturityInstructions": "HOLD_ON_MATURITY", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + } + ], + "creditCard": { + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "cardPlans": [ + { + "nickname": "string", + "planType": "PURCHASE_PLAN", + "atExpiryBalanceTransfersTo": "PURCHASE_PLAN", + "planCreationDate": "string", + "planPeriod": "string", + "planEndDate": "string", + "planReferenceRate": "string", + "planEffectiveRate": "string", + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "interestFreePeriods": [ + { + "from": "string", + "to": "string" + } + ], + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "planFeatures": [ + { + "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE", + "period": "string", + "endDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + }, + "loan": { + "originalStartDate": "string", + "originalLoanAmount": "string", + "originalLoanCurrency": "string", + "loanEndDate": "string", + "nextInstalmentDate": "string", + "minInstalmentAmount": "string", + "minInstalmentCurrency": "string", + "maxRedraw": "string", + "maxRedrawCurrency": "string", + "minRedraw": "string", + "minRedrawCurrency": "string", + "offsetAccountEnabled": true, + "offsetAccountIds": [ + "string" + ], + "lendingRateDetail": [ + { + "loanPurpose": "OWNER_OCCUPIED", + "repaymentType": "PRINCIPAL_AND_INTEREST", + "rateStartDate": "string", + "rateEndDate": "string", + "revertProductId": "string", + "repaymentUType": "fixedRate", + "fixedRate": { + "fixedPeriod": "string", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "variableRate": { + "variableRateType": "FLOATING", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "feeAmount": { + "amount": "string", + "currency": "string", + "repaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + }, + "deposit": { + "lodgementDate": "string", + "nickname": "string", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + }, + "features": [ + { + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "isActivated": true + } + ], + "fees": [ + { + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + } + ], + "addresses": [ + { + "addressUType": "paf", + "simple": { + "mailingName": "string", + "addressLine1": "string", + "addressLine2": "string", + "addressLine3": "string", + "postcode": "string", + "city": "string", + "state": "string", + "country": "AUS" + }, + "paf": { + "dpid": "string", + "thoroughfareNumber1": 0, + "thoroughfareNumber1Suffix": "string", + "thoroughfareNumber2": 0, + "thoroughfareNumber2Suffix": "string", + "flatUnitType": "string", + "flatUnitNumber": "string", + "floorLevelType": "string", + "floorLevelNumber": "string", + "lotNumber": "string", + "buildingName1": "string", + "buildingName2": "string", + "streetName": "string", + "streetType": "string", + "streetSuffix": "string", + "postalDeliveryType": "string", + "postalDeliveryNumber": 0, + "postalDeliveryNumberPrefix": "string", + "postalDeliveryNumberSuffix": "string", + "localityName": "string", + "postcode": "string", + "state": "string" + } + } + ] + }, + "links": { + "self": "string" + }, + "meta": {} +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|[BankingAccountDetailV4](#schemacdr-banking-apibankingaccountdetailv4)|mandatory|none| +|links|[Links](#schemacdr-banking-apilinks)|mandatory|none| +|meta|[Meta](#schemacdr-banking-apimeta)|optional|none| + +

BankingAccountDetailV4

+ + + +```json +{ + "accountId": "string", + "creationDate": "string", + "displayName": "string", + "nickname": "string", + "openStatus": "CLOSED", + "isOwned": true, + "accountOwnership": "UNKNOWN", + "maskedNumber": "string", + "productCategory": "BUSINESS_LOANS", + "productName": "string", + "bsb": "string", + "accountNumber": "string", + "bundleName": "string", + "cardOption": { + "cardScheme": "AMEX", + "cardType": "CHARGE", + "cardImages": [ + { + "title": "string", + "imageUri": "string" + } + ] + }, + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4, + "plans": [ + { + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] + } + ] + }, + "termDeposit": [ + { + "lodgementDate": "string", + "maturityDate": "string", + "maturityAmount": "string", + "maturityCurrency": "string", + "maturityInstructions": "HOLD_ON_MATURITY", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + } + ], + "creditCard": { + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "cardPlans": [ + { + "nickname": "string", + "planType": "PURCHASE_PLAN", + "atExpiryBalanceTransfersTo": "PURCHASE_PLAN", + "planCreationDate": "string", + "planPeriod": "string", + "planEndDate": "string", + "planReferenceRate": "string", + "planEffectiveRate": "string", + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "interestFreePeriods": [ + { + "from": "string", + "to": "string" + } + ], + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "planFeatures": [ + { + "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE", + "period": "string", + "endDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + }, + "loan": { + "originalStartDate": "string", + "originalLoanAmount": "string", + "originalLoanCurrency": "string", + "loanEndDate": "string", + "nextInstalmentDate": "string", + "minInstalmentAmount": "string", + "minInstalmentCurrency": "string", + "maxRedraw": "string", + "maxRedrawCurrency": "string", + "minRedraw": "string", + "minRedrawCurrency": "string", + "offsetAccountEnabled": true, + "offsetAccountIds": [ + "string" + ], + "lendingRateDetail": [ + { + "loanPurpose": "OWNER_OCCUPIED", + "repaymentType": "PRINCIPAL_AND_INTEREST", + "rateStartDate": "string", + "rateEndDate": "string", + "revertProductId": "string", + "repaymentUType": "fixedRate", + "fixedRate": { + "fixedPeriod": "string", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "variableRate": { + "variableRateType": "FLOATING", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "feeAmount": { + "amount": "string", + "currency": "string", + "repaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + }, + "deposit": { + "lodgementDate": "string", + "nickname": "string", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + }, + "features": [ + { + "featureType": "ADDITIONAL_CARDS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "isActivated": true + } + ], + "fees": [ + { + "name": "string", + "feeCategory": "CARD", + "feeType": "CASH_ADVANCE", + "feeMethodUType": "fixedAmount", + "fixedAmount": { + "amount": "string" + }, + "rateBased": { + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "accrualFrequency": "string", + "amountRange": { + "feeMinimum": "string", + "feeMaximum": "string" + } + }, + "variable": { + "feeMinimum": "string", + "feeMaximum": "string" + }, + "feeCap": "string", + "feeCapPeriod": "string", + "currency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "discounts": [ + { + "description": "string", + "discountType": "BALANCE", + "amount": "string", + "balanceRate": "string", + "transactionRate": "string", + "accruedRate": "string", + "feeRate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "eligibility": [ + { + "discountEligibilityType": "BUSINESS", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] + } + ], + "addresses": [ + { + "addressUType": "paf", + "simple": { + "mailingName": "string", + "addressLine1": "string", + "addressLine2": "string", + "addressLine3": "string", + "postcode": "string", + "city": "string", + "state": "string", + "country": "AUS" + }, + "paf": { + "dpid": "string", + "thoroughfareNumber1": 0, + "thoroughfareNumber1Suffix": "string", + "thoroughfareNumber2": 0, + "thoroughfareNumber2Suffix": "string", + "flatUnitType": "string", + "flatUnitNumber": "string", + "floorLevelType": "string", + "floorLevelNumber": "string", + "lotNumber": "string", + "buildingName1": "string", + "buildingName2": "string", + "streetName": "string", + "streetType": "string", + "streetSuffix": "string", + "postalDeliveryType": "string", + "postalDeliveryNumber": 0, + "postalDeliveryNumberPrefix": "string", + "postalDeliveryNumberSuffix": "string", + "localityName": "string", + "postcode": "string", + "state": "string" + } + } + ] +} + +``` + +### Properties + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[BankingAccountV3](#schemacdr-banking-apibankingaccountv3)|mandatory|none| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|object|mandatory|none| +|» bsb|string|optional|The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces| +|» accountNumber|string|optional|The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces| +|» bundleName|string|optional|Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer| +|» cardOption|[BankingProductCardOption](#schemacdr-banking-apibankingproductcardoption)|optional|Information about the type of card available with the account| +|» instalments|[BankingAccountInstalments](#schemacdr-banking-apibankingaccountinstalments)|optional|Details of instalment features on the account| +|» termDeposit|[[BankingTermDepositAccountV2](#schemacdr-banking-apibankingtermdepositaccountv2)]|optional|A structure suited to accounts that have term deposit-like features| +|» creditCard|[BankingCreditCardAccountV2](#schemacdr-banking-apibankingcreditcardaccountv2)|optional|A structure suited to accounts that have credit card-like features| +|» loan|[BankingLoanAccountV3](#schemacdr-banking-apibankingloanaccountv3)|optional|A structure suited to accounts that have loan-like features| +|» deposit|[BankingDepositAccount](#schemacdr-banking-apibankingdepositaccount)|optional|A structure suited to accounts that have deposit-like features without term deposit maturity detail| +|» features|[allOf]|optional|Array of features of the account based on the equivalent structure in Product Reference with the following additional field| + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|»» *anonymous*|[BankingProductFeatureV3](#schemacdr-banking-apibankingproductfeaturev3)|mandatory|Array of features and limitations of the product| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|»» *anonymous*|object|mandatory|none| +|»»» isActivated|[Boolean](#common-field-types)|optional|
  • `true` if the feature has been activated by the customer or is a standard feature of the product.
  • `false` if the feature is not activated but is available for activation.
  • `null` or absent if the activation state is unknown.
(Note this is an additional field appended to the feature object defined in the Product Reference payload.)| + +*continued* + +|Name|Type|Required|Description| +|---|---|---|---| +|» fees|[[BankingProductFeeV2](#schemacdr-banking-apibankingproductfeev2)]|optional|Fees and charges applicable to the account based on the equivalent structure in Product Reference| +|» addresses|[[CommonPhysicalAddress](#schemacdr-banking-apicommonphysicaladdress)]|optional|The addresses for the account to be used for correspondence| + +

BankingAccountInstalments

+ + + +```json +{ + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4, + "plans": [ + { + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] + } + ] +} + +``` + +*Details of instalment features on the account* + +### Properties + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[BankingProductInstalments](#schemacdr-banking-apibankingproductinstalments)|mandatory|none| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|object|mandatory|none| +|» plans|[[BankingInstalmentPlans](#schemacdr-banking-apibankinginstalmentplans)]|optional|Array of instalment plans| + +

BankingInstalmentPlans

+ + + +```json +{ + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|planNickname|string|mandatory|The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels| +|creationDate|[DateString](#common-field-types)|mandatory|The date the plan was created| +|amount|[AmountString](#common-field-types)|mandatory|The total amount of the plan| +|duration|[ExternalRef](#common-field-types)|mandatory|The original expected repayment duration. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|instalmentInterval|[ExternalRef](#common-field-types)|mandatory|The expected repayment interval. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|schedule|[[BankingInstalmentPlanSchedule](#schemacdr-banking-apibankinginstalmentplanschedule)]|mandatory|Array of expected repayment amounts and dates| + +

BankingInstalmentPlanSchedule

+ + + +```json +{ + "amountDue": "string", + "dueDate": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|amountDue|[AmountString](#common-field-types)|mandatory|Amount due with this repayment| +|dueDate|[DateString](#common-field-types)|mandatory|Date this repayment is due| + +

BankingTermDepositAccountV2

+ + + +```json +{ + "lodgementDate": "string", + "maturityDate": "string", + "maturityAmount": "string", + "maturityCurrency": "string", + "maturityInstructions": "HOLD_ON_MATURITY", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|lodgementDate|[DateString](#common-field-types)|mandatory|The lodgement date of the original deposit| +|maturityDate|[DateString](#common-field-types)|mandatory|Maturity date for the term deposit| +|maturityAmount|[AmountString](#common-field-types)|optional|Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated| +|maturityCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|maturityInstructions|[Enum](#common-field-types)|mandatory|Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments| +|depositRateDetail|[BankingDepositRateDetail](#schemacdr-banking-apibankingdepositratedetail)|optional|Detail about deposit rates and adjustments| + +#### Enumerated Values + +|Property|Value| +|---|---| +|maturityInstructions|HOLD_ON_MATURITY| +|maturityInstructions|PAID_OUT_AT_MATURITY| +|maturityInstructions|ROLLED_OVER| + +

BankingDepositRateDetail

+ + + +```json +{ + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] +} + +``` + +*Detail about deposit rates and adjustments* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|depositRateType|[Enum](#common-field-types)|mandatory|The type of rate| +|referenceRate|[RateString](#common-field-types)|mandatory|Reference rate for this account type and terms| +|effectiveRate|[RateString](#common-field-types)|mandatory|Rate being paid for this deposit| +|calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|applicationType|[Enum](#common-field-types)|optional|The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`| +|applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|tiers|[[BankingProductRateTierV4](#schemacdr-banking-apibankingproductratetierv4)]|optional|Rate tiers applicable for this rate| +|applicabilityConditions|[[BankingProductRateConditionV2](#schemacdr-banking-apibankingproductrateconditionv2)]|optional|Array of applicability conditions for a rate| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc)| +|additionalInfo|string|optional|Display text providing more information on the rate| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate| +|adjustments|[[BankingRateAdjustments](#schemacdr-banking-apibankingrateadjustments)]|optional|Adjustments applicable to the rate| + +#### Enumerated Values + +|Property|Value| +|---|---| +|depositRateType|FIXED| +|depositRateType|FLOATING| +|depositRateType|MARKET_LINKED| +|depositRateType|VARIABLE| +|applicationType|MATURITY| +|applicationType|PERIODIC| +|applicationType|UPFRONT| + +

BankingRateAdjustments

+ + + +```json +{ + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +*Information about adjustments to an associated rate* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|adjustmentType|[Enum](#common-field-types)|mandatory|The type of adjustment. For further details, refer to [Deposit Adjustment Rate Types](#tocSproductdepositadjustmentratetypedoc) and [Lending Adjustment Rate Types](#tocSproductlendingadjustmentratetypedoc)| +|amount|[AmountString](#common-field-types)|optional|Adjustment amount if not a rate| +|currency|[CurrencyString](#common-field-types)|optional|Adjustment amount currency. If absent assumes `AUD`| +|rate|[RateString](#common-field-types)|optional|Adjustment to an associated base rate. The impact to the base rate depends on the type of base (deposit or loan) and the `adjustmentType` (bonus, discount or penalty)| +|adjustmentBundle|string|optional|The name of the bundle that makes the adjustment rate applicable| +|adjustmentPeriod|[ExternalRef](#common-field-types)|optional|The original or standard adjustment period after which the adjustment ends. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|adjustmentEndDate|[DateString](#common-field-types)|optional|Date the adjustment will cease to apply| +|additionalValue|string|conditional|Generic field containing additional information relevant to the `adjustmentType` specified. Whether mandatory or not is dependent on the value of `adjustmentType`| +|additionalInfo|string|optional|Display text providing more information on the rate| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate| + +#### Enumerated Values + +|Property|Value| +|---|---| +|adjustmentType|BONUS| +|adjustmentType|DISCOUNT| +|adjustmentType|PENALTY| + +

BankingCreditCardAccountV2

+ + + +```json +{ + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "cardPlans": [ + { + "nickname": "string", + "planType": "PURCHASE_PLAN", + "atExpiryBalanceTransfersTo": "PURCHASE_PLAN", + "planCreationDate": "string", + "planPeriod": "string", + "planEndDate": "string", + "planReferenceRate": "string", + "planEffectiveRate": "string", + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "interestFreePeriods": [ + { + "from": "string", + "to": "string" + } + ], + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "planFeatures": [ + { + "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE", + "period": "string", + "endDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|minPaymentAmount|[AmountString](#common-field-types)|mandatory|The minimum payment amount due for the next card payment| +|paymentDueAmount|[AmountString](#common-field-types)|mandatory|The amount due for the next card payment| +|paymentCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|paymentDueDate|[DateString](#common-field-types)|mandatory|Date that the next payment for the card is due| +|cardPlans|[[BankingCreditCardPlan](#schemacdr-banking-apibankingcreditcardplan)]|mandatory|Card plans sorted in order of repayment allocation. Repayments are allocated to the first entry first.| + +

BankingCreditCardPlan

+ + + +```json +{ + "nickname": "string", + "planType": "PURCHASE_PLAN", + "atExpiryBalanceTransfersTo": "PURCHASE_PLAN", + "planCreationDate": "string", + "planPeriod": "string", + "planEndDate": "string", + "planReferenceRate": "string", + "planEffectiveRate": "string", + "minPaymentAmount": "string", + "paymentDueAmount": "string", + "paymentCurrency": "string", + "paymentDueDate": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "interestFreePeriods": [ + { + "from": "string", + "to": "string" + } + ], + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "planFeatures": [ + { + "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE", + "period": "string", + "endDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|nickname|string|optional|A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided| +|planType|[BankingCardPlanTypes](#schemacdr-banking-apibankingcardplantypes)|mandatory|The credit card plan type| +|atExpiryBalanceTransfersTo|[BankingCardPlanTypes](#schemacdr-banking-apibankingcardplantypes)|optional|A reference to the plan type that any balance will be transferred to at the expiry of this plan| +|planCreationDate|[DateString](#common-field-types)|optional|Date this plan was created| +|planPeriod|[ExternalRef](#common-field-types)|optional|Original duration for this plan. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|planEndDate|[DateString](#common-field-types)|optional|Date this plan is expected to end| +|planReferenceRate|[RateString](#common-field-types)|mandatory|Reference rate for this plan type| +|planEffectiveRate|[RateString](#common-field-types)|mandatory|Effective rate for this plan| +|minPaymentAmount|[AmountString](#common-field-types)|optional|The minimum payment amount due for this plan| +|paymentDueAmount|[AmountString](#common-field-types)|optional|The amount due for this plan| +|paymentCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|paymentDueDate|[DateString](#common-field-types)|optional|Date that the next payment for this plan is due| +|additionalInfo|string|optional|Display text providing more information on the plan| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this plan| +|interestFreePeriods|[object]|optional|Defines when any current or future interest-free periods will be applicable to this plan. The interest-free period itself will be specified through an associated `INTEREST_FREE` plan feature.| +|» from|[DateString](#common-field-types)|optional|The date any associated interest-free period will be available for the plan| +|» to|[DateString](#common-field-types)|mandatory|The date any associated interest-free period will no longer be available| +|adjustments|[[BankingRateAdjustments](#schemacdr-banking-apibankingrateadjustments)]|optional|Adjustments applicable to the plan rate| +|planFeatures|[[BankingCardPlanFeatures](#schemacdr-banking-apibankingcardplanfeatures)]|optional|Array of features available or applicable to this plan| + +

BankingCardPlanTypes

+ + + +```json +"PURCHASE_PLAN" + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[Enum](#common-field-types)|mandatory|none| + +#### Enumerated Values + +|Property|Value| +|---|---| +|*anonymous*|BALANCE_TRANSFER_PLAN| +|*anonymous*|CASH_ADVANCE_PLAN| +|*anonymous*|INSTALMENT_PLAN| +|*anonymous*|PURCHASE_PLAN| + +

BankingCardPlanFeatures

+ + + +```json +{ + "planFeatureType": "BALANCE_TRANSFER_ENDS_INTEREST_FREE", + "period": "string", + "endDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +*Features and limitations available or applicable to the associated plan* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|planFeatureType|[Enum](#common-field-types)|mandatory|Type of feature or limitation. For details refer to [Plan Feature Types](#tocSbankingproductplanfeaturedoc).| +|period|[ExternalRef](#common-field-types)|optional|Original duration of the feature or limitation. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|endDate|[DateString](#common-field-types)|optional|Date that the feature or limitation will cease to apply| +|additionalValue|string|conditional|Detail associated with the planFeatureType. For details refer to [Plan Feature Types](#tocSbankingproductplanfeaturedoc).| +|additionalInfo|string|optional|Display text providing more information on the plan feature| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this plan feature| + +#### Enumerated Values + +|Property|Value| +|---|---| +|planFeatureType|BALANCE_TRANSFER_ENDS_INTEREST_FREE| +|planFeatureType|INSTALMENTS| +|planFeatureType|INTEREST_FREE| + +

BankingDepositAccount

+ + + +```json +{ + "lodgementDate": "string", + "nickname": "string", + "depositRateDetail": { + "depositRateType": "FIXED", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "tiers": [ + { + "name": "string", + "unitOfMeasure": "DAY", + "minimumValue": "string", + "maximumValue": "string", + "rateApplicationMethod": "PER_TIER", + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "applicabilityConditions": [ + { + "rateApplicabilityType": "NEW_CUSTOMER", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ], + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string", + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|lodgementDate|[DateString](#common-field-types)|optional|The lodgement date of the deposit| +|nickname|[DateString](#common-field-types)|optional|A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided| +|depositRateDetail|[BankingDepositRateDetail](#schemacdr-banking-apibankingdepositratedetail)|optional|Detail about deposit rates and adjustments| + +

BankingLoanAccountV3

+ + + +```json +{ + "originalStartDate": "string", + "originalLoanAmount": "string", + "originalLoanCurrency": "string", + "loanEndDate": "string", + "nextInstalmentDate": "string", + "minInstalmentAmount": "string", + "minInstalmentCurrency": "string", + "maxRedraw": "string", + "maxRedrawCurrency": "string", + "minRedraw": "string", + "minRedrawCurrency": "string", + "offsetAccountEnabled": true, + "offsetAccountIds": [ + "string" + ], + "lendingRateDetail": [ + { + "loanPurpose": "OWNER_OCCUPIED", + "repaymentType": "PRINCIPAL_AND_INTEREST", + "rateStartDate": "string", + "rateEndDate": "string", + "revertProductId": "string", + "repaymentUType": "fixedRate", + "fixedRate": { + "fixedPeriod": "string", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "variableRate": { + "variableRateType": "FLOATING", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "feeAmount": { + "amount": "string", + "currency": "string", + "repaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|originalStartDate|[DateString](#common-field-types)|optional|Optional original start date for the loan| +|originalLoanAmount|[AmountString](#common-field-types)|optional|Optional original loan value| +|originalLoanCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|loanEndDate|[DateString](#common-field-types)|optional|Date that the loan is due to be repaid in full| +|nextInstalmentDate|[DateString](#common-field-types)|optional|Next date that an instalment is required| +|minInstalmentAmount|[AmountString](#common-field-types)|optional|Minimum amount of next instalment| +|minInstalmentCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|maxRedraw|[AmountString](#common-field-types)|optional|Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account| +|maxRedrawCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|minRedraw|[AmountString](#common-field-types)|optional|Minimum redraw amount| +|minRedrawCurrency|[CurrencyString](#common-field-types)|optional|If absent assumes `AUD`| +|offsetAccountEnabled|[Boolean](#common-field-types)|optional|Set to `true` if one or more offset accounts are configured for this loan account| +|offsetAccountIds|[string]|optional|The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that `offsetAccountEnabled` is set to `true` but the `offsetAccountIds` field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation| +|lendingRateDetail|[[BankingLendingRateDetail](#schemacdr-banking-apibankinglendingratedetail)]|optional|Information about lending rates and adjustments| + +

BankingLendingRateDetail

+ + + +```json +{ + "loanPurpose": "OWNER_OCCUPIED", + "repaymentType": "PRINCIPAL_AND_INTEREST", + "rateStartDate": "string", + "rateEndDate": "string", + "revertProductId": "string", + "repaymentUType": "fixedRate", + "fixedRate": { + "fixedPeriod": "string", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "variableRate": { + "variableRateType": "FLOATING", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "feeAmount": { + "amount": "string", + "currency": "string", + "repaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + }, + "adjustments": [ + { + "adjustmentType": "BONUS", + "amount": "string", + "currency": "string", + "rate": "string", + "adjustmentBundle": "string", + "adjustmentPeriod": "string", + "adjustmentEndDate": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" + } + ] +} + +``` + +*Information about lending rates and adjustments. Future-dated rates allow scheduled rate changes such as 'revert' rates to be specified.* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|loanPurpose|[Enum](#common-field-types)|optional|The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes| +|repaymentType|[Enum](#common-field-types)|optional|Options in place for repayments. If absent defaults to `PRINCIPAL_AND_INTEREST`| +|rateStartDate|[DateString](#common-field-types)|optional|Date this rate will begin to apply. If not specified, the rate is currently applicable to the account.| +|rateEndDate|[DateString](#common-field-types)|optional|Date this rate will cease to apply. If not specified, the rate on the account is not scheduled to change or 'revert' to a different rate setting.| +|revertProductId|string|optional|The `productId` of the product that this account will revert to at the specified `rateEndDate`| +|repaymentUType|[Enum](#common-field-types)|mandatory|The type of structure to present account specific fields| +|fixedRate|[BankingLendingRateFixed](#schemacdr-banking-apibankinglendingratefixed)|optional|none| +|variableRate|[BankingLendingRateVariable](#schemacdr-banking-apibankinglendingratevariable)|optional|none| +|feeAmount|[BankingLendingFee](#schemacdr-banking-apibankinglendingfee)|optional|none| +|adjustments|[[BankingRateAdjustments](#schemacdr-banking-apibankingrateadjustments)]|optional|Adjustments applicable to the rate or fee| + +#### Enumerated Values + +|Property|Value| +|---|---| +|loanPurpose|INVESTMENT| +|loanPurpose|OWNER_OCCUPIED| +|repaymentType|INTEREST_ONLY| +|repaymentType|PRINCIPAL_AND_FEE| +|repaymentType|PRINCIPAL_AND_INTEREST| +|repaymentUType|fixedRate| +|repaymentUType|variableRate| +|repaymentUType|feeAmount| + +

BankingLendingRateFixed

+ + + +```json +{ + "fixedPeriod": "string", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|fixedPeriod|[ExternalRef](#common-field-types)|optional|The period of time for the fixed rate. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|referenceRate|[RateString](#common-field-types)|mandatory|Reference rate for this account type and terms| +|effectiveRate|[RateString](#common-field-types)|mandatory|The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call| +|calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|applicationType|[Enum](#common-field-types)|optional|The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`| +|applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|interestPaymentDue|[Enum](#common-field-types)|optional|When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered| +|repaymentFrequency|[ExternalRef](#common-field-types)|optional|The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|additionalInfo|string|optional|Display text providing more information on the rate| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate| + +#### Enumerated Values + +|Property|Value| +|---|---| +|applicationType|MATURITY| +|applicationType|PERIODIC| +|applicationType|UPFRONT| +|interestPaymentDue|IN_ADVANCE| +|interestPaymentDue|IN_ARREARS| + +

BankingLendingRateVariable

+ + + +```json +{ + "variableRateType": "FLOATING", + "referenceRate": "string", + "effectiveRate": "string", + "calculationFrequency": "string", + "applicationType": "PERIODIC", + "applicationFrequency": "string", + "interestPaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalValue": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|variableRateType|[Enum](#common-field-types)|mandatory|The type of variable rate| +|referenceRate|[RateString](#common-field-types)|mandatory|Reference rate for this account type and terms| +|effectiveRate|[RateString](#common-field-types)|mandatory|The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call| +|calculationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see `applicationFrequency`). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|applicationType|[Enum](#common-field-types)|optional|The type of approach used to apply the rate to the account. An `applicationFrequency` value is only expected when the approach is `PERIODIC`| +|applicationFrequency|[ExternalRef](#common-field-types)|optional|The period after which the calculated amount(s) (see `calculationFrequency`) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|interestPaymentDue|[Enum](#common-field-types)|optional|When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered| +|repaymentFrequency|[ExternalRef](#common-field-types)|optional|The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|additionalValue|string|conditional|Generic field containing additional information relevant to the [variableRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [variableRateType](#tocSproductlendingratetypedoc)| +|additionalInfo|string|optional|Display text providing more information on the rate| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this rate| + +#### Enumerated Values + +|Property|Value| +|---|---| +|variableRateType|FLOATING| +|variableRateType|MARKET_LINKED| +|variableRateType|VARIABLE| +|applicationType|MATURITY| +|applicationType|PERIODIC| +|applicationType|UPFRONT| +|interestPaymentDue|IN_ADVANCE| +|interestPaymentDue|IN_ARREARS| + +

BankingLendingFee

+ + + +```json +{ + "amount": "string", + "currency": "string", + "repaymentDue": "IN_ADVANCE", + "repaymentFrequency": "string", + "additionalInfo": "string", + "additionalInfoUri": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|amount|[AmountString](#common-field-types)|mandatory|Minimum payment due at specified `repaymentFrequency`| +|currency|[CurrencyString](#common-field-types)|optional|Currency of the fee. `AUD` assumed if not present| +|repaymentDue|[Enum](#common-field-types)|optional|When loan payments are due to be paid within each period| +|repaymentFrequency|[ExternalRef](#common-field-types)|optional|The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)| +|additionalInfo|string|optional|Display text providing more information on the fee| +|additionalInfoUri|[URIString](#common-field-types)|optional|Link to a web page with more information on this fee| + +#### Enumerated Values + +|Property|Value| +|---|---| +|repaymentDue|IN_ADVANCE| +|repaymentDue|IN_ARREARS| + +

ResponseBankingTransactionList

+ + + +```json +{ + "data": { + "transactions": [ + { + "accountId": "string", + "transactionId": "string", + "isDetailAvailable": true, + "type": "DIRECT_DEBIT", + "status": "PENDING", + "description": "string", + "postingDateTime": "string", + "valueDateTime": "string", + "executionDateTime": "string", + "amount": "string", + "currency": "string", + "reference": "string", + "merchantName": "string", + "merchantCategoryCode": "string", + "billerCode": "string", + "billerName": "string", + "crn": "string", + "apcaNumber": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0, + "isQueryParamUnsupported": false + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» transactions|[[BankingTransaction](#schemacdr-banking-apibankingtransaction)]|mandatory|none| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginatedTransaction](#schemacdr-banking-apimetapaginatedtransaction)|mandatory|none| + +

BankingTransaction

+ + + +```json +{ + "accountId": "string", + "transactionId": "string", + "isDetailAvailable": true, + "type": "DIRECT_DEBIT", + "status": "PENDING", + "description": "string", + "postingDateTime": "string", + "valueDateTime": "string", + "executionDateTime": "string", + "amount": "string", + "currency": "string", + "reference": "string", + "merchantName": "string", + "merchantCategoryCode": "string", + "billerCode": "string", + "billerName": "string", + "crn": "string", + "apcaNumber": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|accountId|[ASCIIString](#common-field-types)|mandatory|ID of the account for which transactions are provided| +|transactionId|[ASCIIString](#common-field-types)|conditional|A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if `isDetailAvailable` is set to true.| +|isDetailAvailable|[Boolean](#common-field-types)|mandatory|`true` if extended information is available using the transaction detail endpoint. `false` if extended data is not available| +|type|[Enum](#common-field-types)|mandatory|The type of the transaction| +|status|[Enum](#common-field-types)|mandatory|Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction| +|description|string|mandatory|The transaction description as applied by the financial institution| +|postingDateTime|[DateTimeString](#common-field-types)|conditional|The time the transaction was posted. This field is Mandatory if the transaction has status `POSTED`. This is the time that appears on a standard statement| +|valueDateTime|[DateTimeString](#common-field-types)|optional|Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry| +|executionDateTime|[DateTimeString](#common-field-types)|optional|The time the transaction was executed by the originating customer, if available| +|amount|[AmountString](#common-field-types)|mandatory|The value of the transaction. Negative values mean money was outgoing from the account| +|currency|[CurrencyString](#common-field-types)|optional|The currency for the transaction amount. `AUD` assumed if not present| +|reference|string|mandatory|The reference for the transaction provided by the originating institution. Empty string if no data provided| +|merchantName|string|optional|Name of the merchant for an outgoing payment to a merchant| +|merchantCategoryCode|string|optional|The merchant category code (or MCC) for an outgoing payment to a merchant| +|billerCode|string|optional|BPAY Biller Code for the transaction (if available)| +|billerName|string|optional|Name of the BPAY biller for the transaction (if available)| +|crn|string|conditional|BPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.| +|apcaNumber|string|optional|6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.| + +#### Enumerated Values + +|Property|Value| +|---|---| +|type|DIRECT_DEBIT| +|type|FEE| +|type|INTEREST_CHARGED| +|type|INTEREST_PAID| +|type|OTHER| +|type|PAYMENT| +|type|TRANSFER_INCOMING| +|type|TRANSFER_OUTGOING| +|status|PENDING| +|status|POSTED| + +

ResponseBankingTransactionById

+ + + +```json +{ + "data": { + "accountId": "string", + "transactionId": "string", + "isDetailAvailable": true, + "type": "DIRECT_DEBIT", + "status": "PENDING", + "description": "string", + "postingDateTime": "string", + "valueDateTime": "string", + "executionDateTime": "string", + "amount": "string", + "currency": "string", + "reference": "string", + "merchantName": "string", + "merchantCategoryCode": "string", + "billerCode": "string", + "billerName": "string", + "crn": "string", + "apcaNumber": "string", + "extendedData": { + "payer": "string", + "payee": "string", + "extensionUType": "x2p101Payload", + "x2p101Payload": { + "extendedDescription": "string", + "endToEndId": "string", + "purposeCode": "string" + }, + "service": "X2P1.01" + } + }, + "links": { + "self": "string" + }, + "meta": {} +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|[BankingTransactionDetail](#schemacdr-banking-apibankingtransactiondetail)|mandatory|none| +|links|[Links](#schemacdr-banking-apilinks)|mandatory|none| +|meta|[Meta](#schemacdr-banking-apimeta)|optional|none| + +

BankingTransactionDetail

+ + + +```json +{ + "accountId": "string", + "transactionId": "string", + "isDetailAvailable": true, + "type": "DIRECT_DEBIT", + "status": "PENDING", + "description": "string", + "postingDateTime": "string", + "valueDateTime": "string", + "executionDateTime": "string", + "amount": "string", + "currency": "string", + "reference": "string", + "merchantName": "string", + "merchantCategoryCode": "string", + "billerCode": "string", + "billerName": "string", + "crn": "string", + "apcaNumber": "string", + "extendedData": { + "payer": "string", + "payee": "string", + "extensionUType": "x2p101Payload", + "x2p101Payload": { + "extendedDescription": "string", + "endToEndId": "string", + "purposeCode": "string" + }, + "service": "X2P1.01" + } +} + +``` + +### Properties + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[BankingTransaction](#schemacdr-banking-apibankingtransaction)|mandatory|none| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|object|mandatory|none| +|» extendedData|object|mandatory|none| +|»» payer|string|conditional|Label of the originating payer. Mandatory for inbound payment| +|»» payee|string|conditional|Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)| +|»» extensionUType|[Enum](#common-field-types)|optional|Optional extended data specific to transactions originated via NPP| +|»» x2p101Payload|object|conditional|none| +|»»» extendedDescription|string|conditional|An extended string description. Required if the extensionUType field is `x2p101Payload`| +|»»» endToEndId|string|optional|An end to end ID for the payment created at initiation| +|»»» purposeCode|string|optional|Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service| +|»» service|[Enum](#common-field-types)|mandatory|Identifier of the applicable overlay service. Valid values are: `X2P1.01`| + +#### Enumerated Values + +|Property|Value| +|---|---| +|extensionUType|x2p101Payload| +|service|X2P1.01| + +

ResponseBankingAccountsBalanceList

+ + + +```json +{ + "data": { + "balances": [ + { + "accountId": "string", + "currentBalance": "string", + "availableBalance": "string", + "creditLimit": "string", + "amortisedLimit": "string", + "currency": "string", + "purses": [ + { + "amount": "string", + "currency": "string" + } + ] + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» balances|[[BankingBalance](#schemacdr-banking-apibankingbalance)]|mandatory|The list of balances returned| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +

ResponseBankingAccountsBalanceById

+ + + +```json +{ + "data": { + "accountId": "string", + "currentBalance": "string", + "availableBalance": "string", + "creditLimit": "string", + "amortisedLimit": "string", + "currency": "string", + "purses": [ + { + "amount": "string", + "currency": "string" + } + ] + }, + "links": { + "self": "string" + }, + "meta": {} +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|[BankingBalance](#schemacdr-banking-apibankingbalance)|mandatory|none| +|links|[Links](#schemacdr-banking-apilinks)|mandatory|none| +|meta|[Meta](#schemacdr-banking-apimeta)|optional|none| + +

BankingBalance

+ + + +```json +{ + "accountId": "string", + "currentBalance": "string", + "availableBalance": "string", + "creditLimit": "string", + "amortisedLimit": "string", + "currency": "string", + "purses": [ + { + "amount": "string", + "currency": "string" + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|accountId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the account adhering to the standards for ID permanence| +|currentBalance|[AmountString](#common-field-types)|mandatory|The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing| +|availableBalance|[AmountString](#common-field-types)|mandatory|Balance representing the amount of funds available for transfer. Assumed to be zero or positive| +|creditLimit|[AmountString](#common-field-types)|optional|Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent| +|amortisedLimit|[AmountString](#common-field-types)|optional|Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent| +|currency|[CurrencyString](#common-field-types)|optional|The currency for the balance amounts. If absent assumed to be `AUD`| +|purses|[[BankingBalancePurse](#schemacdr-banking-apibankingbalancepurse)]|optional|Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards| + +

BankingBalancePurse

+ + + +```json +{ + "amount": "string", + "currency": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|amount|[AmountString](#common-field-types)|mandatory|The balance available for this additional currency purse| +|currency|[CurrencyString](#common-field-types)|optional|The currency for the purse| + +

ResponseBankingPayeeListV2

+ + + +```json +{ + "data": { + "payees": [ + { + "payeeId": "string", + "nickname": "string", + "description": "string", + "type": "BILLER", + "creationDate": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» payees|[[BankingPayeeV2](#schemacdr-banking-apibankingpayeev2)]|mandatory|The list of payees returned| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +

ResponseBankingPayeeByIdV2

+ + + +```json +{ + "data": { + "payeeId": "string", + "nickname": "string", + "description": "string", + "type": "BILLER", + "creationDate": "string", + "payeeUType": "biller", + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "links": { + "self": "string" + }, + "meta": {} +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|[BankingPayeeDetailV2](#schemacdr-banking-apibankingpayeedetailv2)|mandatory|none| +|links|[Links](#schemacdr-banking-apilinks)|mandatory|none| +|meta|[Meta](#schemacdr-banking-apimeta)|optional|none| + +

BankingPayeeV2

+ + + +```json +{ + "payeeId": "string", + "nickname": "string", + "description": "string", + "type": "BILLER", + "creationDate": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|payeeId|[ASCIIString](#common-field-types)|mandatory|ID of the payee adhering to the rules of ID permanence| +|nickname|string|mandatory|The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels| +|description|string|optional|A description of the payee provided by the customer| +|type|[Enum](#common-field-types)|mandatory|The type of payee.
  • `DOMESTIC` means a registered payee for domestic payments including NPP.
  • `INTERNATIONAL` means a registered payee for international payments.
  • `BILLER` means a registered payee for BPAY.
  • `DIGITAL_WALLET` means a registered payee for a bank's digital wallet
| +|creationDate|[DateString](#common-field-types)|optional|The date the payee was created by the customer| + +#### Enumerated Values + +|Property|Value| +|---|---| +|type|BILLER| +|type|DIGITAL_WALLET| +|type|DOMESTIC| +|type|INTERNATIONAL| + +

BankingPayeeDetailV2

+ + + +```json +{ + "payeeId": "string", + "nickname": "string", + "description": "string", + "type": "BILLER", + "creationDate": "string", + "payeeUType": "biller", + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } +} + +``` + +### Properties + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[BankingPayeeV2](#schemacdr-banking-apibankingpayeev2)|mandatory|none| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|object|mandatory|none| +|» payeeUType|[Enum](#common-field-types)|mandatory|Type of object included that describes the payee in detail| +|» biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none| +|» domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none| +|» digitalWallet|[BankingDigitalWalletPayee](#schemacdr-banking-apibankingdigitalwalletpayee)|conditional|none| +|» international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none| + +#### Enumerated Values + +|Property|Value| +|---|---| +|payeeUType|biller| +|payeeUType|digitalWallet| +|payeeUType|domestic| +|payeeUType|international| + +

BankingDomesticPayee

+ + + +```json +{ + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|payeeAccountUType|[Enum](#common-field-types)|mandatory|Type of account object included. Valid values are:
  • `account` A standard Australian account defined by BSB/Account Number.
  • `card` A credit or charge card to pay to (note that PANs are masked).
  • `payId` A PayID recognised by NPP
| +|account|[BankingDomesticPayeeAccount](#schemacdr-banking-apibankingdomesticpayeeaccount)|conditional|none| +|card|[BankingDomesticPayeeCard](#schemacdr-banking-apibankingdomesticpayeecard)|conditional|none| +|payId|[BankingDomesticPayeePayId](#schemacdr-banking-apibankingdomesticpayeepayid)|conditional|none| + +#### Enumerated Values + +|Property|Value| +|---|---| +|payeeAccountUType|account| +|payeeAccountUType|card| +|payeeAccountUType|payId| + +

BankingDomesticPayeeAccount

+ + + +```json +{ + "accountName": "string", + "bsb": "string", + "accountNumber": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|accountName|string|optional|Name of the account to pay to| +|bsb|string|mandatory|BSB of the account to pay to| +|accountNumber|string|mandatory|Number of the account to pay to| + +

BankingDomesticPayeeCard

+ + + +```json +{ + "cardNumber": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|cardNumber|[MaskedPANString](#common-field-types)|mandatory|Name of the account to pay to| + +

BankingDomesticPayeePayId

+ + + +```json +{ + "name": "string", + "identifier": "string", + "type": "ABN" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|name|string|optional|The name assigned to the PayID by the owner of the PayID| +|identifier|string|mandatory|The identifier of the PayID (dependent on type)| +|type|[Enum](#common-field-types)|mandatory|The type of the PayID| + +#### Enumerated Values + +|Property|Value| +|---|---| +|type|ABN| +|type|EMAIL| +|type|ORG_IDENTIFIER| +|type|TELEPHONE| + +

BankingBillerPayee

+ + + +```json +{ + "billerCode": "string", + "crn": "string", + "billerName": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|billerCode|string|mandatory|BPAY Biller Code of the Biller| +|crn|string|conditional|BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.| +|billerName|string|mandatory|Name of the Biller| + +

BankingInternationalPayee

+ + + +```json +{ + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|beneficiaryDetails|object|mandatory|none| +|» name|string|optional|Name of the beneficiary| +|» country|[ExternalRef](#common-field-types)|mandatory|Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code| +|» message|string|optional|Response message for the payment| +|bankDetails|object|mandatory|none| +|» country|[ExternalRef](#common-field-types)|mandatory|Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code| +|» accountNumber|string|mandatory|Account Targeted for payment| +|» bankAddress|object|optional|none| +|»» name|string|mandatory|Name of the recipient Bank| +|»» address|string|mandatory|Address of the recipient Bank| +|» beneficiaryBankBIC|[ExternalRef](#common-field-types)|optional|Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)| +|» fedWireNumber|string|optional|Number for Fedwire payment (Federal Reserve Wire Network)| +|» sortCode|string|optional|Sort code used for account identification in some jurisdictions| +|» chipNumber|string|optional|Number for the Clearing House Interbank Payments System| +|» routingNumber|string|optional|International bank routing number| +|» legalEntityIdentifier|[ExternalRef](#common-field-types)|optional|The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)| + +

BankingDigitalWalletPayee

+ + + +```json +{ + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|name|string|mandatory|The display name of the wallet as given by the customer, else a default value defined by the data holder| +|identifier|string|mandatory|The identifier of the digital wallet (dependent on type)| +|type|[Enum](#common-field-types)|mandatory|The type of the digital wallet identifier| +|provider|[Enum](#common-field-types)|mandatory|The provider of the digital wallet| + +#### Enumerated Values + +|Property|Value| +|---|---| +|type|EMAIL| +|type|CONTACT_NAME| +|type|TELEPHONE| +|provider|PAYPAL_AU| +|provider|OTHER| + +

ResponseBankingDirectDebitAuthorisationList

+ + + +```json +{ + "data": { + "directDebitAuthorisations": [ + { + "accountId": "string", + "authorisedEntity": { + "description": "string", + "financialInstitution": "string", + "abn": "string", + "acn": "string", + "arbn": "string" + }, + "lastDebitDateTime": "string", + "lastDebitAmount": "string" + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» directDebitAuthorisations|[[BankingDirectDebit](#schemacdr-banking-apibankingdirectdebit)]|mandatory|The list of authorisations returned| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +

BankingDirectDebit

+ + + +```json +{ + "accountId": "string", + "authorisedEntity": { + "description": "string", + "financialInstitution": "string", + "abn": "string", + "acn": "string", + "arbn": "string" + }, + "lastDebitDateTime": "string", + "lastDebitAmount": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|accountId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the account adhering to the standards for ID permanence.| +|authorisedEntity|[BankingAuthorisedEntity](#schemacdr-banking-apibankingauthorisedentity)|mandatory|none| +|lastDebitDateTime|[DateTimeString](#common-field-types)|optional|The date and time of the last debit executed under this authorisation| +|lastDebitAmount|[AmountString](#common-field-types)|optional|The amount of the last debit executed under this authorisation| + +

BankingAuthorisedEntity

+ + + +```json +{ + "description": "string", + "financialInstitution": "string", + "abn": "string", + "acn": "string", + "arbn": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|description|string|optional|Description of the authorised entity derived from previously executed direct debits| +|financialInstitution|string|conditional|Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme| +|abn|string|optional|Australian Business Number for the authorised entity| +|acn|string|optional|Australian Company Number for the authorised entity| +|arbn|string|optional|Australian Registered Body Number for the authorised entity| + +

ResponseBankingScheduledPaymentsListV2

+ + + +```json +{ + "data": { + "scheduledPayments": [ + { + "scheduledPaymentId": "string", + "nickname": "string", + "payerReference": "string", + "payeeReference": "string", + "status": "ACTIVE", + "from": { + "accountId": "string" + }, + "paymentSet": [ + { + "to": { + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "isAmountCalculated": true, + "amount": "string", + "currency": "string" + } + ], + "recurrence": { + "nextPaymentDate": "string", + "recurrenceUType": "eventBased", + "onceOff": { + "paymentDate": "string" + }, + "intervalSchedule": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] + }, + "lastWeekDay": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" + }, + "eventBased": { + "description": "string" + } + } + } + ] + }, + "links": { + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" + }, + "meta": { + "totalRecords": 0, + "totalPages": 0 + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|data|object|mandatory|none| +|» scheduledPayments|[[BankingScheduledPaymentV2](#schemacdr-banking-apibankingscheduledpaymentv2)]|mandatory|The list of scheduled payments to return| +|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none| +|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +

BankingScheduledPaymentV2

+ + + +```json +{ + "scheduledPaymentId": "string", + "nickname": "string", + "payerReference": "string", + "payeeReference": "string", + "status": "ACTIVE", + "from": { + "accountId": "string" + }, + "paymentSet": [ + { + "to": { + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "isAmountCalculated": true, + "amount": "string", + "currency": "string" + } + ], + "recurrence": { + "nextPaymentDate": "string", + "recurrenceUType": "eventBased", + "onceOff": { + "paymentDate": "string" + }, + "intervalSchedule": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] + }, + "lastWeekDay": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" + }, + "eventBased": { + "description": "string" + } + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|scheduledPaymentId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the scheduled payment adhering to the standards for ID permanence| +|nickname|string|optional|The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels| +|payerReference|string|mandatory|The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided| +|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided| +|status|[Enum](#common-field-types)|mandatory|Indicates whether the schedule is currently active. The value `SKIP` is equivalent to `ACTIVE` except that the customer has requested the next normal occurrence to be skipped.| +|from|[BankingScheduledPaymentFrom](#schemacdr-banking-apibankingscheduledpaymentfrom)|mandatory|Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object| +|paymentSet|[[BankingScheduledPaymentSetV2](#schemacdr-banking-apibankingscheduledpaymentsetv2)]|mandatory|[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]| +|recurrence|[BankingScheduledPaymentRecurrence](#schemacdr-banking-apibankingscheduledpaymentrecurrence)|mandatory|Object containing the detail of the schedule for the payment| + +#### Enumerated Values + +|Property|Value| +|---|---| +|status|ACTIVE| +|status|INACTIVE| +|status|SKIP| + +

BankingScheduledPaymentSetV2

+ + + +```json +{ + "to": { + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } + }, + "isAmountCalculated": true, + "amount": "string", + "currency": "string" +} + +``` + +*The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|to|[BankingScheduledPaymentToV2](#schemacdr-banking-apibankingscheduledpaymenttov2)|mandatory|Object containing details of the destination of the payment. Used to specify a variety of payment destination types| +|isAmountCalculated|[Boolean](#common-field-types)|optional|Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed| +|amount|[AmountString](#common-field-types)|conditional|The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present| +|currency|[CurrencyString](#common-field-types)|optional|The currency for the payment. `AUD` assumed if not present| + +

BankingScheduledPaymentToV2

+ + + +```json +{ + "toUType": "accountId", + "accountId": "string", + "payeeId": "string", + "nickname": "string", + "payeeReference": "string", + "digitalWallet": { + "name": "string", + "identifier": "string", + "type": "EMAIL", + "provider": "PAYPAL_AU" + }, + "domestic": { + "payeeAccountUType": "account", + "account": { + "accountName": "string", + "bsb": "string", + "accountNumber": "string" + }, + "card": { + "cardNumber": "string" + }, + "payId": { + "name": "string", + "identifier": "string", + "type": "ABN" + } + }, + "biller": { + "billerCode": "string", + "crn": "string", + "billerName": "string" + }, + "international": { + "beneficiaryDetails": { + "name": "string", + "country": "string", + "message": "string" + }, + "bankDetails": { + "country": "string", + "accountNumber": "string", + "bankAddress": { + "name": "string", + "address": "string" + }, + "beneficiaryBankBIC": "string", + "fedWireNumber": "string", + "sortCode": "string", + "chipNumber": "string", + "routingNumber": "string", + "legalEntityIdentifier": "string" + } + } +} + +``` + +*Object containing details of the destination of the payment. Used to specify a variety of payment destination types* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|toUType|[Enum](#common-field-types)|mandatory|The type of object provided that specifies the destination of the funds for the payment.| +|accountId|[ASCIIString](#common-field-types)|conditional|Present if `toUType` is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent| +|payeeId|[ASCIIString](#common-field-types)|conditional|Present if `toUType` is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a `payeeId` should not be provided and the full payee details should be provided instead| +|nickname|string|conditional|The short display name of the payee as provided by the customer unless `toUType` is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels| +|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.| +|digitalWallet|[BankingDigitalWalletPayee](#schemacdr-banking-apibankingdigitalwalletpayee)|conditional|none| +|domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none| +|biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none| +|international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none| + +#### Enumerated Values + +|Property|Value| +|---|---| +|toUType|accountId| +|toUType|biller| +|toUType|digitalWallet| +|toUType|domestic| +|toUType|international| +|toUType|payeeId| + +

BankingScheduledPaymentFrom

+ + + +```json +{ + "accountId": "string" +} + +``` + +*Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|accountId|[ASCIIString](#common-field-types)|mandatory|ID of the account that is the source of funds for the payment| + +

BankingScheduledPaymentRecurrence

+ + + +```json +{ + "nextPaymentDate": "string", + "recurrenceUType": "eventBased", + "onceOff": { + "paymentDate": "string" + }, + "intervalSchedule": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] + }, + "lastWeekDay": { + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" + }, + "eventBased": { + "description": "string" + } +} + +``` + +*Object containing the detail of the schedule for the payment* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|nextPaymentDate|[DateString](#common-field-types)|optional|The date of the next payment under the recurrence schedule| +|recurrenceUType|[Enum](#common-field-types)|mandatory|The type of recurrence used to define the schedule| +|onceOff|[BankingScheduledPaymentRecurrenceOnceOff](#schemacdr-banking-apibankingscheduledpaymentrecurrenceonceoff)|conditional|Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff| +|intervalSchedule|[BankingScheduledPaymentRecurrenceIntervalSchedule](#schemacdr-banking-apibankingscheduledpaymentrecurrenceintervalschedule)|conditional|Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule| +|lastWeekDay|[BankingScheduledPaymentRecurrenceLastWeekday](#schemacdr-banking-apibankingscheduledpaymentrecurrencelastweekday)|conditional|Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay| +|eventBased|[BankingScheduledPaymentRecurrenceEventBased](#schemacdr-banking-apibankingscheduledpaymentrecurrenceeventbased)|conditional|Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased| + +#### Enumerated Values + +|Property|Value| +|---|---| +|recurrenceUType|eventBased| +|recurrenceUType|intervalSchedule| +|recurrenceUType|lastWeekDay| +|recurrenceUType|onceOff| + +

BankingScheduledPaymentRecurrenceOnceOff

+ + + +```json +{ + "paymentDate": "string" +} + +``` + +*Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|paymentDate|[DateString](#common-field-types)|mandatory|The scheduled date for the once off payment| + +

BankingScheduledPaymentRecurrenceIntervalSchedule

+ + + +```json +{ + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "nonBusinessDayTreatment": "AFTER", + "intervals": [ + { + "interval": "string", + "dayInInterval": "string" + } + ] +} + +``` + +*Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely| +|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely| +|nonBusinessDayTreatment|[Enum](#common-field-types)|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored| +|intervals|[[BankingScheduledPaymentInterval](#schemacdr-banking-apibankingscheduledpaymentinterval)]|mandatory|An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry| + +#### Enumerated Values + +|Property|Value| +|---|---| +|nonBusinessDayTreatment|AFTER| +|nonBusinessDayTreatment|BEFORE| +|nonBusinessDayTreatment|ON| +|nonBusinessDayTreatment|ONLY| + +

BankingScheduledPaymentInterval

+ + + +```json +{ + "interval": "string", + "dayInInterval": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|interval|[ExternalRef](#common-field-types)|mandatory|An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate| +|dayInInterval|[ExternalRef](#common-field-types)|optional|Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.| + +

BankingScheduledPaymentRecurrenceLastWeekday

+ + + +```json +{ + "finalPaymentDate": "string", + "paymentsRemaining": 1, + "interval": "string", + "lastWeekDay": "FRI", + "nonBusinessDayTreatment": "AFTER" +} + +``` + +*Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely| +|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely| +|interval|[ExternalRef](#common-field-types)|mandatory|The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate| +|lastWeekDay|[Enum](#common-field-types)|mandatory|The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.| +|nonBusinessDayTreatment|[Enum](#common-field-types)|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored| + +#### Enumerated Values + +|Property|Value| +|---|---| +|lastWeekDay|FRI| +|lastWeekDay|MON| +|lastWeekDay|SAT| +|lastWeekDay|SUN| +|lastWeekDay|THU| +|lastWeekDay|TUE| +|lastWeekDay|WED| +|nonBusinessDayTreatment|AFTER| +|nonBusinessDayTreatment|BEFORE| +|nonBusinessDayTreatment|ON| +|nonBusinessDayTreatment|ONLY| + +

BankingScheduledPaymentRecurrenceEventBased

+ + + +```json +{ + "description": "string" +} + +``` + +*Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|description|string|mandatory|Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer| + +

CommonPhysicalAddress

+ + + +```json +{ + "addressUType": "paf", + "simple": { + "mailingName": "string", + "addressLine1": "string", + "addressLine2": "string", + "addressLine3": "string", + "postcode": "string", + "city": "string", + "state": "string", + "country": "AUS" + }, + "paf": { + "dpid": "string", + "thoroughfareNumber1": 0, + "thoroughfareNumber1Suffix": "string", + "thoroughfareNumber2": 0, + "thoroughfareNumber2Suffix": "string", + "flatUnitType": "string", + "flatUnitNumber": "string", + "floorLevelType": "string", + "floorLevelNumber": "string", + "lotNumber": "string", + "buildingName1": "string", + "buildingName2": "string", + "streetName": "string", + "streetType": "string", + "streetSuffix": "string", + "postalDeliveryType": "string", + "postalDeliveryNumber": 0, + "postalDeliveryNumberPrefix": "string", + "postalDeliveryNumberSuffix": "string", + "localityName": "string", + "postcode": "string", + "state": "string" + } +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|addressUType|[Enum](#common-field-types)|mandatory|The type of address object present| +|simple|[CommonSimpleAddress](#schemacdr-banking-apicommonsimpleaddress)|conditional|none| +|paf|[CommonPAFAddress](#schemacdr-banking-apicommonpafaddress)|conditional|Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)| + +#### Enumerated Values + +|Property|Value| +|---|---| +|addressUType|paf| +|addressUType|simple| + +

CommonSimpleAddress

+ + + +```json +{ + "mailingName": "string", + "addressLine1": "string", + "addressLine2": "string", + "addressLine3": "string", + "postcode": "string", + "city": "string", + "state": "string", + "country": "AUS" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|mailingName|string|optional|Name of the individual or business formatted for inclusion in an address used for physical mail| +|addressLine1|string|mandatory|First line of the standard address object| +|addressLine2|string|optional|Second line of the standard address object| +|addressLine3|string|optional|Third line of the standard address object| +|postcode|string|conditional|Mandatory for Australian addresses| +|city|string|mandatory|Name of the city or locality| +|state|string|mandatory|Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT| +|country|[ExternalRef](#common-field-types)|optional|A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present.| + +

CommonPAFAddress

+ + + +```json +{ + "dpid": "string", + "thoroughfareNumber1": 0, + "thoroughfareNumber1Suffix": "string", + "thoroughfareNumber2": 0, + "thoroughfareNumber2Suffix": "string", + "flatUnitType": "string", + "flatUnitNumber": "string", + "floorLevelType": "string", + "floorLevelNumber": "string", + "lotNumber": "string", + "buildingName1": "string", + "buildingName2": "string", + "streetName": "string", + "streetType": "string", + "streetSuffix": "string", + "postalDeliveryType": "string", + "postalDeliveryNumber": 0, + "postalDeliveryNumberPrefix": "string", + "postalDeliveryNumberSuffix": "string", + "localityName": "string", + "postcode": "string", + "state": "string" +} + +``` + +*Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|dpid|string|optional|Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier| +|thoroughfareNumber1|[PositiveInteger](#common-field-types)|optional|Thoroughfare number for a property (first number in a property ranged address)| +|thoroughfareNumber1Suffix|string|optional|Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated| +|thoroughfareNumber2|[PositiveInteger](#common-field-types)|optional|Second thoroughfare number (only used if the property has a ranged address eg 23-25)| +|thoroughfareNumber2Suffix|string|optional|Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated| +|flatUnitType|string|optional|Type of flat or unit for the address| +|flatUnitNumber|string|optional|Unit number (including suffix, if applicable)| +|floorLevelType|string|optional|Type of floor or level for the address| +|floorLevelNumber|string|optional|Floor or level number (including alpha characters)| +|lotNumber|string|optional|Allotment number for the address| +|buildingName1|string|optional|Building/Property name 1| +|buildingName2|string|optional|Building/Property name 2| +|streetName|string|optional|The name of the street| +|streetType|string|optional|The street type. Valid enumeration defined by Australia Post PAF code file| +|streetSuffix|string|optional|The street type suffix. Valid enumeration defined by Australia Post PAF code file| +|postalDeliveryType|string|optional|Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file| +|postalDeliveryNumber|[PositiveInteger](#common-field-types)|optional|Postal delivery number if the address is a postal delivery type| +|postalDeliveryNumberPrefix|string|optional|Postal delivery number prefix related to the postal delivery number| +|postalDeliveryNumberSuffix|string|optional|Postal delivery number suffix related to the postal delivery number| +|localityName|string|mandatory|Full name of locality| +|postcode|string|mandatory|Postcode for the locality| +|state|string|mandatory|State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT| + + + + + +```json +{ + "self": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|self|[URIString](#common-field-types)|mandatory|Fully qualified link that generated the current response document| + +

Meta

+ + + +```json +{} + +``` + +### Properties + +*None* + +

LinksPaginated

+ + + +```json +{ + "self": "string", + "first": "string", + "prev": "string", + "next": "string", + "last": "string" +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|self|[URIString](#common-field-types)|mandatory|Fully qualified link that generated the current response document| +|first|[URIString](#common-field-types)|conditional|URI to the first page of this set. Mandatory if this response is not the first page| +|prev|[URIString](#common-field-types)|conditional|URI to the previous page of this set. Mandatory if this response is not the first page| +|next|[URIString](#common-field-types)|conditional|URI to the next page of this set. Mandatory if this response is not the last page| +|last|[URIString](#common-field-types)|conditional|URI to the last page of this set. Mandatory if this response is not the last page| + +

MetaPaginated

+ + + +```json +{ + "totalRecords": 0, + "totalPages": 0 +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|totalRecords|[NaturalNumber](#common-field-types)|mandatory|The total number of records in the full set. See [pagination](#pagination).| +|totalPages|[NaturalNumber](#common-field-types)|mandatory|The total number of pages in the full set. See [pagination](#pagination).| + +

MetaPaginatedTransaction

+ + + +```json +{ + "totalRecords": 0, + "totalPages": 0, + "isQueryParamUnsupported": false +} + +``` + +### Properties + +*allOf* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none| + +*and* + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|object|mandatory|none| +|» isQueryParamUnsupported|[Boolean](#common-field-types)|optional|**true** if *"text"* query parameter is not supported| + +

MetaError

+ + + +```json +{ + "urn": "string" +} + +``` + +*Additional data for customised error codes* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|urn|string|conditional|The CDR error code URN which the application-specific error code extends. Mandatory if the error `code` is an application-specific error rather than a standardised error code.| + +

ResponseErrorListV2

+ + + +```json +{ + "errors": [ + { + "code": "string", + "title": "string", + "detail": "string", + "meta": { + "urn": "string" + } + } + ] +} + +``` + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|errors|[object]|mandatory|none| +|» code|string|mandatory|The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.| +|» title|string|mandatory|A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.| +|» detail|string|mandatory|A human-readable explanation specific to this occurrence of the problem.| +|» meta|[MetaError](#schemacdr-banking-apimetaerror)|optional|Additional data for customised error codes| + +

BankingProductCategoryV2

+ + + +```json +"BUSINESS_LOANS" + +``` + +*The category to which a product or account belongs. See [here](#product-categories) for more details* + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|*anonymous*|[Enum](#common-field-types)|mandatory|The category to which a product or account belongs. See [here](#product-categories) for more details| + +#### Enumerated Values + +|Property|Value| +|---|---| +|*anonymous*|BUSINESS_LOANS| +|*anonymous*|BUY_NOW_PAY_LATER| +|*anonymous*|CRED_AND_CHRG_CARDS| +|*anonymous*|LEASES| +|*anonymous*|MARGIN_LOANS| +|*anonymous*|OVERDRAFTS| +|*anonymous*|PERS_LOANS| +|*anonymous*|REGULATED_TRUST_ACCOUNTS| +|*anonymous*|RESIDENTIAL_MORTGAGES| +|*anonymous*|TERM_DEPOSITS| +|*anonymous*|TRADE_FINANCE| +|*anonymous*|TRANS_AND_SAVINGS_ACCOUNTS| +|*anonymous*|TRAVEL_CARDS| + diff --git a/slate/source/includes/cds_banking_non_bank_lending.md b/slate/source/includes/cds_banking_non_bank_lending.md index a5cc09ff..8fafef67 100644 --- a/slate/source/includes/cds_banking_non_bank_lending.md +++ b/slate/source/includes/cds_banking_non_bank_lending.md @@ -51,24 +51,24 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/accounts', Obtain a list of accounts. -Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html) +Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html), [v2](../../../../includes/obsolete/get-accounts-v2.html) ###Endpoint Version | | | |---|--| -|Version|**2** +|Version|**3**

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| -|product-category|query|string|optional|Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.)| -|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.)| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| |is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -135,7 +135,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html) |Status|Meaning|Description|Schema| |---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountListV2](#schemacdr-banking-apiresponsebankingaccountlistv2)| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountListV3](#schemacdr-banking-apiresponsebankingaccountlistv3)| |400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| |406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| |422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| @@ -144,7 +144,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-accounts-v1.html) |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -211,22 +211,24 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/balances', Obtain balances for multiple, filtered accounts +Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-balances-v1.html) + ###Endpoint Version | | | |---|--| -|Version|**1** +|Version|**2**

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| -|product-category|query|string|optional|Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| -|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| |is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -304,7 +306,7 @@ Obtain balances for multiple, filtered accounts |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -404,8 +406,8 @@ Obtain balances for a specified list of accounts |---|---|---|---|---| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -463,7 +465,7 @@ Obtain balances for a specified list of accounts |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -540,8 +542,8 @@ Obtain the balance for a single specified account |Name|In|Type|Required|Description| |---|---|---|---|---| |accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the specific account requested| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -587,7 +589,7 @@ Obtain the balance for a single specified account |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -654,20 +656,20 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}', Obtain detailed information on a single account. -Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html) +Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html), [v2](../../../../includes/obsolete/get-account-detail-v2.html), [v3](../../../../includes/obsolete/get-account-detail-v3.html) ###Endpoint Version | | | |---|--| -|Version|**3** +|Version|**4**

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| |accountId|path|[ASCIIString](#common-field-types)|mandatory|A tokenised identifier for the account which is unique but not shareable| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -693,6 +695,29 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html "bsb": "string", "accountNumber": "string", "bundleName": "string", + "instalments": { + "maximumPlanCount": 1, + "instalmentsLimit": "string", + "minimumPlanValue": "string", + "maximumPlanValue": "string", + "minimumSplit": 4, + "maximumSplit": 4, + "plans": [ + { + "planNickname": "string", + "creationDate": "string", + "amount": "string", + "duration": "string", + "instalmentInterval": "string", + "schedule": [ + { + "amountDue": "string", + "dueDate": "string" + } + ] + } + ] + }, "specificAccountUType": "creditCard", "termDeposit": [ { @@ -883,7 +908,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html |Status|Meaning|Description|Schema| |---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountByIdV3](#schemacdr-banking-apiresponsebankingaccountbyidv3)| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingAccountByIdV4](#schemacdr-banking-apiresponsebankingaccountbyidv4)| |400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| |404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
  • [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
  • [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| |406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| @@ -892,7 +917,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-account-detail-v1.html |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -959,7 +984,7 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/transac Obtain transactions for a specific account. -Some general notes that apply to all end points that retrieve transactions: +Some general notes that apply to all endpoints that retrieve transactions: - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as: @@ -978,7 +1003,7 @@ Some general notes that apply to all end points that retrieve transactions: |Name|In|Type|Required|Description| |---|---|---|---|---| -|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get transactions for. Must have previously been returned by one of the account list end points.| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.| |oldest-time|query|[DateTimeString](#common-field-types)|optional|Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type| |newest-time|query|[DateTimeString](#common-field-types)|optional|Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type| |min-amount|query|[AmountString](#common-field-types)|optional|Filter transactions to only transactions with amounts higher than or equal to this amount| @@ -986,8 +1011,8 @@ Some general notes that apply to all end points that retrieve transactions: |text|query|string|optional|Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -1033,7 +1058,7 @@ Some general notes that apply to all end points that retrieve transactions: "meta": { "totalRecords": 0, "totalPages": 0, - "isQueryParamUnsupported": true + "isQueryParamUnsupported": false } } ``` @@ -1052,7 +1077,7 @@ Some general notes that apply to all end points that retrieve transactions: |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -1129,10 +1154,10 @@ Obtain detailed information on a transaction for a specific account |Name|In|Type|Required|Description| |---|---|---|---|---| -|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get transactions for. Must have previously been returned by one of the account list end points| -|transactionId|path|[ASCIIString](#common-field-types)|mandatory|ID of the transaction obtained from a previous call to one of the other transaction end points| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints| +|transactionId|path|[ASCIIString](#common-field-types)|mandatory|ID of the transaction obtained from a previous call to one of the other transaction endpoints| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -1195,7 +1220,7 @@ Obtain detailed information on a transaction for a specific account |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -1271,11 +1296,11 @@ Obtain direct debit authorisations for a specific account |Name|In|Type|Required|Description| |---|---|---|---|---| -|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points.| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -1331,7 +1356,7 @@ Obtain direct debit authorisations for a specific account |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -1399,22 +1424,24 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/accounts/direct-debits', Obtain direct debit authorisations for multiple, filtered accounts +Obsolete versions: [v1](../../../../includes/obsolete/get-bulk-direct-debits-v1.html) + ###Endpoint Version | | | |---|--| -|Version|**1** +|Version|**2**

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| -|product-category|query|string|optional|Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| -|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| |is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -1490,7 +1517,7 @@ Obtain direct debit authorisations for multiple, filtered accounts |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -1590,8 +1617,8 @@ Obtain direct debit authorisations for a specified list of accounts |---|---|---|---|---| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -1647,7 +1674,7 @@ Obtain direct debit authorisations for a specified list of accounts |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -1725,11 +1752,11 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for |Name|In|Type|Required|Description| |---|---|---|---|---| -|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment| +|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -1873,7 +1900,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -1941,24 +1968,24 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/payments/scheduled', Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments -Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html) +Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](../../../../includes/obsolete/get-scheduled-payments-bulk-v2.html) ###Endpoint Version | | | |---|--| -|Version|**2** +|Version|**3**

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| -|product-category|query|string|optional|Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| -|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed| |is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -2122,7 +2149,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-bul |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -2224,8 +2251,8 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for |---|---|---|---|---| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -2369,7 +2396,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-scheduled-payments-for |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -2450,8 +2477,8 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-payees-v1.html) |type|query|string|optional|Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -2511,7 +2538,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-payees-v1.html) |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -2592,8 +2619,8 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-payee-detail-v1.html) |Name|In|Type|Required|Description| |---|---|---|---|---| |payeeId|path|[ASCIIString](#common-field-types)|mandatory|The ID used to locate the details of a particular payee| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| |x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.| |x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.| @@ -2682,7 +2709,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-payee-detail-v1.html) |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.| |200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| |404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.| @@ -2742,7 +2769,7 @@ fetch('https://data.holder.com.au/cds-au/v1/banking/products', Obtain a list of products that are currently openly offered to the market -Note that the results returned by this end point are expected to be ordered in descending order according to ``lastUpdated``. +Note that the results returned by this endpoint are expected to be ordered in descending order according to `lastUpdated`. ### Conventions In the product reference payloads there are a number of recurring conventions that are explained here, in one place. @@ -2753,9 +2780,9 @@ In the product detail payload there are a number of arrays articulating generic - 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](#productfeaturetypedoc). 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. +- Each element has a field name [additionalValue](#productfeaturetypedoc). 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. +- 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 @@ -2767,34 +2794,34 @@ These URIs do not need to all link to different pages. If desired, they can all #### 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. +For this reason, while `productCategory` is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime. Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process. #### Dates -It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter. +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. -Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html) [v2](../../../../includes/obsolete/get-products-v2.html) +Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html), [v2](../../../../includes/obsolete/get-products-v2.html), [v3](../../../../includes/obsolete/get-products-v3.html) ###Endpoint Version | | | |---|--| -|Version|**3** +|Version|**4**

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| -|effective|query|string|optional|Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'| +|effective|query|string|optional|Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`| |updated-since|query|[DateTimeString](#common-field-types)|optional|Only include products that have been updated after the specified date and time. If absent defaults to include all products| |brand|query|string|optional|Filter results based on a specific brand| -|product-category|query|string|optional|Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| +|product-category|query|string|optional|Used to filter results on the `productCategory` field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.| |page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)| |page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)| -|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)| -|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.| +|x-v|header|string|mandatory|Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers)| +|x-min-v|header|string|optional|Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a `406 Not Acceptable`.| #### Enumerated Values @@ -2901,7 +2928,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html) [v2] |Status|Meaning|Description|Schema| |---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingProductListV2](#schemacdr-banking-apiresponsebankingproductlistv2)| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingProductListV3](#schemacdr-banking-apiresponsebankingproductlistv3)| |400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
  • [400 - Invalid Field](#error-400-field-invalid)
  • [400 - Missing Field](#error-400-field-missing)
  • [400 - Invalid Version](#error-400-header-invalid-version)
  • [400 - Invalid Date](#error-400-field-invalid-date-time)
  • [400 - Invalid Page Size](#error-400-field-invalid-page-size)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| |406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
  • [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| |422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
  • [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)| @@ -2910,7 +2937,7 @@ Obsolete versions: [v1](../../../../includes/obsolete/get-products-v1.html) [v2] |Status|Header|Type|Format|Description| |---|---|---|---|---| -|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.| +|200|x-v|string||The [version](#response-headers) of the API endpoint that the data holder has responded with.|