v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

BankAccounts

CreateBankAccount

Store a bank account on file for a square account

post/v2/bank-accounts

Request body

idempotency_keystring required

Unique ID. For more information, see the Idempotency.

source_idstring required

The ID of the source that represents the bank account information to be stored. This field accepts the payment token created by WebSDK

customer_idstring

The ID of the customer associated with the bank account to be stored.

Example request

{
  "customer_id": "HM3B2D5JKGZ69359BTEHXM2V8M",
  "idempotency_key": "4e43559a-f0fd-47d3-9da2-7ea1f97d94be",
  "source_id": "bnon:CA4SEHsQwr0rx6DbWLD5BQaqMnoYAQ"
}

Response

Success

Example response

{
  "bank_account": {
    "account_number_suffix": "000",
    "account_type": "CHECKING",
    "bank_name": "Citizens Bank",
    "country": "US",
    "creditable": true,
    "currency": "USD",
    "customer_id": "HM3B2D5JKGZ69359BTEHXM2V8M",
    "debitable": true,
    "fingerprint": "sq-1-mO3XNctJpTLL8uYowOWpioS8nQyTc838gcBo90254XonoEJ_c7Uw6yqL6qihFNY8fA",
    "holder_name": "Nicola Snow",
    "id": "bact:OxfBTiXgByaXds1K4GB",
    "primary_bank_identification_number": "011401533",
    "status": "VERIFIED",
    "version": 2
  }
}