Skip to content

Commit

Permalink
Release/1.28.0 (#336)
Browse files Browse the repository at this point in the history
* Create clean version of release 1.28.0

* Removed last remaining diffs

* Updates to NBL Draft Standards

To reflect details and feedback from #317, and to support #318.

* Decision Proposal 306 Candidate Standards

Reflects proposed changes to the Banking Standards as a result of consultation and feedback to #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 <[email protected]>
Co-authored-by: Nils Berge <[email protected]>
  • Loading branch information
3 people authored Nov 10, 2023
1 parent 94960d7 commit e50413d
Show file tree
Hide file tree
Showing 154 changed files with 119,705 additions and 2,672 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<h1 id='additional-standards'>Additional Standards</h1>
<h1 id='additional-standards'>Additional Standards</h1><pre class="highlight diff tab-diff"><code>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)
</code></pre>
<p>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.</p>

<p>These standards fall into three categories:</p>
Expand All @@ -13,11 +15,11 @@

<ul>
<li><a href="./includes/additional/candidates/telco.html">Candidate Standards for the Telecommunications sector</a></li>
<li><a href="./includes/additional/candidates/dp306/banking-dp306.html">Candidate Standards for Banking Decision Proposal 306</a></li>
</ul>
<h2 id='draft-standards'>Draft Standards</h2>
<p>The Consumer Data Standards currently include the following Draft Standards:</p>
<pre class="highlight diff tab-diff"><code>Added Draft Standards for non-bank lending
</code></pre>

<ul>
<li><a href="./includes/additional/drafts/non-bank-lending/banking-non-bank-lending.html">Draft Standards for the Banking and Non-Bank Lending sector</a></li>
</ul>
Expand Down
16,704 changes: 16,704 additions & 0 deletions docs/includes/additional/candidates/dp306/banking-dp306.html

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions docs/includes/additional/candidates/dp306/banking-dp306_apis
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<h1 id='banking-apis'>Banking APIs</h1>
<aside class="notice">
This standard is part of the Consumer Data Standards and is classified as a <strong>Candidate Standard</strong><br/>
This means that:
<ul>
<li>The standard <i>is not</i> binding</li>
<li>The standard can only become binding via a formal decision of the Data Standards Chair</li>
<li>The standard is considered stable</li>
<li>Material changes to the standard require a formal decision of the Data Standards Chair</li>
</ul>
</aside>

<p>This specification defines the APIs for Data Holders exposing Banking endpoints.</p>

