• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Bank account created

EVENT bank_account.created

Published when you link an external bank account to a Square account in the Seller Dashboard. Square sets the initial status to VERIFICATION_IN_PROGRESS and publishes the event.

Required permissions: BANK_ACCOUNTS_READ

Event payload

Name Description
merchant_id
string

The ID of the target merchant associated with the event.

location_id
string

The ID of the target location associated with the event.

type
string

The type of event this represents, "bank_account.created".

event_id
string

A unique ID for the webhook event.

created_at
string

Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
BankAccountCreatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "6SSW7HV8K2ST5",
  "location_id": "S8GWD5DBJ3HF3",
  "type": "bank_account.created",
  "event_id": "d214f854-adb1-4f56-b078-4b8697a3187a",
  "created_at": "2020-02-15T04:38:13Z",
  "data": {
    "type": "bank_account",
    "id": "bact:cgvL1yv43VFjexample",
    "object": {
      "bank_account": {
        "id": "bact:cgvL1yv43VFjexample",
        "account_number_suffix": "526",
        "country": "US",
        "currency": "USD",
        "account_type": "CHECKING",
        "holder_name": "John Doe",
        "primary_bank_identification_number": "101211111",
        "location_id": "S8GWD5DBJ3HF3",
        "status": "VERIFICATION_IN_PROGRESS",
        "creditable": true,
        "debitable": true,
        "version": 1,
        "bank_name": "Bank Name"
      }
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?