• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Technical Reference

You are viewing an old version of the API

Technical Reference

Square API

Square APIs enable you to accept payments securely and integrate your app with Square’s first party product ecosystem. Build full-featured business apps for yourself or millions of Square sellers.

Our API Reference is organized around core business workflows: taking payments, managing orders, syncing items and inventory with Square Point of Sale, creating customer records, managing business locations, and enabling Square sellers to use your app.

The Square API follows the general patterns of REST. If you’re new here, you may want to check out our Getting Started Guide or learn more about the Square Data Model.

IMPORTANT: We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

You are viewing an old version of the API

Payments

Take payments and issue refunds

Square's Payment APIs make it easy for you to take payments, manage refunds, and help customers check out online.

Orders

Itemize payments, issue refunds, and push orders into Square of Sale

Square's Payment APIs make it easy for you to take itemize payments, fulfill orders at physical locations, and report on a merchant's sales.

Subscriptions

Create and manage subscriptions.

Subscriptions enable sellers to generate a reliable cash flow and recurring revenue to grow their businesses. Square offers the Subscriptions API for developers to embed subscription functionality in their applications. You first create a subscription plan using the Catalog API and then use the Subscriptions API to create and manage subscriptions.

For more information, see Square Subscriptions.

Invoices

Create and manage invoices.

Square invoices enable you to request or automatically collect payments from customer for orders created using the Orders API.

The Invoices API makes it easy for you to manage invoices. After you create and publish an invoice using the API, Square follows up with customers: sends invoices to the customer's email address or automatically charges the customer's card on file. Square makes it easy for your customers to pay by hosting each invoice on a web page where customers can pay for it.

For more information, see Manage Invoices Using the Invoices API.

Items

APIs for enriching payments with items and inventory

Sync merchant catalogs and inventory to provide consistent itemization and reporting across all channels

Customers

Create and manage customer profiles, save cards on file for customers, and sync custom CRM systems with Square.

Create and manage customer profiles, as well as search for customers based on various criteria such as customer group membership and when the customer was created. Save cards on file for the customers to facilitate future transactions. Sync contacts between your CRM system and Square.

Loyalty

Create loyalty accounts for buyers in a loyalty program, allow them to earn points, and to redeem rewards.

Create loyalty accounts for buyers in a loyalty program, add points to their loyalty account, and redeem rewards.

Business

Manage locations and merchant details

Use the Location and Merchant APIs to keep track of core business details, such as addresses and business hours. Use Devices and Cash Drawers to keep track of the point of sale devices and cash drawer shift activity in a business.

Team Management

Manage your team of employees

Use the Team and Labor APIs to keep track of who works at your business and when they clock in / out.

Financials

Get details about your business' deposits and bank accounts

Auth

Manage access to Square merchant accounts

Use OAuth to gain programmatic access to other Square merchants, and use the Mobile Authorization API to grant access to Reader SDK to take payments.

Additional Resources

Other resources to help you build

Share Feedback

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