BCU Bank Banking Account Scheduled Payments API

openapi: 3.2.0
info:
  title: CDR Banking Banking Account Balances Banking Account Scheduled Payments API
  version: 1.36.0
  description: Specifications for resource endpoints applicable to data holders in the Banking sector.
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  contact:
    name: Data Standards Body
    email: contact@dsb.gov.au
    url: https://dsb.gov.au/
servers:
- description: MTLS
  url: https://mtls.dh.example.com/cds-au/v1
tags:
- name: Banking Account Scheduled Payments
  x-shortName: Scheduled Payments
  description: Banking Account Scheduled Payment endpoints
paths:
  /banking/accounts/{accountId}/payments/scheduled:
    get:
      tags:
      - Banking Account Scheduled Payments
      summary: Get Scheduled Payments for Account
      description: 'Obtain scheduled, outgoing payments for a specific account.


        Obsolete versions: [v1](includes/obsolete/get-scheduled-payments-for-account-v1.html).'
      operationId: listScheduledPayments
      parameters:
      - $ref: '#/components/parameters/PathAccountId'
      - $ref: '#/components/parameters/QueryPage'
      - $ref: '#/components/parameters/QueryPageSize'
      - $ref: '#/components/parameters/HeaderXV'
      - $ref: '#/components/parameters/HeaderXMinV'
      - $ref: '#/components/parameters/HeaderXFAPIInteractionId'
      - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
      - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
      - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListScheduledPayments200'
        '400':
          $ref: '#/components/responses/ListScheduledPayments400'
        '404':
          $ref: '#/components/responses/ListScheduledPayments404'
        '406':
          $ref: '#/components/responses/ListScheduledPayments406'
        '422':
          $ref: '#/components/responses/ListScheduledPayments422'
      x-scopes:
      - bank:regular_payments:read
      x-version: '2'
  /banking/payments/scheduled:
    get:
      tags:
      - Banking Account Scheduled Payments
      summary: Get Scheduled Payments Bulk
      description: 'Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments.


        Obsolete versions: [v1](includes/obsolete/get-scheduled-payments-bulk-v1.html), [v2](includes/obsolete/get-scheduled-payments-bulk-v2.html).'
      operationId: listScheduledPaymentsBulk
      parameters:
      - $ref: '#/components/parameters/QueryBankingProductCategory'
      - $ref: '#/components/parameters/QueryBankingAccountOpenStatus'
      - $ref: '#/components/parameters/QueryBankingAccountIsOwned'
      - $ref: '#/components/parameters/QueryPage'
      - $ref: '#/components/parameters/QueryPageSize'
      - $ref: '#/components/parameters/HeaderXV'
      - $ref: '#/components/parameters/HeaderXMinV'
      - $ref: '#/components/parameters/HeaderXFAPIInteractionId'
      - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
      - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
      - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListScheduledPaymentsBulk200'
        '400':
          $ref: '#/components/responses/ListScheduledPaymentsBulk400'
        '406':
          $ref: '#/components/responses/ListScheduledPaymentsBulk406'
        '422':
          $ref: '#/components/responses/ListScheduledPaymentsBulk422'
      x-scopes:
      - bank:regular_payments:read
      x-version: '3'
    post:
      tags:
      - Banking Account Scheduled Payments
      summary: Get Scheduled Payments For Specific Accounts
      description: 'Obtain scheduled payments for a specified list of accounts.


        Obsolete versions: [v1](includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html).'
      operationId: listScheduledPaymentsSpecificAccounts
      parameters:
      - $ref: '#/components/parameters/QueryPage'
      - $ref: '#/components/parameters/QueryPageSize'
      - $ref: '#/components/parameters/HeaderXV'
      - $ref: '#/components/parameters/HeaderXMinV'
      - $ref: '#/components/parameters/HeaderXFAPIInteractionId'
      - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
      - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
      - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      requestBody:
        $ref: '#/components/requestBodies/RequestAccountIds'
      responses:
        '200':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts200'
        '400':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts400'
        '406':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts406'
        '422':
          $ref: '#/components/responses/ListScheduledPaymentsSpecificAccounts422'
      x-scopes:
      - bank:regular_payments:read
      x-version: '2'
  /banking/accounts/{accountId}/payments/plans:
    get:
      tags:
      - Banking Account Scheduled Payments
      summary: Get Instalment Plans for Account
      description: Obtain instalment plans for a single specified account. The response **MUST** be ordered by plan _creationDate_ in descending order. If _isInstalmentDetailAvailable_ was specified as `true` for the provided _accountId_ but no plans match the provided parameters, an empty array **MUST** be returned. If _isInstalmentDetailAvailable_ was specified as `false` for the provided _accountId_, then the endpoint **MAY** respond with [404 - Resource Not Implemented](#error-404-resource-not-implemented).
      operationId: listInstalmentPlans
      parameters:
      - $ref: '#/components/parameters/PathAccountId'
      - $ref: '#/components/parameters/QueryPlanStatus'
      - $ref: '#/components/parameters/QueryPage'
      - $ref: '#/components/parameters/QueryPageSize'
      - $ref: '#/components/parameters/HeaderXV'
      - $ref: '#/components/parameters/HeaderXMinV'
      - $ref: '#/components/parameters/HeaderXFAPIInteractionId'
      - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
      - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
      - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListInstalmentPlans200'
        '400':
          $ref: '#/components/responses/ListInstalmentPlans400'
        '404':
          $ref: '#/components/responses/ListInstalmentPlans404'
        '406':
          $ref: '#/components/responses/ListInstalmentPlans406'
        '422':
          $ref: '#/components/responses/ListInstalmentPlans422'
      x-scopes:
      - bank:regular_payments:read
      x-version: '1'
  /banking/accounts/payments/plans:
    get:
      tags:
      - Banking Account Scheduled Payments
      summary: Get Instalment Plans Bulk
      description: Obtain instalment plans for multiple accounts. The response **MUST** be ordered by plan _creationDate_ in descending order. If instalments are not supported for any account type, the endpoint **MAY** respond with [404 - Resource Not Implemented](#error-404-resource-not-implemented).
      operationId: listInstalmentPlansBulk
      parameters:
      - $ref: '#/components/parameters/QueryPlanStatus'
      - $ref: '#/components/parameters/QueryPage'
      - $ref: '#/components/parameters/QueryPageSize'
      - $ref: '#/components/parameters/HeaderXV'
      - $ref: '#/components/parameters/HeaderXMinV'
      - $ref: '#/components/parameters/HeaderXFAPIInteractionId'
      - $ref: '#/components/parameters/HeaderXFAPIAuthDate'
      - $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
      - $ref: '#/components/parameters/HeaderXCDSClientHeaders'
      responses:
        '200':
          $ref: '#/components/responses/ListInstalmentPlansBulk200'
        '400':
          $ref: '#/components/responses/ListInstalmentPlansBulk400'
        '406':
          $ref: '#/components/responses/ListInstalmentPlansBulk406'
        '422':
          $ref: '#/components/responses/ListInstalmentPlansBulk422'
      x-scopes:
      - bank:regular_payments:read
      x-version: '1'
components:
  schemas:
    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
    BankingDigitalWalletPayee:
      required:
      - identifier
      - name
      - provider
      - type
      type: object
      properties:
        name:
          type: string
          description: The display name of the wallet as given by the customer, else a default value defined by the data holder.
        identifier:
          type: string
          description: The identifier of the digital wallet (dependent on type).
        type:
          type: string
          description: The type of the digital wallet identifier.
          enum:
          - EMAIL
          - CONTACT_NAME
          - TELEPHONE
        provider:
          type: string
          description: The provider of the digital wallet.
          enum:
          - PAYPAL_AU
          - OTHER
    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 available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.
        billerName:
          type: string
          description: Name of the Biller.
      x-conditional:
      - crn
    BankingAccountId:
      type: string
      description: A unique identifier for a Banking account, generated according to [CDR ID Permanence](#id-permanence) requirements.
      x-cds-type: ASCIIString
    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.
          example: 1
          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`.<ul><li>`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.<li>`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.<li>`ON` - If a scheduled payment date is a non-business day the payment will be made on that day regardless.<li>`ONLY` - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored.</ul>
          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 the _recurrenceUType_ value is `intervalSchedule`.
    Meta:
      type: object
    BankingScheduledPaymentToV2:
      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
          - biller
          - digitalWallet
          - domestic
          - international
          - payeeId
        accountId:
          description: Present if _toUType_ is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent.
          allOf:
          - $ref: '#/components/schemas/BankingAccountId'
        payeeId:
          description: Present if _toUType_ is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a _payeeId_ should not be provided and the full payee details should be provided instead.
          allOf:
          - $ref: '#/components/schemas/BankingPayeeId'
        nickname:
          type: string
          description: The short display name of the payee as provided by the customer unless _toUType_ is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels.
        payeeReference:
          type: string
          description: The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.
        digitalWallet:
          $ref: '#/components/schemas/BankingDigitalWalletPayee'
        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
      - digitalWallet
      - domestic
      - biller
      - international
      - nickname
      - payeeReference
    MetaPaginated:
      required:
      - totalPages
      - totalRecords
      type: object
      properties:
        totalRecords:
          type: integer
          description: The total number of records in the full set. See [pagination](#pagination).
          x-cds-type: NaturalNumber
        totalPages:
          type: integer
          description: The total number of pages in the full set. See [pagination](#pagination).
          x-cds-type: NaturalNumber
    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.
          example: 1
          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:
          - FRI
          - MON
          - SAT
          - SUN
          - THU
          - TUE
          - WED
        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`.<ul><li>`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.<li>`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.<li>`ON` - If a scheduled payment date is a non-business day the payment will be made on that day regardless.<li>`ONLY` - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored.</ul>
          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 the _recurrenceUType_ value is `lastWeekDay`.
    BankingDomesticPayee:
      required:
      - payeeAccountUType
      type: object
      properties:
        payeeAccountUType:
          type: string
          description: 'Type of account object included. Valid values are: <ul><li>`account` A standard Australian account defined by BSB/Account Number.<li>`card` A credit or charge card to pay to (note that PANs are masked).<li>`payId` A PayID recognised by NPP.</ul>'
          enum:
          - account
          - card
          - payId
        account:
          $ref: '#/components/schemas/BankingDomesticPayeeAccount'
        card:
          $ref: '#/components/schemas/BankingDomesticPayeeCard'
        payId:
          $ref: '#/components/schemas/BankingDomesticPayeePayId'
      x-conditional:
      - account
      - card
      - payId
    BankingInstalmentPlan:
      required:
      - accountId
      - planId
      - planReference
      - merchantName
      - planNickname
      - creationDate
      - amount
      - duration
      - instalmentInterval
      - schedule
      type: object
      properties:
        accountId:
          description: Unique identifier for the account.
          allOf:
          - $ref: '#/components/schemas/BankingAccountId'
        planId:
          description: Unique identifier for this plan in accordance with ID Permanence requirements.
          allOf:
          - $ref: '#/components/schemas/BankingInstalmentPlanId'
        planReference:
          type: string
          description: Unique purchase or order number for this plan, aligned to other channels.
        merchantName:
          type: string
          description: Name of the merchant associated with the instalment plan.
        merchantCategoryCode:
          type: string
          description: The merchant category code (MCC) for the merchant associated with the instalment plan.
        planNickname:
          type: string
          description: The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with other channels.
        creationDate:
          type: string
          description: The date the plan was created.
          x-cds-type: DateString
        amount:
          type: string
          description: The original transaction amount the instalment plan was created for, including any upfront payment. E.g., For a $100 purchase split into four repayments, this would be `100.00`.
          x-cds-type: AmountString
        planCurrency:
          type: string
          description: The currency of the plan amount. If absent assumed to be `AUD`.
          default: AUD
          x-cds-type: CurrencyString
        planCharge:
          type: string
          description: Any charges incorporated into the scheduled amounts due, excluding other fees. E.g., If the consumer agrees to repay a $100 purchase plus a $5 charge split across four instalments, this would be `5.00`.
          x-cds-type: AmountString
        planRate:
          type: string
          description: If displayed to the consumer, the percentage value of any charges incorporated into the scheduled amounts due, excluding other fees. E.g., If the consumer agrees to repay a $1000 purchase plus 10% interest split across twelve instalments, this would be `0.1`.
          x-cds-type: RateString
        duration:
          type: string
          description: The expected repayment period as at the creation of the plan. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). E.g., For a further three fortnightly repayments from the _creationDate_, this would be `P6W`.
          x-cds-type: ExternalRef
        instalmentInterval:
          type: string
          description: The expected repayment interval. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). E.g., For fortnightly repayments, this would be `P2W`.
          x-cds-type: ExternalRef
        schedule:
          type: array
          description: Array of scheduled repayment amounts and dates.
          items:
            $ref: '#/components/schemas/BankingInstalmentPlanSchedule'
    BankingScheduledPaymentId:
      type: string
      description: A unique identifier for a Banking scheduled payment, generated according to [CDR ID Permanence](#id-permanence) requirements.
      x-cds-type: ASCIIString
    BankingScheduledPaymentV2:
      required:
      - from
      - payerReference
      - paymentSet
      - recurrence
      - scheduledPaymentId
      - status
      type: object
      properties:
        scheduledPaymentId:
          description: Unique identifier for the scheduled payment.
          allOf:
          - $ref: '#/components/schemas/BankingScheduledPaymentId'
        nickname:
          type: string
          description: The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels.
        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’s account. Empty string if no data provided.
        payeeReference:
          type: string
          description: The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided.
        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
          - INACTIVE
          - SKIP
        from:
          $ref: '#/components/schemas/BankingScheduledPaymentFrom'
        paymentSet:
          type: array
          items:
            $ref: '#/components/schemas/BankingScheduledPaymentSetV2'
        recurrence:
          $ref: '#/components/schemas/BankingScheduledPaymentRecurrence'
      x-conditional:
      - payeeReference
    RequestAccountIdListV1:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - accountIds
          properties:
            accountIds:
              type: array
              description: Array of _accountId_ values to obtain data for.
              items:
                $ref: '#/components/schemas/BankingAccountId'
        meta:
          $ref: '#/components/schemas/Meta'
    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:
          - eventBased
          - intervalSchedule
          - lastWeekDay
          - onceOff
        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
    ResponseErrorListV2:
      type: object
      required:
      - errors
      properties:
        errors:
          description: List of errors.
          type: array
          items:
            $ref: '#/components/schemas/ErrorV2'
    BankingPayeeId:
      type: string
      description: A unique identifier for a Banking payee, generated according to [CDR ID Permanence](#id-permanence) requirements.
      x-cds-type: ASCIIString
    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:
          - ABN
          - EMAIL
          - ORG_IDENTIFIER
          - TELEPHONE
    BankingInstalmentPlanId:
      type: string
      description: A unique identifier for a Banking instalment plan, generated according to [CDR ID Permanence](#id-permanence) requirements.
      x-cds-type: ASCIIString
    BankingProductCategoryV2:
      type: string
      description: The category to which a product or account belongs. See [here](#product-categories) for more details.
      enum:
      - BUSINESS_LOANS
      - BUY_NOW_PAY_LATER
      - CRED_AND_CHRG_CARDS
      - LEASES
      - MARGIN_LOANS
      - OVERDRAFTS
      - PERS_LOANS
      - REGULATED_TRUST_ACCOUNTS
      - RESIDENTIAL_MORTGAGES
      - TERM_DEPOSITS
      - TRADE_FINANCE
      - TRANS_AND_SAVINGS_ACCOUNTS
      - TRAVEL_CARDS
    BankingDomesticPayeeCard:
      required:
      - cardNumber
      type: object
      properties:
        cardNumber:
          type: string
          description: Name of the account to pay to.
          x-cds-type: MaskedPANString
    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.
    BankingInstalmentPlanSchedule:
      required:
      - amountDue
      - dueDate
      type: object
      properties:
        amountDue:
          type: string
          description: Amount due with this repayment.
          x-cds-type: AmountString
        dueDate:
          type: string
          description: Date this repayment is or was due.
          x-cds-type: DateString
        isPaid:
          type: boolean
          default: false
          description: Whether the associated _amountDue_ has been paid or is otherwise considered as not outstanding. `false` is assumed if absent.
    BankingScheduledPaymentSetV2:
      required:
      - to
      type: object
      properties:
        to:
          $ref: '#/components/schemas/BankingScheduledPaymentToV2'
        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.
          default: false
        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.
          default: AUD
          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
    ErrorV2:
      type: object
      required:
      - code
      - title
      - detail
      x-conditional:
      - meta
      properties:
        code:
          type: string
          description: The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the _meta_ object. Otherwise, the value is the error code URN.
        title:
          type: string
          description: A short, human-readable summary of the problem that **MUST NOT** change from occurrence to occurrence of the problem represented by the error code.
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
        meta:
          type: object
          x-conditional:
          - urn
          description: Additional data for customised error codes.
          properties:
            urn:
              type: string
              description: The CDR error code URN which the application-specific error code extends. Mandatory if the error _code_ is an application-specific error rather than a standardised error code.
    BankingInternationalPayee:
      required:
      - bankDetails
      - beneficiaryDetails
      type: object
      properties:
        beneficiaryDetails:
          required:
          - country
          type: object
          properties:
            name:
              type: string
              description: Name of the beneficiary.
            country:
              type: string
 

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bcu-bank/refs/heads/main/openapi/bcu-bank-banking-account-scheduled-payments-api-openapi.yml