eBay Transaction 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 Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
2 operations
across 2 paths,
and defines 11 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}.
2 operations2 paths11 schemas2 GET
Metadata
The identity and technical contract details declared by the specification.
eBay Transaction 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 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Transaction 2
GET
/transaction
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…
getTransactions5 params→ 200204400500
GET
/transaction_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…
getTransactionSummary2 params→ 200400500
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are TransactionSummaryResponse (36 properties), Transaction (21 properties), Amount (7 properties), Transactions (7 properties). Each schema is shown below with its type and property counts.
Tax
object
This type is used to return the tax details of a transaction.
2 properties
Transaction
object
This type is used to express the details of one of the following monetary transactions: a buyer's payment for an order, a refund to the buyer for a returned it…
21 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
OrderLineItem
object
This type is used to show the fees and donations that are deducted from a seller payout for each line item in an order.
4 properties
PayoutDetails
object
This type provide payout details for a split-payout case. This type is only applicable for split payouts.
2 properties
Fee
object
This type is used to display fees that are automatically deducted from seller payouts.
4 properties
Buyer
object
This type is used to express details about the buyer associated with an order. At this time, the only field in this type is the eBay user ID of the buyer, but…
1 property
Transactions
object
This is the base response type of the getTransactions method. The getTransactions response includes details on one or more monetary transactions that match the…
7 properties
Reference
object
This field is returned for NONSALECHARGE transactions that contain non-transactional seller fees.
2 properties
FeeJurisdiction
object
This container returns jurisdiction information about region-specific fees that are charged to sellers.
2 properties
TransactionSummaryResponse
object
This type is the base response type of the getTransactionSummary method, and based on the filters that are used in the getTransactionSummary call URI, the resp…
36 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
