openapi: 3.0.3
info:
  version: 1.1.0
  title: Product Manager API Documentation
  description: This is the API of Product Manager
  license:
    name: Biza Pty Ltd
    url: https://biza.io
  contact:
    email: hello@biza.io
    name: Biza.io
    url: https://biza.io/
servers:
  - url: https://api.pm.productdata.au
    description: Product Manager API
tags:
  - name: Admin
    description: Admin APIs
    x-internal: true
  - name: CDR Banking Products
    description: CDR Banking Products APIs
    x-internal: true
  - name: Changes
    description: Changes APIs
  - name: Changesets
    description: Changesets APIs
  - name: Products
    description: Products APIs
  - name: Spaces
    description: Spaces APIs
  - name: Tables
    description: Tables APIs
paths:
  /{spaceId}/adapter/cds-au/v1/banking/products/internal/{internalProductId}:
    get:
      x-internal: true
      description: >-
        Retrieve detailed information for a single publicly available product
        using an `internalId`.


        Unlike the public `GET /banking/products/{productId}` endpoint (which
        looks the product up by the `productId` published to the CDR), this
        endpoint resolves a product by one of the `internalId` values configured
        against it in Product Manager. A product in PM can have one or more
        `internalId` entries linked to it, which lets a customer's HaaS data
        adapter map its own internal product identifiers to the CDR-published
        product without needing to know the generated public `productId`.
      operationId: adapterGetBankingInternalProductDetail
      parameters:
        - $ref: '#/components/parameters/PathSpaceId'
        - $ref: '#/components/parameters/PathInternalProductId'
        - $ref: '#/components/parameters/HeaderXV'
        - $ref: '#/components/parameters/HeaderXMinV'
      responses:
        '200':
          $ref: '#/components/responses/GetBankingProductDetail'
        '400':
          $ref: '#/components/responses/GetProductDetail400'
        '404':
          $ref: '#/components/responses/GetProductDetail404'
        '406':
          $ref: '#/components/responses/GetProductDetail406'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
      summary: Get Internal Product Detail
      security: []
      tags:
        - CDR Banking Products
      x-version: '4'
