Technical Reference
You are viewing an old version of the API
Technical Reference
Technical Reference
Square APISquare 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.
Payments
Take payments and issue refunds.
Square's Payment APIs make it easy for you to take payments, manage refunds, and help customers checkout online.
-
Payments
The Payments API lets developers take and manage payments.
-
Refunds
Manage and issue refunds for payments made to Square sellers.
-
Disputes
Use the Disputes API to manage disputes (chargebacks).
-
Checkout
Accept payments through a pre-built, Square-hosted checkout page. No frontend required.
-
Apple Pay
Apple Pay support APIs
-
Cards
Use the Cards API to save a credit or debit card on file.
-
Payouts
Get a list of deposits and withdrawals from a seller's bank accounts.
Terminal
Manage checkouts and Interac refunds on a Square Terminal.
Use the Terminal API to connect to a Square Terminal and create Terminal checkouts and Terminal Interac refunds.
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.
Invoices
Create and manage invoices.
Use the Invoices API to create, configure, and publish invoices for orders that were created using the Orders API.
Catalog
The Square Catalog API lets you programmatically catalog product items for sale or services for hire for a Square seller.
With the Square Catalog API, you can build an application to catalog products or services for a Square seller, search for the resulting catalog, and retrieve specified catalog objects.
Inventory
The Square Inventory API lets you programmatically manage the product inventory for a Square seller.
With the Square Inventory API, you can create an application to keep track of quantities of salable product items, inspect inventory changes, and update the inventory states for Square sellers.
Customers
Work with customer profiles, customer-related custom attributes, customer groups, and customer segments.
Use the Customers API to create and manage customer profiles (including group membership), search customer profiles, and sync custom CRM systems with Square. Use the Customer Custom Attributes API to create and manage custom attributes for customer profiles. Use the Customer Groups API to create and manage customer groups and the Customer Segments API to retrieve information about customer segments.
-
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
Create and manage loyalty accounts in Square loyalty programs.
Use the Loyalty API to create and manage loyalty accounts for buyers, which includes allowing buyers to earn points and redeem points for discounts.
Gift Cards
Create and access gift cards and link customers to gift cards.
Bookings
Create and manage bookings for Square sellers.
Create and manage bookings for Square sellers.
Business
Manage a seller's core business information, devices used for business, and suppliers.
Use the Locations and Merchants APIs to keep track of a seller's core business details, such as addresses and business hours.
Use the Devices API and Cash Drawer Shifts API to keep track of the point of sale devices and cash drawer shift activity in a business.
Use the Vendors API to keep track of a seller's suppliers.
-
Merchants
Retrieve information about an organization that sells with Square.
-
Locations
Get a list of all a seller's locations.
-
Devices
Manages a pairing between a third-party Point of Sale application and a Square Terminal in a seller location.
-
Cash Drawers
Get details about cash drawer shifts.
-
Vendors
Manages a seller's suppliers.
Team
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 and clock out.
Financials
Get details about the deposits and bank accounts for your business.
Online
Manage snippets for Square Online sites.
Use the Snippets API and Sites API to insert snippets into Square Online sites.
Auth
Manage access to Square seller accounts.
Use OAuth to gain programmatic access to other Square sellers. Use the Mobile Authorization API to grant access to the Reader SDK to take payments.
Additional Resources
Other resources to help you build