Square

Square Terminal API

The Terminal API from Square — 15 operation(s) for terminal.

Documentation GitHub OpenAPI

Business capability

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/terminals/actions Send an action request to a Terminal device · Square Create Terminal Action #

Ask an LLM

“How do I push a custom action, like a device pairing check, to a Square Terminal?”

“Can I ask a Terminal device to collect something other than a payment?”

Tell an agent

Send Terminal action {action} to the device.

Create a Terminal action request {action} with idempotency key {idempotency_key}.

POST /v2/terminals/actions/search Search Terminal action requests · Square Search Terminal Actions #

Ask an LLM

“Which Terminal action requests did I send in the last 30 days?”

“Can I filter Terminal actions by device or status?”

Tell an agent

Search Terminal actions matching {query}.

List my recent Terminal action requests, up to {limit}.

GET /v2/terminals/actions/{action_id} Get a Terminal action request · Square Get Terminal Action #

Ask an LLM

“What is the status of an action I sent to a Terminal?”

“Can I look up one Terminal action request by its ID?”

Tell an agent

Get Terminal action {action_id}.

Check the status of Terminal action {action_id}.

POST /v2/terminals/actions/{action_id}/cancel Cancel a Terminal action request · Square Cancel Terminal Action #

Ask an LLM

“Can I cancel an action request before the device completes it?”

“What statuses allow a Terminal action to be canceled?”

Tell an agent destructive · confirm first

Cancel Terminal action {action_id}.

Stop the pending Terminal action {action_id} on the device.

POST /v2/terminals/actions/{action_id}/dismiss Dismiss a Terminal action request · Square Dismiss Terminal Action #

Ask an LLM

“How do I clear a finished action off the Terminal screen?”

“When is dismissing a Terminal action allowed?”

Tell an agent

Dismiss Terminal action {action_id}.

Clear Terminal action {action_id} from the device display.

POST /v2/terminals/checkouts Send a checkout to a Terminal device · Square Create Terminal Checkout #

Ask an LLM

“How do I make a Square Terminal prompt the customer to pay a set amount?”

“Can I start an in-person card payment from my app on a Terminal?”

Tell an agent

Send checkout {checkout} to the Terminal.

Create a Terminal checkout {checkout} with idempotency key {idempotency_key}.

POST /v2/terminals/checkouts/search Search Terminal checkout requests · Square Search Terminal Checkouts #

Ask an LLM

“Which Terminal checkouts did my app create recently?”

“Can I find Terminal checkouts that are still pending on a device?”

Tell an agent

Search Terminal checkouts matching {query}.

List recent Terminal checkouts, at most {limit}.

GET /v2/terminals/checkouts/{checkout_id} Get a Terminal checkout request · Square Get Terminal Checkout #

Ask an LLM

“Did the customer finish paying on the Terminal checkout I sent?”

“What details come back for one Terminal checkout?”

Tell an agent

Get Terminal checkout {checkout_id}.

Check whether Terminal checkout {checkout_id} was completed.

POST /v2/terminals/checkouts/{checkout_id}/cancel Cancel a Terminal checkout · Square Cancel Terminal Checkout #

Ask an LLM

“Can I cancel a checkout that is waiting on the Terminal?”

“How do I stop a customer from paying a checkout I sent by mistake?”

Tell an agent destructive · confirm first

Cancel Terminal checkout {checkout_id}.

Abort the pending payment on Terminal checkout {checkout_id}.

POST /v2/terminals/checkouts/{checkout_id}/dismiss Dismiss a Terminal checkout · Square Dismiss Terminal Checkout #

Ask an LLM

“Is it possible to dismiss a checkout from the Terminal screen?”

“When can a Terminal checkout be dismissed instead of canceled?”

Tell an agent

Dismiss Terminal checkout {checkout_id}.

Clear Terminal checkout {checkout_id} off the device.

POST /v2/terminals/refunds Refund an Interac payment on a Terminal · Square Create Terminal Refund #

Ask an LLM

“How do I refund an Interac debit payment taken on a Square Terminal in Canada?”

“Why must Interac refunds go through the Terminal device?”

Tell an agent

Create a Terminal refund {refund}.

Start an Interac refund {refund} on the Terminal with key {idempotency_key}.

POST /v2/terminals/refunds/search Search Interac Terminal refunds · Square Search Terminal Refunds #

Ask an LLM

“Which Interac Terminal refunds were requested in the last 30 days?”

“Can I filter Terminal refund requests by status?”

Tell an agent

Search Terminal refunds matching {query}.

List Interac Terminal refund requests, up to {limit}.

GET /v2/terminals/refunds/{terminal_refund_id} Get an Interac Terminal refund · Square Get Terminal Refund #

Ask an LLM

“What is the status of an Interac refund I started on the Terminal?”

“Can I retrieve a Terminal refund object by its ID?”

Tell an agent

Get Terminal refund {terminal_refund_id}.

Check Interac Terminal refund {terminal_refund_id}.

POST /v2/terminals/refunds/{terminal_refund_id}/cancel Cancel an Interac Terminal refund · Square Cancel Terminal Refund #

Ask an LLM

“Can I cancel an Interac refund request before it finishes?”

“What happens if I cancel a pending Terminal refund?”

Tell an agent destructive · confirm first

Cancel Terminal refund {terminal_refund_id}.

Stop the pending Interac refund {terminal_refund_id}.

POST /v2/terminals/refunds/{terminal_refund_id}/dismiss Dismiss an Interac Terminal refund · Square Dismiss Terminal Refund #

Ask an LLM

“How do I dismiss a refund request showing on the Terminal?”

“When is it allowed to dismiss a Terminal refund?”

Tell an agent

Dismiss Terminal refund {terminal_refund_id}.

Clear Interac refund request {terminal_refund_id} from the Terminal screen.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/square:square-terminal-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Terminal API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (143 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-terminal-api-openapi.yml

Square Terminal API

Operations 15

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification