openapi: 3.0.3
info:
  contact:
    email: contact@dsb.gov.au
    name: Data Standards Body
    url: https://dsb.gov.au/
  description: Specifications for resource endpoints applicable to data holders in the Banking sector.
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  title: CDR Accounts Banking API
  version: 1.36.0
servers:
- description: MTLS
  url: https://mtls.dh.example.com/cds-au/v1
tags:
- name: Banking
paths:
  /banking/accounts:
    get:
      tags:
      - Banking
      summary: Get Accounts
      description: Obtain a list of accounts
      operationId: listAccounts
      parameters:
      - name: product-category
        in: query
        description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
        schema:
          type: string
          enum:
          - TRANS_AND_SAVINGS_ACCOUNTS
          - TERM_DEPOSITS
          - TRAVEL_CARDS
          - REGULATED_TRUST_ACCOUNTS
          - RESIDENTIAL_MORTGAGES
          - CRED_AND_CHRG_CARDS
          - PERS_LOANS
          - MARGIN_LOANS
          - LEASES
          - TRADE_FINANCE
          - OVERDRAFTS
          - BUSINESS_LOANS
      - name: open-status
        in: query
        description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
        schema:
          type: string
          default: ALL
          enum:
          - OPEN
          - CLOSED
          - ALL
      - name: is-owned
        in: query
        description: Filters accounts based on whether they are owned by the authorised customer.  True for owned accounts, false for unowned accounts and absent for all accounts
        schema:
          type: boolean
          x-cds-type: Boolean
        x-cds-type: Boolean
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingAccountList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:accounts.basic:read
      - default:
        - bank:accounts.basic:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/accounts/balances:
    get:
      tags:
      - Banking
      summary: Get Bulk Balances
      description: Obtain balances for multiple, filtered accounts
      operationId: listBalancesBulk
      parameters:
      - name: product-category
        in: query
        description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
        schema:
          type: string
          enum:
          - TRANS_AND_SAVINGS_ACCOUNTS
          - TERM_DEPOSITS
          - TRAVEL_CARDS
          - REGULATED_TRUST_ACCOUNTS
          - RESIDENTIAL_MORTGAGES
          - CRED_AND_CHRG_CARDS
          - PERS_LOANS
          - MARGIN_LOANS
          - LEASES
          - TRADE_FINANCE
          - OVERDRAFTS
          - BUSINESS_LOANS
      - name: open-status
        in: query
        description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
        schema:
          type: string
          default: ALL
          enum:
          - OPEN
          - CLOSED
          - ALL
      - name: is-owned
        in: query
        description: Filters accounts based on whether they are owned by the authorised customer.  True for owned accounts, false for unowned accounts and absent for all accounts
        schema:
          type: boolean
          x-cds-type: Boolean
        x-cds-type: Boolean
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:accounts.basic:read
      - default:
        - bank:accounts.basic:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
    post:
      tags:
      - Banking
      summary: Get Balances For Specific Accounts
      description: Obtain balances for a specified list of accounts
      operationId: listBalancesSpecificAccounts
      parameters:
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      requestBody:
        description: The list of account IDs to obtain balances for
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestAccountIds'
        required: true
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:accounts.basic:read
      - default:
        - bank:accounts.basic:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
      x-codegen-request-body-name: accountIds
  /banking/accounts/{accountId}/balance:
    get:
      tags:
      - Banking
      summary: Get Account Balance
      description: Obtain the balance for a single specified account
      operationId: getBalance
      parameters:
      - name: accountId
        in: path
        description: ID of the specific account requested
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
          default: '1'
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingAccountsBalanceById'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:accounts.basic:read
      - default:
        - bank:accounts.basic:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/accounts/{accountId}:
    get:
      tags:
      - Banking
      summary: Get Account Detail
      description: Obtain detailed information on a single account
      operationId: getAccountDetail
      parameters:
      - name: accountId
        in: path
        description: A tokenised identifier for the account which is unique but not shareable
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '4'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingAccountById'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:accounts.detail:read
      - default:
        - bank:accounts.detail:read
      x-version: '4'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/accounts/{accountId}/transactions:
    get:
      tags:
      - Banking
      summary: Get Transactions For Account
      description: "Obtain transactions for a specific account.\n\nSome general notes that apply to all end points that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the date/time which will be defined as:\n\t\t- Posted date/time if available, then\n\t\t- Execution date/time if available, then\n\t\t- A reasonable date/time nominated by the data holder using internal data structures\n- For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account\n- For aggregated transactions (ie. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information accross the subsidiary transactions as possible, is required to be shared"
      operationId: getTransactions
      parameters:
      - name: accountId
        in: path
        description: ID of the account to get transactions for.  Must have previously been returned by one of the account list end points.
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: oldest-time
        in: query
        description: Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days.  Format is aligned to DateTimeString common type
        schema:
          type: string
          x-cds-type: DateTimeString
        x-cds-type: DateTimeString
      - name: newest-time
        in: query
        description: Constrain the transaction history request to transactions with effective time at or before this date/time.  If absent defaults to today.  Format is aligned to DateTimeString common type
        schema:
          type: string
          x-cds-type: DateTimeString
        x-cds-type: DateTimeString
      - name: min-amount
        in: query
        description: Filter transactions to only transactions with amounts higher or equal to than this amount
        schema:
          type: string
          x-cds-type: AmountString
        x-cds-type: AmountString
      - name: max-amount
        in: query
        description: Filter transactions to only transactions with amounts less than or equal to than this amount
        schema:
          type: string
          x-cds-type: AmountString
        x-cds-type: AmountString
      - name: text
        in: query
        description: Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)
        schema:
          type: string
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingTransactionList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:transactions:read
      - default:
        - bank:transactions:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/accounts/{accountId}/transactions/{transactionId}:
    get:
      tags:
      - Banking
      summary: Get Transaction Detail
      description: Obtain detailed information on a transaction for a specific account
      operationId: getTransactionDetail
      parameters:
      - name: accountId
        in: path
        description: ID of the account to get transactions for.  Must have previously been returned by one of the account list end points
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: transactionId
        in: path
        description: ID of the transaction obtained from a previous call to one of the other transaction end points
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ResponseBankingTransactionByIdV2'
                - $ref: '#/components/schemas/ResponseBankingTransactionById'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:transactions:read
      - default:
        - bank:transactions:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/accounts/{accountId}/direct-debits:
    get:
      tags:
      - Banking
      summary: Get Direct Debits For Account
      description: Obtain direct debit authorisations for a specific account
      operationId: listDirectDebits
      parameters:
      - name: accountId
        in: path
        description: ID of the account to get direct debit authorisations for.  Must have previously been returned by one of the account list end points.
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:regular_payments:read
      - default:
        - bank:regular_payments:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/accounts/direct-debits:
    get:
      tags:
      - Banking
      summary: Get Bulk Direct Debits
      description: Obtain direct debit authorisations for multiple, filtered accounts
      operationId: listDirectDebitsBulk
      parameters:
      - name: product-category
        in: query
        description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
        schema:
          type: string
          enum:
          - TRANS_AND_SAVINGS_ACCOUNTS
          - TERM_DEPOSITS
          - TRAVEL_CARDS
          - REGULATED_TRUST_ACCOUNTS
          - RESIDENTIAL_MORTGAGES
          - CRED_AND_CHRG_CARDS
          - PERS_LOANS
          - MARGIN_LOANS
          - LEASES
          - TRADE_FINANCE
          - OVERDRAFTS
          - BUSINESS_LOANS
      - name: open-status
        in: query
        description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
        schema:
          type: string
          default: ALL
          enum:
          - OPEN
          - CLOSED
          - ALL
      - name: is-owned
        in: query
        description: Filters accounts based on whether they are owned by the authorised customer.  True for owned accounts, false for unowned accounts and absent for all accounts
        schema:
          type: boolean
          x-cds-type: Boolean
        x-cds-type: Boolean
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers)
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:regular_payments:read
      - default:
        - bank:regular_payments:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
    post:
      tags:
      - Banking
      summary: Get Direct Debits For Specific Accounts
      description: Obtain direct debit authorisations for a specified list of accounts
      operationId: listDirectDebitsSpecificAccounts
      parameters:
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers)
        required: true
        schema:
          type: string
          default: '1'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      requestBody:
        description: Array of specific accountIds to obtain authorisations for
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestAccountIds'
        required: true
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:regular_payments:read
      - default:
        - bank:regular_payments:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
      x-codegen-request-body-name: accountIds
  /banking/accounts/{accountId}/payments/scheduled:
    get:
      tags:
      - Banking
      summary: Get Scheduled Payments for Account
      description: Obtain scheduled, outgoing payments for a specific account
      operationId: listScheduledPayments
      parameters:
      - name: accountId
        in: path
        description: ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers)
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:regular_payments:read
      - default:
        - bank:regular_payments:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/payments/scheduled:
    get:
      tags:
      - Banking
      summary: Get Scheduled Payments Bulk
      description: Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
      operationId: listScheduledPaymentsBulk
      parameters:
      - name: product-category
        in: query
        description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
        schema:
          type: string
          enum:
          - TRANS_AND_SAVINGS_ACCOUNTS
          - TERM_DEPOSITS
          - TRAVEL_CARDS
          - REGULATED_TRUST_ACCOUNTS
          - RESIDENTIAL_MORTGAGES
          - CRED_AND_CHRG_CARDS
          - PERS_LOANS
          - MARGIN_LOANS
          - LEASES
          - TRADE_FINANCE
          - OVERDRAFTS
          - BUSINESS_LOANS
      - name: open-status
        in: query
        description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
        schema:
          type: string
          default: ALL
          enum:
          - OPEN
          - CLOSED
          - ALL
      - name: is-owned
        in: query
        description: Filters accounts based on whether they are owned by the authorised customer.  True for owned accounts, false for unowned accounts and absent for all accounts
        schema:
          type: boolean
          x-cds-type: Boolean
        x-cds-type: Boolean
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:regular_payments:read
      - default:
        - bank:regular_payments:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
    post:
      tags:
      - Banking
      summary: Get Scheduled Payments For Specific Accounts
      description: Obtain scheduled payments for a specified list of accounts
      operationId: listScheduledPaymentsSpecificAccounts
      parameters:
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      requestBody:
        description: Array of specific accountIds to obtain scheduled payments for.  The accounts specified are the source of funds for the payments returned
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestAccountIds'
        required: true
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:regular_payments:read
      - default:
        - bank:regular_payments:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
      x-codegen-request-body-name: accountIds
  /banking/payees:
    get:
      tags:
      - Banking
      summary: Get Payees
      description: Obtain a list of pre-registered payees
      operationId: listPayees
      parameters:
      - name: type
        in: query
        description: Filter on the payee type field.  In addition to normal type field values, ALL can be specified to retrieve all payees.  If absent the assumed value is ALL
        schema:
          type: string
          default: ALL
          enum:
          - DOMESTIC
          - INTERNATIONAL
          - BILLER
          - ALL
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingPayeeList'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:payees:read
      - default:
        - bank:payees:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/payees/{payeeId}:
    get:
      tags:
      - Banking
      summary: Get Payee Detail
      description: 'Obtain detailed information on a single payee.


        Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient'
      operationId: getPayeeDetail
      parameters:
      - name: payeeId
        in: path
        description: The ID used to locate the details of a particular payee
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
        required: true
        schema:
          type: string
          default: '2'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
        schema:
          type: string
      - name: x-fapi-interaction-id
        in: header
        description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
        schema:
          type: string
          format: uuid
      - name: x-fapi-auth-date
        in: header
        description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-fapi-customer-ip-address
        in: header
        description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
        schema:
          type: string
      - name: x-cds-client-headers
        in: header
        description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls.  Not required for unattended or unauthenticated calls.
        schema:
          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
          type: string
          x-cds-type: Base64
        x-cds-type: Base64
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
              schema:
                type: string
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingPayeeById'
        '400':
          description: Bad Request
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          headers:
            x-fapi-interaction-id:
              description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      security:
      - PSUOAuth2Security:
        - bank:payees:read
      - default:
        - bank:payees:read
      x-version: '1'
      x-auth-type: Application User
      x-throttling-tier: Unlimited
  /banking/products:
    get:
      tags:
      - Banking
      summary: Get Products
      description: 'Obtain a list of products that are currently openly offered to the market


        Note that the results returned by this end point are expected to be ordered according to updated-since


        ### Conventions

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


        #### Arrays Of Features


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


        - Each element in an array has the same structure so that clients can reliably interpret the payloads

        - Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.

        - Each element has a field name [additionalValue](https://consumerdatastandardsaustralia.github.io/standards/#productfeaturetypedoc).  This is a generic field with contents that will vary based on the type of object being described. The contents of this field for the ADDITIONAL_CARDS feature is the number of cards allowed while the contents of this field for the MAX_LIMIT constraint would be the maximum credit limit allowed for the product.

        - An element in these arrays of the same type may appear more than once. For instance, a product may offer two separate loyalty programs that the customer can select from. A fixed term mortgage may have different rates for different term lengths.

        - An element in these arrays may contain an additionalInfo and additionalInfoUri field. The additionalInfo field is used to provide displayable text clarifying the purpose of the element in some way when the product is presented to a customer. The additionalInfoUri provides a link to externally hosted information specifically relevant to that feature of the product.

        - Depending on the type of data being represented there may be additional specific fields.


        #### URIs To More Information


        As the complexities and nuances of a financial product can not easily be fully expressed in a data structure without a high degree of complexity it is necessary to provide additional reference information that a potential customer can access so that they are fully informed of the features and implications of the product. The payloads for product reference therefore contain numerous fields that are provided to allow the product holder to describe the product more fully using a web page hosted on their online channels.


        These URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use difference HTML anchors to focus on a specific topic such as eligibility or fees.


        #### Linkage To Accounts

        From the moment that a customer applies for a product and an account is created the account and the product that spawned it will diverge.  Rates and features of the product may change and a discount may be negotiated for the account.


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


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


        #### Dates

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


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


        NOTE: This version must be implemented by **July 2026**


        Obsolete versions: [v1](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v1.html) [v2](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v2.html),[v3](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v3.html)'
      operationId: listProducts
      parameters:
      - name: effective
        in: query
        description: Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are 'CURRENT', 'FUTURE' and 'ALL'. If absent defaults to 'CURRENT'
        schema:
          type: string
          default: CURRENT
          enum:
          - CURRENT
          - FUTURE
          - ALL
      - name: updated-since
        in: query
        description: Only include products that have been updated after the specified date and time. If absent defaults to include all products
        schema:
          type: string
          x-cds-type: DateTimeString
        x-cds-type: DateTimeString
      - name: brand
        in: query
        description: Filter results based on a specific brand
        schema:
          type: string
      - name: product-category
        in: query
        description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all products returned.
        schema:
          type: string
          enum:
          - TRANS_AND_SAVINGS_ACCOUNTS
          - TERM_DEPOSITS
          - TRAVEL_CARDS
          - REGULATED_TRUST_ACCOUNTS
          - RESIDENTIAL_MORTGAGES
          - CRED_AND_CHRG_CARDS
          - PERS_LOANS
          - MARGIN_LOANS
          - LEASES
          - TRADE_FINANCE
          - BUY_NOW_PAY_LATER
          - OVERDRAFTS
          - BUSINESS_LOANS
      - name: page
        in: query
        description: Page of results to request (standard pagination)
        schema:
          type: integer
          default: 1
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: page-size
        in: query
        description: Page size to request. Default is 25 (standard pagination)
        schema:
          type: integer
          default: 25
          x-cds-type: PositiveInteger
        x-cds-type: PositiveInteger
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ) and [x-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ). If the value of [x-min-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ) is equal to or higher than the value of [x-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ) then the [x-min-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ) header should be 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://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ )
        required: true
        schema:
          type: string
          default: '5'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ) and [x-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*response-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAM6QvIGb$ ) of the API end point that the data holder has responded with.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingProductList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      x-version: '5'
  /banking/products/{productId}:
    get:
      tags:
      - Banking
      summary: Get Product Detail
      description: 'Obtain detailed information on a single product offered openly to the market.


        NOTE: This version must be implemented by **July 2026**


        Obsolete versions: [v1](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-product-detail-v1.html) [v2](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-product-detail-v2.html) [v3](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v3.html),[v4](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v4.html),[v5](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v5.html)'
      operationId: getProductDetail
      parameters:
      - name: productId
        in: path
        description: ID of the specific product requested
        required: true
        schema:
          type: string
          x-cds-type: ASCIIString
        x-cds-type: ASCIIString
      - name: x-v
        in: header
        description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](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)
        required: true
        schema:
          type: string
          default: '7'
      - name: x-min-v
        in: header
        description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ) and [x-v](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*request-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAEaeBCoC$ ). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            x-v:
              description: The [version](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*response-headers__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAM6QvIGb$ ) of the API end point that the data holder has responded with.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBankingProductById'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorList'
      x-version: '7'
