Square provides APIs for payment processing, point of sale, and business management solutions enabling developers to build custom commerce applications.
APIs.json: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/apis.yml
- Type: Index
- Position: Consumer
- Access: 3rd-Party
- Restaurant
- Bookings
- Catalog
- Checkout
- Customers
- Disputes
- Ecommerce
- Financial Technology
- Gift Cards
- Inventory
- Invoicing
- Labor
- Locations
- Loyalty
- Merchants
- Orders
- Payments
- Point of Sale
- Refunds
- Retail
- Subscriptions
- Team
- Terminal
- Webhooks
- Created: 2025-02-08
- Modified: 2026-06-03
The Payments API lets applications take and manage payments by charging payment methods supported by the Web Payments SDK or In-App Payments SDK, including credit cards, gift cards, digital wallets, and ACH bank transfers. It can also record cash or external payments received outside of Square.
- Commerce
- Financial Technology
- Payments
- Point of Sale
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Orders API lets applications itemize payments using custom line items or catalog objects, send orders to physical Point of Sale devices for fulfillment, attach customers to payments, and search through all of a seller's past sales with itemization data.
- Commerce
- Orders
- Point of Sale
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Catalog API programmatically catalogs a Square seller's products for sale and services for hire, enabling applications to create, update, and manage catalog items, categories, variations, and pricing.
- Catalog
- Commerce
- Products
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Inventory API programmatically manages a Square seller's inventory of catalog items, including updating and tracking inventory changes and retrieving inventory counts.
- Commerce
- Inventory
- Retail
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Customers API lets applications create and manage customer profiles to streamline bookings, build loyalty programs, sell gift cards, and offer discounts. It enables syncing CRM systems with Square.
- Commerce
- CRM
- Customers
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Locations API lets applications create and manage the locations of a seller's business, including retrieving location details and managing location settings.
- Business Management
- Commerce
- Locations
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Team API lets applications create and manage a roster of team members, configure jobs, and synchronize team member data with external platforms including accounting and payroll systems.
- Business Management
- Employees
- Team
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Labor API is the timekeeping component of Square's team management APIs, enabling applications to manage time tracking and scheduling for team members, record hours worked, and handle breaks, wages, and declared cash tips for labor cost reporting and payroll.
- Business Management
- Labor
- Time Tracking
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Bookings API enables creating reservations of services provided by a seller's staff for customers at particular locations and times. Applications can create, update, cancel, and search for available bookings.
- Appointments
- Bookings
- Scheduling
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Loyalty API allows applications to set up and manage loyalty programs, enroll buyers, accrue points, and redeem rewards. It works with the Orders API to manage loyalty accounts and rewards at participating locations.
- Customer Engagement
- Loyalty
- Rewards
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Gift Cards API enables sellers to launch a gifting program with digital and physical gift cards. Applications can create, retrieve, link, and unlink gift cards, and manage gift card activities such as activating, loading, and redeeming.
- Commerce
- Customer Engagement
- Gift Cards
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Invoices API lets applications request or automatically collect payments from customers for orders created using the Orders API. It supports creating, updating, publishing, and managing invoices with multiple payment schedules and methods.
- Billing
- Invoices
- Payments
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Subscriptions API enables sellers to generate recurring revenue by offering scheduled fulfillment of products or services. Applications can create and manage subscription plans with configurable billing periods, pricing, and discounts.
- Commerce
- Recurring Payments
- Subscriptions
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Checkout API creates Square-hosted checkout pages for collecting payments. Applications can generate payment links with a simple API call, supporting credit cards, debit cards, Google Pay, Apple Pay, Afterpay, and Cash App.
- Checkout
- Commerce
- Payments
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Terminal API lets developers integrate Square in-person payments so custom POS applications can use Square Terminal for card chip and NFC payments, with EMV certification and PCI compliance built in.
- In-Person Payments
- Point of Sale
- Terminal
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Refunds API lets applications refund the entire payment amount or a portion of it for card payments, and record refunds of cash or external payments.
- Commerce
- Payments
- Refunds
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Disputes API manages payment disputes and chargebacks, allowing applications to list disputes, retrieve dispute details, challenge disputes by submitting evidence, and accept disputes.
- Chargebacks
- Disputes
- Payments
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Merchants API groups individual seller locations into larger organizations, with each merchant representing one organization or business that sells with Square.
- Business Management
- Commerce
- Merchants
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Cards API lets applications save a credit or debit card on file for a customer, enabling faster future payments without re-entering card details.
- Cards
- Commerce
- Payments
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Vendors API lets applications manage vendors and suppliers for a seller, enabling creation, retrieval, and updating of vendor information.
- Inventory
- Suppliers
- Vendors
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Cash Drawers API is a reporting API for businesses that use a cash drawer with their Square Point of Sale terminals, providing filtered and paged lists of cash drawer shift data for a given location.
- Cash Drawers
- Point of Sale
- Reporting
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Bank Accounts API lets applications retrieve a list of a seller's bank accounts and get details about specific bank accounts linked to a Square account.
- Bank Accounts
- Financial Technology
- Payments
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Payouts API lets applications get a list of deposits and withdrawals from a seller's bank accounts, providing visibility into funds movement.
- Financial Technology
- Payments
- Payouts
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Apple Pay API provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.
- Apple Pay
- Digital Wallets
- Payments
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Sites API lets applications retrieve basic details about Square Online sites belonging to a seller, such as site ID, title, and domain. It is used in combination with the Snippets API.
- Ecommerce
- Sites
- Square Online
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Snippets API lets applications add custom scripts to a Square Online site. Snippets can run as modals, pop ups, or background jobs, offering a range of functionality to extend Square Online features.
- Ecommerce
- Snippets
- Square Online
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The OAuth API lets applications obtain and manage access tokens that grant scoped, permissioned access to a seller's Square account, supporting the authorization code grant flow, token refresh, and token revocation for connecting third-party apps.
- Authentication
- OAuth
- Security
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Webhook Subscriptions API lets applications programmatically create and manage webhook subscriptions to receive real-time event notifications for changes to payments, orders, customers, inventory, and other Square resources.
- Events
- Notifications
- Webhooks
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
- AsyncAPI — AsyncAPI Specification
The Events API lets applications search and retrieve the history of events that have occurred in a seller's Square account, providing an audit trail and the ability to replay or backfill webhook-style event data.
- Audit
- Events
- Webhooks
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Devices API lets applications create device codes to pair Square hardware such as Square Terminal and Square Register, and retrieve device details for managing point-of-sale devices.
- Devices
- Point of Sale
- Terminal
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Customer Groups API lets applications create and manage groups of customers, enabling segmentation for targeted marketing, pricing rules, and loyalty programs.
- CRM
- Customer Groups
- Customers
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Customer Segments API lets applications retrieve the smart, automatically maintained customer segments defined in a seller's Square Customer Directory, supporting targeted engagement based on buyer behavior.
- CRM
- Customer Segments
- Customers
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Gift Card Activities API lets applications create and list gift card activities such as activating, loading, redeeming, adjusting, and refunding balances, providing a full ledger of gift card transactions.
- Customer Engagement
- Gift Cards
- Transactions
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Custom Attributes APIs let applications define and attach custom metadata to core Square resources, including customers, orders, bookings, merchants, and locations, enabling tailored data models and integrations on top of the Square platform.
- Custom Attributes
- Extensibility
- Metadata
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Reporting API (Beta) provides a new way to access all of a business's data to build custom reports and integrations, surfacing sales, payments, and operational metrics across a seller's Square account.
- Analytics
- Business Intelligence
- Reporting
- Documentation
- API Reference
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Channels API lets applications represent and manage the sales channels through which a seller transacts, enabling attribution of orders and payments to specific online or in-person channels.
- Commerce
- Omnichannel
- Sales Channels
- Documentation
- API Reference
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Transfer Orders API lets applications create and manage transfers of inventory stock between a seller's locations, supporting multi-location retail and restaurant operations.
- Commerce
- Inventory
- Transfer Orders
- Documentation
- API Reference
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
- Portal
- Documentation
- API Reference
- Getting Started
- Authentication
- Changelog
- S D Ks
- SDK
- Webhooks
- AsyncAPI — AsyncAPI Specification
- Sandbox
- Rate Limits
- Documentation
- Getting Started
- Documentation
- Console
- Console
- Sign Up
- Blog
- Support
- Pricing
- Terms of Service
- Privacy Policy
- Support
- Partners
- Status Page
- GitHub Organization
- OpenAPI — OpenAPI Specification
- Stack Overflow
- X (Twitter)
- Support
- JSON Schema — JSON Schema
- JSON Schema — JSON Schema
- JSON Schema — JSON Schema
- JSON Schema — JSON Schema
- JSON Schema — JSON Schema
- JSON Schema — JSON Schema
- JSON Schema — JSON Schema
- JSON-LD — JSON-LD
- Features
- Use Cases
- Integrations
- SDK
- SDK
- SDK
- SDK
- SDK
- SDK
- SDK
- SDK
- Code Examples
- SDK
- SDK
- SDK
- SDK
- SDK
- Code Examples
- Code Examples
- OpenAPI — OpenAPI Specification
- Rules
- Vocabulary
- M C P Server
- Tools
- Tools
- Documentation
- SDK
- L L Ms Txt
- JSON Structure
- JSON Structure
- JSON Structure
- JSON Structure
- JSON Structure
- JSON Structure
- JSON Structure
- Example
- Example
- Example
- Example
- Example
- Example
- Example
- Plans
- Rate Limits
- Fin Ops
Email: kin@apievangelist.com Email: developers@squareup.com URL: https://squareup.com