action square_get_bank_account {
  label: "GetBankAccount"
  description: "Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount)\nlinked to a Square account."
  provider: square
  method: GET
  path: "/v2/bank-accounts/{bank_account_id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      bank_account_id: {
        type: "string"
      }
    }
    required: ["bank_account_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Response object returned by `GetBankAccount`."
    properties: {
      bank_account: {
        type: "object"
        description: "Represents a bank account. For more information about \nlinking a bank account to a Square account, see \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api)."
        required: ["account_number_suffix", "account_type", "country", "creditable", "currency", "debitable", "holder_name", "id", "primary_bank_identification_number", "status"]
        properties: {
          account_number_suffix: {
            type: "string"
            description: "The last few digits of the account number."
          }
          account_type: {
            type: "string"
            description: "The financial purpose of the associated bank account."
          }
          bank_name: {
            type: "string"
            description: "Read only. Name of actual financial institution. \nFor example \"Bank of America\"."
          }
          country: {
            type: "string"
            description: "The ISO 3166 Alpha-2 country code where the bank account is based."
          }
          creditable: {
            type: "boolean"
            description: "Indicates whether it is possible for Square to send money to this bank account."
          }
          currency: {
            type: "string"
            description: "The 3-character ISO 4217 currency code indicating the operating\ncurrency of the bank account. For example, the currency code for US dollars\nis `USD`."
          }
          debit_mandate_reference_id: {
            type: "string"
            description: "Reference identifier that will be displayed to UK bank account owners\nwhen collecting direct debit authorization. Only required for UK bank accounts."
          }
          debitable: {
            type: "boolean"
            description: "Indicates whether it is possible for Square to take money from this \nbank account."
          }
          fingerprint: {
            type: "string"
            description: "A Square-assigned, unique identifier for the bank account based on the\naccount information. The account fingerprint can be used to compare account\nentries and determine if the they represent the same real-world bank account."
          }
          holder_name: {
            type: "string"
            description: "Name of the account holder. This name must match the name \non the targeted bank account record."
          }
          id: {
            type: "string"
            description: "The unique, Square-issued identifier for the bank account."
          }
          location_id: {
            type: "string"
            description: "The location to which the bank account belongs."
          }
          primary_bank_identification_number: {
            type: "string"
            description: "Primary identifier for the bank. For more information, see \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api)."
          }
          reference_id: {
            type: "string"
            description: "Client-provided identifier for linking the banking account to an entity\nin a third-party system (for example, a bank account number or a user identifier)."
          }
          secondary_bank_identification_number: {
            type: "string"
            description: "Secondary identifier for the bank. For more information, see \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api)."
          }
          status: {
            type: "string"
            description: "Read-only. The current verification status of this BankAccount object."
          }
          version: {
            type: "integer"
            description: "The current version of the `BankAccount`."
          }
        }
      }
      errors: {
        type: "array"
        description: "Information on errors encountered during the request."
        items: {
          type: "object"
          description: "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information."
          required: ["category", "code"]
          properties: {
            category: {
              type: "string"
              description: "The high-level category for the error."
            }
            code: {
              type: "string"
              description: "The specific code of the error."
            }
            detail: {
              type: "string"
              description: "A human-readable description of the error for debugging purposes."
            }
            field: {
              type: "string"
              description: "The name of the field provided in the original request (if any) that\nthe error pertains to."
            }
          }
        }
      }
    }
  }
}