Docs Home
Dev Essentials
PaymentsCommerceCustomersStaffMerchants
Release notes

Docs

Docs Home
Dev Essentials
Payments
Commerce
Customers
Staff
Merchants
Release notes
Overview
Delayed Capture
Partial Payments
Statement Descriptions
Card Surcharges
ACH Bank Transfer Payment
Afterpay and Clearpay Payments
Cash App Payments
Cash Payments
External Payments
House Accounts
Collect Application Fees
Update Payment and Tip Amounts
Retrieve Payments
Troubleshoot
Webhooks
Refund Payments
Refund a Payment with an App Fee
Retrieve Refunds
Process an Unlinked Refund
Webhooks
Process Disputes
Test in the Sandbox
Take Payments on Hardware
Terminal API
Quickstart
Take Payments for Orders
Take One-Off Payments
POS App Pairing
Monitor Square Terminals
Check Device Information
Customize Terminal Checkouts
Add Payment and Checkout Features
Save Card on File
Print or Issue Receipts
Customize the Idle Screen
Confirmation Screen
Signature Capture Screen
Data Collection Screen
Menu Selection List Screen
QR Code Screen
Link and Dismiss Actions
Manage Terminal Actions
Authorize the Mobile Payments SDK
Pair and Manage Card Readers
Take a Payment
Tap to Pay on Android
Offline Payments
Handling Errors
Authorize the Mobile Payments SDK
Pair and Manage Card Readers
Take a Payment
Tap to Pay on iPhone
Offline Payments
Configure for Square Stand or Square Kiosk
Handling Errors
Migrate from Reader SDK
React Native Plugin
Flutter Plugin
How It Works
Build on Android
Build on iOS
Build on Mobile Web
Find Your Android Fingerprint
Use the API in Offline Mode
Add an Alert Dialog Helper Class
Accept E-Money Payments
Accept QR Payments
Mobile Web Technical Reference
Payments API Integration
Set Up the Web Client App
Add the SDK to the Web Client
Deploy the Application
Take a Card Payment
Apple Pay
Google Pay
Digital Wallet Payment Requests
ACH Bank Transfer
Store and Charge Bank Accounts on File
Afterpay
Cash App Pay
Take a Gift Card Payment
Take Partial Payments
Customize the Card Entry Form
Charge and Store Cards
Add a Content Security Policy
Exception Handling
Set up the Client
Deploy the Server
Install the SDK
Build on Android
Build on iOS
Google Pay
Apple Pay
Localize an Application
Gift Card Payments
Flutter Plugin
React Native Plugin
Customize the Payment Entry Form
Connect to a Backend Service
Remove the Postal Code Requirement
Troubleshoot
How It Works
Verify a Buyer
Quick Pay Checkout
Square Order Checkout
Subscription Plan Checkout
Checkout Settings
Checkout Configurations
Manage Checkout
Guidelines and Limitations
Common Pitfalls and Solutions
Subscription Plans and Variations
Manage Subscriptions
Subscription Actions and Events
Pause, Resume, or Cancel Subscriptions
Subscription Billing and Invoices
Swap Subscription Plan Variations
Create and Publish Invoices
Retrieve, List, or Search Invoices
Create or Delete Invoice Attachments
Update Invoices
Cancel or Delete Invoices
Pay or Refund Invoices
Walkthrough: Create and Publish Invoices
Manage Cards
Create a Card on File from Payment ID
Create a Card on File and Make a Payment
Create a Shared Card on File and Make a Payment
Manage Card Declines
List Payouts
Get Payout
List Payout Entries
Bank Account API Operations
Payment Methods by Country
Payments Pricing
Strong Customer Authentication
Payment Minimums

/

Payments

/

Take Payments on Hardware

/

Terminal API

/

Customize Terminal Checkouts

Manage Terminal Actions

Applies to: Terminal API

Learn how to customize buyer workflows, save cards on file, check a device status, and perform other tasks.

Overview
Requirements and limitations
Create a Terminal action request
Search for a Terminal action request
Cancel a Terminal action request
Types of Terminal actions
Link to section

Overview

Important

Terminal actions are in Beta.

The Terminal API provides additional ways for a Square Terminal and a Point of Sale (POS) application to interact. These interactions are called Terminal actions.

Link to section

Requirements and limitations

  • A Square Terminal must be paired with a POS application.
  • Applications must have the following OAuth permissions:
    • PAYMENTS_READ for getting or searching for a Terminal action request.