ResponseBankingScheduledPaymentsListV2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bank-of-queensland/main/json-schema/bank-of-queensland-response-banking-scheduled-payments-list-v2-schema.json",
  "title": "ResponseBankingScheduledPaymentsListV2",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bank-of-queensland-banking-account-scheduled-payments-api-openapi.yml#/components/schemas/ResponseBankingScheduledPaymentsListV2",
  "properties": {
    "data": {
      "$ref": "#/$defs/ResponseBankingScheduledPaymentsListV2_data"
    },
    "links": {
      "$ref": "#/$defs/LinksPaginated"
    },
    "meta": {
      "$ref": "#/$defs/MetaPaginated"
    }
  },
  "required": [
    "data",
    "links",
    "meta"
  ],
  "type": "object",
  "$defs": {
    "BankingAccountId": {
      "description": "A unique identifier for a Banking account, generated according to [CDR ID Permanence](#id-permanence) requirements.",
      "type": "string",
      "x-cds-type": "ASCIIString"
    },
    "BankingBillerPayee": {
      "properties": {
        "billerCode": {
          "description": "BPAY Biller Code of the Biller.",
          "type": "string"
        },
        "crn": {
          "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.",
          "type": "string"
        },
        "billerName": {
          "description": "Name of the Biller.",
          "type": "string"
        }
      },
      "required": [
        "billerCode",
        "billerName"
      ],
      "type": "object",
      "x-conditional": [
        "crn"
      ]
    },
    "BankingDigitalWalletPayee": {
      "properties": {
        "name": {
          "description": "The display name of the wallet as given by the customer, else a default value defined by the data holder.",
          "type": "string"
        },
        "identifier": {
          "description": "The identifier of the digital wallet (dependent on type).",
          "type": "string"
        },
        "type": {
          "description": "The type of the digital wallet identifier.",
          "enum": [
            "EMAIL",
            "CONTACT_NAME",
            "TELEPHONE"
          ],
          "type": "string"
        },
        "provider": {
          "description": "The provider of the digital wallet.",
          "enum": [
            "PAYPAL_AU",
            "OTHER"
          ],
          "type": "string"
        }
      },
      "required": [
        "identifier",
        "name",
        "provider",
        "type"
      ],
      "type": "object"
    },
    "BankingDomesticPayee": {
      "properties": {
        "payeeAccountUType": {
          "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"
          ],
          "type": "string"
        },
        "account": {
          "$ref": "#/$defs/BankingDomesticPayeeAccount"
        },
        "card": {
          "$ref": "#/$defs/BankingDomesticPayeeCard"
        },
        "payId": {
          "$ref": "#/$defs/BankingDomesticPayeePayId"
        }
      },
      "required": [
        "payeeAccountUType"
      ],
      "type": "object",
      "x-conditional": [
        "account",
        "card",
        "payId"
      ]
    },
    "BankingDomesticPayeeAccount": {
      "properties": {
        "accountName": {
          "description": "Name of the account to pay to.",
          "type": "string"
        },
        "bsb": {
          "description": "BSB of the account to pay to.",
          "type": "string"
        },
        "accountNumber": {
          "description": "Number of the account to pay to.",
          "type": "string"
        }
      },
      "required": [
        "accountNumber",
        "bsb"
      ],
      "type": "object"
    },
    "BankingDomesticPayeeCard": {
      "properties": {
        "cardNumber": {
          "description": "Name of the account to pay to.",
          "type": "string",
          "x-cds-type": "MaskedPANString"
        }
      },
      "required": [
        "cardNumber"
      ],
      "type": "object"
    },
    "BankingDomesticPayeePayId": {
      "properties": {
        "name": {
          "description": "The name assigned to the PayID by the owner of the PayID.",
          "type": "string"
        },
        "identifier": {
          "description": "The identifier of the PayID (dependent on type).",
          "type": "string"
        },
        "type": {
          "description": "The type of the PayID.",
          "enum": [
            "ABN",
            "EMAIL",
            "ORG_IDENTIFIER",
            "TELEPHONE"
          ],
          "type": "string"
        }
      },
      "required": [
        "identifier",
        "type"
      ],
      "type": "object"
    },
    "BankingInternationalPayee": {
      "properties": {
        "beneficiaryDetails": {
          "$ref": "#/$defs/BankingInternationalPayee_beneficiaryDetails"
        },
        "bankDetails": {
          "$ref": "#/$defs/BankingInternationalPayee_bankDetails"
        }
      },
      "required": [
        "bankDetails",
        "beneficiaryDetails"
      ],
      "type": "object"
    },
    "BankingInternationalPayee_bankDetails": {
      "properties": {
        "country": {
          "description": "Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "accountNumber": {
          "description": "Account Targeted for payment.",
          "type": "string"
        },
        "bankAddress": {
          "$ref": "#/$defs/BankingInternationalPayee_bankDetails_bankAddress"
        },
        "beneficiaryBankBIC": {
          "description": "Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html).",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "fedWireNumber": {
          "description": "Number for Fedwire payment (Federal Reserve Wire Network).",
          "type": "string"
        },
        "sortCode": {
          "description": "Sort code used for account identification in some jurisdictions.",
          "type": "string"
        },
        "chipNumber": {
          "description": "Number for the Clearing House Interbank Payments System.",
          "type": "string"
        },
        "routingNumber": {
          "description": "International bank routing number.",
          "type": "string"
        },
        "legalEntityIdentifier": {
          "description": "The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html).",
          "type": "string",
          "x-cds-type": "ExternalRef"
        }
      },
      "required": [
        "accountNumber",
        "country"
      ],
      "type": "object"
    },
    "BankingInternationalPayee_bankDetails_bankAddress": {
      "properties": {
        "name": {
          "description": "Name of the recipient Bank.",
          "type": "string"
        },
        "address": {
          "description": "Address of the recipient Bank.",
          "type": "string"
        }
      },
      "required": [
        "address",
        "name"
      ],
      "type": "object"
    },
    "BankingInternationalPayee_beneficiaryDetails": {
      "properties": {
        "name": {
          "description": "Name of the beneficiary.",
          "type": "string"
        },
        "country": {
          "description": "Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "message": {
          "description": "Response message for the payment.",
          "type": "string"
        }
      },
      "required": [
        "country"
      ],
      "type": "object"
    },
    "BankingPayeeId": {
      "description": "A unique identifier for a Banking payee, generated according to [CDR ID Permanence](#id-permanence) requirements.",
      "type": "string",
      "x-cds-type": "ASCIIString"
    },
    "BankingScheduledPaymentFrom": {
      "description": "Object containing details of the source of the payment. Currently only specifies an _accountId_ but provided as an object to facilitate future extensibility and consistency with the _to_ object.",
      "properties": {
        "accountId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingAccountId"
            }
          ],
          "description": "Unique identifier for the account."
        }
      },
      "required": [
        "accountId"
      ],
      "type": "object"
    },
    "BankingScheduledPaymentId": {
      "description": "A unique identifier for a Banking scheduled payment, generated according to [CDR ID Permanence](#id-permanence) requirements.",
      "type": "string",
      "x-cds-type": "ASCIIString"
    },
    "BankingScheduledPaymentInterval": {
      "properties": {
        "interval": {
          "description": "An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with _nextPaymentDate_.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "dayInInterval": {
          "default": "P1D",
          "description": "Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is `P1D`. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        }
      },
      "required": [
        "interval"
      ],
      "type": "object"
    },
    "BankingScheduledPaymentRecurrence": {
      "description": "Object containing the detail of the schedule for the payment.",
      "properties": {
        "nextPaymentDate": {
          "description": "The date of the next payment under the recurrence schedule.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "recurrenceUType": {
          "description": "The type of recurrence used to define the schedule.",
          "enum": [
            "eventBased",
            "intervalSchedule",
            "lastWeekDay",
            "onceOff"
          ],
          "type": "string"
        },
        "onceOff": {
          "$ref": "#/$defs/BankingScheduledPaymentRecurrenceOnceOff"
        },
        "intervalSchedule": {
          "$ref": "#/$defs/BankingScheduledPaymentRecurrenceIntervalSchedule"
        },
        "lastWeekDay": {
          "$ref": "#/$defs/BankingScheduledPaymentRecurrenceLastWeekday"
        },
        "eventBased": {
          "$ref": "#/$defs/BankingScheduledPaymentRecurrenceEventBased"
        }
      },
      "required": [
        "recurrenceUType"
      ],
      "type": "object",
      "x-conditional": [
        "onceOff",
        "intervalSchedule",
        "lastWeekDay",
        "eventBased"
      ]
    },
    "BankingScheduledPaymentRecurrenceEventBased": {
      "description": "Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if the _recurrenceUType_ value is `eventBased`.",
      "properties": {
        "description": {
          "description": "Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer.",
          "type": "string"
        }
      },
      "required": [
        "description"
      ],
      "type": "object"
    },
    "BankingScheduledPaymentRecurrenceIntervalSchedule": {
      "description": "Indicates that the schedule of payments is defined by a series of intervals. Mandatory if the _recurrenceUType_ value is `intervalSchedule`.",
      "properties": {
        "finalPaymentDate": {
          "description": "The limit date after which no more payments should be made using this schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "paymentsRemaining": {
          "description": "Indicates the number of payments remaining in the schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely.",
          "type": "integer",
          "x-cds-type": "PositiveInteger"
        },
        "nonBusinessDayTreatment": {
          "default": "ON",
          "description": "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.<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>",
          "enum": [
            "AFTER",
            "BEFORE",
            "ON",
            "ONLY"
          ],
          "type": "string"
        },
        "intervals": {
          "description": "An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry.",
          "items": {
            "$ref": "#/$defs/BankingScheduledPaymentInterval"
          },
          "type": "array"
        }
      },
      "required": [
        "intervals"
      ],
      "type": "object"
    },
    "BankingScheduledPaymentRecurrenceLastWeekday": {
      "description": "Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if the _recurrenceUType_ value is `lastWeekDay`.",
      "properties": {
        "finalPaymentDate": {
          "description": "The limit date after which no more payments should be made using this schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "paymentsRemaining": {
          "description": "Indicates the number of payments remaining in the schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.",
          "type": "integer",
          "x-cds-type": "PositiveInteger"
        },
        "interval": {
          "description": "The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with _nextPaymentDate_.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "lastWeekDay": {
          "description": "The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.",
          "enum": [
            "FRI",
            "MON",
            "SAT",
            "SUN",
            "THU",
            "TUE",
            "WED"
          ],
          "type": "string"
        },
        "nonBusinessDayTreatment": {
          "default": "ON",
          "description": "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.<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>",
          "enum": [
            "AFTER",
            "BEFORE",
            "ON",
            "ONLY"
          ],
          "type": "string"
        }
      },
      "required": [
        "interval",
        "lastWeekDay"
      ],
      "type": "object"
    },
    "BankingScheduledPaymentRecurrenceOnceOff": {
      "description": "Indicates that the payment is a once off payment on a specific future date. Mandatory if the _recurrenceUType_ value is `onceOff`.",
      "properties": {
        "paymentDate": {
          "description": "The scheduled date for the once off payment.",
          "type": "string",
          "x-cds-type": "DateString"
        }
      },
      "required": [
        "paymentDate"
      ],
      "type": "object"
    },
    "BankingScheduledPaymentSetV2": {
      "description": "The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.",
      "properties": {
        "to": {
          "$ref": "#/$defs/BankingScheduledPaymentToV2"
        },
        "isAmountCalculated": {
          "default": false,
          "description": "Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then `false` is assumed.",
          "type": "boolean"
        },
        "amount": {
          "description": "The amount of the next payment if known. Mandatory unless the _isAmountCalculated_ field is set to `true`. Must be zero or positive if present.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "currency": {
          "default": "AUD",
          "description": "The currency for the payment. `AUD` assumed if not present.",
          "type": "string",
          "x-cds-type": "CurrencyString"
        }
      },
      "required": [
        "to"
      ],
      "type": "object",
      "x-conditional": [
        "amount"
      ]
    },
    "BankingScheduledPaymentToV2": {
      "description": "Object containing details of the destination of the payment. Used to specify a variety of payment destination types.",
      "properties": {
        "toUType": {
          "description": "The type of object provided that specifies the destination of the funds for the payment.",
          "enum": [
            "accountId",
            "biller",
            "digitalWallet",
            "domestic",
            "international",
            "payeeId"
          ],
          "type": "string"
        },
        "accountId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingAccountId"
            }
          ],
          "description": "Present if _toUType_ is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent."
        },
        "payeeId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingPayeeId"
            }
          ],
          "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."
        },
        "nickname": {
          "description": "The short display name of the payee as provided by the customer unless _toUType_ is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels.",
          "type": "string"
        },
        "payeeReference": {
          "description": "The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.",
          "type": "string"
        },
        "digitalWallet": {
          "$ref": "#/$defs/BankingDigitalWalletPayee"
        },
        "domestic": {
          "$ref": "#/$defs/BankingDomesticPayee"
        },
        "biller": {
          "$ref": "#/$defs/BankingBillerPayee"
        },
        "international": {
          "$ref": "#/$defs/BankingInternationalPayee"
        }
      },
      "required": [
        "toUType"
      ],
      "type": "object",
      "x-conditional": [
        "accountId",
        "payeeId",
        "digitalWallet",
        "domestic",
        "biller",
        "international",
        "nickname",
        "payeeReference"
      ]
    },
    "BankingScheduledPaymentV2": {
      "properties": {
        "scheduledPaymentId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingScheduledPaymentId"
            }
          ],
          "description": "Unique identifier for the scheduled payment."
        },
        "nickname": {
          "description": "The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels.",
          "type": "string"
        },
        "payerReference": {
          "description": "The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided.",
          "type": "string"
        },
        "payeeReference": {
          "description": "The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided.",
          "type": "string"
        },
        "status": {
          "description": "Indicates whether the schedule is currently active. The value `SKIP` is equivalent to `ACTIVE` except that the customer has requested the next normal occurrence to be skipped.",
          "enum": [
            "ACTIVE",
            "INACTIVE",
            "SKIP"
          ],
          "type": "string"
        },
        "from": {
          "$ref": "#/$defs/BankingScheduledPaymentFrom"
        },
        "paymentSet": {
          "items": {
            "$ref": "#/$defs/BankingScheduledPaymentSetV2"
          },
          "type": "array"
        },
        "recurrence": {
          "$ref": "#/$defs/BankingScheduledPaymentRecurrence"
        }
      },
      "required": [
        "from",
        "payerReference",
        "paymentSet",
        "recurrence",
        "scheduledPaymentId",
        "status"
      ],
      "type": "object",
      "x-conditional": [
        "payeeReference"
      ]
    },
    "LinksPaginated": {
      "properties": {
        "self": {
          "description": "Fully qualified link that generated the current response document.",
          "type": "string",
          "x-cds-type": "URIString"
        },
        "first": {
          "description": "URI to the first page of this set. Mandatory if this response is not the first page.",
          "type": "string",
          "x-cds-type": "URIString"
        },
        "prev": {
          "description": "URI to the previous page of this set. Mandatory if this response is not the first page.",
          "type": "string",
          "x-cds-type": "URIString"
        },
        "next": {
          "description": "URI to the next page of this set. Mandatory if this response is not the last page.",
          "type": "string",
          "x-cds-type": "URIString"
        },
        "last": {
          "description": "URI to the last page of this set. Mandatory if this response is not the last page.",
          "type": "string",
          "x-cds-type": "URIString"
        }
      },
      "required": [
        "self"
      ],
      "type": "object",
      "x-conditional": [
        "prev",
        "next",
        "first",
        "last"
      ]
    },
    "MetaPaginated": {
      "properties": {
        "totalRecords": {
          "description": "The total number of records in the full set. See [pagination](#pagination).",
          "type": "integer",
          "x-cds-type": "NaturalNumber"
        },
        "totalPages": {
          "description": "The total number of pages in the full set. See [pagination](#pagination).",
          "type": "integer",
          "x-cds-type": "NaturalNumber"
        }
      },
      "required": [
        "totalPages",
        "totalRecords"
      ],
      "type": "object"
    },
    "ResponseBankingScheduledPaymentsListV2_data": {
      "properties": {
        "scheduledPayments": {
          "description": "The list of scheduled payments to return.",
          "items": {
            "$ref": "#/$defs/BankingScheduledPaymentV2"
          },
          "type": "array"
        }
      },
      "required": [
        "scheduledPayments"
      ],
      "type": "object"
    }
  }
}