Skip to main content
The Bank Accounts API allows you to store, retrieve, and manage bank accounts linked to a Square account. Bank accounts enable ACH payments and direct bank transfers.

​
Client Methods

​
List Bank Accounts

Returns a list of BankAccount objects linked to a Square account. 
client.BankAccounts.List(ctx context.Context, request *square.ListBankAccountsRequest) (*square.ListBankAccountsResponse, error)
​
request
*square.ListBankAccountsRequest
Request parameters for listing bank accounts
​
response
*square.ListBankAccountsResponse
The list of bank accounts
request := &square.ListBankAccountsRequest{
    Limit: square.Int(50),
    LocationID: square.String("location_id"),
}

response, err := client.BankAccounts.List(context.TODO(), request)
if err != nil {
    log.Fatal(err)
}

// Iterate through bank accounts
for _, account := range response.BankAccounts {
    fmt.Printf("Account ID: %s, Status: %s\n", account.ID, account.Status)
}

​
Create Bank Account

Store a bank account on file for a Square account. 
client.BankAccounts.CreateBankAccount(ctx context.Context, request *square.CreateBankAccountRequest) (*square.CreateBankAccountResponse, error)
​
request
*square.CreateBankAccountRequest
required
Request parameters for creating a bank account
​
response
*square.CreateBankAccountResponse
The created bank account details
request := &square.CreateBankAccountRequest{
    IdempotencyKey: "4e43559a-f0fd-47d3-9da2-7ea1f97d94be",
    SourceID: "bnon:CA4SEHsQwr0rx6DbWLD5BQaqMnoYAQ",
    CustomerID: square.String("HM3B2D5JKGZ69359BTEHXM2V8M"),
}

response, err := client.BankAccounts.CreateBankAccount(context.TODO(), request)
if err != nil {
    log.Fatal(err)
}

fmt.Printf("Bank account created with ID: %s\n", response.BankAccount.ID)

​
Get Bank Account

Retrieve details of a BankAccount linked to a Square account. 
client.BankAccounts.Get(ctx context.Context, request *square.GetBankAccountsRequest) (*square.GetBankAccountResponse, error)
​
BankAccountID
string
required
Square-issued ID of the desired BankAccount.
​
response
*square.GetBankAccountResponse
The bank account details
request := &square.GetBankAccountsRequest{
    BankAccountID: "bank_account_id",
}

response, err := client.BankAccounts.Get(context.TODO(), request)
if err != nil {
    log.Fatal(err)
}

if response.BankAccount != nil {
    fmt.Printf("Account Holder: %s\n", response.BankAccount.HolderName)
    fmt.Printf("Account Type: %s\n", response.BankAccount.AccountType)
    fmt.Printf("Status: %s\n", response.BankAccount.Status)
}

​
Get Bank Account by V1 ID

Returns details of a BankAccount identified by V1 bank account ID. This is useful for migrating from Connect V1 APIs. 
client.BankAccounts.GetByV1ID(ctx context.Context, request *square.GetByV1IDBankAccountsRequest) (*square.GetBankAccountByV1IDResponse, error)
​
V1BankAccountID
string
required
Connect V1 ID of the desired BankAccount.
​
response
*square.GetBankAccountByV1IDResponse
The bank account details
request := &square.GetByV1IDBankAccountsRequest{
    V1BankAccountID: "v1_bank_account_id",
}

response, err := client.BankAccounts.GetByV1ID(context.TODO(), request)
if err != nil {
    log.Fatal(err)
}

​
Disable Bank Account

Disable a bank account. 
client.BankAccounts.DisableBankAccount(ctx context.Context, request *square.DisableBankAccountsRequest) (*square.DisableBankAccountResponse, error)
​
BankAccountID
string
required
Square-issued ID of the BankAccount to disable.
​
response
*square.DisableBankAccountResponse
The disabled bank account details
request := &square.DisableBankAccountsRequest{
    BankAccountID: "bank_account_id",
}

response, err := client.BankAccounts.DisableBankAccount(context.TODO(), request)
if err != nil {
    log.Fatal(err)
}

fmt.Println("Bank account disabled successfully")

​
Key Concepts

​
Bank Account Tokens

Bank account tokens (nonces) are single-use tokens generated by the Square Web Payments SDK that represent bank account details. You use a bank account token as the SourceID when creating a bank account on file.

​
ACH Payments

Bank accounts on file enable ACH (Automated Clearing House) payments, which are electronic bank-to-bank transfers. ACH payments typically take 3-5 business days to settle.

​
Bank Account Verification

Depending on your integration and requirements, bank accounts may need to be verified before they can be used for payments. Verification methods include:
  • Micro-deposit verification
  • Instant verification via bank login
  • Manual verification

​
Bank Account Status

Bank accounts can have the following statuses:
  • VERIFICATION_IN_PROGRESS: The account is being verified
  • VERIFIED: The account is verified and ready to use
  • DISABLED: The account has been disabled

​
BankAccount Object Fields

The BankAccount object includes:
  • ID: Unique identifier for the bank account
  • AccountNumberSuffix: Last few digits of the account number
  • Country: Country code for the account
  • Currency: Currency code for the account
  • AccountType: Type of account (CHECKING, SAVINGS, etc.)
  • HolderName: Name of the account holder
  • PrimaryBankIdentificationNumber: Routing number or equivalent
  • Status: Current status of the bank account
  • Creditable: Whether the account can receive credits
  • Debitable: Whether the account can be debited
  • Fingerprint: Unique identifier for the bank account across Square
  • Version: Version number for optimistic concurrency
  • BankName: Name of the financial institution

​
Use Cases

​
Customer Payments

Store customer bank accounts for recurring payments or one-time ACH transactions:
Example: Store Customer Bank Account
request := &square.CreateBankAccountRequest{
    IdempotencyKey: uuid.New().String(),
    SourceID: bankAccountToken, // from Web Payments SDK
    CustomerID: square.String(customerID),
}

response, err := client.BankAccounts.CreateBankAccount(context.TODO(), request)

​
Merchant Payouts

Merchants can link bank accounts to receive payouts from Square:
Example: List Merchant Bank Accounts
request := &square.ListBankAccountsRequest{
    Limit: square.Int(10),
}

response, err := client.BankAccounts.List(context.TODO(), request)
for _, account := range response.BankAccounts {
    if account.Status == "VERIFIED" && *account.Creditable {
        fmt.Printf("Ready for payouts: %s\n", account.ID)
    }
}

​
Security Considerations

​
PCI Compliance

Square handles PCI compliance for stored bank accounts. Bank account details are securely stored and tokenized. You never have access to the full account number after it’s saved.

​
Data Protection

Bank account information is sensitive. Always:
  • Use HTTPS for all API calls
  • Never log or store full account numbers
  • Implement proper access controls
  • Follow data retention policies

​
Learn More

Build docs developers (and LLMs) love

Get started for freeTalk to us