eBay Payment_dispute 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 Payment_dispute. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
9 operations
across 9 paths,
and defines 23 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}.
9 operations9 paths23 schemas4 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
eBay Payment_dispute 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 9
Across 9 paths, the API surfaces 9 operations — 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are PaymentDispute (20 properties), ReturnAddress (9 properties), PaymentDisputeSummary (9 properties), DisputeEvidence (8 properties). Each schema is shown below with its type and property counts.
PaymentDisputeActivity
object
This type is used by each recorded activity on a payment dispute, from creation to resolution.
3 properties
AddEvidencePaymentDisputeRequest
object
This type is used by the request payload of the addEvidence method. The addEvidence method is used to create a new evidence set against a payment dispute with…
3 properties
ContestPaymentDisputeRequest
object
This type is used by the request payload of the contestPaymentDispute method.
3 properties
PaymentDisputeActivityHistory
object
This type is used by the base response of the getActivities method, and includes a log of all activities of a payment dispute, from creation to resolution.
1 property
DisputeAmount
object
This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the…
5 properties
MonetaryTransaction
object
This type is used to provide details about one or more monetary transactions that occur as part of a payment dispute.
4 properties
UpdateEvidencePaymentDisputeRequest
object
This type is used by the request payload of the updateEvidence method. The updateEvidence method is used to update an existing evidence set against a payment d…
4 properties
DisputeSummaryResponse
object
This type defines the base response payload of the getPaymentDisputeSummaries method. Each payment dispute that matches the input criteria is returned under th…
7 properties
PaymentDispute
object
This type is used by the base response of the getPaymentDispute method. The getPaymentDispute method retrieves detailed information on a specific payment dispu…
20 properties
EvidenceRequest
object
This type is used by the evidenceRequests array that is returned in the getPaymentDispute response if one or more evidential documents are being requested to h…
5 properties
AddEvidencePaymentDisputeResponse
object
This type is used by the response payload of the addEvidence method. Its only field is an unique identifier of an evidence set.
1 property
TrackingInfo
object
This type is used for seller provided shipment tracking information.
2 properties
ReturnAddress
object
This type is used by the payment dispute methods, and is relevant if the buyer will be returning the item to the seller.
9 properties
FileInfo
object
This type is used by the files array, which shows the name, ID, file type, and upload date for each provided evidential file.
4 properties
FileEvidence
object
This type is used to store the unique identifier of an evidence file. Evidence files are used by seller to contest a payment dispute.
1 property
OrderLineItems
object
This type is used by the lineItems array that is used to identify one or more line items in the order with the payment dispute.
2 properties
PaymentDisputeOutcomeDetail
object
This type is used by the resolution container that is returned for payment disputes that have been resolved.
6 properties
InfoFromBuyer
object
This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provide…
3 properties
Phone
object
This type is used by the returnAddress
2 properties
DisputeEvidence
object
This type is used by the evidence array that is returned in the getPaymentDispute response if one or more evidential documents are associated with the payment…
8 properties
AcceptPaymentDisputeRequest
object
This type is used by base request of the acceptPaymentDispute method.
2 properties
PaymentDisputeSummary
object
This type is used by each payment dispute that is returned with the getPaymentDisputeSummaries method.
9 properties
SimpleAmount
object
This type defines the monetary value of the payment dispute, and the currency used.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