<table>
<tr><td><a href='../../../../includes/swagger/cds_banking_dp306.json'>Banking OpenAPI Specification (JSON)</a></td></tr>
<tr><td><a href='../../../../includes/swagger/cds_banking_dp306.yaml'>Banking OpenAPI Specification (YAML)</a></td></tr>
</table>
<pre class="highlight diff tab-diff"><code>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.
</code></pre>
49 changes: 24 additions & 25 deletions docs/includes/additional/candidates/telco.html
Original file line number Diff line number Diff line change
Expand Up @@ -593,8 +593,7 @@
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1 id='telco-apis'>Telco APIs</h1><pre class="highlight diff tab-diff"><code>Removed references to 'Other Versions' in 'Get Telco Accounts' and 'Get Telco Account Detail'
</code></pre><aside class="notice">
<h1 id='telco-apis'>Telco APIs</h1><aside class="notice">
This standard is part of the Consumer Data Standards and is classified as a <strong>Candidate Standard</strong><br/>
This means that:
<ul>
Expand Down Expand Up @@ -7374,19 +7373,19 @@ <h3 class="schema-toc" id="tocStelcoproduct">TelcoProduct</h3>
</tr>
<tr>
<td>type</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of product. <a href="https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745">MOBILE</a> service or BROADBAND fixed internet service</td>
</tr>
<tr>
<td>purpose</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>optional</td>
<td>The purpose type of the product. If absent, then the value PERSONAL is assumed</td>
</tr>
<tr>
<td>billingType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of product</td>
</tr>
Expand Down Expand Up @@ -7806,7 +7805,7 @@ <h3 class="schema-toc" id="tocStelcoaccountbase">TelcoAccountBase</h3>
</tr>
<tr>
<td>openStatus</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>optional</td>
<td>Open or closed status for the account. If not present then OPEN is assumed</td>
</tr>
Expand Down Expand Up @@ -8035,7 +8034,7 @@ <h3 class="schema-toc" id="tocStelcopaymentschedule">TelcoPaymentSchedule</h3>
</tr>
<tr>
<td>paymentScheduleUType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of object present in this response</td>
</tr>
Expand Down Expand Up @@ -8118,7 +8117,7 @@ <h3 class="schema-toc" id="tocStelcoconcession">TelcoConcession</h3>
</thead><tbody>
<tr>
<td>type</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The concession type</td>
</tr>
Expand Down Expand Up @@ -8172,7 +8171,7 @@ <h3 class="schema-toc" id="tocStelcoconcession">TelcoConcession</h3>
</tr>
<tr>
<td>appliedTo</td>
<td>[string]</td>
<td>[<a href="#common-field-types">Enum</a>]</td>
<td>optional</td>
<td>Array of ENUM&#39;s to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed</td>
</tr>
Expand Down Expand Up @@ -8369,7 +8368,7 @@ <h3 class="schema-toc" id="tocStelcoinvoice">TelcoInvoice</h3>
</tr>
<tr>
<td>paymentStatus</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>Indicator of the payment status for the invoice</td>
</tr>
Expand Down Expand Up @@ -8609,7 +8608,7 @@ <h3 class="schema-toc" id="tocStelcobillingtransaction">TelcoBillingTransaction<
</tr>
<tr>
<td>transactionUType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>Indicator of the type of transaction object present in this record</td>
</tr>
Expand Down Expand Up @@ -8833,7 +8832,7 @@ <h3 class="schema-toc" id="tocStelcobillingothertransaction">TelcoBillingOtherTr
</tr>
<tr>
<td>type</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>optional</td>
<td>Type of charge. Assumed to be OTHER if absent</td>
</tr>
Expand Down Expand Up @@ -8910,7 +8909,7 @@ <h3 class="schema-toc" id="tocStelcobillingpaymenttransaction">TelcoBillingPayme
</tr>
<tr>
<td>method</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The method of payment</td>
</tr>
Expand Down Expand Up @@ -9172,7 +9171,7 @@ <h3 id='properties-35'>Properties</h3>
</thead><tbody>
<tr>
<td><em>anonymous</em></td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>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</td>
</tr>
Expand Down Expand Up @@ -9254,7 +9253,7 @@ <h3 class="schema-toc" id="tocScommonphysicaladdress">CommonPhysicalAddress</h3>
</thead><tbody>
<tr>
<td>addressUType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of address object present</td>
</tr>
Expand Down Expand Up @@ -10819,7 +10818,7 @@ <h3 class="schema-toc" id="tocStelcoproductdetailfeature">TelcoProductDetailFeat
</tr>
<tr>
<td>category</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>optional</td>
<td>The type of the feature</td>
</tr>
Expand Down Expand Up @@ -11423,13 +11422,13 @@ <h3 class="schema-toc" id="tocStelcoaccountplan">TelcoAccountPlan</h3>
</tr>
<tr>
<td>type</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of the plan. The type of plan. A <a href="https://www.legislation.gov.au/Details/C2022C00170/Html/Volume_1#_Toc95898745">MOBILE</a> service or BROADBAND fixed internet service</td>
</tr>
<tr>
<td>billingType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The billing type of then plan</td>
</tr>
Expand Down Expand Up @@ -11724,7 +11723,7 @@ <h3 id='properties-74'>Properties</h3>
</thead><tbody>
<tr>
<td>cardScheme</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of credit card held on file</td>
</tr>
Expand All @@ -11736,7 +11735,7 @@ <h3 id='properties-74'>Properties</h3>
</tr>
<tr>
<td>calculationType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The mechanism by which the payment amount is calculated. Explanation of values are as follows:<br/><ul><li><strong>STATIC</strong> - Indicates a consistent, static amount, per payment</li><li><strong>BALANCE</strong> - Indicates that the outstanding balance for the account is paid per period</li><li><strong>CALCULATED</strong> - Indicates that the payment amount is variable and calculated using a pre-defined algorithm</li></ul></td>
</tr>
Expand Down Expand Up @@ -11834,7 +11833,7 @@ <h3 id='properties-75'>Properties</h3>
</tr>
<tr>
<td>calculationType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The mechanism by which the payment amount is calculated. Explanation of values are as follows:<br/><ul><li><strong>STATIC</strong> - Indicates a consistent, static amount, per payment</li><li><strong>BALANCE</strong> - Indicates that the outstanding balance for the account is paid per period</li><li><strong>CALCULATED</strong> - Indicates that the payment amount is variable and calculated using a pre-defined algorithm</li></ul></td>
</tr>
Expand Down Expand Up @@ -11897,13 +11896,13 @@ <h3 id='properties-76'>Properties</h3>
</tr>
<tr>
<td>type</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The type of the digital wallet identifier</td>
</tr>
<tr>
<td>provider</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The provider of the digital wallet</td>
</tr>
Expand All @@ -11915,7 +11914,7 @@ <h3 id='properties-76'>Properties</h3>
</tr>
<tr>
<td>calculationType</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>mandatory</td>
<td>The mechanism by which the payment amount is calculated. Explanation of values are as follows:<br/><ul><li><strong>STATIC</strong> - Indicates a consistent, static amount, per payment</li><li><strong>BALANCE</strong> - Indicates that the outstanding balance for the account is paid per period</li><li><strong>CALCULATED</strong> - Indicates that the payment amount is variable and calculated using a pre-defined algorithm</li></ul></td>
</tr>
Expand Down Expand Up @@ -12493,7 +12492,7 @@ <h3 id='properties-89'>Properties</h3>
</tr>
<tr>
<td>type</td>
<td>string</td>
<td><a href="#common-field-types">Enum</a></td>
<td>optional</td>
<td>A free text description of the charge</td>
</tr>
Expand Down
Loading

0 comments on commit e50413d

Please sign in to comment.