Square Transactions 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 Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
4 operations
across 4 paths,
and defines 35 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.
4 operations4 paths35 schemas2 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Square Transactions 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 4
Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Tender (17 properties), Card (17 properties), Address (14 properties), Refund (10 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).
CardBrand
string
Indicates a card's brand, such as VISA or MASTERCARD.
TenderBuyNowPayLaterDetailsBrand
string
TenderSquareAccountDetails
object
Represents the details of a tender with type SQUAREACCOUNT.
1 property
CardType
string
Indicates a card's type, such as CREDIT or DEBIT.
TenderCardDetailsStatus
string
Indicates the card transaction's current status.
AdditionalRecipient
object
Represents an additional recipient (other than the merchant) receiving a portion of this tender.
4 properties2 required
RetrieveTransactionResponse
object
Defines the fields that are included in the response body of a request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint. On…
2 properties
CardPrepaidType
string
Indicates a card's prepaid type, such as NOTPREPAID or PREPAID.
RefundStatus
string
Indicates a refund's current status.
TenderBuyNowPayLaterDetails
object
Represents the details of a tender with type BUYNOWPAYLATER.
2 properties
VoidTransactionResponse
object
Defines the fields that are included in the response body of a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint.
1 property
Country
string
Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/count…
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
CaptureTransactionResponse
object
Defines the fields that are included in the response body of a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint.
1 property
TenderCashDetails
object
Represents the details of a tender with type CASH.
2 properties
TenderBankAccountDetailsStatus
string
Indicates the bank account payment's current status.
TenderCardDetails
object
Represents additional details of a tender with type CARD or SQUAREGIFTCARD
3 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
Tender
object
Represents a tender (i.e., a method of payment) used in a Square transaction.
17 properties1 required
TenderCardDetailsEntryMethod
string
Indicates the method used to enter the card's details.
Address
object
Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addr…
14 properties
TenderSquareAccountDetailsStatus
string
TransactionProduct
string
Indicates the Square product used to process a transaction.
Refund
object
Represents a refund processed for a Square transaction.
10 properties6 required
ListTransactionsResponse
object
Defines the fields that are included in the response body of a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. One of e…
3 properties
TenderBuyNowPayLaterDetailsStatus
string
CardCoBrand
string
Indicates the brand for a co-branded card.
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.
Card
object
Represents the payment details of a card to be used for payments. These details are determined by the payment token generated by Web Payments SDK.
17 properties
TenderType
string
Indicates a tender's type.
Transaction
object
Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale. The tenders field of this object lists all methods of…
10 properties
TenderBankAccountDetails
object
Represents the details of a tender with type BANKACCOUNT. See [BankAccountPaymentDetails](entity:BankAccountPaymentDetails) for more exposed details of a bank…
1 property
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
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 Transactions 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.
