When to use Connect V1

In general, the current Square API (Connect V2) can do most operations needed to manage the Square resources. Although Connect V1 has many equivalent endpoints, most of them have been deprecated in favor of the Square API. We strongly discourage using Connect V1 in most cases.

However, there are a few exceptions where you must use Connect V1 to perform operations.

Financials
Permalink Get a link to this section

You must use Connect V1 to list and view bank accounts and settlements. What does this mean? When a customer buys something from a Square seller, the payment is processed and added to the balance in the seller’s Square account. A fully onboarded seller has their Square account linked to one or more bank accounts so that the money in their Square balance can be deposited in one of their bank accounts. Common use cases would be: listing bank accounts, tracking the status of settlements, and seeing the bank account associated to a settlement.

Use the following Connect V1 endpoints:

Bank Accounts

ListBankAccounts

RetrieveBankAccount

Settlements

ListSettlements

RetrieveSettlement

Payments
Permalink Get a link to this section

You use the V2 Payments API to create and manage card payments. You can use the Search Orders endpoint to list and view almost all details for card and cash transactions. However, if you need to read any of the following information from a payment, you must use the V1 Payments endpoints:

  • Device detail about a Square Point of Sale transaction

  • Itemization detail (such as type, merchant-defined category, or SKU)

Use the following Connect V1 endpoints:

Payments V1

ListPayments

RetrievePayment

Employees
Permalink Get a link to this section

You use Labor API to employee shifts, breaks, and wages. However, you must use Connect V1 to manage employees and employee roles. Employee roles define actions and permissions that can be assigned to an employee.

Use the following Connect V1 endpoints:

Employees

CreateEmployee

UpdateEmployee

ListEmployees

RetrieveEmployee

Employee Roles

CreateEmployeeRole

UpdateEmployeeRole

ListEmployeeRoles

RetrieveEmployeeRole

Note that there are Connect V2 List Employees and Retrieve Employee endpoints but it may be simpler for you to use their V1 equivalents since all other employee operations are only available in Connect V1.

Cash Drawer Shifts
Permalink Get a link to this section

Cash drawer shifts track cash transactions so that total money in the cash drawer can be reconciled for a specific period of time (a cash drawer shift) for a particular device in a particular location. You must use Connect V1 to track cash drawer shifts.

Use the following Connect V1 endpoints:

Cash Drawer Shifts

ListCashDrawerShifts

RetrieveCashDrawerShift

Point of Sale Favorites Setup
Permalink Get a link to this section

Square Point of Sale enables you to organize your items into favorites pages so that you can display a subset of items from your catalog. You must use Connect V1 to manage these pages and the cells that represent specific items on each page.

Use the following Connect V1 endpoints:

Pages

CreatePage

ListPages

UpdatePage

DeletePage

Page Cells

UpdatePageCell

DeletePageCell

Webhooks
Permalink Get a link to this section

Webhooks are a way to notify your application when events occur with resources in a Square account. Currently, Square API (Connect V2) webhooks support only the catalog.version.updated and inventory.count.updated events.

To get events about payments and timecards, you must use Connect V1 webhooks. Unlike the Square API webhooks where you manage your webhooks entirely in the Developer Dashboard, you must use the Connect V1 Webhooks API to subscribe the particular webhooks you want.

Use the following Connect V1 endpoints:

ListWebhooks

UpdateWebhooks