Search developer resources

Square API

API version2026-08-19

All versions ->

API Reference

Square API guides have all the information you need to build for sellers of every size. Our guides also provide the context to understand how our SDKs and APIs work together with Square hardware, software, and the Square Online Store.

New to Square development? Learn more about working with the Square API.

This API Reference has all the detailed API endpoint information you need to build with our APIs. Square APIs let you take payments securely, integrate your application with Square first-party products, and do so much more

Whether youre customizing Square for your own business, publishing in the Square App Marketplace, or working one-on-one with Square sellers, the Square Developer platform has the resources you need.

Dev Essentials

API version2026-08-19

All versions ->

Authenticate your app, provide secure delegated access to Square account data, and manage webhook subscriptions.

OAuth

Allow your application to gain programmatic access to Square seller accounts.

Webhook subscriptions

Create and manage webhook subscriptions.

Events

Search for Square API events that occur within a 28-day timeframe.

Payments

Take payments, process refunds, manage disputes, enable subscriptions, and get paid for your sales.

Payments

The Payments API lets developers take and manage payments.

Refunds

Manage and issue refunds for payments made to Square sellers.

Checkout

Accept payments through a pre-built, Square-hosted checkout page. No frontend required.

Terminal

Requests a checkout from a paired Square Terminal.

Disputes

Use the Disputes API to manage disputes (chargebacks).

Invoices

Create, configure, and publish invoices for orders that were created using the Orders API.

Cards

Use the Cards API to save a credit or debit card on file.

Subscriptions

Create and manage subscriptions.

Bank accounts

Geta list of a seller's bank accounts.

Payouts

Get a list of deposits and withdrawals from a seller's bank accounts.

Devices

Create device codes used to connect Square Terminal with a 3rd-party point of sale system, and get details about all connected Terminals.

Apple pay

Apple Pay support APIs

Commerce

Process orders, manage catalogs, track inventory, book reservations, and manage vendors.

Orders

Get sales data for a Square seller, itemize payments, push orders to POS, and more.

Order custom attributes

Create and manage order-related custom attribute definitions and custom attributes.

Catalog

Programmatically catalogs a Square sellers products for sale and services for hire.

Inventory

Programmatically manages a Square sellers inventory of catalog items.

Transfer order

Programmatically manages a Square sellers location stock transfers.

Bookings

Create and manage bookings for Square sellers with the Bookings API.

Booking custom attributes

Create and manage booking-related custom attribute definitions and custom attributes.

Vendors

Manages a seller's suppliers.

Channels

Returns a seller's sales, marketing, and fulfillment channels.

Sites

Get details about Square Online sites that belong to Square sellers.

Snippets

Manage snippets for Square Online sites.

Cash drawers

Get details about cash drawer shifts.

Customers

Securely manage customer data and integrate engagement features to increase repeat business and attract new customers.

Customers

Create and manage customer profiles and sync CRM systems with Square.

Customer custom attributes

Create and manage customer-related custom attribute definitions and custom attributes.

Customer groups

Create and manage customer groups to streamline and automate workflows and help personalize customer interactions.

Customer segments

Retrieve customer segments (also called smart groups) in a business account.

Loyalty

Enroll buyers in a Square loyalty program, view program settings, manage and track loyalty activity, and create and manage promotions.

Gift cards

Create and retrieve gift cards and manage gift cards on file.

Gift card activities

Create and retrieve gift card activities.

Staff

Manage team members and jobs, track hours worked, and manage team schedules.

Labor

Manage timecards and schedules for team members.

Team

Manage a roster of team members and pull employee data into accounting and payroll systems.

Merchants

Manage a seller's core business information used for business, and suppliers.

Merchants

Retrieve information about an organization that sells with Square.

Merchant custom attributes

Create and manage merchant-related custom attribute definitions and custom attributes.

Locations

Create and manage the locations of a seller's business.

Location custom attributes

Create and manage location-related custom attribute definitions and custom attributes.

Additional Resources

Other resources to help you build

Object Index

Browse through all datatypes of the Square API