Square Terminal API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Terminal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
15 operations
across 15 paths,
and defines 60 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://connect.squareup.com.
15 operations15 paths60 schemas3 GET12 POST
Metadata
The identity and technical contract details declared by the specification.
Square Terminal API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes.
An API key is passed in the header as Authorization (oauth2ClientSecret).
Paths & Operations 15
Across 15 paths, the API surfaces 15 operations — 3 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are TerminalCheckout (21 properties), TerminalAction (20 properties), TerminalRefund (14 properties), DeviceMetadata (12 properties). Each schema is shown below with its type and property counts.
Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
CheckoutOptionsPaymentType
string
TerminalCheckoutQuery
object
2 properties
TerminalActionActionType
string
Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.
TerminalRefundQuery
object
2 properties
SearchTerminalActionsResponse
object
3 properties
SearchTerminalActionsRequest
object
3 properties
TerminalRefundQuerySort
object
1 property
TipSettings
object
5 properties
SelectOption
object
2 properties2 required
CreateTerminalActionResponse
object
2 properties
CreateTerminalRefundRequest
object
2 properties1 required
TerminalActionQuery
object
2 properties
CancelTerminalRefundResponse
object
2 properties
ActionCancelReason
string
CollectedData
object
1 property
TerminalCheckoutQuerySort
object
1 property
CreateTerminalActionRequest
object
2 properties2 required
TerminalRefundQueryFilter
object
3 properties
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
SignatureOptions
object
3 properties2 required
CreateTerminalRefundResponse
object
2 properties
GetTerminalActionResponse
object
2 properties
TimeRange
object
Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on…
2 properties
TerminalRefund
object
Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.
14 properties4 required
DataCollectionOptions
object
4 properties3 required
QrCodeOptions
object
Fields to describe the action that displays QR-Codes.
3 properties3 required
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
ConfirmationDecision
object
1 property
ReceiptOptions
object
Describes receipt action fields.
3 properties1 required
SearchTerminalRefundsRequest
object
3 properties
CreateTerminalCheckoutRequest
object
2 properties2 required
TerminalActionQueryFilter
object
4 properties
SaveCardOptions
object
Describes save-card action fields.
3 properties1 required
TerminalCheckoutQueryFilter
object
3 properties
DismissTerminalActionResponse
object
2 properties
SelectOptions
object
4 properties3 required
SignatureImage
object
2 properties
DataCollectionOptionsInputType
string
Describes the input type of the data.
TerminalActionQuerySort
object
1 property
PaymentOptions
object
4 properties
CancelTerminalCheckoutResponse
object
2 properties
DismissTerminalCheckoutResponse
object
2 properties
DismissTerminalRefundResponse
object
2 properties
SearchTerminalRefundsResponse
object
3 properties
ConfirmationOptions
object
5 properties3 required
PaymentOptionsDelayAction
string
Describes the action to be applied to a delayed capture payment when the delayduration has elapsed.
TerminalCheckout
object
Represents a checkout processed by the Square Terminal.
21 properties2 required
SearchTerminalCheckoutsResponse
object
3 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
SearchTerminalCheckoutsRequest
object
3 properties
DeviceCheckoutOptions
object
5 properties1 required
CancelTerminalActionResponse
object
2 properties
DeviceMetadata
object
12 properties
TerminalAction
object
Represents an action processed by the Square Terminal.
20 properties
CreateTerminalCheckoutResponse
object
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
GetTerminalCheckoutResponse
object
2 properties
GetTerminalRefundResponse
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Square Terminal API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