components:
  schemas:
    ResponseErrorList:
      required:
      - errors
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ResponseErrorList_errors'
    ResponseBankingPayeeById:
      required:
      - data
      - links
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BankingPayeeDetail'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
    BankingDomesticPayeeCard:
      required:
      - cardNumber
      type: object
      properties:
        cardNumber:
          type: string
          description: Name of the account to pay to
          x-cds-type: MaskedPANString
    ResponseBankingTransactionList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResponseBankingTransactionList_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
    BankingTransactionDetail:
      allOf:
      - $ref: '#/components/schemas/BankingTransaction'
      - required:
        - extendedData
        type: object
        properties:
          extendedData:
            $ref: '#/components/schemas/BankingTransactionDetail_extendedData'
    ResponseBankingAccountById:
      required:
      - data
      - links
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BankingAccountDetail'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
    BankingTransactionDetail_extendedData_x2p101Payload:
      required:
      - extendedDescription
      type: object
      properties:
        extendedDescription:
          type: string
          description: An extended string description. Only present if specified by the extensionUType field
        endToEndId:
          type: string
          description: An end to end ID for the payment created at initiation
        purposeCode:
          type: string
          description: Purpose of the payment.  Format is defined by NPP standards for the x2p1.01 overlay service
    ResponseBankingProductList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          required:
          - products
          type: object
          properties:
            products:
              type: array
              description: The list of products returned.  If the filter results in an empty set then this array may have no records
              items:
                $ref: '#/components/schemas/BankingProductV3'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated_2'
    ResponseBankingProductById:
      required:
      - data
      - links
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BankingProductDetailV3'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
    BankingBalance:
      required:
      - accountId
      - availableBalance
      - currentBalance
      type: object
      properties:
        accountId:
          type: string
          description: A unique ID of the account adhering to the standards for ID permanence
          x-cds-type: ASCIIString
        currentBalance:
          type: string
          description: The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing
          x-cds-type: AmountString
        availableBalance:
          type: string
          description: Balance representing the amount of funds available for transfer. Assumed to be zero or positive
          x-cds-type: AmountString
        creditLimit:
          type: string
          description: Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent
          x-cds-type: AmountString
        amortisedLimit:
          type: string
          description: Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent
          x-cds-type: AmountString
        currency:
          type: string
          description: The currency for the balance amounts. If absent assumed to be AUD
          x-cds-type: CurrencyString
        purses:
          type: array
          description: Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards
          items:
            $ref: '#/components/schemas/BankingBalancePurse'
    BankingScheduledPaymentRecurrenceIntervalSchedule:
      required:
      - intervals
      type: object
      properties:
        finalPaymentDate:
          type: string
          description: The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
          x-cds-type: DateString
        paymentsRemaining:
          type: integer
          description: Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely
          x-cds-type: PositiveInteger
        nonBusinessDayTreatment:
          type: string
          description: Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.<br/>**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.<br/>**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.<br/>**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.<br/>**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
          default: 'ON'
          enum:
          - AFTER
          - BEFORE
          - 'ON'
          - ONLY
        intervals:
          type: array
          description: An array of interval objects defining the payment schedule.  Each entry in the array is additive, in that it adds payments to the overall payment schedule.  If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry
          items:
            $ref: '#/components/schemas/BankingScheduledPaymentInterval'
      description: Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
    RequestAccountIds:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RequestAccountIds_data'
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
    ResponseBankingAccountsBalanceList_data:
      required:
      - balances
      type: object
      properties:
        balances:
          type: array
          description: The list of balances returned
          items:
            $ref: '#/components/schemas/BankingBalance'
    BankingScheduledPaymentInterval:
      required:
      - interval
      type: object
      properties:
        interval:
          type: string
          description: An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)  (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
          x-cds-type: ExternalRef
        dayInInterval:
          type: string
          description: Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
          x-cds-type: ExternalRef
    BankingDomesticPayeeAccount:
      required:
      - accountNumber
      - bsb
      type: object
      properties:
        accountName:
          type: string
          description: Name of the account to pay to
        bsb:
          type: string
          description: BSB of the account to pay to
        accountNumber:
          type: string
          description: Number of the account to pay to
    ResponseBankingAccountList_data:
      required:
      - accounts
      type: object
      properties:
        accounts:
          type: array
          description: The list of accounts returned. If the filter results in an empty set then this array may have no records
          items:
            $ref: '#/components/schemas/BankingAccount'
    ResponseErrorList_errors:
      required:
      - code
      - detail
      - title
      type: object
      properties:
        code:
          type: string
          description: Error code
        title:
          type: string
          description: Error title
        detail:
          type: string
          description: Error details
        meta:
          type: object
          properties: {}
          description: Optional additional data for specific error types
    BankingBillerPayee:
      required:
      - billerCode
      - billerName
      type: object
      properties:
        billerCode:
          type: string
          description: BPAY Biller Code of the Biller
        crn:
          type: string
          description: BPAY CRN of the Biller. If the contents of the CRN match the format of a Credit Card PAN then it should be masked using the rules applicable for the MaskedPANString common type
        billerName:
          type: string
          description: Name of the Biller
      x-conditional:
      - crn
    BankingDomesticPayee:
      required:
      - payeeAccountUType
      type: object
      properties:
        payeeAccountUType:
          type: string
          description: 'Type of account object included. Valid values are: **account** A standard Australian account defined by BSB/Account Number. **card** A credit or charge card to pay to (note that PANs are masked). **payId** A PayID recognised by NPP'
          enum:
          - account
          - card
          - payId
        account:
          $ref: '#/components/schemas/BankingDomesticPayeeAccount'
        card:
          $ref: '#/components/schemas/BankingDomesticPayeeCard'
        payId:
          $ref: '#/components/schemas/BankingDomesticPayeePayId'
      x-conditional:
      - account
      - card
      - payId
    BankingBalancePurse:
      required:
      - amount
      type: object
      properties:
        amount:
          type: string
          description: The balance available for this additional currency purse
          x-cds-type: AmountString
        currency:
          type: string
          description: The currency for the purse
          x-cds-type: CurrencyString
    ResponseBankingDirectDebitAuthorisationList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
    Links:
      required:
      - self
      type: object
      properties:
        self:
          type: string
          description: Fully qualified link that generated the current response document
          x-cds-type: URIString
    BankingLoanAccount:
      required:
      - loanEndDate
      - nextInstalmentDate
      - repaymentFrequency
      type: object
      properties:
        originalStartDate:
          type: string
          description: Optional original start date for the loan
          x-cds-type: DateString
        originalLoanAmount:
          type: string
          description: Optional original loan value
          x-cds-type: AmountString
        originalLoanCurrency:
          type: string
          description: If absent assumes AUD
          x-cds-type: CurrencyString
        loanEndDate:
          type: string
          description: Date that the loan is due to be repaid in full
          x-cds-type: DateString
        nextInstalmentDate:
          type: string
          description: Next date that an instalment is required
          x-cds-type: DateString
        minInstalmentAmount:
          type: string
          description: Minimum amount of next instalment
          x-cds-type: AmountString
        minInstalmentCurrency:
          type: string
          description: If absent assumes AUD
          x-cds-type: CurrencyString
        maxRedraw:
          type: string
          description: Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account
          x-cds-type: AmountString
        maxRedrawCurrency:
          type: string
          description: If absent assumes AUD
          x-cds-type: CurrencyString
        minRedraw:
          type: string
          description: Minimum redraw amount
          x-cds-type: AmountString
        minRedrawCurrency:
          type: string
          description: If absent assumes AUD
          x-cds-type: CurrencyString
        offsetAccountEnabled:
          type: boolean
          description: Set to true if one or more offset accounts are configured for this loan account
          x-cds-type: Boolean
        offsetAccountIds:
          type: array
          description: The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation
          items:
            type: string
            x-cds-type: ASCIIString
        repaymentType:
          type: string
          description: Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
          default: PRINCIPAL_AND_INTEREST
          enum:
          - INTEREST_ONLY
          - PRINCIPAL_AND_INTEREST
        repaymentFrequency:
          type: string
          description: The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
          x-cds-type: ExternalRef
    BankingTransactionDetail_extendedData_nppPayload:
      required:
      - extendedDescription
      - service
      - serviceVersion
      type: object
      properties:
        extendedDescription:
          type: string
          description: An extended string description. Only present if specified by the extensionUType field
        endToEndId:
          type: string
          description: An end to end ID for the payment created at initiation
        purposeCode:
          type: string
          description: Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1)
        service:
          type: string
          description: Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion.
          enum:
          - X2P1
          - IFTI
          - BSCT
          - CATSCT
        serviceVersion:
          type: string
          description: Two-digit NPP service overlay version with leading zero.
    BankingProductV3:
      required:
      - brand
      - description
      - isTailored
      - lastUpdated
      - name
      - productCategory
      - productId
      type: object
      properties:
        productId:
          type: string
          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.
          x-cds-type: ASCIIString
        effectiveFrom:
          type: string
          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
          x-cds-type: DateTimeString
        effectiveTo:
          type: string
          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
          x-cds-type: DateTimeString
        lastUpdated:
          type: string
          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)
          x-cds-type: DateTimeString
        productCategory:
          $ref: '#/components/schemas/BankingProductCategory_2'
        name:
          type: string
          description: The display name of the product
        description:
          type: string
          description: A description of the product
        brand:
          type: string
          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
        brandName:
          type: string
          description: An optional display name of the brand
        brandGroup:
          type: string
          description: The brandGroup of a consumer data sharing brand that the product is associated with.
        applicationUri:
          type: string
          description: A link to an application web page where this product can be applied for.
          x-cds-type: URIString
        isTailored:
          type: boolean
          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
          x-cds-type: Boolean
        additionalInformation:
          type: object
          description: Object that contains links to additional information on specific topics
          properties:
            overviewUri:
              type: string
              description: General overview of the product
              x-cds-type: URIString
            termsUri:
              type: string
              description: Terms and conditions for the product
              x-cds-type: URIString
            eligibilityUri:
              type: string
              description: Eligibility rules and criteria for the product
              x-cds-type: URIString
            feesAndPricingUri:
              type: string
              description: Description of fees, pricing, discounts, exemptions and bonuses for the product
              x-cds-type: URIString
            bundleUri:
              type: string
              description: Description of a bundle that this product can be part of
              x-cds-type: URIString
            additionalOverviewUris:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  additionalInfoUri:
                    type: string
                    x-cds-type: URIString
            additionalTermsUris:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  additionalInfoUri:
                    type: string
                    x-cds-type: URIString
            additionalEligibilityUris:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  additionalInfoUri:
                    type: string
                    x-cds-type: URIString
            additionalFeesAndPricingUris:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  additionalInfoUri:
                    type: string
                    x-cds-type: URIString
            additionalBundleUris:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                  additionalInfoUri:
                    type: string
                    x-cds-type: URIString
        cardArt:
          type: array
          description: An array of card art images
          items:
            type: object
            required:
            - imageUri
            - cardScheme
            - cardType
            properties:
              title:
                type: string
                description: Display label for the specific image
              imageUri:
                type: string
                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 [RFC 2397](https://tools.ietf.org/html/rfc2397)
                x-cds-type: URIString
              cardScheme:
                type: string
                description: The scheme (brand) for the card art
                enum:
                - AMEX
                - EFTPOS
                - MASTERCARD
                - VISA
                - OTHER
              cardType:
                type: string
                description: The type of card the art represents
                enum:
                - CHARGE
                - CREDIT
                - DEBIT
    BankingProductDetailV3:
      allOf:
      - $ref: '#/components/schemas/BankingProductV3'
      - type: object
        properties:
          bundles:
            type: array
            description: An array of bundles that this product participates in.  Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle.  It is assumed that the current product is included in the bundle also
            items:
              $ref: '#/components/schemas/BankingProductBundle'
          features:
            type: array
            description: Array of features available for the product
            items:
              $ref: '#/components/schemas/BankingProductFeature_2'
          constraints:
            type: array
            description: Constraints on the application for or operation of the product such as minimum balances or limit thresholds
            items:
              anyOf:
              - $ref: '#/components/schemas/BankingProductConstraintV2'
              - $ref: '#/components/schemas/BankingProductConstraint'
          eligibility:
            type: array
            description: Eligibility criteria for the product
            items:
              $ref: '#/components/schemas/BankingProductEligibility'
          fees:
            type: array
            description: Fees applicable for the product
            items:
              $ref: '#/components/schemas/BankingProductFee_2'
          instalments:
            type: object
            description: Details of instalment features on the account.
            properties:
              maximumConcurrentPlans:
                type: number
                description: 'maximumConcurrentPlans '
                default: 0
              instalmentsLimit:
                type: number
                description: Maximum number of concurrent active instalment plans that may be created on the account. If null, there is no predetermined maximum number
                default: 0
              minimumPlanValue:
                type: number
                description: Minimum value that can be opened as an instalment plan.
                default: 0
              maximumPlanValue:
                type: number
                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.
                default: 0
              minimumSplit:
                type: number
                description: Maximum number of instalment payments a plan can be created with.
                default: 4
              maximumSplit:
                type: number
                description: '4'
                default: 4
          depositRates:
            type: array
            description: Interest rates available for deposits
            items:
              $ref: '#/components/schemas/BankingProductDepositRate_2'
          lendingRates:
            type: array
            description: Interest rates charged against lending balances
            items:
              $ref: '#/components/schemas/BankingProductLendingRate_2'
    BankingProductFee_2:
      required:
      - feeType
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the fee
        feeType:
          type: string
          description: The type of fee
          enum:
          - PERIODIC
          - TRANSACTION
          - WITHDRAWAL
          - DEPOSIT
          - PAYMENT
          - PURCHASE
          - EVENT
          - UPFRONT
          - EXIT
          - CASH_ADVANCE
          - DISHONOUR
          - ENQUIRY
          - LATE_PAYMENT
          - OTHER
          - UPFRONT_PER_PLAN
          - VARIATION
        feeMethodUType:
          type: string
          description: The U type of fee method
          enum:
          - fixedAmount
          - rateBased
          - variable
        fixedAmount:
          type: object
          properties:
            amount:
              type: string
              x-cds-type: AmountString
        rateBased:
          type: object
          properties:
            rate:
              type: string
              x-cds-type: RateString
            rateType:
              type: string
              enum:
              - BALANCE
              - TRANSACTION
              - ACCRUED
            accrualFrequency:
              type: string
            amountRange:
              type: object
              properties:
                feeMinimum:
                  type: string
                  x-cds-type: AmountString
                feeMaximum:
                  type: string
                  x-cds-type: AmountString
        variable:
          type: object
          properties:
            feeMinimum:
              type: string
              x-cds-type: AmountString
            feeMaximum:
              type: string
              x-cds-type: AmountString
        feeCap:
          type: string
          x-cds-type: AmountString
        feeCapPeriod:
          type: string
        currency:
          type: string
          default: AUD
        additionalValue:
          type: string
        additionalInfo:
          type: string
        additionalInfoUri:
          type: string
          x-cds-type: URIString
        discounts:
          type: array
          items:
            type: object
            properties:
              description:
                type: string
              discountType:
                type: string
                enum:
                - BALANCE
                - TRANSACTION
                - PAYMENTS
                - FEE_CAP
              discountMethodUType:
                type: string
                enum:
                - fixedAmount
                - rateBased
              fixedAmount:
                type: object
                properties:
                  amount:
                    type: string
              rateBased:
                type: object
                properties:
                  rate:
                    type: string
                  rateType:
                    type: string
                  amountRange:
                    type: object
                    properties:
                      discountMinimum:
                        type: string
                      discountMaximum:
                        type: string
              eligibility:
                type: array
                items:
                  type: object
                  properties:
                    discountEligibilityType:
                      type: string
                      enum:
                      - BUSINESS
                      - PENSIONER
                      - STUDENT
                      - STAFF
                      - OTHER
                    additionalValue:
                      type: string
                    additionalInfo:
                      type: string
                    additionalInfoUri:
                      type: string
              additionalValue:
                type: string
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
    BankingProductCategory:
      type: string
      description: The category to which a product or account belongs. See [here](https://consumerdatastandardsaustralia.github.io/standards/#product-categories) for more details
      enum:
      - TRANS_AND_SAVINGS_ACCOUNTS
      - TERM_DEPOSITS
      - TRAVEL_CARDS
      - REGULATED_TRUST_ACCOUNTS
      - RESIDENTIAL_MORTGAGES
      - CRED_AND_CHRG_CARDS
      - PERS_LOANS
      - MARGIN_LOANS
      - LEASES
      - TRADE_FINANCE
      - OVERDRAFTS
      - BUSINESS_LOANS
    BankingProductConstraintV2:
      required:
      - constraintType
      type: object
      properties:
        constraintType:
          type: string
          description: The type of constraint described.  See the next section for an overview of valid values and their meaning
          enum:
          - MIN_BALANCE
          - MAX_BALANCE
          - OPENING_BALANCE
          - MAX_LIMIT
          - MIN_LIMIT
          - MIN_LVR
          - MAX_LVR
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the [constraintType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductconstrainttypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAN3kju5n$ ) specified.  Whether mandatory or not is dependent on the value of [constraintType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductconstrainttypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAN3kju5n$ )
        additionalInfo:
          type: string
          description: Display text providing more information the constraint
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on the constraint
          x-cds-type: URIString
      x-conditional:
      - additionalValue
    BankingProductCategory_2:
      type: string
      description: The category to which a product or account belongs. See [here](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*product-categories__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KACYanF6g$ ) for more details
      enum:
      - TRANS_AND_SAVINGS_ACCOUNTS
      - TERM_DEPOSITS
      - TRAVEL_CARDS
      - REGULATED_TRUST_ACCOUNTS
      - RESIDENTIAL_MORTGAGES
      - CRED_AND_CHRG_CARDS
      - PERS_LOANS
      - MARGIN_LOANS
      - LEASES
      - TRADE_FINANCE
      - OVERDRAFTS
      - BUSINESS_LOANS
    BankingProductFeature:
      required:
      - featureType
      type: object
      properties:
        featureType:
          type: string
          description: The type of feature described
          enum:
          - CARD_ACCESS
          - ADDITIONAL_CARDS
          - UNLIMITED_TXNS
          - FREE_TXNS
          - FREE_TXNS_ALLOWANCE
          - LOYALTY_PROGRAM
          - OFFSET
          - OVERDRAFT
          - REDRAW
          - INSURANCE
          - BALANCE_TRANSFERS
          - INTEREST_FREE
          - INTEREST_FREE_TRANSFERS
          - DIGITAL_WALLET
          - DIGITAL_BANKING
          - NPP_PAYID
          - NPP_ENABLED
          - DONATE_INTEREST
          - BILL_PAYMENT
          - COMPLEMENTARY_PRODUCT_DISCOUNTS
          - BONUS_REWARDS
          - NOTIFICATIONS
          - OTHER
        additionalValue:
          type: string
          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)
        additionalInfo:
          type: string
          description: Display text providing more information on the feature. Mandatory if the [feature type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc) is set to OTHER
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this feature
          x-cds-type: URIString
      x-conditional:
      - additionalValue
      - additionalInfo
    BankingInternationalPayee_bankDetails:
      required:
      - accountNumber
      - country
      type: object
      properties:
        country:
          type: string
          description: Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code
          x-cds-type: ExternalRef
        accountNumber:
          type: string
          description: Account Targeted for payment
        bankAddress:
          $ref: '#/components/schemas/BankingInternationalPayee_bankDetails_bankAddress'
        beneficiaryBankBIC:
          type: string
          description: Swift bank code.  Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)
          x-cds-type: ExternalRef
        fedWireNumber:
          type: string
          description: Number for Fedwire payment (Federal Reserve Wire Network)
        sortCode:
          type: string
          description: Sort code used for account identification in some jurisdictions
        chipNumber:
          type: string
          description: Number for the Clearing House Interbank Payments System
        routingNumber:
          type: string
          description: International bank routing number
        legalEntityIdentifier:
          type: string
          description: The legal entity identifier (LEI) for the beneficiary.  Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)
          x-cds-type: ExternalRef
    ResponseBankingScheduledPaymentsList_data:
      required:
      - scheduledPayments
      type: object
      properties:
        scheduledPayments:
          type: array
          description: The list of scheduled payments to return
          items:
            $ref: '#/components/schemas/BankingScheduledPayment'
    CommonSimpleAddress:
      required:
      - addressLine1
      - city
      - state
      type: object
      properties:
        mailingName:
          type: string
          description: Name of the individual or business formatted for inclusion in an address used for physical mail
        addressLine1:
          type: string
          description: First line of the standard address object
        addressLine2:
          type: string
          description: Second line of the standard address object
        addressLine3:
          type: string
          description: Third line of the standard address object
        postcode:
          type: string
          description: Mandatory for Australian addresses
        city:
          type: string
          description: Name of the city or locality
        state:
          type: string
          description: Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
        country:
          type: string
          description: A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present.
          default: AUS
          x-cds-type: ExternalRef
      x-conditional:
      - postcode
    BankingScheduledPaymentRecurrenceEventBased:
      required:
      - description
      type: object
      properties:
        description:
          type: string
          description: Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
      description: Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
    LinksPaginated:
      required:
      - self
      type: object
      properties:
        self:
          type: string
          description: Fully qualified link that generated the current response document
          x-cds-type: URIString
        first:
          type: string
          description: URI to the first page of this set. Mandatory if this response is not the first page
          x-cds-type: URIString
        prev:
          type: string
          description: URI to the previous page of this set. Mandatory if this response is not the first page
          x-cds-type: URIString
        next:
          type: string
          description: URI to the next page of this set. Mandatory if this response is not the last page
          x-cds-type: URIString
        last:
          type: string
          description: URI to the last page of this set. Mandatory if this response is not the last page
          x-cds-type: URIString
      x-conditional:
      - prev
      - next
      - first
      - last
    BankingProductLendingRate_2:
      required:
      - lendingRateType
      - rate
      type: object
      properties:
        lendingRateType:
          type: string
          description: The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning
          enum:
          - FIXED
          - VARIABLE
          - INTRODUCTORY
          - DISCOUNT
          - PENALTY
          - FLOATING
          - MARKET_LINKED
          - CASH_ADVANCE
          - PURCHASE
          - BUNDLE_DISCOUNT_FIXED
          - BUNDLE_DISCOUNT_VARIABLE
        rate:
          type: string
          description: The rate to be applied
          x-cds-type: RateString
        comparisonRate:
          type: string
          description: A comparison rate equivalent for this rate
          x-cds-type: RateString
        calculationFrequency:
          type: string
          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://urldefense.com/v3/__https://en.wikipedia.org/wiki/ISO_8601*Durations__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KALMCofJm$ ) (excludes recurrence syntax)
          x-cds-type: ExternalRef
        applicationFrequency:
          type: string
          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://urldefense.com/v3/__https://en.wikipedia.org/wiki/ISO_8601*Durations__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KALMCofJm$ ) (excludes recurrence syntax)
          x-cds-type: ExternalRef
        applicationType:
          type: string
          description: The type of application for the rate
          enum:
          - PERIODIC
          - AT_MATURITY
        interestPaymentDue:
          type: string
          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_ARREARS
          - IN_ADVANCE
        repaymentType:
          type: string
          description: Options in place for repayments. If absent, the lending rate is applicable to all repayment types
          enum:
          - INTEREST_ONLY
          - PRINCIPAL_AND_INTEREST
        loanPurpose:
          type: string
          description: The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
          enum:
          - OWNER_OCCUPIED
          - INVESTMENT
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the [lendingRateType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductlendingratetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAAjXElvz$ ) specified. Whether mandatory or not is dependent on the value of [lendingRateType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductlendingratetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAAjXElvz$ )
        additionalInfo:
          type: string
          description: Display text providing more information on the rate.
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this rate
          x-cds-type: URIString
        applicabilityConditions:
          type: array
          description: Conditions that must be met for this rate to apply
          items:
            type: object
            properties:
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
                x-cds-type: URIString
              additionalValue:
                type: string
              rateApplicabilityType:
                type: string
                enum:
                - NEW_CUSTOMER
                - RECURRING_DEPOSIT
                - MIN_BALANCE
                - MAX_BALANCE
                - OTHER
        tiers:
          type: array
          description: Rate tiers applicable for this rate
          items:
            $ref: '#/components/schemas/BankingProductRateTierV3'
      x-conditional:
      - additionalValue
    ResponseBankingTransactionByIdV2:
      required:
      - data
      - links
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BankingTransactionDetailV2'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
    CommonPhysicalAddress:
      required:
      - addressUType
      type: object
      properties:
        addressUType:
          type: string
          description: The type of address object present
          enum:
          - simple
          - paf
        simple:
          $ref: '#/components/schemas/CommonSimpleAddress'
        paf:
          $ref: '#/components/schemas/CommonPAFAddress'
      x-conditional:
      - simple
      - paf
    BankingScheduledPaymentRecurrenceLastWeekday:
      required:
      - interval
      - lastWeekDay
      type: object
      properties:
        finalPaymentDate:
          type: string
          description: The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
          x-cds-type: DateString
        paymentsRemaining:
          type: integer
          description: Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
          x-cds-type: PositiveInteger
        interval:
          type: string
          description: The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate
          x-cds-type: ExternalRef
        lastWeekDay:
          type: string
          description: The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
          enum:
          - MON
          - TUE
          - WED
          - THU
          - FRI
          - SAT
          - SUN
        nonBusinessDayTreatment:
          type: string
          description: Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.<br/>**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.<br/>**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.<br/>**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.<br/>**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
          default: 'ON'
          enum:
          - AFTER
          - BEFORE
          - 'ON'
          - ONLY
      description: Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay
    BankingScheduledPayment:
      required:
      - from
      - payeeReference
      - payerReference
      - paymentSet
      - recurrence
      - scheduledPaymentId
      - status
      type: object
      properties:
        scheduledPaymentId:
          type: string
          description: A unique ID of the scheduled payment adhering to the standards for ID permanence
          x-cds-type: ASCIIString
        nickname:
          type: string
          description: The short display name of the payee as provided by the customer
        payerReference:
          type: string
          description: The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer account. Empty string if no data provided
        payeeReference:
          type: string
          description: The reference for the transaction that will be provided by the originating institution. Empty string if no data provided
        status:
          type: string
          description: Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
          enum:
          - ACTIVE
          - SKIP
          - INACTIVE
        from:
          $ref: '#/components/schemas/BankingScheduledPaymentFrom'
        paymentSet:
          type: array
          items:
            $ref: '#/components/schemas/BankingScheduledPaymentSet'
        recurrence:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrence'
    ResponseBankingScheduledPaymentsList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResponseBankingScheduledPaymentsList_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
    BankingProductEligibility:
      required:
      - eligibilityType
      type: object
      properties:
        eligibilityType:
          type: string
          description: The type of eligibility criteria described.  See the next section for an overview of valid values and their meaning
          enum:
          - BUSINESS
          - PENSION_RECIPIENT
          - MIN_AGE
          - MAX_AGE
          - MIN_INCOME
          - MIN_TURNOVER
          - STAFF
          - STUDENT
          - EMPLOYMENT_STATUS
          - RESIDENCY_STATUS
          - NATURAL_PERSON
          - OTHER
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the [eligibilityType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproducteligibilitytypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAB4SwQ9M$ ) specified. Whether mandatory or not is dependent on the value of [eligibilityType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproducteligibilitytypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAB4SwQ9M$ )
        additionalInfo:
          type: string
          description: Display text providing more information on the [eligibility](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproducteligibilitytypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAB4SwQ9M$ ) criteria. Mandatory if the field is set to OTHER
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this eligibility criteria
          x-cds-type: URIString
      x-conditional:
      - additionalValue
      - additionalInfo
    BankingDomesticPayeePayId:
      required:
      - identifier
      - type
      type: object
      properties:
        name:
          type: string
          description: The name assigned to the PayID by the owner of the PayID
        identifier:
          type: string
          description: The identifier of the PayID (dependent on type)
        type:
          type: string
          description: The type of the PayID
          enum:
          - EMAIL
          - TELEPHONE
          - ABN
          - ORG_IDENTIFIER
    BankingProductBundle:
      required:
      - description
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the bundle
        description:
          type: string
          description: Description of the bundle
        additionalInfo:
          type: string
          description: Display text providing more information on the bundle
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on the bundle criteria and benefits
          x-cds-type: URIString
        productIds:
          type: array
          description: Array of product IDs for products included in the bundle that are available via the product end points.  Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points
          items:
            type: string
            x-cds-type: ASCIIString
    ResponseBankingTransactionById:
      required:
      - data
      - links
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BankingTransactionDetail'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
    BankingProductDepositRate_2:
      required:
      - depositRateType
      - rate
      type: object
      properties:
        depositRateType:
          type: string
          description: The type of rate (base, bonus, etc).
          enum:
          - FIXED
          - BONUS
          - BUNDLE_BONUS
          - VARIABLE
          - INTRODUCTORY
          - FLOATING
          - MARKET_LINKED
        rate:
          type: string
          description: The rate to be applied
          x-cds-type: RateString
        calculationFrequency:
          type: string
          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://urldefense.com/v3/__https://en.wikipedia.org/wiki/ISO_8601*Durations__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KALMCofJm$ ) (excludes recurrence syntax)
          x-cds-type: ExternalRef
        applicationFrequency:
          type: string
          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://urldefense.com/v3/__https://en.wikipedia.org/wiki/ISO_8601*Durations__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KALMCofJm$ ) (excludes recurrence syntax)
          x-cds-type: ExternalRef
        applicationType:
          type: string
          description: The type of application for the rate
          enum:
          - PERIODIC
          - AT_MATURITY
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the [depositRateType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductdepositratetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KADm4m0-G$ ) specified. Whether mandatory or not is dependent on the value of [depositRateType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductdepositratetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KADm4m0-G$ )
        additionalInfo:
          type: string
          description: Display text providing more information on the rate
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this rate
          x-cds-type: URIString
        applicabilityConditions:
          type: array
          description: Conditions that must be met for this rate to apply
          items:
            type: object
            properties:
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
                x-cds-type: URIString
              additionalValue:
                type: string
              rateApplicabilityType:
                type: string
                enum:
                - NEW_CUSTOMER
                - RECURRING_DEPOSIT
                - MIN_BALANCE
                - MAX_BALANCE
                - OTHER
        tiers:
          type: array
          description: Rate tiers applicable for this rate
          items:
            $ref: '#/components/schemas/BankingProductRateTierV3'
      x-conditional:
      - additionalValue
    BankingProductConstraint:
      required:
      - constraintType
      type: object
      properties:
        constraintType:
          type: string
          description: The type of constraint described.  See the next section for an overview of valid values and their meaning
          enum:
          - MIN_BALANCE
          - MAX_BALANCE
          - OPENING_BALANCE
          - MAX_LIMIT
          - MIN_LIMIT
          - OTHER
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the [constraintType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductconstrainttypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAN3kju5n$ ) specified.  Whether mandatory or not is dependent on the value of [constraintType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductconstrainttypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KAN3kju5n$ )
        additionalInfo:
          type: string
          description: Display text providing more information the constraint
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on the constraint
          x-cds-type: URIString
      x-conditional:
      - additionalValue
    BankingPayee:
      required:
      - nickname
      - payeeId
      - type
      type: object
      properties:
        payeeId:
          type: string
          description: ID of the payee adhering to the rules of ID permanence
          x-cds-type: ASCIIString
        nickname:
          type: string
          description: The short display name of the payee as provided by the customer
        description:
          type: string
          description: A description of the payee provided by the customer
        type:
          type: string
          description: The type of payee. DOMESTIC means a registered payee for domestic payments including NPP. INTERNATIONAL means a registered payee for international payments. BILLER means a registered payee for BPAY
          enum:
          - DOMESTIC
          - INTERNATIONAL
          - BILLER
        creationDate:
          type: string
          description: The date the payee was created by the customer
          x-cds-type: DateString
    BankingTransactionDetail_extendedDataV2:
      type: object
      properties:
        payer:
          type: string
          description: Label of the originating payer. Mandatory for inbound payment
        payee:
          type: string
          description: Label of the target PayID.  Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)
        extensionUType:
          type: string
          description: Optional extended data provided specific to transaction originated via NPP
          enum:
          - nppPayload
        nppPayload:
          $ref: '#/components/schemas/BankingTransactionDetail_extendedData_nppPayload'
    BankingInternationalPayee_bankDetails_bankAddress:
      required:
      - address
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the recipient Bank
        address:
          type: string
          description: Address of the recipient Bank
    BankingScheduledPaymentRecurrenceOnceOff:
      required:
      - paymentDate
      type: object
      properties:
        paymentDate:
          type: string
          description: The scheduled date for the once off payment
          x-cds-type: DateString
      description: Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
    BankingProductDepositRate:
      required:
      - depositRateType
      - rate
      type: object
      properties:
        depositRateType:
          type: string
          description: The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning
          enum:
          - FIXED
          - BONUS
          - BUNDLE_BONUS
          - VARIABLE
          - INTRODUCTORY
          - FLOATING
          - MARKET_LINKED
        rate:
          type: string
          description: The rate to be applied
          x-cds-type: RateString
        calculationFrequency:
          type: string
          description: The period after which the rate is applied to the balance.
        applicationFrequency:
          type: string
          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)
          x-cds-type: ExternalRef
        applicationType:
          type: string
          description: The type of application for the rate
          enum:
          - PERIODIC
          - AT_MATURITY
        additionalValue:
          type: string
          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)
        additionalInfo:
          type: string
          description: Display text providing more information on the rate
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this rate
          x-cds-type: URIString
        applicabilityConditions:
          type: array
          description: Conditions that must be met for this rate to apply
          items:
            type: object
            properties:
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
                x-cds-type: URIString
              additionalValue:
                type: string
              rateApplicabilityType:
                type: string
                enum:
                - NEW_CUSTOMER
                - RECURRING_DEPOSIT
                - MIN_BALANCE
                - MAX_BALANCE
                - OTHER
        tiers:
          type: array
          description: Rate tiers applicable for this rate
          items:
            type: object
            required:
            - minimumValue
            - name
            - unitOfMeasure
            properties:
              name:
                type: string
              unitOfMeasure:
                type: string
                enum:
                - DOLLAR
                - PERCENT
                - MONTH
                - DAY
              minimumValue:
                type: string
              maximumValue:
                type: string
              rateApplicationMethod:
                type: string
                enum:
                - WHOLE_BALANCE
                - PER_TIER
              applicabilityConditions:
                type: array
                items:
                  type: object
                  properties:
                    additionalInfo:
                      type: string
                    additionalInfoUri:
                      type: string
                      x-cds-type: URIString
                    additionalValue:
                      type: string
                    rateApplicabilityType:
                      type: string
                      enum:
                      - NEW_CUSTOMER
                      - RECURRING_DEPOSIT
                      - MIN_BALANCE
                      - MAX_BALANCE
                      - OTHER
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
                x-cds-type: URIString
      x-conditional:
      - additionalValue
    ResponseBankingAccountsBalanceList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResponseBankingAccountsBalanceList_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
    BankingPayeeDetail:
      allOf:
      - $ref: '#/components/schemas/BankingPayee'
      - required:
        - payeeUType
        type: object
        properties:
          payeeUType:
            type: string
            description: Type of object included that describes the payee in detail
            enum:
            - domestic
            - biller
            - international
          domestic:
            $ref: '#/components/schemas/BankingDomesticPayee'
          biller:
            $ref: '#/components/schemas/BankingBillerPayee'
          international:
            $ref: '#/components/schemas/BankingInternationalPayee'
        x-conditional:
        - domestic
        - biller
        - international
    BankingProductFee:
      required:
      - feeType
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the fee
        feeType:
          type: string
          description: The type of fee
          enum:
          - PERIODIC
          - TRANSACTION
          - WITHDRAWAL
          - DEPOSIT
          - PAYMENT
          - PURCHASE
          - EVENT
          - UPFRONT
          - EXIT
          - CASH_ADVANCE
          - DISHONOUR
          - ENQUIRY
          - LATE_PAYMENT
          - OTHER
          - UPFRONT_PER_PLAN
          - VARIATION
        feeMethodUType:
          type: string
          description: The U type of fee method
          enum:
          - fixedAmount
          - rateBased
          - variable
        fixedAmount:
          type: object
          properties:
            amount:
              type: string
              x-cds-type: AmountString
        rateBased:
          type: object
          properties:
            rate:
              type: string
              x-cds-type: RateString
            rateType:
              type: string
              enum:
              - BALANCE
              - TRANSACTION
              - ACCRUED
            accrualFrequency:
              type: string
            amountRange:
              type: object
              properties:
                feeMinimum:
                  type: string
                  x-cds-type: AmountString
                feeMaximum:
                  type: string
                  x-cds-type: AmountString
        variable:
          type: object
          properties:
            feeMinimum:
              type: string
              x-cds-type: AmountString
            feeMaximum:
              type: string
              x-cds-type: AmountString
        feeCap:
          type: string
          x-cds-type: AmountString
        feeCapPeriod:
          type: string
        currency:
          type: string
          default: AUD
        additionalValue:
          type: string
        additionalInfo:
          type: string
        additionalInfoUri:
          type: string
          x-cds-type: URIString
        discounts:
          type: array
          description: An optional list of discounts to this fee that may be available
          items:
            type: object
            properties:
              description:
                type: string
              discountType:
                type: string
                enum:
                - BALANCE
                - TRANSACTION
                - PAYMENTS
                - FEE_CAP
              discountMethodUType:
                type: string
                enum:
                - fixedAmount
                - rateBased
              fixedAmount:
                type: object
                properties:
                  amount:
                    type: string
              rateBased:
                type: object
                properties:
                  rate:
                    type: string
                  rateType:
                    type: string
                  amountRange:
                    type: object
                    properties:
                      discountMinimum:
                        type: string
                      discountMaximum:
                        type: string
              eligibility:
                type: array
                items:
                  type: object
                  properties:
                    discountEligibilityType:
                      type: string
                      enum:
                      - BUSINESS
                      - PENSIONER
                      - STUDENT
                      - STAFF
                      - OTHER
                    additionalValue:
                      type: string
                    additionalInfo:
                      type: string
                    additionalInfoUri:
                      type: string
              additionalValue:
                type: string
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
      x-conditional:
      - additionalValue
      - fixedAmount
      - rateBased
      - variable
    BankingCreditCardAccount:
      required:
      - minPaymentAmount
      - paymentDueAmount
      - paymentDueDate
      type: object
      properties:
        minPaymentAmount:
          type: string
          description: The minimum payment amount due for the next card payment
          x-cds-type: AmountString
        paymentDueAmount:
          type: string
          description: The amount due for the next card payment
          x-cds-type: AmountString
        paymentCurrency:
          type: string
          description: If absent assumes AUD
          x-cds-type: CurrencyString
        paymentDueDate:
          type: string
          description: Date that the next payment for the card is due
          x-cds-type: DateString
    BankingScheduledPaymentFrom:
      required:
      - accountId
      type: object
      properties:
        accountId:
          type: string
          description: ID of the account that is the source of funds for the payment
          x-cds-type: ASCIIString
      description: Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
    BankingScheduledPaymentSet:
      required:
      - to
      type: object
      properties:
        to:
          $ref: '#/components/schemas/BankingScheduledPaymentTo'
        isAmountCalculated:
          type: boolean
          description: Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed
          x-cds-type: Boolean
        amount:
          type: string
          description: The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
          x-cds-type: AmountString
        currency:
          type: string
          description: The currency for the payment. AUD assumed if not present
          x-cds-type: CurrencyString
      description: The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry
      x-conditional:
      - amount
    BankingTransactionDetailV2:
      allOf:
      - $ref: '#/components/schemas/BankingTransaction'
      - required:
        - extendedData
        type: object
        properties:
          extendedData:
            $ref: '#/components/schemas/BankingTransactionDetail_extendedDataV2'
    MetaPaginated:
      required:
      - totalPages
      - totalRecords
      type: object
      properties:
        totalRecords:
          type: integer
          description: The total number of records in the full set. See [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
          x-cds-type: NaturalNumber
        totalPages:
          type: integer
          description: The total number of pages in the full set. See [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
          x-cds-type: NaturalNumber
    BankingScheduledPaymentRecurrence:
      required:
      - recurrenceUType
      type: object
      properties:
        nextPaymentDate:
          type: string
          description: The date of the next payment under the recurrence schedule
          x-cds-type: DateString
        recurrenceUType:
          type: string
          description: The type of recurrence used to define the schedule
          enum:
          - onceOff
          - intervalSchedule
          - lastWeekDay
          - eventBased
        onceOff:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceOnceOff'
        intervalSchedule:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceIntervalSchedule'
        lastWeekDay:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekday'
        eventBased:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrenceEventBased'
      description: Object containing the detail of the schedule for the payment
      x-conditional:
      - onceOff
      - intervalSchedule
      - lastWeekDay
      - eventBased
    BankingTransaction:
      required:
      - accountId
      - amount
      - description
      - isDetailAvailable
      - reference
      - status
      - type
      type: object
      properties:
        accountId:
          type: string
          description: ID of the account for which transactions are provided
          x-cds-type: ASCIIString
        transactionId:
          type: string
          description: A unique ID of the transaction adhering to the standards for ID permanence.  This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type
          x-cds-type: ASCIIString
        isDetailAvailable:
          type: boolean
          description: True if extended information is available using the transaction detail end point. False if extended data is not available
          x-cds-type: Boolean
        type:
          type: string
          description: The type of the transaction
          enum:
          - FEE
          - INTEREST_CHARGED
          - INTEREST_PAID
          - TRANSFER_OUTGOING
          - TRANSFER_INCOMING
          - PAYMENT
          - DIRECT_DEBIT
          - OTHER
        status:
          type: string
          description: Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction
          enum:
          - PENDING
          - POSTED
        description:
          type: string
          description: The transaction description as applied by the financial institution
        postingDateTime:
          type: string
          description: The time the transaction was posted. This field is Mandatory if the transaction has status POSTED.  This is the time that appears on a standard statement
          x-cds-type: DateTimeString
        valueDateTime:
          type: string
          description: Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry
          x-cds-type: DateTimeString
        executionDateTime:
          type: string
          description: The time the transaction was executed by the originating customer, if available
          x-cds-type: DateTimeString
        amount:
          type: string
          description: The value of the transaction. Negative values mean money was outgoing from the account
          x-cds-type: AmountString
        currency:
          type: string
          description: The currency for the transaction amount. AUD assumed if not present
          x-cds-type: CurrencyString
        reference:
          type: string
          description: The reference for the transaction provided by the originating institution. Empty string if no data provided
        merchantName:
          type: string
          description: Name of the merchant for an outgoing payment to a merchant
        merchantCategoryCode:
          type: string
          description: The merchant category code (or MCC) for an outgoing payment to a merchant
        billerCode:
          type: string
          description: BPAY Biller Code for the transaction (if available)
        billerName:
          type: string
          description: Name of the BPAY biller for the transaction (if available)
        crn:
          type: string
          description: BPAY CRN for the transaction (if available)
        apcaNumber:
          type: string
          description: 6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.
      x-conditional:
      - transactionId
      - postingDateTime
    BankingInternationalPayee_beneficiaryDetails:
      required:
      - country
      type: object
      properties:
        name:
          type: string
          description: Name of the beneficiary
        country:
          type: string
          description: Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code
          x-cds-type: ExternalRef
        message:
          type: string
          description: Response message for the payment
    ResponseBankingPayeeList_data:
      required:
      - payees
      type: object
      properties:
        payees:
          type: array
          description: The list of payees returned
          items:
            $ref: '#/components/schemas/BankingPayee'
    ResponseBankingPayeeList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResponseBankingPayeeList_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
    BankingAccountDetail:
      allOf:
      - $ref: '#/components/schemas/BankingAccount'
      - type: object
        properties:
          bsb:
            type: string
            description: The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
          accountNumber:
            type: string
            description: The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
          bundleName:
            type: string
            description: Optional field to indicate if this account is part of a bundle that is providing additional benefit for to the customer
          specificAccountUType:
            type: string
            description: The type of structure to present account specific fields.
            enum:
            - termDeposit
            - creditCard
            - loan
          termDeposit:
            type: array
            items:
              $ref: '#/components/schemas/BankingTermDepositAccount'
          creditCard:
            $ref: '#/components/schemas/BankingCreditCardAccount'
          loan:
            $ref: '#/components/schemas/BankingLoanAccount'
          depositRate:
            type: string
            description: current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call
            x-cds-type: RateString
          lendingRate:
            type: string
            description: The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
            x-cds-type: RateString
          depositRates:
            type: array
            description: Fully described deposit rates for this account based on the equivalent structure in Product Reference
            items:
              $ref: '#/components/schemas/BankingProductDepositRate'
          lendingRates:
            type: array
            description: Fully described deposit rates for this account based on the equivalent structure in Product Reference
            items:
              $ref: '#/components/schemas/BankingProductLendingRate'
          features:
            type: array
            description: Array of features of the account based on the equivalent structure in Product Reference with the following additional field
            items:
              type: object
              allOf:
              - $ref: '#/components/schemas/BankingProductFeature'
              - type: object
                properties:
                  isActivated:
                    type: string
                    description: True if the feature is already activated and false if the feature is available for activation. Defaults to true if absent. (note this is an additional field appended to the feature object defined in the Product Reference payload)
          fees:
            type: array
            description: Fees and charges applicable to the account based on the equivalent structure in Product Reference
            items:
              $ref: '#/components/schemas/BankingProductFee'
          addresses:
            type: array
            description: The addresses for the account to be used for correspondence
            items:
              $ref: '#/components/schemas/CommonPhysicalAddress'
        x-conditional:
        - termDeposit
        - creditCard
        - loan
    BankingAccount:
      required:
      - accountId
      - accountOwnership
      - displayName
      - maskedNumber
      - productCategory
      - productName
      type: object
      properties:
        accountId:
          type: string
          description: A unique ID of the account adhering to the standards for ID permanence
          x-cds-type: ASCIIString
        creationDate:
          type: string
          description: Date that the account was created (if known)
          x-cds-type: DateString
        displayName:
          type: string
          description: The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.
        nickname:
          type: string
          description: A customer supplied nick name for the account
        openStatus:
          type: string
          description: Open or closed status for the account. If not present then OPEN is assumed
          default: OPEN
          enum:
          - OPEN
          - CLOSED
        isOwned:
          type: boolean
          description: Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed
          default: true
          x-cds-type: Boolean
        accountOwnership:
          type: string
          description: Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers.
          default: UNKNOWN
          enum:
          - UNKNOWN
          - ONE_PARTY
          - TWO_PARTY
          - MANY_PARTY
          - OTHER
        maskedNumber:
          type: string
          description: A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
          x-cds-type: MaskedAccountString
        productCategory:
          $ref: '#/components/schemas/BankingProductCategory'
        productName:
          type: string
          description: The unique identifier of the account as defined by the data holder (akin to model number for the account)
    BankingTransactionDetail_extendedData:
      required:
      - service
      type: object
      properties:
        payer:
          type: string
          description: Label of the originating payer. Mandatory for inbound payment
        payee:
          type: string
          description: Label of the target PayID.  Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID)
        extensionUType:
          type: string
          description: Optional extended data provided specific to transaction originated via NPP
          enum:
          - x2p101Payload
        x2p101Payload:
          $ref: '#/components/schemas/BankingTransactionDetail_extendedData_x2p101Payload'
        service:
          type: string
          description: 'Identifier of the applicable overlay service. Valid values are: X2P1.01'
          enum:
          - X2P1.01
    BankingInternationalPayee:
      required:
      - bankDetails
      - beneficiaryDetails
      type: object
      properties:
        beneficiaryDetails:
          $ref: '#/components/schemas/BankingInternationalPayee_beneficiaryDetails'
        bankDetails:
          $ref: '#/components/schemas/BankingInternationalPayee_bankDetails'
    MetaPaginated_2:
      required:
      - totalPages
      - totalRecords
      type: object
      properties:
        totalRecords:
          type: integer
          description: The total number of records in the full set. See [pagination](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*pagination__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KADXoEMpQ$ ).
          x-cds-type: NaturalNumber
        totalPages:
          type: integer
          description: The total number of pages in the full set. See [pagination](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*pagination__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KADXoEMpQ$ ).
          x-cds-type: NaturalNumber
    ResponseBankingDirectDebitAuthorisationList_data:
      required:
      - directDebitAuthorisations
      type: object
      properties:
        directDebitAuthorisations:
          type: array
          description: The list of authorisations returned
          items:
            $ref: '#/components/schemas/BankingDirectDebit'
    BankingAuthorisedEntity:
      type: object
      properties:
        description:
          type: string
          description: Description of the authorised entity derived from previously executed direct debits
        financialInstitution:
          type: string
          description: Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme
        abn:
          type: string
          description: Australian Business Number for the authorised entity
        acn:
          type: string
          description: Australian Company Number for the authorised entity
        arbn:
          type: string
          description: Australian Registered Body Number for the authorised entity
    BankingTermDepositAccount:
      required:
      - lodgementDate
      - maturityDate
      - maturityInstructions
      type: object
      properties:
        lodgementDate:
          type: string
          description: The lodgement date of the original deposit
          x-cds-type: DateString
        maturityDate:
          type: string
          description: Maturity date for the term deposit
          x-cds-type: DateString
        maturityAmount:
          type: string
          description: Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated
          x-cds-type: AmountString
        maturityCurrency:
          type: string
          description: If absent assumes AUD
          x-cds-type: CurrencyString
        maturityInstructions:
          type: string
          description: Current instructions on action to be taken at maturity
          enum:
          - ROLLED_OVER
          - PAID_OUT_AT_MATURITY
    CommonPAFAddress:
      required:
      - localityName
      - postcode
      - state
      type: object
      properties:
        dpid:
          type: string
          description: Unique identifier for an address as defined by Australia Post.  Also known as Delivery Point Identifier
        thoroughfareNumber1:
          type: integer
          description: Thoroughfare number for a property (first number in a property ranged address)
          x-cds-type: PositiveInteger
        thoroughfareNumber1Suffix:
          type: string
          description: Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
        thoroughfareNumber2:
          type: integer
          description: Second thoroughfare number (only used if the property has a ranged address eg 23-25)
          x-cds-type: PositiveInteger
        thoroughfareNumber2Suffix:
          type: string
          description: Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
        flatUnitType:
          type: string
          description: Type of flat or unit for the address
        flatUnitNumber:
          type: string
          description: Unit number (including suffix, if applicable)
        floorLevelType:
          type: string
          description: Type of floor or level for the address
        floorLevelNumber:
          type: string
          description: Floor or level number (including alpha characters)
        lotNumber:
          type: string
          description: Allotment number for the address
        buildingName1:
          type: string
          description: Building/Property name 1
        buildingName2:
          type: string
          description: Building/Property name 2
        streetName:
          type: string
          description: The name of the street
        streetType:
          type: string
          description: The street type. Valid enumeration defined by Australia Post PAF code file
        streetSuffix:
          type: string
          description: The street type suffix. Valid enumeration defined by Australia Post PAF code file
        postalDeliveryType:
          type: string
          description: Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
        postalDeliveryNumber:
          type: integer
          description: Postal delivery number if the address is a postal delivery type
          x-cds-type: PositiveInteger
        postalDeliveryNumberPrefix:
          type: string
          description: Postal delivery number prefix related to the postal delivery number
        postalDeliveryNumberSuffix:
          type: string
          description: Postal delivery number suffix related to the postal delivery number
        localityName:
          type: string
          description: Full name of locality
        postcode:
          type: string
          description: Postcode for the locality
        state:
          type: string
          description: State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
      description: Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)
    BankingProductRateTierV3:
      required:
      - minimumValue
      - name
      - unitOfMeasure
      type: object
      description: Defines the criteria and conditions for which a rate applies
      properties:
        name:
          type: string
          description: A display name for the tier
        unitOfMeasure:
          type: string
          description: The unit of measure that applies to the tierValueMinimum and tierValueMaximum values
          enum:
          - DOLLAR
          - PERCENT
          - MONTH
          - DAY
        minimumValue:
          type: string
          description: The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
        maximumValue:
          type: string
          description: The number of tierUnitOfMeasure units that form the upper bound of the tier or band.
        rateApplicationMethod:
          type: string
          description: The method used to calculate the amount to be applied using one or more tiers.
          enum:
          - WHOLE_BALANCE
          - PER_TIER
        applicabilityConditions:
          type: array
          description: Conditions that must be met for this tier to apply
          items:
            type: object
            properties:
              additionalInfo:
                type: string
                description: Display text providing more information
              additionalInfoUri:
                type: string
                description: Link to a web page with more information
                x-cds-type: URIString
              additionalValue:
                type: string
                description: Value relevant to the condition
              rateApplicabilityType:
                type: string
                description: The type of applicability condition
                enum:
                - NEW_CUSTOMER
                - RECURRING_DEPOSIT
                - MIN_BALANCE
                - MAX_BALANCE
                - OTHER
        additionalInfo:
          type: string
          description: Display text providing more information on the rate tier.
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this rate tier
          x-cds-type: URIString
    ResponseBankingAccountsBalanceById:
      required:
      - data
      - links
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BankingBalance'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
    BankingDirectDebit:
      required:
      - accountId
      - authorisedEntity
      type: object
      properties:
        accountId:
          type: string
          description: A unique ID of the account adhering to the standards for ID permanence.
          x-cds-type: ASCIIString
        authorisedEntity:
          $ref: '#/components/schemas/BankingAuthorisedEntity'
        lastDebitDateTime:
          type: string
          description: The date and time of the last debit executed under this authorisation
          x-cds-type: DateTimeString
        lastDebitAmount:
          type: string
          description: The amount of the last debit executed under this authorisation
          x-cds-type: AmountString
    BankingProductLendingRate:
      required:
      - lendingRateType
      - rate
      type: object
      properties:
        lendingRateType:
          type: string
          description: The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning
          enum:
          - FIXED
          - VARIABLE
          - INTRODUCTORY
          - DISCOUNT
          - PENALTY
          - FLOATING
          - MARKET_LINKED
          - CASH_ADVANCE
          - PURCHASE
          - BUNDLE_DISCOUNT_FIXED
          - BUNDLE_DISCOUNT_VARIABLE
        rate:
          type: string
          description: The rate to be applied
          x-cds-type: RateString
        comparisonRate:
          type: string
          description: A comparison rate equivalent for this rate
          x-cds-type: RateString
        calculationFrequency:
          type: string
          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)
          x-cds-type: ExternalRef
        applicationFrequency:
          type: string
          description: The period after which the calculated amount(s) are applied to the account.
        applicationType:
          type: string
          description: The type of application for the rate
          enum:
          - PERIODIC
          - AT_MATURITY
        interestPaymentDue:
          type: string
          description: When loan payments are due to be paid within each period.
          enum:
          - IN_ARREARS
          - IN_ADVANCE
        repaymentType:
          type: string
          description: Options in place for repayments.
          enum:
          - INTEREST_ONLY
          - PRINCIPAL_AND_INTEREST
        loanPurpose:
          type: string
          description: The reason for taking out the loan.
          enum:
          - OWNER_OCCUPIED
          - INVESTMENT
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the lendingRateType specified.
        additionalInfo:
          type: string
          description: Display text providing more information on the rate.
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this rate
          x-cds-type: URIString
        applicabilityConditions:
          type: array
          description: Conditions that must be met for this rate to apply
          items:
            type: object
            properties:
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
                x-cds-type: URIString
              additionalValue:
                type: string
              rateApplicabilityType:
                type: string
                enum:
                - NEW_CUSTOMER
                - RECURRING_DEPOSIT
                - MIN_BALANCE
                - MAX_BALANCE
                - OTHER
        tiers:
          type: array
          description: Rate tiers applicable for this rate
          items:
            type: object
            required:
            - minimumValue
            - name
            - unitOfMeasure
            properties:
              name:
                type: string
              unitOfMeasure:
                type: string
                enum:
                - DOLLAR
                - PERCENT
                - MONTH
                - DAY
              minimumValue:
                type: string
              maximumValue:
                type: string
              rateApplicationMethod:
                type: string
                enum:
                - WHOLE_BALANCE
                - PER_TIER
              applicabilityConditions:
                type: array
                items:
                  type: object
                  properties:
                    additionalInfo:
                      type: string
                    additionalInfoUri:
                      type: string
                      x-cds-type: URIString
                    additionalValue:
                      type: string
                    rateApplicabilityType:
                      type: string
                      enum:
                      - NEW_CUSTOMER
                      - RECURRING_DEPOSIT
                      - MIN_BALANCE
                      - MAX_BALANCE
                      - OTHER
              additionalInfo:
                type: string
              additionalInfoUri:
                type: string
                x-cds-type: URIString
      x-conditional:
      - additionalValue
    ResponseBankingTransactionList_data:
      required:
      - transactions
      type: object
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/BankingTransaction'
    RequestAccountIds_data:
      required:
      - accountIds
      type: object
      properties:
        accountIds:
          type: array
          items:
            type: string
            description: Array of specific accountIds to obtain authorisations for
            x-cds-type: ASCIIString
    ResponseBankingAccountList:
      required:
      - data
      - links
      - meta
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResponseBankingAccountList_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
    BankingProductFeature_2:
      required:
      - featureType
      type: object
      properties:
        featureType:
          type: string
          description: The type of feature described
          enum:
          - CARD_ACCESS
          - ADDITIONAL_CARDS
          - UNLIMITED_TXNS
          - FREE_TXNS
          - FREE_TXNS_ALLOWANCE
          - LOYALTY_PROGRAM
          - OFFSET
          - OVERDRAFT
          - REDRAW
          - INSURANCE
          - BALANCE_TRANSFERS
          - INTEREST_FREE
          - INTEREST_FREE_TRANSFERS
          - DIGITAL_WALLET
          - DIGITAL_BANKING
          - NPP_PAYID
          - NPP_ENABLED
          - DONATE_INTEREST
          - BILL_PAYMENT
          - COMPLEMENTARY_PRODUCT_DISCOUNTS
          - BONUS_REWARDS
          - NOTIFICATIONS
          - FUNDS_AVAILABLE_AFTER
          - OTHER
        additionalValue:
          type: string
          description: Generic field containing additional information relevant to the [featureType](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductfeaturetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KANohWM7P$ ) specified. Whether mandatory or not is dependent on the value of the [featureType.](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductfeaturetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KANohWM7P$ )
        additionalInfo:
          type: string
          description: Display text providing more information on the feature. Mandatory if the [feature type](https://urldefense.com/v3/__https://consumerdatastandardsaustralia.github.io/standards/*tocSproductfeaturetypedoc__;Iw!!NJXWK16iIFCjY1RxFh8!wuUyIkLE_6EOEDj0DlpQqQYCOtGDRFgSIwaBoxMrvyBvPd-Sx0HkvyiUjf2BAfFMP9uD26z37_sauK7njr6KANohWM7P$ ) is set to OTHER
        additionalInfoUri:
          type: string
          description: Link to a web page with more information on this feature
          x-cds-type: URIString
      x-conditional:
      - additionalValue
      - additionalInfo
    BankingScheduledPaymentTo:
      required:
      - toUType
      type: object
      properties:
        toUType:
          type: string
          description: The type of object provided that specifies the destination of the funds for the payment.
          enum:
          - accountId
          - payeeId
          - domestic
          - biller
          - international
        accountId:
          type: string
          description: Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
          x-cds-type: ASCIIString
        payeeId:
          type: string
          description: Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead
          x-cds-type: ASCIIString
        domestic:
          $ref: '#/components/schemas/BankingDomesticPayee'
        biller:
          $ref: '#/components/schemas/BankingBillerPayee'
        international:
          $ref: '#/components/schemas/BankingInternationalPayee'
      description: Object containing details of the destination of the payment. Used to specify a variety of payment destination types
      x-conditional:
      - accountId
      - payeeId
      - domestic
      - biller
      - international