How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Square

Square Payments API

The Payments API from Square — 5 operation(s) for payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Square Payments 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 Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 7 operations across 5 paths, and defines 45 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.

7 operations 5 paths 45 schemas 2 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
Contact
Square Developer Platform
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Square Payments 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 7

Across 5 paths, the API surfaces 7 operations — 2 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payments 7
GET
/v2/payments
Square List Payments
ListPayments 15 params → 200
POST
/v2/payments
Square Create Payment
CreatePayment body → 200
POST
/v2/payments/cancel
Square Cancel Payment by Idempotency Key
CancelPaymentByIdempotencyKey body → 200
GET
/v2/payments/{payment_id}
Square Get Payment
GetPayment 1 param → 200
PUT
/v2/payments/{payment_id}
Square Update Payment
UpdatePayment 1 param body → 200
POST
/v2/payments/{payment_id}/cancel
Square Cancel Payment
CancelPayment 1 param → 200
POST
/v2/payments/{payment_id}/complete
Square Complete Payment
CompletePayment 1 param body → 200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are Payment (44 properties), CreatePaymentRequest (25 properties), Card (17 properties), CardPaymentDetails (16 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.
GetPaymentResponse
object
Defines the response returned by [GetPayment](api-endpoint:Payments-GetPayment).
2 properties
ExternalPaymentDetails
object
Stores details about an external payment. Contains only non-confidential information. For more information, see [Take External Payments](https://developer.squa…
4 properties 2 required
ProcessingFee
object
Represents the Square processing fee.
3 properties
UpdatePaymentRequest
object
Describes a request to update a payment using [UpdatePayment](api-endpoint:Payments-UpdatePayment).
2 properties 1 required
CardType
string
Indicates a card's type, such as CREDIT or DEBIT.
CompletePaymentResponse
object
Defines the response returned by[CompletePayment](api-endpoint:Payments-CompletePayment).
2 properties
CreatePaymentResponse
object
Defines the response returned by [CreatePayment](api-endpoint:Payments-CreatePayment). If there are errors processing the request, the payment field might not…
2 properties
ClearpayDetails
object
Additional details about Clearpay payments.
1 property
CardPrepaidType
string
Indicates a card's prepaid type, such as NOTPREPAID or PREPAID.
CancelPaymentByIdempotencyKeyRequest
object
Describes a request to cancel a payment using [CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey).
1 property 1 required
BuyNowPayLaterDetails
object
Additional details about a Buy Now Pay Later payment type.
3 properties
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…
BankAccountPaymentDetails
object
Additional details about BANKACCOUNT type payments.
8 properties
CustomerDetails
object
Details about the customer making the payment.
2 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
ApplicationDetailsExternalSquareProduct
string
A list of products to return to external callers.
RiskEvaluation
object
Represents fraud risk information for the associated payment. When you take a payment through Square's Payments API (using the CreatePayment endpoint), Square…
2 properties 1 required
AfterpayDetails
object
Additional details about Afterpay payments.
1 property
UpdatePaymentResponse
object
Defines the response returned by [UpdatePayment](api-endpoint:Payments-UpdatePayment).
2 properties
PaymentSortField
string
CashPaymentDetails
object
Stores details about a cash payment. Contains only non-confidential information. For more information, see [Take Cash Payments](https://developer.squareup.com/…
2 properties 1 required
CreatePaymentRequest
object
Describes a request to create a payment using [CreatePayment](api-endpoint:Payments-CreatePayment).
25 properties 2 required
Payment
object
Represents a payment processed by the Square API.
44 properties
CancelPaymentByIdempotencyKeyResponse
object
Defines the response returned by [CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey). On success, errors is empty.
1 property
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
CashAppDetails
object
Additional details about WALLET type payments with the brand of CASHAPP.
3 properties
ACHDetails
object
ACH-specific details about BANKACCOUNT type payments with the transfertype of ACH.
3 properties
SquareAccountDetails
object
Additional details about Square Account payments.
2 properties
CardCoBrand
string
Indicates the brand for a co-branded card.
CancelPaymentResponse
object
Defines the response returned by [CancelPayment](api-endpoint:Payments-CancelPayment).
2 properties
ApplicationDetails
object
Details about the application that took the payment.
2 properties
RiskEvaluationRiskLevel
string
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 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
OfflinePaymentDetails
object
Details specific to offline payments.
1 property
DeviceDetails
object
Details about the device that took the payment.
3 properties
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
ListPaymentsResponse
object
Defines the response returned by [ListPayments](api-endpoint:Payments-ListPayments).
3 properties
CardPaymentTimeline
object
The timeline for card payments.
3 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
CompletePaymentRequest
object
Describes a request to complete (capture) a payment using [CompletePayment](api-endpoint:Payments-CompletePayment). By default, payments are set to autocomplet…
1 property
CardPaymentDetails
object
Reflects the current status of a card payment. Contains only non-confidential information.
16 properties
DigitalWalletDetails
object
Additional details about WALLET type payments. Contains only non-confidential information.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-payments-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
AE Profile APIs.io
Square Channels API
AE Profile APIs.io
Square Transfer Orders API
AE Profile APIs.io
Square ApplePay API
AE Profile APIs.io
Square BankAccounts API
AE Profile APIs.io
Square BookingCustomAttributes API
AE Profile APIs.io
Square Bookings API
AE Profile APIs.io
Square Cards API
AE Profile APIs.io
Square CashDrawers API
AE Profile APIs.io
Square Catalog API
AE Profile APIs.io
Square Checkout API
AE Profile APIs.io
Square CustomerCustomAttributes API
AE Profile APIs.io
#Payments
← Back to S APIs
API Details
ID
square:square-payments-api
Server
https://connect.squareup.com
Docs
https://developer.squareup.com/docs/payments-overview
Provider
Square
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=square-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/square-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Payments 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.