ResponseBankingTransactionListV2

{
  "$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-transaction-list-v2-schema.json",
  "title": "ResponseBankingTransactionListV2",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bank-of-queensland-banking-account-transactions-api-openapi.yml#/components/schemas/ResponseBankingTransactionListV2",
  "properties": {
    "data": {
      "$ref": "#/$defs/ResponseBankingTransactionListV2_data"
    },
    "links": {
      "$ref": "#/$defs/LinksPaginated"
    },
    "meta": {
      "$ref": "#/$defs/MetaPaginatedTransaction"
    }
  },
  "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"
    },
    "BankingInstalmentPlanId": {
      "description": "A unique identifier for a Banking instalment plan, generated according to [CDR ID Permanence](#id-permanence) requirements.",
      "type": "string",
      "x-cds-type": "ASCIIString"
    },
    "BankingTransactionId": {
      "description": "A unique identifier for a Banking transaction, generated according to [CDR ID Permanence](#id-permanence) requirements.",
      "type": "string",
      "x-cds-type": "ASCIIString"
    },
    "BankingTransactionV2": {
      "properties": {
        "accountId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingAccountId"
            }
          ],
          "description": "Unique identifier for the account."
        },
        "transactionId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingTransactionId"
            }
          ],
          "description": "Unique identifier for the transaction. 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. Mandatory if the _isDetailAvailable_ value is `true`."
        },
        "isDetailAvailable": {
          "description": "`true` if extended information is available using the transaction detail endpoint. `false` if extended data is not available.",
          "type": "boolean"
        },
        "type": {
          "description": "The type of the transaction.",
          "enum": [
            "DIRECT_DEBIT",
            "FEE",
            "INTEREST_CHARGED",
            "INTEREST_PAID",
            "OTHER",
            "PAYMENT",
            "TRANSFER_INCOMING",
            "TRANSFER_OUTGOING"
          ],
          "type": "string"
        },
        "status": {
          "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"
          ],
          "type": "string"
        },
        "description": {
          "description": "The transaction description as applied by the financial institution.",
          "type": "string"
        },
        "postingDateTime": {
          "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.",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "valueDateTime": {
          "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.",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "executionDateTime": {
          "description": "The time the transaction was executed by the originating customer, if available.",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "amount": {
          "description": "The value of the transaction. Negative values mean money was outgoing from the account.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "currency": {
          "default": "AUD",
          "description": "The currency for the transaction amount. `AUD` assumed if not present.",
          "type": "string",
          "x-cds-type": "CurrencyString"
        },
        "reference": {
          "description": "The reference for the transaction provided by the originating institution. Empty string if no data provided.",
          "type": "string"
        },
        "merchantName": {
          "description": "Name of the merchant for an outgoing payment to a merchant.",
          "type": "string"
        },
        "merchantCategoryCode": {
          "description": "The merchant category code (or MCC) for an outgoing payment to a merchant.",
          "type": "string"
        },
        "instalmentPlanId": {
          "allOf": [
            {
              "$ref": "#/$defs/BankingInstalmentPlanId"
            }
          ],
          "description": "If the transaction is associated with an instalment plan, the corresponding _planId_ value. It should be noted that if the transaction is for a fee associated with a plan, or any amount of repayment, the _amount_ of the transaction may not match a scheduled instalment amount."
        },
        "billerCode": {
          "description": "BPAY Biller Code for the transaction (if available).",
          "type": "string"
        },
        "billerName": {
          "description": "Name of the BPAY biller for the transaction (if available).",
          "type": "string"
        },
        "crn": {
          "description": "BPAY CRN for the transaction (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"
        },
        "apcaNumber": {
          "description": "6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.",
          "type": "string"
        }
      },
      "required": [
        "accountId",
        "amount",
        "description",
        "isDetailAvailable",
        "reference",
        "status",
        "type"
      ],
      "type": "object",
      "x-conditional": [
        "transactionId",
        "postingDateTime",
        "crn"
      ]
    },
    "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"
    },
    "MetaPaginatedTransaction": {
      "allOf": [
        {
          "$ref": "#/$defs/MetaPaginated"
        },
        {
          "$ref": "#/$defs/MetaPaginatedTransaction_allOf"
        }
      ]
    },
    "MetaPaginatedTransaction_allOf": {
      "properties": {
        "isQueryParamUnsupported": {
          "default": false,
          "description": "`true` if _text_ query parameter is not supported.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "ResponseBankingTransactionListV2_data": {
      "properties": {
        "transactions": {
          "items": {
            "$ref": "#/$defs/BankingTransactionV2"
          },
          "type": "array"
        }
      },
      "required": [
        "transactions"
      ],
      "type": "object"
    }
  }
}