List Bank Accounts - Automate.ax

square.listBankAccounts returns a list of BankAccount objects linked to a Square account.

Example

automations/square-list-bank-accounts.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("List Square Bank Accounts", () => {
  onDashboardRun({ title: "List Square Bank Accounts" })

  square.listBankAccounts({
    cursor: "cursor",
    limit: 1,
    locationId: "location_id",
    customerId: "customer_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires BANK_ACCOUNTS_READ.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	The pagination cursor returned by a previous call to this endpoint. Use it in the next `ListBankAccounts` request to retrieve the next set of results. See the Pagination guide for more information.
`limit`	`number \| null`	No	—	Upper limit on the number of bank accounts to return in the response. Currently, 1000 is the largest supported limit. You can specify a limit of up to 1000 bank accounts. This is also the default limit.
`locationId`	`string \| null`	No	—	Location ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific location.
`customerId`	`string \| null`	No	—	Customer ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific customer.

Use the official ListBankAccounts reference for provider field semantics and limits.

Output

Returns the official Square.ListBankAccountsResponse response as a codec-safe object. Square integer money amounts remain bigint values.