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

Square Refunds API

The Refunds API from Square — 2 operation(s) for refunds.

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

This API exposes 3 operations across 2 paths, and defines 22 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.

3 operations 2 paths 22 schemas 2 GET1 POST

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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square Refunds 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 3

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

Refunds 3
GET
/v2/refunds
Square List Payment Refunds
ListPaymentRefunds 8 params → 200
POST
/v2/refunds
Square Refund Payment
RefundPayment body → 200
GET
/v2/refunds/{refund_id}
Square Get Payment Refund
GetPaymentRefund 1 param → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Card (17 properties), PaymentRefund (16 properties), Address (14 properties), RefundPaymentRequest (13 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.
ProcessingFee
object
Represents the Square processing fee.
3 properties
CardType
string
Indicates a card's type, such as CREDIT or DEBIT.
CardPrepaidType
string
Indicates a card's prepaid type, such as NOTPREPAID or PREPAID.
DestinationDetailsExternalRefundDetails
object
Stores details about an external refund. Contains only non-confidential information.
3 properties 2 required
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
RefundPaymentRequest
object
Describes a request to refund a payment using [RefundPayment](api-endpoint:Refunds-RefundPayment).
13 properties 2 required
DestinationDetailsCardRefundDetails
object
3 properties
PaymentRefund
object
Represents a refund of a payment made using Square. Contains information about the original payment and the amount of money refunded.
16 properties 2 required
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
ListPaymentRefundsResponse
object
Defines the response returned by [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds). Either errors or refunds is present in a given response (never…
3 properties
CardCoBrand
string
Indicates the brand for a co-branded card.
GetPaymentRefundResponse
object
Defines the response returned by [GetRefund](api-endpoint:Refunds-GetPaymentRefund). Note: If there are errors processing the request, the refund field might n…
2 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 properties 2 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
RefundPaymentResponse
object
Defines the response returned by [RefundPayment](api-endpoint:Refunds-RefundPayment). If there are errors processing the request, the refund field might not be…
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
DestinationDetails
object
Details about a refund's destination.
3 properties
DestinationDetailsCashRefundDetails
object
Stores details about a cash refund. Contains only non-confidential information.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-refunds-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square Refunds 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.