components:
  securitySchemes:
    TokenBasedAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://id.biza.io/oauth/token
          scopes:
            biza-au:pm:read: Read Access to the Product Manager API
            biza-au:pm:write: Write Access to the Product Manager API
  parameters:
    PathSpaceId:
      description: ID of the PRD Admin space
      explode: false
      in: path
      name: spaceId
      required: true
      schema:
        type: string
        format: uuid
      x-cds-type: ASCIIString
      style: simple
    PathInternalProductId:
      description: >-
        One of the `internalId` values configured against a product in Product
        Manager.


        A product can have one or more `internalId`s linked to it, allowing a
        customer's HaaS data adapter to look the product up by its own internal
        product identifier rather than the `productId` published to the CDR.
      explode: false
      in: path
      name: internalProductId
      required: true
      schema:
        type: string
      x-cds-type: ASCIIString
      style: simple
    HeaderXV:
      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_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)

        and
        [_x-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers).
        If the value

        of
        [_x-min-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        is equal to or higher than the

        value of
        [_x-v_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        then

        the
        [_x-min-v_](https://consumerdatastandardsaustralia.github.io/standards/#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](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
      explode: false
      in: header
      name: x-v
      required: true
      schema:
        type: string
      style: simple
    HeaderXMinV:
      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_](https://consumerdatastandardsaustralia.github.io/standards/#request-headers)
        and
        [_x-v_](https://consumerdatastandardsaustralia.github.io/standards/#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
  schemas:
    LinksV1:
      properties:
        self:
          description: Fully qualified link that generated the current response document
          type: string
          format: uri
          x-cds-type: URIString
          example: https://api.bank.com.au/cds-au/v1/endpoint/path
      required:
        - self
      type: object
    MetaV1:
      type: object
    LinksMetaV1:
      properties:
        links:
          $ref: '#/components/schemas/LinksV1'
        meta:
          $ref: '#/components/schemas/MetaV1'
      required:
        - links
        - meta
      type: object
    BankingProductAdditionalInformationV1:
      description: Object that contains links to additional information on specific topics
      properties:
        bundleUri:
          description: Description of a bundle that this product can be part of
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/bundles
        eligibilityUri:
          description: Eligibility rules and criteria for the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/eligibility
        feesAndPricingUri:
          description: >-
            Description of fees, pricing, discounts, exemptions and bonuses for
            the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/fees-and-charges
        overviewUri:
          description: General overview of the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products
        termsUri:
          description: Terms and conditions for the product
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/terms
    BankingProductCardArtV1:
      properties:
        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](https://tools.ietf.org/html/rfc2397).
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/card-art.png
        title:
          description: Display label for the specific image
          type: string
          example: Customise your card and look snazzy
      required:
        - imageUri
    EnumBankingProductCategoryV1:
      description: >+

        The productCategory enumeration provides the values for categorising
        products and accounts. These are explained in the following tables:


        **Deposit Products**


        | Enum | Description

        |------|------------|

        | 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... |

        | 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. |

        | TRAVEL_CARDS               | This grouping of products includes
        prepaid cards with multi-currency capabilities.|

        | REGULATED_TRUST_ACCOUNTS   | This grouping of products includes
        accounts were funds are held in trust in regulated industries with
        complex rules embedded on how the products must operate. Industries that
        require this sort of product include real estate agents, solicitors and
        conveyancers. |


        **Lending Products**


        |Enum|Description|

        |----|-----------|

        |BUSINESS_LOANS|This grouping of products incorporates all types of
        lending for business purpose that is not a trade finance facility,
        lease, overdraft, residential mortgage, credit card or margin lending.
        It includes traditional term loans, bank guarantees and commercial
        bills. This category would incorporate both secured and unsecured
        business purpose lending including all business purpose equipment
        finance that is not covered by a lease.|

        |CRED_AND_CHRG_CARDS|This grouping of products includes all lending
        products that are issued for the purpose of allowing a flexible line of
        credit accessed through use of a card. These may be called various names
        including Credit Cards, Charge Cards and Store Cards.|

        |LEASES|This grouping of products will include all types of leases
        including Financial Lease, Operating Lease, Sale and leaseback, etc...|

        |MARGIN_LOANS|This grouping of products includes all types of margin
        loans which let you borrow money to invest in traded assets including
        shares & commodities or in managed funds.|

        |OVERDRAFTS|This grouping of products includes all types of lending
        which allows for the loan amount to be withdrawn, repaid, and redrawn
        again in any manner and any number of times, until the arrangement
        expires. These loans may be secured or unsecured, and generally don’t
        have set / minimum repayment requirements.|

        |PERS_LOANS|This grouping of products includes all lending for personal
        purposes that is not a residential mortgage, credit card or margin
        lending. These loans may be unsecured loans and term loans for purchase
        assets used as security such as motor vehicles. These may be called
        various names including Personal Loans and Car Loans.|

        |RESIDENTIAL_MORTGAGES|This grouping of products includes all lending
        products that are available for the primary purpose of borrowing for the
        purpose of purchasing or renovating residential property, where a
        residential property will be used as security. This group will include
        both fixed, variable & secured overdraft types of product and may
        include both owner-occupied and investment purpose borrowing.|

        |TRADE_FINANCE | This grouping of products includes specialised lending
        products specifically designed to facilitate domestic & international
        trade. This includes the issuance of letters of credit, factoring,
        export credit.

      enum:
        - BUSINESS_LOANS
        - CRED_AND_CHRG_CARDS
        - LEASES
        - MARGIN_LOANS
        - OVERDRAFTS
        - PERS_LOANS
        - REGULATED_TRUST_ACCOUNTS
        - RESIDENTIAL_MORTGAGES
        - TERM_DEPOSITS
        - TRADE_FINANCE
        - TRANS_AND_SAVINGS_ACCOUNTS
        - TRAVEL_CARDS
      type: string
      example: TRANS_AND_SAVINGS_ACCOUNTS
    BankingProductV3:
      properties:
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV1'
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          x-cds-type: URIString
        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
          example: ACME
        brandName:
          description: An optional display name of the brand
          type: string
        cardArt:
          description: An array of card art images
          items:
            $ref: '#/components/schemas/BankingProductCardArtV1'
          type: array
        description:
          description: A description of the product
          type: string
          example: An amazing example product
        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
          format: date-time
          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
          format: date-time
          x-cds-type: DateTimeString
        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
          example: true
        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
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        name:
          description: The display name of the product
          type: string
          example: Example Product
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        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
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    BankingProductBundleV1:
      properties:
        additionalInfo:
          description: Display text providing more information on the bundle
          type: string
          example: A great bundle with all the extras
        additionalInfoUri:
          description: >-
            Link to a web page with more information on the bundle criteria and
            benefits
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/bundles
        description:
          description: Description of the bundle
          type: string
          example: Provides a savings account and loan
        name:
          description: Name of the bundle
          type: string
          example: ACME Super Bundle
        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
          type: array
      required:
        - description
        - name
      type: object
    EnumBankingProductConstraintTypeV1:
      description: >

        Each Product or Account has a set of Constraints. These are explained in
        a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        MIN_BALANCE | A minimum balance is required for the product | The
        minimum balance in AmountString format

        MAX_BALANCE | A maximum balance is required for the product | The
        maximum balance in AmountString format

        OPENING_BALANCE | An opening balance is required for the product | The
        minimum opening 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_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
      enum:
        - MAX_BALANCE
        - MAX_LIMIT
        - MIN_BALANCE
        - MIN_LIMIT
        - OPENING_BALANCE
      type: string
      example: MIN_BALANCE
    BankingProductConstraintV1:
      properties:
        additionalInfo:
          description: Display text providing more information on the constraint
          type: string
          example: Some information about the constraint
        additionalInfoUri:
          description: Link to a web page with more information on the constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/constraints
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
            specified.  Whether mandatory or not is dependent on the value of
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
          type: string
          example: Type specific value, see documentation
        constraintType:
          $ref: '#/components/schemas/EnumBankingProductConstraintTypeV1'
      required:
        - constraintType
      type: object
      x-conditional:
        - additionalValue
    EnumBankingDepositRateTypeV1:
      description: >

        The type of rate (base, bonus, etc). These are explained in a table as
        follows:


        | 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

        FIXED | Fixed rate for a period of time | The period of time fixed.
        Formatted according to ISO 8601 Durations

        VARIABLE | A variable base rate for the product | NA

        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

        DISCOUNT | A specific discount rate that may be applied. A discount rate
        reduces the interest payable | Description of the discount rate that is
        applicable

        PENALTY | A specific penalty rate that may be applied. A penalty rate
        increases the interest payable | Description of the penalty rate that is
        applicable

        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

        CASH_ADVANCE | Specific rate applied to cash advances from the account |
        NA

        PURCHASE | Specific rate applied to purchases from the account | NA

        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
      enum:
        - BONUS
        - BUNDLE_BONUS
        - FIXED
        - FLOATING
        - INTRODUCTORY
        - MARKET_LINKED
        - VARIABLE
      type: string
      example: FIXED
    BankingProductRateConditionV1:
      description: Defines a condition for the applicability of a tiered rate
      properties:
        additionalInfo:
          description: Display text providing more information on the condition
          type: string
          example: >-
            Package discount is assessed on the package lending balance when you
            apply for a package.
        additionalInfoUri:
          description: Link to a web page with more information on this condition
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.bank.com.au/home-loans/package.html
      type: object
    EnumBankingRateApplicationMethodV1:
      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
      example: WHOLE_BALANCE
    EnumUnitOfMeasureV1:
      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
      example: DOLLAR
    BankingProductRateTierV3:
      description: Defines the criteria and conditions for which a rate applies
      properties:
        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
          format: uri
          x-cds-type: URIString
        applicabilityConditions:
          $ref: '#/components/schemas/BankingProductRateConditionV1'
        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: number
        minimumValue:
          description: >-
            The number of unitOfMeasure units that form the lower bound of the
            tier. The tier should be inclusive of this value
          type: number
          example: 0.05
        name:
          description: A display name for the tier
          type: string
          example: Example Rate Tier
        rateApplicationMethod:
          $ref: '#/components/schemas/EnumBankingRateApplicationMethodV1'
        unitOfMeasure:
          $ref: '#/components/schemas/EnumUnitOfMeasureV1'
      required:
        - minimumValue
        - name
        - unitOfMeasure
      type: object
    BankingProductDepositRateV2:
      properties:
        additionalInfo:
          description: Display text providing more information on the rate
          type: string
          example: A great deposit rate
        additionalInfoUri:
          description: Link to a web page with more information on this rate
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/home-loans/deposit-rates
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [depositRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdepositratetypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [depositRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdepositratetypedoc)
          type: string
          example: Type specific value, see docs
        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: DurationString
          example: P30D
        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: DurationString
          example: P1D
        depositRateType:
          $ref: '#/components/schemas/EnumBankingDepositRateTypeV1'
        rate:
          description: The rate to be applied
          type: string
          x-cds-type: RateString
          example: '0.011'
        tiers:
          description: Rate tiers applicable for this rate
          items:
            $ref: '#/components/schemas/BankingProductRateTierV3'
          type: array
      required:
        - depositRateType
        - rate
      type: object
      x-conditional:
        - additionalValue
    EnumBankingProductEligibilityTypeV1:
      description: >

        Each Product or Account has a set of Product Eligibility types. These
        are explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        BUSINESS | Only business may apply for the account | NA

        PENSION_RECIPIENT | A recipient of a government pension may apply for
        the product | NA

        MIN_AGE | Only customers older than a minimum age may apply | The
        minimum age in years

        MAX_AGE | Only customers younger than a maximum age may apply | The
        maximum 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

        STAFF | Only a staff member of the provider may apply | NA

        STUDENT | Only students may apply for the product | NA

        EMPLOYMENT_STATUS | An eligibility constraint based on employment status
        applies | A description of the status required

        RESIDENCY_STATUS | An eligibility constraint based on residency status
        applies | A description of the status required

        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
      enum:
        - BUSINESS
        - EMPLOYMENT_STATUS
        - MAX_AGE
        - MIN_AGE
        - MIN_INCOME
        - MIN_TURNOVER
        - NATURAL_PERSON
        - OTHER
        - PENSION_RECIPIENT
        - RESIDENCY_STATUS
        - STAFF
        - STUDENT
      type: string
      example: MIN_TURNOVER
    BankingProductEligibilityV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the
            [eligibility](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            criteria. Mandatory if the field is set to OTHER
          type: string
          example: Eligibility Criteria
        additionalInfoUri:
          description: >-
            Link to a web page with more information on this eligibility
            criteria
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
          type: string
          example: Type dependent value, see docs
        eligibilityType:
          $ref: '#/components/schemas/EnumBankingProductEligibilityTypeV1'
      required:
        - eligibilityType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductFeatureTypeV1:
      description: >

        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        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

        ADDITIONAL_CARDS | Additional cards can be requested | The maximum
        number of additional cards. If no maximum then should be set to null

        UNLIMITED_TXNS | Unlimited free transactions available | 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)

        LOYALTY_PROGRAM | A points based loyalty program is available | Name of
        the loyalty program

        OFFSET | An offset account can be connected to the product | NA

        OVERDRAFT | An overdraft can be applied for | NA

        REDRAW | Redraw of repaid principal above minimum required is available
        | NA

        INSURANCE | Insurance is provided as an additional feature of the
        product | Text description of the type of insurance (e.g. Travel
        Insurance)

        BALANCE_TRANSFERS | Balance transfers can be made to the account (eg.
        for credit cards) | NA

        INTEREST_FREE | Interest free period for purchases | Interest free
        period. Formatted according to ISO 8601 Durations

        INTEREST_FREE_TRANSFERS | Interest free period for balance transfers |
        Interest free period. Formatted according to ISO 8601 Durations

        DIGITAL_WALLET | A Digital wallet can be attached to the product | The
        name or brand of the wallet

        DIGITAL_BANKING | Access is available to online banking features for the
        product | NA

        NPP_PAYID | An account of this product type can be used as the target of
        an NPP PayID | NA

        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

        DONATE_INTEREST | Indicates that interest generated from the product can
        be automatically donated to a charity or community group | NA

        BILL_PAYMENT | The product can be attached to an automatic budgeting and
        bill payment service | Optional name of the service

        COMPLEMENTARY_PRODUCT_DISCOUNTS | Indicates that complementary,
        discounted offerings (such as gift cards, or discounted travel) is
        available | Description of the complementary offering

        BONUS_REWARDS | Bonus loyalty rewards points are available | Number of
        points available

        NOTIFICATIONS | Advanced notifications are available for the product |
        Description of the notification capability

        OTHER | Another feature that can not be included in any of the other
        categories. The additionalInfo field is mandatory for this type | NA
      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - DIGITAL_BANKING
        - DIGITAL_WALLET
        - DONATE_INTEREST
        - FREE_TXNS
        - FREE_TXNS_ALLOWANCE
        - INSURANCE
        - INTEREST_FREE
        - INTEREST_FREE_TRANSFERS
        - LOYALTY_PROGRAM
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - UNLIMITED_TXNS
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV1'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductDiscountTypeV1:
      description: >

        Each Product or Account has a set of Discount Types types. These are
        explained in a table as follows:


        | 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

        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

        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

        ELIGIBILITY_ONLY | Discount applies based on customer eligibility
        (eligibility array must be populated) | N/A
      enum:
        - BALANCE
        - DEPOSITS
        - ELIGIBILITY_ONLY
        - FEE_CAP
        - PAYMENTS
      type: string
      example: BALANCE
    EnumBankingProductDiscountEligibilityTypeV1:
      description: >

        Each Product or Account has a set of Discount Eligibility Types types.
        These are explained in a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        BUSINESS | A business or other non-person legal entity | NA

        PENSION_RECIPIENT | A recipient of a government pension may receive the
        discount | Optional. Should contain a description of which pensions
        qualify

        MIN_AGE | Only customers older than a minimum age receive the discount |
        The minimum age in years

        MAX_AGE | Only customers younger than a maximum age receive the discount
        | The maximum 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

        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?

        EMPLOYMENT_STATUS | An eligibility constraint based on employment status
        applies | A description of the status required

        RESIDENCY_STATUS | An eligibility constraint based on residency status
        applies | A description of the status required

        NATURAL_PERSON | The customer must be a natural person rather than
        another legal entity | NA

        INTRODUCTORY | The discount is only available during an introductory
        period | The period of time for the introductory discount. Formatted
        according to ISO 8601 Durations

        OTHER | Another eligibility criteria exists as described in the
        additionalInfo field (if this option is specified then the
        additionalInfo field is mandatory) | NA
      enum:
        - BUSINESS
        - EMPLOYMENT_STATUS
        - INTRODUCTORY
        - MAX_AGE
        - MIN_AGE
        - MIN_INCOME
        - MIN_TURNOVER
        - NATURAL_PERSON
        - OTHER
        - PENSION_RECIPIENT
        - RESIDENCY_STATUS
        - STAFF
        - STUDENT
      type: string
      example: BUSINESS
    BankingProductDiscountEligibilityV1:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on this eligibility
            constraint. Whether mandatory or not is dependent on the value of
            discountEligibilityType.
          type: string
          example: Eligibility criteria explanation
        additionalInfoUri:
          description: >-
            Link to a web page with more information on this eligibility
            constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/eligibility
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [discountEligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounteligibilitydoc)
            specified. Whether mandatory or not is dependent on the value of
            [discountEligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounteligibilitydoc)
          type: string
          example: Type specific value, see docs
        discountEligibilityType:
          $ref: '#/components/schemas/EnumBankingProductDiscountEligibilityTypeV1'
      required:
        - discountEligibilityType
      type: object
      x-conditional:
        - additionalInfo
        - additionalValue
    BankingProductDiscountV1:
      properties:
        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
          example: '0.012'
        additionalInfo:
          description: Display text providing more information on the discount
          type: string
          example: Discount Information
        additionalInfoUri:
          description: Link to a web page with more information on this discount
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/discounts
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [discountType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounttypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [discountType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdiscounttypedoc)
          type: string
          example: Type specific value, see docs
        amount:
          description: >-
            Dollar value of the discount. One of amount, balanceRate,
            transactionRate, accruedRate and feeRate is mandatory.
          type: string
          x-cds-type: AmountString
          example: '11.00'
        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
          example: '0.0103'
        description:
          description: Description of the discount
          type: string
          example: A great discount offer for having multiple accounts with us.
        discountType:
          $ref: '#/components/schemas/EnumBankingProductDiscountTypeV1'
        eligibility:
          description: >-
            Eligibility constraints that apply to this discount. Mandatory if
            discountType is ELIGIBILITY_ONLY.
          items:
            $ref: '#/components/schemas/BankingProductDiscountEligibilityV1'
          type: array
        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
          example: '0.0124'
        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
          example: '0.00234'
      required:
        - description
        - discountType
      type: object
      x-conditional:
        - accruedRate
        - additionalValue
        - amount
        - balanceRate
        - eligibility
        - feeRate
        - transactionRate
    EnumBankingProductFeeTypeV1:
      description: >

        Each Product or Account has a set of Fee Types. These are explained in a
        table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        PERIODIC | A periodic fee such as a monthly account servicing fee | The
        period of charge. Formatted according to ISO 8601 Durations

        TRANSACTION | A fee associated with any transaction (incorporates
        WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE) | NA

        WITHDRAWAL | A fee associated with making a withdrawal | NA

        DEPOSIT | A fee associated with making a deposit | NA

        PAYMENT | A fee associated with making a payment | NA

        PURCHASE | A fee associated with making a purchase at a merchant | NA

        EVENT | A fee in relation to a particular event (e.g. ordering a new
        card, viewing a balance or stopping a cheque) | NA

        UPFRONT | A fee paid at the beginning of the product lifecycle, such as
        an establishment fee, loyalty program fee or application fee | NA

        EXIT | A fee for closing the product | 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
      enum:
        - DEPOSIT
        - EVENT
        - EXIT
        - PAYMENT
        - PERIODIC
        - PURCHASE
        - TRANSACTION
        - UPFRONT
        - VARIABLE
        - WITHDRAWAL
      type: string
      example: EXIT
    BankingProductFeeV1:
      properties:
        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: DurationString
          example: P1D
        accruedRate:
          description: >-
            A fee rate calculated based on a proportion of the calculated
            interest accrued on the account. One of amount, balanceRate,
            transactionRate and accruedRate is mandatory unless the feeType is
            `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '0.002'
        additionalInfo:
          description: Display text providing more information on the fee
          type: string
          example: Additional Fee Information
        additionalInfoUri:
          description: Link to a web page with more information on this fee
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [feeType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeetypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [feeType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeetypedoc)
          type: string
          example: Type specific value, see docs
        amount:
          description: >-
            The amount charged for the fee. One of amount, balanceRate,
            transactionRate and accruedRate is mandatory unless the feeType is
            `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '10.01'
        balanceRate:
          description: >-
            A fee rate calculated based on a proportion of the balance. One of
            amount, balanceRate, transactionRate and accruedRate is mandatory
            unless the feeType is `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '0.0023'
        currency:
          description: The currency the fee will be charged in. Assumes AUD if absent
          type: string
          x-cds-type: CurrencyString
          example: AUD
          pattern: \w{3}
        discounts:
          description: An optional list of discounts to this fee that may be available
          items:
            $ref: '#/components/schemas/BankingProductDiscountV1'
          type: array
        feeType:
          $ref: '#/components/schemas/EnumBankingProductFeeTypeV1'
        name:
          description: Name of the fee
          type: string
          example: Fee Name
        transactionRate:
          description: >-
            A fee rate calculated based on a proportion of a transaction. One of
            amount, balanceRate, transactionRate and accruedRate is mandatory
            unless the feeType is `VARIABLE`
          type: string
          x-cds-type: AmountString
          example: '0.0023'
      required:
        - feeType
        - name
      type: object
      x-conditional:
        - additionalValue
        - amount
        - balanceRate
        - transactionRate
        - accruedRate
    EnumBankingInterestPaymentDueV1:
      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
      example: IN_ARREARS
    EnumBankingLendingRateTypeV1:
      description: >

        The type of rate (base, bonus, etc). These are explained in a table as
        follows:


        | 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

        VARIABLE | A variable base rate for the product | NA

        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

        DISCOUNT | A specific discount rate that may be applied. A discount rate
        reduces the interest payable | Description of the discount rate that is
        applicable

        PENALTY | A specific penalty rate that may be applied. A penalty rate
        increases the interest payable | Description of the penalty rate that is
        applicable

        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

        CASH_ADVANCE | Specific rate applied to cash advances from the account |
        NA

        PURCHASE | Specific rate applied to purchases from the account | NA

        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
      enum:
        - BUNDLE_DISCOUNT_FIXED
        - BUNDLE_DISCOUNT_VARIABLE
        - CASH_ADVANCE
        - DISCOUNT
        - FIXED
        - FLOATING
        - INTRODUCTORY
        - MARKET_LINKED
        - PENALTY
        - PURCHASE
        - VARIABLE
      type: string
      example: FIXED
    EnumBankingLoanPurposeV1:
      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
      example: OWNER_OCCUPIED
    EnumBankingProductLendingRateRepaymentTypeV1:
      description: >-
        Options in place for repayments. If absent, the lending rate is
        applicable to all repayment types
      enum:
        - INTEREST_ONLY
        - PRINCIPAL_AND_INTEREST
      type: string
      example: PRINCIPAL_AND_INTEREST
    BankingProductLendingRateV2:
      properties:
        additionalInfo:
          description: Display text providing more information on the rate.
          type: string
          example: Owner Occupied with Principal and Interest repayment type
        additionalInfoUri:
          description: Link to a web page with more information on this rate
          type: string
          format: uri
          x-cds-type: URIString
          example: >-
            https://www.bank.com.au/personal/apply-online/download-printed-forms/home-loan-update-002842.pdf
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [lendingRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductlendingratetypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [lendingRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductlendingratetypedoc)
          type: string
          example: P1Y
        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: DurationString
          example: P1M
        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: DurationString
          example: P1D
        comparisonRate:
          description: A comparison rate equivalent for this rate
          type: string
          x-cds-type: RateString
          example: '0.0456'
        interestPaymentDue:
          $ref: '#/components/schemas/EnumBankingInterestPaymentDueV1'
        lendingRateType:
          $ref: '#/components/schemas/EnumBankingLendingRateTypeV1'
        loanPurpose:
          $ref: '#/components/schemas/EnumBankingLoanPurposeV1'
        rate:
          description: The rate to be applied
          type: string
          x-cds-type: RateString
          example: '0.0456'
        repaymentType:
          $ref: '#/components/schemas/EnumBankingProductLendingRateRepaymentTypeV1'
        tiers:
          description: Rate tiers applicable for this rate
          items:
            $ref: '#/components/schemas/BankingProductRateTierV3'
          type: array
      required:
        - lendingRateType
        - rate
      type: object
      x-conditional:
        - additionalValue
    BankingProductDetailV3:
      allOf:
        - $ref: '#/components/schemas/BankingProductV3'
        - 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/BankingProductBundleV1'
              type: array
            constraints:
              description: >-
                Constraints on the application for or operation of the product
                such as minimum balances or limit thresholds
              items:
                $ref: '#/components/schemas/BankingProductConstraintV1'
              type: array
            depositRates:
              description: Interest rates available for deposits
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            eligibility:
              description: Eligibility criteria for the product
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV1'
              type: array
            features:
              description: Array of features available for the product
              items:
                $ref: '#/components/schemas/BankingProductFeatureV1'
              type: array
            fees:
              description: Fees applicable to the product
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
          type: object
    ResponseBankingProductByIdV3:
      allOf:
        - $ref: '#/components/schemas/LinksMetaV1'
        - type: object
          properties:
            version:
              type: string
              default: V3
            data:
              $ref: '#/components/schemas/BankingProductDetailV3'
          required:
            - data
            - version
      type: object
    BankingProductAdditionalInformationUriV1:
      type: object
      required:
        - additionalInfoUri
      properties:
        description:
          type: string
          description: Display text providing more information about the document URI
          example: Additional Product Information can be found at ACME Bank website
        additionalInfoUri:
          type: string
          description: The URI describing the additional information
          format: uri
          x-cds-type: URIString
          example: >-
            https://www.acmebank.com.au/products/home-loans/home-loans-full-example.pdf
    BankingProductAdditionalInformationV2:
      description: Object that contains links to additional information on specific topics
      properties:
        bundleUri:
          description: >-
            Description of a bundle that this product can be part of. Mandatory
            if `additionalBundleUris` includes one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/bundles
        eligibilityUri:
          description: >-
            Eligibility rules and criteria for the product. Mandatory if
            `additionalEligibilityUris` includes one or more supporting
            documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/eligibility
        feesAndPricingUri:
          description: >-
            Description of fees, pricing, discounts, exemptions and bonuses for
            the product. Mandatory if `additionalFeesAndPricingUris` includes
            one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/fees-and-charges
        overviewUri:
          description: >-
            General overview of the product. Mandatory if
            `additionalOverviewUris` includes one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products
        termsUri:
          description: >-
            Terms and conditions for the product. Mandatory if
            `additionalTermsUris` includes one or more supporting documents.
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/terms
        additionalOverviewUris:
          type: array
          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/BankingProductAdditionalInformationUriV1'
        additionalTermsUris:
          type: array
          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/BankingProductAdditionalInformationUriV1'
        additionalEligibilityUris:
          type: array
          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/BankingProductAdditionalInformationUriV1'
        additionalFeesAndPricingUris:
          type: array
          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/BankingProductAdditionalInformationUriV1'
        additionalBundleUris:
          type: array
          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/BankingProductAdditionalInformationUriV1'
      type: object
      x-conditional:
        - overviewUri
        - termsUri
        - eligibilityUri
        - feesAndPricingUri
        - bundleUri
    BankingProductV4:
      properties:
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV2'
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          x-cds-type: URIString
        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
          example: ACME
        brandName:
          description: An optional display name of the brand
          type: string
        cardArt:
          description: An array of card art images
          items:
            $ref: '#/components/schemas/BankingProductCardArtV1'
          type: array
        description:
          description: A description of the product
          type: string
          example: An amazing example product
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (i.e. is
            available for origination). Used to enable the articulation of
            products to the regime before they are available for customers to
            originate.
          type: string
          format: date-time
          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
          format: date-time
          x-cds-type: DateTimeString
        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
          example: true
        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
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        name:
          description: The display name of the product
          type: string
          example: Example Product
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        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
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    EnumBankingProductFeatureTypeV2:
      description: >
        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | 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                                                                          
        |

        | 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                                                                                                                 
        |

        | INSURANCE                       | Insurance is provided as an
        additional feature of the
        product                                                                                                                                                                              
        | Text description of the type of insurance (e.g. Travel
        Insurance)                                                   |

        | INSTALMENT_PLAN                 | The product has the option to pay
        for eligible purchases over time with a set number of
        payments.                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | 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                                                                                                                 
        |
      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CASHBACK_OFFER
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - DIGITAL_BANKING
        - DIGITAL_WALLET
        - DONATE_INTEREST
        - EXTRA_REPAYMENTS
        - FRAUD_PROTECTION
        - FREE_TXNS
        - FREE_TXNS_ALLOWANCE
        - GUARANTOR
        - INSTALMENT_PLAN
        - INSURANCE
        - INTEREST_FREE
        - INTEREST_FREE_TRANSFERS
        - LOYALTY_PROGRAM
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - RELATIONSHIP_MANAGEMENT
        - UNLIMITED_TXNS
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV2:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV2'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductDetailV4:
      allOf:
        - $ref: '#/components/schemas/BankingProductV4'
        - 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/BankingProductBundleV1'
              type: array
            constraints:
              description: >-
                Constraints on the application for or operation of the product
                such as minimum balances or limit thresholds
              items:
                $ref: '#/components/schemas/BankingProductConstraintV1'
              type: array
            depositRates:
              description: Interest rates available for deposits
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            eligibility:
              description: Eligibility criteria for the product
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV1'
              type: array
            features:
              description: Array of features available for the product
              items:
                $ref: '#/components/schemas/BankingProductFeatureV2'
              type: array
            fees:
              description: Fees applicable to the product
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
          type: object
    ResponseBankingProductByIdV4:
      allOf:
        - $ref: '#/components/schemas/LinksMetaV1'
        - type: object
          properties:
            version:
              type: string
              default: V4
            data:
              $ref: '#/components/schemas/BankingProductDetailV4'
          required:
            - data
            - version
      type: object
    EnumBankingProductConstraintTypeV2:
      description: >

        Each Product or Account has a set of Constraints. These are explained in
        a table as follows:


        | Value | Description | Use of `additionalValue` Field

        |-------|-------------|-------------------------------|

        MIN_BALANCE | A minimum balance is required for the product | The
        minimum balance in AmountString format

        MAX_BALANCE | A maximum balance is required for the product | The
        maximum balance in AmountString format

        OPENING_BALANCE | An opening balance is required for the product | The
        minimum opening 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_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

        | MAX_LVR | A maximum LVR (Loan to Value Ratio) exists. | The maximum
        LVR in [RateString](#common-field-types) format. 

        | MIN_LVR | A minimum LVR (Loan to Value Ratio) exists. | The minimum
        LVR in [RateString](#common-field-types) format. 
      enum:
        - MAX_BALANCE
        - MAX_LIMIT
        - MAX_LVR
        - MIN_BALANCE
        - MIN_LIMIT
        - MIN_LVR
        - OPENING_BALANCE
      type: string
      example: MIN_BALANCE
    BankingProductConstraintV2:
      properties:
        additionalInfo:
          description: Display text providing more information on the constraint
          type: string
          example: Some information about the constraint
        additionalInfoUri:
          description: Link to a web page with more information on the constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/constraints
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
            specified.  Whether mandatory or not is dependent on the value of
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
          type: string
          example: Type specific value, see documentation
        constraintType:
          $ref: '#/components/schemas/EnumBankingProductConstraintTypeV2'
      required:
        - constraintType
      type: object
      x-conditional:
        - additionalValue
    BankingProductDetailV5:
      allOf:
        - $ref: '#/components/schemas/BankingProductV4'
        - 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/BankingProductBundleV1'
              type: array
            constraints:
              description: >-
                Constraints on the application for or operation of the product
                such as minimum balances or limit thresholds
              items:
                $ref: '#/components/schemas/BankingProductConstraintV2'
              type: array
            depositRates:
              description: Interest rates available for deposits
              items:
                $ref: '#/components/schemas/BankingProductDepositRateV2'
              type: array
            eligibility:
              description: Eligibility criteria for the product
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV1'
              type: array
            features:
              description: Array of features available for the product
              items:
                $ref: '#/components/schemas/BankingProductFeatureV2'
              type: array
            fees:
              description: Fees applicable to the product
              items:
                $ref: '#/components/schemas/BankingProductFeeV1'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV2'
              type: array
          type: object
    ResponseBankingProductByIdV5:
      allOf:
        - $ref: '#/components/schemas/LinksMetaV1'
        - type: object
          properties:
            version:
              type: string
              default: V5
            data:
              $ref: '#/components/schemas/BankingProductDetailV5'
          required:
            - data
    BankingProductCardArtV2:
      properties:
        cardScheme:
          description: Card scheme available with the account.
          enum:
            - AMEX
            - EFTPOS
            - MASTERCARD
            - VISA
            - OTHER
          type: string
          example: OTHER
        cardType:
          description: Card type available with the account.
          enum:
            - CHARGE
            - CREDIT
            - DEBIT
          type: string
          example: DEBIT
        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
          format: uri
          x-cds-type: URIString
          example: https://acme.recipient/logo.png
      required:
        - cardScheme
        - cardType
        - imageUri
      type: object
    BankingProductV5:
      properties:
        productId:
          description: >-
            A data holder-specific unique identifier for a Banking 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
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (i.e. is
            available for origination). Used to enable the articulation of
            products to the regime before they are available for customers to
            originate.
          type: string
          format: date-time
          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
          format: date-time
          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
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV1'
        name:
          description: The display name of the product.
          type: string
          example: Example Product
        description:
          description: A description of the product.
          type: string
          example: An amazing example product
        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
          example: ACME
        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
          format: uri
          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
          example: true
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV2'
        cardArt:
          description: Information about any cards available with the account.
          items:
            $ref: '#/components/schemas/BankingProductCardArtV2'
          type: array
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    EnumBankingProductFeatureTypeV3:
      description: >+
        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | 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                                                                          
        |

        | 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.                                                                                                                                
        |
        NA                                                                                                                 
        |

        | GUARANTOR                       | Subject to terms and conditions, the
        customer may be able to nominate a guarantor during the origination
        process.                                                                                                                          
        |
        NA                                                                                                                 
        |

        | INSURANCE                       | Insurance is provided as an
        additional feature of the
        product                                                                                                                                                                              
        | Text description of the type of insurance (e.g. Travel
        Insurance)                                                   |

        | INSTALMENT_PLAN                 | The product has the option to pay
        for eligible purchases over time with a set number of
        payments.                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | 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                                                                                                                 
        |

      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CASHBACK_OFFER
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - 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
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - RELATIONSHIP_MANAGEMENT
        - UNLIMITED_TXNS
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV3:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            is set to OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV3'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductConstraintTypeV3:
      description: >
        Each Product or Account has a set of Constraints. These are explained in
        a table as follows:


        | Value           |
        Description                                                                                                                     
        | Use of `additionalValue` Field                               

        |-----------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
         MIN_BALANCE     | A minimum balance is required for the product                                                                                    | The minimum balance in AmountString format                   
         MAX_BALANCE     | A maximum balance is required for the product                                                                                    | The maximum balance in AmountString format                   
         OPENING_BALANCE | An opening balance is required for the product                                                                                   | The minimum opening 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_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                     
        | MAX_LVR         | A maximum LVR (Loan to Value Ratio)
        exists.                                                                                     
        | The maximum LVR in [RateString](#common-field-types) format. 

        | MIN_LVR         | A minimum LVR (Loan to Value Ratio)
        exists.                                                                                     
        | The minimum LVR in [RateString](#common-field-types) format. 

        | OTHER           | Another constraint that can not be included in any
        of the other categories. The additionalInfo field is mandatory for this
        type. | The minimum LVR in [RateString](#common-field-types) format. 
      enum:
        - MAX_BALANCE
        - MAX_LIMIT
        - MAX_LVR
        - MIN_BALANCE
        - MIN_LIMIT
        - MIN_LVR
        - OPENING_BALANCE
        - OTHER
      type: string
      example: MIN_BALANCE
    BankingProductConstraintV3:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the constraint. Mandatory
            if constraintType = OTHER
          type: string
          example: Some information about the constraint
        additionalInfoUri:
          description: Link to a web page with more information on the constraint
          type: string
          format: uri
          x-cds-type: URIString
          example: https://www.acmebank.com.au/products/constraints
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
            specified.  Whether mandatory or not is dependent on the value of
            [constraintType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductconstrainttypedoc)
          type: string
          example: Type specific value, see documentation
        constraintType:
          $ref: '#/components/schemas/EnumBankingProductConstraintTypeV3'
      required:
        - constraintType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductEligibilityV2:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the
            [eligibility](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            criteria. Mandatory if the eligibilityType value is OTHER.
          type: string
          example: Eligibility Criteria
        additionalInfoUri:
          description: >-
            Link to a web page with more information on this eligibility
            criteria
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
            specified. Whether mandatory or not is dependent on the value of
            [eligibilityType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproducteligibilitytypedoc)
          type: string
          example: Type dependent value, see docs
        eligibilityType:
          $ref: '#/components/schemas/EnumBankingProductEligibilityTypeV1'
      required:
        - eligibilityType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    EnumBankingProductFeeTypeV2:
      description: >

        Each Product or Account has a set of Fee Types. These are explained in a
        table as follows:

        | **Fee Type**       |
        **Description**                                                                                                            
        | **Additional Conditions / Notes**                                    |

        | ------------------ |
        ---------------------------------------------------------------------------------------------------------------------------
        | -------------------------------------------------------------------- |

        | `CASH_ADVANCE`     | A fee associated with a cash
        advance.                                                                                      
        | N/A                                                                  |

        | `DEPOSIT`          | A fee associated with making a
        deposit.                                                                                    
        | N/A                                                                  |

        | `DISHONOUR`        | A fee associated with a
        dishonour.                                                                                         
        | N/A                                                                  |

        | `ENQUIRY`          | A fee associated with an enquiry, including a
        balance
        enquiry.                                                              |
        N/A                                                                  |

        | `EVENT`            | A fee in relation to a particular event (e.g.,
        ordering a new card, viewing a balance or stopping a
        cheque).                |
        N/A                                                                  |

        | `EXIT`             | A fee for closing the
        product.                                                                                             
        | N/A                                                                  |

        | `LATE_PAYMENT`     | A fee associated with making a payment after a
        due
        date.                                                                   
        | Number of days late, after which the associated fee will be applied. |

        | `OTHER`            | Another fee that cannot be included in any of the
        other
        categories.                                                         |
        The `additionalInfo` field is **mandatory** for this type.           |

        | `PAYMENT`          | A fee associated with making a
        payment.                                                                                    
        | N/A                                                                  |

        | `PERIODIC`         | A periodic fee such as a monthly account
        servicing
        fee.                                                                    
        | The period of charge, formatted according to **ISO 8601 Durations**. |

        | `PURCHASE`         | A fee associated with making a purchase at a
        merchant.                                                                     
        | N/A                                                                  |

        | `REPLACEMENT`      | A fee associated with receiving a replacement,
        including cards, cheques, statements, security
        tokens.                       |
        N/A                                                                  |

        | `TRANSACTION`      | A fee associated with any transaction
        (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and
        PURCHASE).                             |
        N/A                                                                  |

        | `UPFRONT`          | A fee paid at the beginning of the product
        lifecycle, such as an establishment fee, loyalty program fee or
        application fee. |
        N/A                                                                  |

        | `UPFRONT_PER_PLAN` | A fee paid at the creation of a new payment plan,
        such as an instalment
        plan.                                               |
        N/A                                                                  |

        | `VARIATION`        | A fee associated with a request for a variation,
        including to an existing process, instruction or
        terms.                    |
        N/A                                                                  |

        | `WITHDRAWAL`       | A fee associated with making a
        withdrawal.                                                                                 
        | N/A                                                                  |
      enum:
        - CASH_ADVANCE
        - DEPOSIT
        - DISHONOUR
        - ENQUIRY
        - EVENT
        - EXIT
        - LATE_PAYMENT
        - OTHER
        - PAYMENT
        - PERIODIC
        - PURCHASE
        - REPLACEMENT
        - TRANSACTION
        - UPFRONT
        - UPFRONT_PER_PLAN
        - VARIATION
        - WITHDRAWAL
      example: CASH_ADVANCE
      type: string
    BankingFeeAmountV1:
      properties:
        amount:
          description: The specific amount charged for the fee each time it is incurred.
          type: string
          x-cds-type: AmountString
          example: '10.00'
      required:
        - amount
      type: object
    BankingFeeRangeV1:
      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
    BankingFeeRateV1:
      properties:
        rateType:
          description: >-
            Type of fee rate calculation.<ul><li>`BALANCE` A fee rate based on a
            balance</li><li>`INTEREST_ACCRUED` A fee rate based on interest
            accrued</li><li>`TRANSACTION` A fee rate based on a
            transaction.</li></ul>
          enum:
            - BALANCE
            - INTEREST_ACCRUED
            - TRANSACTION
          type: string
          example: BALANCE
        rate:
          description: The fee rate calculated according to the _rateType_.
          type: string
          x-cds-type: RateString
          example: '0.05'
        accrualFrequency:
          description: >-
            The indicative frequency with which the fee is calculated on the
            account if applicable. 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/BankingFeeRangeV1'
      required:
        - rate
        - rateType
      type: object
      x-conditional:
        - balanceRate
        - transactionRate
        - accruedRate
    BankingFeeDiscountAmountV1:
      properties:
        amount:
          description: >-
            The specific amount discounted from the fee each time it is
            incurred.
          type: string
          x-cds-type: AmountString
          example: '10.00'
      required:
        - amount
      type: object
    BankingFeeDiscountRangeV1:
      description: >-
        A minimum or maximum fee discount amount where a specific fixed amount
        is not known until the fee is incurred.
      properties:
        discountMinimum:
          description: The minimum fee discount that will be applied per occurrence.
          type: string
          x-cds-type: AmountString
        discountMaximum:
          description: The maximum fee discount that will be applied per occurrence.
          type: string
          x-cds-type: AmountString
      type: object
    BankingFeeDiscountRateV1:
      properties:
        rateType:
          description: >-
            Type of fee rate discount calculation.<ul><li>`BALANCE` A fee rate
            discount based on a balance</li><li>`FEE` A fee rate discount based
            on the fee to which the discount is
            attached</li><li>`INTEREST_ACCRUED` A fee rate discount based on
            interest accrued</li><li>`TRANSACTION` A fee rate discount based on
            a transaction.</li></ul>
          enum:
            - BALANCE
            - FEE
            - INTEREST_ACCRUED
            - TRANSACTION
          type: string
          example: FEE
        rate:
          description: The fee rate discount calculated according to the _rateType_.
          type: string
          x-cds-type: RateString
          example: '0.05'
        amountRange:
          $ref: '#/components/schemas/BankingFeeDiscountRangeV1'
      required:
        - rate
        - rateType
      type: object
    BankingProductDiscountV2:
      description: >-
        Note that the currency of the fee discount is expected to be the same as
        the currency of the fee itself.
      properties:
        description:
          description: Description of the discount.
          type: string
          example: Christmas special discount
        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
          example: PAYMENTS
        discountMethodUType:
          description: Reference to the applicable fee discount method structure.
          enum:
            - fixedAmount
            - rateBased
          type: string
          example: fixedAmount
        fixedAmount:
          allOf:
            - $ref: '#/components/schemas/BankingFeeDiscountAmountV1'
          description: >-
            Mandatory if the _discountMethodUType_ value is `fixedAmount`. Where
            the discount is a specific amount.
        rateBased:
          allOf:
            - $ref: '#/components/schemas/BankingFeeDiscountRateV1'
          description: >-
            Mandatory if the _discountMethodUType_ value is `rateBased`. Where
            the discount is based on a type of rate. Unless noted in
            _additionalInfo_, assumes the application and calculation frequency
            are the same as the corresponding fee.
        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
          format: uri
          x-cds-type: URIString
        eligibility:
          description: >-
            Eligibility constraints that apply to this discount. Mandatory if
            _discountType_ is `ELIGIBILITY_ONLY`.
          items:
            $ref: '#/components/schemas/BankingProductDiscountEligibilityV1'
          type: array
      required:
        - description
        - discountMethodUType
        - discountType
      type: object
      x-conditional:
        - fixedAmount
        - rateBased
        - additionalValue
        - eligibility
    BankingProductFeeV2:
      properties:
        name:
          description: Name of the fee.
          type: string
          example: Special fee
        feeType:
          $ref: '#/components/schemas/EnumBankingProductFeeTypeV2'
        feeMethodUType:
          description: Reference to the applicable fee charging method structure.
          enum:
            - fixedAmount
            - rateBased
            - variable
          type: string
          example: rateBased
        fixedAmount:
          allOf:
            - $ref: '#/components/schemas/BankingFeeAmountV1'
          description: >-
            Mandatory if the _feeMethodUType_ value is `fixedAmount`. Where the
            fee is a specific amount.
        rateBased:
          allOf:
            - $ref: '#/components/schemas/BankingFeeRateV1'
          description: >-
            Mandatory if the _feeMethodUType_ value is `rateBased`. Where the
            fee is based on a type of rate.
        variable:
          allOf:
            - $ref: '#/components/schemas/BankingFeeRangeV1'
          description: >-
            Mandatory if the _feeMethodUType_ value is `variable`. Where the
            amount or rate may not be known until the fee is incurred.
        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:
          default: AUD
          description: The currency the fee will be charged in. Assumes `AUD` if absent.
          type: string
          x-cds-type: CurrencyString
          pattern: \w{3}
        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. Mandatory if the
            feeType value is OTHER.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this fee.
          type: string
          format: uri
          x-cds-type: URIString
        discounts:
          description: An optional list of discounts to this fee that may be available.
          items:
            $ref: '#/components/schemas/BankingProductDiscountV2'
          type: array
      required:
        - feeMethodUType
        - feeType
        - name
      type: object
      x-conditional:
        - fixedAmount
        - rateBased
        - variable
        - additionalValue
        - additionalInfo
    BankingProductRateConditionV2:
      description: Defines a condition for the applicability of a rate.
      properties:
        rateApplicabilityType:
          description: >-
            Category of applicability condition associated with the rate. For
            more information refer to [Rate and Tier Applicability
            Types](#tocSbankingproductrateconditiondoc).
          enum:
            - MIN_DEPOSITS
            - MIN_DEPOSIT_AMOUNT
            - DEPOSIT_BALANCE_INCREASED
            - EXISTING_CUST
            - NEW_ACCOUNTS
            - NEW_CUSTOMER
            - NEW_CUSTOMER_TO_GROUP
            - ONLINE_ONLY
            - OTHER
            - MIN_PURCHASES
            - MAX_WITHDRAWALS
            - MAX_WITHDRAWAL_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. Mandatory
            if the
            [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc) value
            is `OTHER`.
          type: string
        additionalInfoUri:
          description: Link to a web page with more information on this condition.
          type: string
          format: uri
          x-cds-type: URIString
      required:
        - rateApplicabilityType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductRateTierV4:
      description: Defines the criteria and conditions for which a rate applies.
      properties:
        name:
          description: A display name for the tier.
          type: string
          example: Sample display name
        unitOfMeasure:
          description: >-
            The unit of measure that applies to the _minimumValue_ and
            _maximumValue_ values, e.g.,<ul><li>`DOLLAR` for a dollar amount
            (with values in AmountString format)<li>`PERCENT` for Loan-to-Value
            Ratio or LVR (with values in RateString format)<li>`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).</ul>
          enum:
            - DAY
            - DOLLAR
            - MONTH
            - PERCENT
          type: string
          example: DAY
        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
          example: '10'
        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: Applicability conditions for the rate 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
          format: uri
          x-cds-type: URIString
      required:
        - minimumValue
        - name
        - unitOfMeasure
      type: object
    BankingProductDepositRateV3:
      properties:
        depositRateType:
          $ref: '#/components/schemas/EnumBankingDepositRateTypeV1'
        rate:
          description: The rate to be applied.
          type: string
          x-cds-type: RateString
          example: '0.05'
        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.
          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). Mandatory if the _applicationType_
            value is `PERIODIC`.
          type: string
          x-cds-type: ExternalRef
        tiers:
          description: Rate tiers applicable for this rate.
          items:
            $ref: '#/components/schemas/BankingProductRateTierV4'
          type: array
        applicabilityConditions:
          description: Applicability conditions for the 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
          format: uri
          x-cds-type: URIString
      required:
        - applicationType
        - depositRateType
        - rate
      type: object
      x-conditional:
        - additionalValue
        - applicationFrequency
    EnumBankingLendingRateTypeV2:
      description: >
        The type of rate (base, bonus, etc). These are explained in a table as
        follows:


        | 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                     
         VARIABLE                 | A variable base rate for the product                                                                                                       | NA                                                                                      
         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 
         DISCOUNT                 | A specific discount rate that may be applied. A discount rate reduces the interest payable                                                 | Description of the discount rate that is applicable                                     
         PENALTY                  | A specific penalty rate that may be applied. A penalty rate increases the interest payable                                                 | Description of the penalty rate that is applicable                                      
         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                                                           
         CASH_ADVANCE             | Specific rate applied to cash advances from the account                                                                                    | NA                                                                                      
         PURCHASE                 | Specific rate applied to purchases from the account                                                                                        | NA                                                                                      
         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                                                                  
         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                                                                  
      enum:
        - BUNDLE_DISCOUNT_FIXED
        - BUNDLE_DISCOUNT_VARIABLE
        - CASH_ADVANCE
        - DISCOUNT
        - FIXED
        - FLOATING
        - INTRODUCTORY
        - MARKET_LINKED
        - PENALTY
        - PURCHASE
        - VARIABLE
        - BALANCE_TRANSFER
      type: string
      example: FIXED
    EnumBankingProductLendingRateRepaymentTypeV2:
      description: Option in place for repayments.
      enum:
        - INTEREST_ONLY
        - OTHER
        - PRINCIPAL_AND_INTEREST
        - UNCONSTRAINED
      type: string
    EnumBankingLoanPurposeV2:
      description: The reason for taking out the loan.
      enum:
        - INVESTMENT
        - OTHER
        - OWNER_OCCUPIED
        - UNCONSTRAINED
      type: string
    BankingProductLendingRateV3:
      properties:
        lendingRateType:
          $ref: '#/components/schemas/EnumBankingLendingRateTypeV2'
        rate:
          description: The rate to be applied.
          type: string
          x-cds-type: RateString
          example: '0.05'
        comparisonRate:
          description: A comparison rate equivalent for this rate.
          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.
          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). Mandatory if the _applicationType_
            value is `PERIODIC`.
          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:
          $ref: '#/components/schemas/EnumBankingProductLendingRateRepaymentTypeV2'
        loanPurpose:
          $ref: '#/components/schemas/EnumBankingLoanPurposeV2'
        tiers:
          description: Rate tiers applicable for this rate.
          items:
            $ref: '#/components/schemas/BankingProductRateTierV4'
          type: array
        applicabilityConditions:
          description: Applicability conditions for the rate.
          items:
            $ref: '#/components/schemas/BankingProductRateConditionV2'
          type: array
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [_lendingRateType_] specified. Whether mandatory or not is dependent
            on the value of [_lendingRateType_].
          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
          format: uri
          x-cds-type: URIString
      required:
        - applicationType
        - lendingRateType
        - loanPurpose
        - rate
        - repaymentType
      type: object
      x-conditional:
        - additionalValue
        - applicationFrequency
    BankingProductDetailV6:
      allOf:
        - $ref: '#/components/schemas/BankingProductV5'
        - 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 _productID_ values 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/BankingProductBundleV1'
              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/BankingProductConstraintV3'
              type: array
            eligibility:
              description: Eligibility criteria for the product.
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV2'
              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/BankingProductDepositRateV3'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances.
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV3'
              type: array
          type: object
    ResponseBankingProductByIdV6:
      allOf:
        - $ref: '#/components/schemas/LinksMetaV1'
        - type: object
          properties:
            version:
              type: string
              default: V6
            data:
              $ref: '#/components/schemas/BankingProductDetailV6'
          required:
            - data
    EnumBankingProductCategoryV2:
      description: >+
        The productCategory enumeration provides the values for categorising
        products and accounts. These are explained in the

        following tables:


        **Deposit Products**


        | Enum                       |
        Description                                                                                                                                                                                                                                                                                                      

        |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

        | 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... |

        | 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.                    |

        | TRAVEL_CARDS               | This grouping of products includes
        prepaid cards with multi-currency
        capabilities.                                                                                                                                                                                                                              
        |

        | REGULATED_TRUST_ACCOUNTS   | This grouping of products includes
        accounts were funds are held in trust in regulated industries with
        complex rules embedded on how the products must operate. Industries that
        require this sort of product include real estate agents, solicitors and
        conveyancers.                                             |


        **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 includes products regulated as a
        buy now pay later arrangement under the National Consumer Credit
        Protection Act 2009 and other Buy Now, Pay Later (BNPL) products with
        key characteristics which may include (but are not limited to): the
        provision of finance (excluding supplying cash), the involvement of a
        third-party financing entity, a fixed charge for providing credit under
        a prescribed limit instead of charging interest, and a fixed charge for
        missing a payment. |

        | 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.                                                                                                                                                                                                                                                                                     

      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
      example: TRANS_AND_SAVINGS_ACCOUNTS
    BankingProductV6:
      properties:
        productId:
          description: >-
            A data holder-specific unique identifier for a Banking 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
          example: 9bf2cae7-ca32-4124-905b-68404de9628f
        effectiveFrom:
          description: >-
            The date and time from which this product is effective (i.e. is
            available for origination). Used to enable the articulation of
            products to the regime before they are available for customers to
            originate.
          type: string
          format: date-time
          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
          format: date-time
          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
          format: date-time
          x-cds-type: DateTimeString
          example: '2022-08-20T03:01:42+00:00'
        productCategory:
          $ref: '#/components/schemas/EnumBankingProductCategoryV2'
        name:
          description: The display name of the product.
          type: string
          example: Example Product
        description:
          description: A description of the product.
          type: string
          example: An amazing example product
        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
          example: ACME
        brandName:
          description: An optional display name of the brand.
          type: string
        brandGroup:
          description: >-
            The *brandGroup* of a consumer data sharing brand that the product
            is associated with.
          type: string
          x-cds-type: ASCIIString
        applicationUri:
          description: >-
            A link to an application web page where this product can be applied
            for.
          type: string
          format: uri
          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
          example: true
        additionalInformation:
          $ref: '#/components/schemas/BankingProductAdditionalInformationV2'
        cardArt:
          description: Information about any cards available with the account.
          items:
            $ref: '#/components/schemas/BankingProductCardArtV2'
          type: array
      required:
        - brand
        - description
        - isTailored
        - lastUpdated
        - name
        - productCategory
        - productId
      type: object
    EnumBankingProductFeatureTypeV4:
      description: >+
        Each Product or Account has a set of Product Features. These are
        explained in a table as follows:


        | 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                                                                          
        |

        | 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.                                                                                                                                                          
        |
        NA                                                                                                                 
        |

        | GUARANTOR                       | Subject to terms and conditions, the
        customer may be able to nominate a guarantor during the origination
        process.                                                                                                                                                    
        |
        NA                                                                                                                 
        |

        | INSURANCE                       | Insurance is provided as an
        additional feature of the
        product                                                                                                                                                                                                        
        | Text description of the type of insurance (e.g. Travel
        Insurance)                                                   |

        | INSTALMENT_PLAN                 | The product has the option to pay
        for eligible purchases over time with a set number of
        payments.                                                                                                                                                                    
        |
        NA                                                                                                                 
        |

        | 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                                                                                                                 
        |

        | EXTRA_DOWN_PAYMENT              | When a transaction value would
        exceed the credit limit available for an instalment plan, there is an
        ability to make a larger than usual initial down payment to enable the
        creation of a plan based on a reduced amount outstanding, so it remains
        within the limit. |
        NA                                                                                                                 
        |

      enum:
        - ADDITIONAL_CARDS
        - BALANCE_TRANSFERS
        - BILL_PAYMENT
        - BONUS_REWARDS
        - CASHBACK_OFFER
        - CARD_ACCESS
        - COMPLEMENTARY_PRODUCT_DISCOUNTS
        - 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
        - NOTIFICATIONS
        - NPP_ENABLED
        - NPP_PAYID
        - OFFSET
        - OTHER
        - OVERDRAFT
        - REDRAW
        - RELATIONSHIP_MANAGEMENT
        - UNLIMITED_TXNS
        - EXTRA_DOWN_PAYMENT
      type: string
      example: CARD_ACCESS
    BankingProductFeatureV4:
      properties:
        additionalInfo:
          description: >-
            Display text providing more information on the feature. Mandatory if
            the [feature
            type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            value is OTHER
          type: string
          example: Additional Feature Information
        additionalInfoUri:
          description: Link to a web page with more information on this feature
          type: string
          format: uri
          x-cds-type: URIString
        additionalValue:
          description: >-
            Generic field containing additional information relevant to the
            [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
            specified. Whether mandatory or not is dependent on the value of the
            [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc)
          example: Type specific value, see docs
          type: string
        featureType:
          $ref: '#/components/schemas/EnumBankingProductFeatureTypeV4'
      required:
        - featureType
      type: object
      x-conditional:
        - additionalValue
        - additionalInfo
    BankingProductInstalmentsV1:
      description: Details of instalment features on the account.
      properties:
        maximumConcurrentPlans:
          description: >-
            Maximum number of concurrent active instalment plans that may be
            created on the account. If `null`, there is no predetermined maximum
            number.
          type: integer
          x-cds-type: NaturalNumber
        instalmentsLimit:
          description: >-
            Maximum combined limit of all instalment plans that may be created
            on the account. If `null` or not present, an opened account balance
            _creditLimit_ may be assumed to provide a maximum limit for
            instalments.
          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. If `null` or
            not present, _instalmentsLimit_ is assumed to be the maximum
            individual plan value.
          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:
        - maximumSplit
        - minimumSplit
      type: object
    BankingProductDetailV7:
      allOf:
        - $ref: '#/components/schemas/BankingProductV6'
        - 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 _productID_ values 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/BankingProductBundleV1'
              type: array
            features:
              description: Array of features and limitations of the product.
              items:
                $ref: '#/components/schemas/BankingProductFeatureV4'
              type: array
            constraints:
              description: >-
                Constraints on the application for the product such as minimum
                balances or limit thresholds.
              items:
                $ref: '#/components/schemas/BankingProductConstraintV3'
              type: array
            eligibility:
              description: Eligibility criteria for the product.
              items:
                $ref: '#/components/schemas/BankingProductEligibilityV2'
              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/BankingProductDepositRateV3'
              type: array
            lendingRates:
              description: Interest rates charged against lending balances.
              items:
                $ref: '#/components/schemas/BankingProductLendingRateV3'
              type: array
            instalments:
              $ref: '#/components/schemas/BankingProductInstalmentsV1'
          type: object
    ResponseBankingProductByIdV7:
      allOf:
        - $ref: '#/components/schemas/LinksMetaV1'
        - type: object
          properties:
            version:
              type: string
              default: V7
            data:
              $ref: '#/components/schemas/BankingProductDetailV7'
          required:
            - data
    ResponseBankingProductById:
      oneOf:
        - $ref: '#/components/schemas/ResponseBankingProductByIdV3'
        - $ref: '#/components/schemas/ResponseBankingProductByIdV4'
        - $ref: '#/components/schemas/ResponseBankingProductByIdV5'
        - $ref: '#/components/schemas/ResponseBankingProductByIdV6'
        - $ref: '#/components/schemas/ResponseBankingProductByIdV7'
      discriminator:
        propertyName: version
        mapping:
          V3: '#/components/schemas/ResponseBankingProductByIdV3'
          V4: '#/components/schemas/ResponseBankingProductByIdV4'
          V5: '#/components/schemas/ResponseBankingProductByIdV5'
          V6: '#/components/schemas/ResponseBankingProductByIdV6'
          V7: '#/components/schemas/ResponseBankingProductByIdV7'
    ErrorFieldMissingV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Field/Missing
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Missing Required Field
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the parameter name of the missing field.
          type: string
          example: fieldName missing
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Field/Missing
          type: object
      required:
        - code
        - title
        - detail
    ErrorHeaderInvalidVersionV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/InvalidVersion
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Version
        detail:
          description: Holds a human readable description of this specific error.
          type: string
          example: Invalid Version specified
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/InvalidVersion
          type: object
      required:
        - code
        - title
        - detail
    ErrorGeneralExpectedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:GeneralError/Expected
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Expected Error Encountered
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be populated with a meaningful error description,
            without revealing sensitive information.
          type: string
          example: General Expected error occurred
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:GeneralError/Expected
          type: object
      required:
        - code
        - title
        - detail
    ErrorHeaderMissingV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/Missing
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Missing Required Header
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the HTTP header name.
          type: string
          example: Required header headerName is missing
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/Missing
          type: object
      required:
        - code
        - title
        - detail
    ErrorHeaderInvalidV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/Invalid
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Header
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be the HTTP header name. The error detail MAY include
            further details explaining the valid format.
          type: string
          example: Supplied header headerName was invalid
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/Invalid
          type: object
      required:
        - code
        - title
        - detail
    GetProductDetail400Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorFieldMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
        - $ref: '#/components/schemas/ErrorHeaderMissingV1'
        - $ref: '#/components/schemas/ErrorHeaderInvalidV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Field/Missing: '#/components/schemas/ErrorFieldMissingV1'
          urn:au-cds:error:cds-all:Header/InvalidVersion: '#/components/schemas/ErrorHeaderInvalidVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
          urn:au-cds:error:cds-all:Header/Missing: '#/components/schemas/ErrorHeaderMissingV1'
          urn:au-cds:error:cds-all:Header/Invalid: '#/components/schemas/ErrorHeaderInvalidV1'
    ErrorResourceUnavailableV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/Unavailable
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unavailable Resource
        detail:
          description: >-
            The requested resource identifier is temporarily unavailable.
            Subsequent requests for the resource may be successful. Applies when
            the resource ID is provided in the request body. The error detail is
            the resource ID of the resource being requested.
          type: string
          example: The requested resource identifier is temporarily unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/Unavailable
          type: object
      required:
        - code
        - title
        - detail
    ErrorResourceNotFoundV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/NotFound
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Resource Not Found
        detail:
          description: >-
            The requested resource URL is not an API endpoint defined by the
            Consumer Data Standards and it is not a URL recognised by the Data
            Holder or Data Recipient.
          type: string
          example: >-
            The requested resource URL is not an API endpoint defined by the
            Consumer Data Standards
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/NotFound
          type: object
      required:
        - code
        - title
        - detail
    ErrorResourceInvalidV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/Invalid
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Invalid Resource
        detail:
          description: >-
            The requested resource identifier is permanently unavailable. No
            subsequent request for the resource will be successful. Applies when
            the resource ID is provided in the URI. The error detail is the
            resource ID of the resource being requested.
          type: string
          example: The requested resource identifier is permanently unavailable.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/Invalid
          type: object
      required:
        - code
        - title
        - detail
    ErrorResourceNotImplementedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Resource/NotImplemented
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Resource Not Implemented
        detail:
          description: >-
            The requested resource URL is a valid API endpoint defined by the
            Consumer Data Standards, but it is not implemented or not currently
            supported.
          type: string
          example: >-
            The requested resource URL is a valid API endpoint defined by the
            Consumer Data Standards, but it is not implemented or not currently
            supported.
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Resource/NotImplemented
          type: object
      required:
        - code
        - title
        - detail
    GetProductDetail404Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorResourceUnavailableV1'
        - $ref: '#/components/schemas/ErrorResourceNotFoundV1'
        - $ref: '#/components/schemas/ErrorResourceInvalidV1'
        - $ref: '#/components/schemas/ErrorResourceNotImplementedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Resource/Unavailable: '#/components/schemas/ErrorResourceUnavailableV1'
          urn:au-cds:error:cds-all:Resource/NotFound: '#/components/schemas/ErrorResourceNotFoundV1'
          urn:au-cds:error:cds-all:Resource/Invalid: '#/components/schemas/ErrorResourceInvalidV1'
          urn:au-cds:error:cds-all:Resource/NotImplemented: '#/components/schemas/ErrorResourceNotImplementedV1'
    ErrorHeaderUnsupportedVersionV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Header/UnsupportedVersion
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unsupported Version
        detail:
          description: >-
            A request is made for a version that is lower than the minimum
            version or greater than maximum version the Data Holder supports for
            the requested endpoint. The error detail MAY include the minimum and
            maximum versions the Data Holder supports.
          type: string
          example: Unsupported Version Requested
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Header/UnsupportedVersion
          type: object
      required:
        - code
        - title
        - detail
    GetProductDetail406Item:
      oneOf:
        - $ref: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
        - $ref: '#/components/schemas/ErrorGeneralExpectedV1'
      discriminator:
        propertyName: code
        mapping:
          urn:au-cds:error:cds-all:Header/UnsupportedVersion: '#/components/schemas/ErrorHeaderUnsupportedVersionV1'
          urn:au-cds:error:cds-all:GeneralError/Expected: '#/components/schemas/ErrorGeneralExpectedV1'
    ErrorGeneralUnexpectedV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:GeneralError/Unexpected
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Unexpected Error Encountered
        detail:
          description: >-
            Holds a human readable description of this specific error. The error
            detail SHOULD be populated with a meaningful error description,
            without revealing sensitive information.
          type: string
          example: General Unexpected error occurred
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:GeneralError/Unexpected
          type: object
      required:
        - code
        - title
        - detail
    ErrorServiceUnavailableV1:
      type: object
      properties:
        code:
          description: >-
            Holds an endpoint specific error code. This MAY be a standard CDR
            error code or an application-specific error code.
          type: string
          default: urn:au-cds:error:cds-all:Service/Unavailable
        title:
          description: Holds a human readable label of the error that is constant per code
          type: string
          default: Service Unavailable
        detail:
          description: Holds a human readable description of this specific error
          type: string
          example: Service Currently Unavailable
        meta:
          description: Holds additional endpoint specific data relevant to the error
          properties:
            urn:
              description: Holds a standard CDR error code
              type: string
              format: uri
              x-cds-type: URIString
              default: urn:au-cds:error:cds-all:Service/Unavailable
          type: object
      required:
        - code
        - title
        - detail
  responses:
    GetBankingProductDetail:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseBankingProductById'
    GetProductDetail400:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetProductDetail400Item'
                type: array
            required:
              - errors
            type: object
    GetProductDetail404:
      description: Resource Not Found
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetProductDetail404Item'
                type: array
            required:
              - errors
            type: object
    GetProductDetail406:
      description: Not Acceptable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/GetProductDetail406Item'
                type: array
            required:
              - errors
            type: object
    Generic500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ErrorGeneralUnexpectedV1'
                type: array
            required:
              - errors
            type: object
    Generic503:
      description: Service Unavailable
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/ErrorServiceUnavailableV1'
                type: array
            required:
              - errors
            type: object
