eBay Payout API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Payout. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
3 operations
across 3 paths,
and defines 7 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
3 operations3 paths7 schemas3 GET
Metadata
The identity and technical contract details declared by the specification.
eBay Payout API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
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.
Payout 3
GET
/payout/{payout_Id}
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, incl…
getPayout2 params→ 200400404500
GET
/payout
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, incl…
getPayouts5 params→ 200204400500
GET
/payout_summary
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, incl…
getPayoutSummary2 params→ 200400500
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Payout (14 properties), Amount (7 properties), Payouts (7 properties), Fee (4 properties). Each schema is shown below with its type and property counts.
PayoutInstrument
object
This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts.
4 properties
Payouts
object
This type is the base response type of the getPayouts method, and contains an array of one or more payouts (that match the input criteria), the total count of…
7 properties
Amount
object
This type is used to express the dollar value and currency used for any transaction retrieved with the Finances API , including an order total, a seller payout…
7 properties
PayoutSummaryResponse
object
This type is the base response type of the getPayoutSummary method, and contains the total count of seller payouts (that match the input criteria), the total c…
3 properties
Payout
object
This type is used to express the details of one seller payout that is returned with the getPayout or getPayouts methods.
14 properties
Fee
object
This type is used to display fees that are automatically deducted from seller payouts.
4 properties
FeeJurisdiction
object
This container returns jurisdiction information about region-specific fees that are charged to sellers.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
