Skip to content

api-evangelist/square

Repository files navigation

Square (square)

Square provides APIs for payment processing, point of sale, and business management solutions enabling developers to build custom commerce applications.

URL: Visit APIs.json URL

Run: Capabilities Using Naftiko

Scope

  • Type: Index
  • Position: Consumer
  • Access: 3rd-Party

Tags:

  • 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

Timestamps

  • Created: 2025-02-08
  • Modified: 2026-06-03

APIs

Square Payments API

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.

Human URL: https://developer.squareup.com/docs/payments-overview

Tags:

  • Commerce, Financial Technology, Payments, Point of Sale

Properties

Square Orders API

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.

Human URL: https://developer.squareup.com/docs/orders-api/what-it-does

Tags:

  • Commerce, Orders, Point of Sale

Properties

Square Catalog API

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.

Human URL: https://developer.squareup.com/docs/catalog-api/what-it-does

Tags:

  • Catalog, Commerce, Products

Properties

Square Inventory API

The Inventory API programmatically manages a Square seller's inventory of catalog items, including updating and tracking inventory changes and retrieving inventory counts.

Human URL: https://developer.squareup.com/docs/inventory-api/what-it-does

Tags:

  • Commerce, Inventory, Retail

Properties

Square Customers API

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.

Human URL: https://developer.squareup.com/docs/customers

Tags:

  • Commerce, CRM, Customers

Properties

Square Locations API

The Locations API lets applications create and manage the locations of a seller's business, including retrieving location details and managing location settings.

Human URL: https://developer.squareup.com/docs/locations-api

Tags:

  • Business Management, Commerce, Locations

Properties

Square Team API

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.

Human URL: https://developer.squareup.com/docs/team/overview

Tags:

  • Business Management, Employees, Team

Properties

Square Labor API

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.

Human URL: https://developer.squareup.com/docs/labor-api/what-it-does

Tags:

  • Business Management, Labor, Time Tracking

Properties

Square Bookings API

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.

Human URL: https://developer.squareup.com/docs/bookings-api/what-it-is

Tags:

  • Appointments, Bookings, Scheduling

Properties

Square Loyalty API

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.

Human URL: https://developer.squareup.com/docs/loyalty-api/overview

Tags:

  • Customer Engagement, Loyalty, Rewards

Properties

Square Gift Cards API

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.

Human URL: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api

Tags:

  • Commerce, Customer Engagement, Gift Cards

Properties

Square Invoices API

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.

Human URL: https://developer.squareup.com/docs/invoices-api/overview

Tags:

  • Billing, Invoices, Payments

Properties

Square Subscriptions API

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.

Human URL: https://developer.squareup.com/docs/subscriptions-api/overview

Tags:

  • Commerce, Recurring Payments, Subscriptions

Properties

Square Checkout API

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.

Human URL: https://developer.squareup.com/docs/checkout-api

Tags:

  • Checkout, Commerce, Payments

Properties

Square Terminal API

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.

Human URL: https://developer.squareup.com/docs/terminal-api/overview

Tags:

  • In-Person Payments, Point of Sale, Terminal

Properties

Square Refunds API

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.

Human URL: https://developer.squareup.com/docs/payments-refunds

Tags:

  • Commerce, Payments, Refunds

Properties

Square Disputes API

The Disputes API manages payment disputes and chargebacks, allowing applications to list disputes, retrieve dispute details, challenge disputes by submitting evidence, and accept disputes.

Human URL: https://developer.squareup.com/docs/disputes-api/overview

Tags:

  • Chargebacks, Disputes, Payments

Properties

Square Merchants API

The Merchants API groups individual seller locations into larger organizations, with each merchant representing one organization or business that sells with Square.

Human URL: https://developer.squareup.com/docs/merchants-api

Tags:

  • Business Management, Commerce, Merchants

Properties

Square Cards API

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.

Human URL: https://developer.squareup.com/docs/cards-api/overview

Tags:

  • Cards, Commerce, Payments

Properties

Square Vendors API

The Vendors API lets applications manage vendors and suppliers for a seller, enabling creation, retrieval, and updating of vendor information.

Human URL: https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps

Tags:

  • Inventory, Suppliers, Vendors

Properties

Square Cash Drawers API

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.

Human URL: https://developer.squareup.com/docs/cashdrawershift-api/reporting

Tags:

  • Cash Drawers, Point of Sale, Reporting

Properties

Square Bank Accounts API

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.

Human URL: https://developer.squareup.com/docs/bank-accounts-api

Tags:

  • Bank Accounts, Financial Technology, Payments

Properties

Square Payouts API

The Payouts API lets applications get a list of deposits and withdrawals from a seller's bank accounts, providing visibility into funds movement.

Human URL: https://developer.squareup.com/docs/payouts-api/overview

Tags:

  • Financial Technology, Payments, Payouts

Properties

Square Apple Pay API

The Apple Pay API provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.

Human URL: https://developer.squareup.com/docs/web-payments/apple-pay

Tags:

  • Apple Pay, Digital Wallets, Payments

Properties

Square Sites API

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.

Human URL: https://developer.squareup.com/docs/sites-api/overview

