{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-ninjas-com/json-schema/api-ninjas-com-branch-info-schema.json",
  "title": "BranchInfo",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/api-ninjas-com-bsb-api-openapi.yml#/components/schemas/BranchInfo",
  "type": "object",
  "properties": {
    "bank_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the bank. Premium only."
    },
    "bsb": {
      "type": "string",
      "description": "The 6-digit BSB number, hyphenated."
    },
    "branch_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the branch. Premium only."
    },
    "street_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "The street address of the branch. Premium only."
    },
    "suburb": {
      "type": "string",
      "description": "The suburb of the branch."
    },
    "state": {
      "type": "string",
      "description": "The Australian state or territory code (e.g. NSW, VIC, QLD)."
    },
    "postcode": {
      "type": "string",
      "description": "The 4-digit Australian postcode of the branch."
    },
    "country": {
      "type": "string",
      "description": "Always AU."
    },
    "phone_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The customer service phone number of the bank. Premium only."
    },
    "direct_entry_supported": {
      "type": "boolean",
      "description": "Whether the branch supports Direct Entry (DE) payments - the Australian equivalent of ACH. Premium only."
    },
    "rtgs_supported": {
      "type": "boolean",
      "description": "Whether the branch supports RTGS (Real-Time Gross Settlement) wire transfers via RITS. Premium only."
    },
    "npp_supported": {
      "type": "boolean",
      "description": "Whether the branch supports the New Payments Platform (NPP) for instant payments and PayID. Premium only."
    },
    "swift_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "The SWIFT/BIC code of the bank, useful for international wire transfers. Premium only."
    }
  }
}