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 Payouts API

The Payouts API from Square — 3 operation(s) for payouts.

Square Payouts 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 Payouts. 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 3 paths, and defines 43 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 3 paths 43 schemas 3 GET

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 Payouts 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 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Payouts 3
GET
/v2/payouts
Square List Payouts
ListPayouts 7 params → 200
GET
/v2/payouts/{payout_id}
Square Get Payout
GetPayout 1 param → 200
GET
/v2/payouts/{payout_id}/payout-entries
Square List Payout Entries
ListPayoutEntries 4 params → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are PayoutEntry (32 properties), Payout (12 properties), Error (4 properties), ListPayoutEntriesResponse (3 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).
PaymentBalanceActivityDisputeDetail
object
2 properties
GetPayoutResponse
object
2 properties
PayoutFee
object
Represents a payout fee that can incur as part of a payout.
3 properties
PayoutStatus
string
Payout status types
PayoutFeeType
string
Represents the type of payout fee that can incur as part of a payout.
PaymentBalanceActivityOtherAdjustmentDetail
object
1 property
PaymentBalanceActivityTaxOnFeeDetail
object
2 properties
PaymentBalanceActivityAutomaticSavingsReversedDetail
object
2 properties
PaymentBalanceActivityHoldAdjustmentDetail
object
1 property
PaymentBalanceActivitySquarePayrollTransferReversedDetail
object
1 property
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
ListPayoutEntriesResponse
object
The response to retrieve payout records entries.
3 properties
PaymentBalanceActivityReserveReleaseDetail
object
1 property
PaymentBalanceActivityReserveHoldDetail
object
1 property
Payout
object
An accounting of the amount owed the seller and record of the actual transfer to their external bank account or to the Square balance.
12 properties 2 required
PaymentBalanceActivityAutomaticSavingsDetail
object
2 properties
PayoutEntry
object
One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity. The total amount of the payout will equal the sum of the pa…
32 properties 2 required
PaymentBalanceActivityThirdPartyFeeRefundDetail
object
2 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
PaymentBalanceActivityAppFeeRevenueDetail
object
2 properties
PaymentBalanceActivitySquarePayrollTransferDetail
object
1 property
PaymentBalanceActivityDepositFeeDetail
object
1 property
PaymentBalanceActivityFeeDetail
object
1 property
PayoutType
string
The type of payout: “BATCH” or “SIMPLE”. BATCH payouts include a list of payout entries that can be considered settled. SIMPLE payouts do not have any payout e…
ListPayoutsResponse
object
The response to retrieve payout records entries.
3 properties
PaymentBalanceActivityChargeDetail
object
1 property
PaymentBalanceActivityFreeProcessingDetail
object
1 property
PaymentBalanceActivityThirdPartyFeeDetail
object
1 property
PaymentBalanceActivitySquareCapitalReversedPaymentDetail
object
1 property
PaymentBalanceActivitySquareCapitalPaymentDetail
object
1 property
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
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
PaymentBalanceActivityRefundDetail
object
2 properties
PaymentBalanceActivityAppFeeRefundDetail
object
3 properties
PaymentBalanceActivityDepositFeeReversedDetail
object
1 property
DestinationType
string
List of possible destinations against which a payout can be made.
ActivityType
string
PaymentBalanceActivityOtherDetail
object
1 property
PaymentBalanceActivityOpenDisputeDetail
object
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
Destination
object
Information about the destination against which the payout was made.
2 properties
PaymentBalanceActivityReleaseAdjustmentDetail
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-payouts-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 Payouts 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.