Tags:

  • Ecommerce, Sites, Square Online

Properties

Square Snippets API

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.

Human URL: https://developer.squareup.com/docs/snippets-api/overview

Tags:

  • Ecommerce, Snippets, Square Online

Properties

Square OAuth API

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.

Human URL: https://developer.squareup.com/docs/oauth-api/overview

Tags:

  • Authentication, OAuth, Security

Properties

Square Webhook Subscriptions API

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.

Human URL: https://developer.squareup.com/docs/webhooks/overview

Tags:

  • Events, Notifications, Webhooks

Properties

Square Events API

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.

Human URL: https://developer.squareup.com/docs/events-api/overview

Tags:

  • Audit, Events, Webhooks

Properties

Square Devices API

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.

Human URL: https://developer.squareup.com/docs/devices-api/overview

Tags:

  • Devices, Point of Sale, Terminal

Properties

Square Customer Groups API

The Customer Groups API lets applications create and manage groups of customers, enabling segmentation for targeted marketing, pricing rules, and loyalty programs.

Human URL: https://developer.squareup.com/docs/customer-groups-api/what-it-does

Tags:

  • CRM, Customer Groups, Customers

Properties

Square Customer Segments API

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.

Human URL: https://developer.squareup.com/docs/customer-segments-api/what-it-does

Tags:

  • CRM, Customer Segments, Customers

Properties

Square Gift Card Activities API

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.

Human URL: https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api

Tags:

  • Customer Engagement, Gift Cards, Transactions

Properties

Square Custom Attributes API

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.

Human URL: https://developer.squareup.com/docs/customer-custom-attributes-api/overview

Tags:

  • Custom Attributes, Extensibility, Metadata

Properties

Square Reporting API

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.

Human URL: https://developer.squareup.com/docs/reporting-api

Tags:

  • Analytics, Business Intelligence, Reporting

Properties

Square Channels API

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.

Human URL: https://developer.squareup.com/docs/channels-api/overview

Tags:

  • Commerce, Omnichannel, Sales Channels

Properties

Square Transfer Orders API

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.

Human URL: https://developer.squareup.com/docs/transfer-orders-api/overview

Tags:

  • Commerce, Inventory, Transfer Orders

Properties

Common Properties

Features

Name Description
Tap/dip/swipe: 2.6%+15¢ Free, 2.5%+15¢ Plus, 2.4%+15¢ Premium
Online (Square site): 3.3%+30¢ Free, 2.9%+30¢ Plus/Premium
Online API: 2.9%+30¢ all plans
Manual entry/card on file: 3.5%+15¢ all plans
ACH (invoice): 1% $1 min ($10 cap on Plus/Premium)
ACH (API): 1% $1 min, $5 cap
Afterpay BNPL: 6%+30¢
Cash/check: free
Bitcoin: 0% until 2027
International cards: +1.50% on top
Square Payments, POS, Online, Invoices, Subscriptions APIs
Square Reader/Stand/Terminal/Register hardware
Webhooks for transactions, customers, orders
OAuth 2.0 + Personal access tokens
Catalog API for items, categories, taxes, modifiers
Customer Directory API

Use Cases

Name Description
Accept Payments Online
Build Custom POS Systems
Manage Product Catalogs
Track Inventory Across Locations
Create Loyalty and Rewards Programs
Send and Manage Invoices
Schedule Appointments and Bookings
Manage Team Members and Labor
Process Refunds and Disputes
Sell Gift Cards
Set Up Recurring Subscriptions

Integrations

Name Description
Apple Pay
Google Pay
Cash App Pay
Afterpay
QuickBooks
WooCommerce
Wix
BigCommerce

Artifacts

Machine-readable API specifications organized by format.

OpenAPI

AsyncAPI

JSON Schema

JSON Structure

JSON-LD

Examples

Plans & Pricing

Rate Limits

FinOps

Naftiko Capabilities

Self-contained Naftiko capabilities, one per Square business surface (OpenAPI tag). Each file inlines its upstream consumes block plus REST and MCP exposers.

Square Payments API

Square Orders API

Square Catalog API

Square Inventory API

Square Customers API

Square Locations API

Square Team API

Square Labor API

Square Bookings API

Square Loyalty API

Square Gift Cards API

Square Invoices API

Square Subscriptions API

Square Checkout API

Square Terminal API

Square Refunds API

Square Disputes API

Square Merchants API

Square Cards API

Square Vendors API

Square Cash Drawers API

Square Bank Accounts API

Square Payouts API

Square Apple Pay API

Square Sites API

Square Snippets API

Square OAuth API

Square Webhook Subscriptions API

Square Events API

Square Devices API

Square Customer Groups API

Square Customer Segments API

Square Gift Card Activities API

Square Custom Attributes API

Vocabulary

  • Square Vocabulary — Unified taxonomy mapping 42 resources, 42 actions, 42 workflows, and 4 personas across operational (OpenAPI) and capability (Naftiko) dimensions

Rules

Maintainers

FN: Kin Lane

Email: kin@apievangelist.com

About

Square provides APIs for payment processing, point of sale, and business management solutions enabling developers to build custom commerce applications.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors