Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Onboarding API

The Onboarding API from eBay — 1 operation(s) for onboarding.

eBay Onboarding 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 Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 2 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}.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.9.2
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

eBay Onboarding 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Onboarding 1
GET
/payments_program/{marketplace_id}/{payments_program_type}/onboarding
Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow. This method retrieves a seller's onboarding status for a payme…
getPaymentsProgramOnboarding 2 params → 200400404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PaymentsProgramOnboardingSteps (3 properties), PaymentsProgramOnboardingResponse (2 properties). Each schema is shown below with its type and property counts.

PaymentsProgramOnboardingResponse
object
Type used by the payments program onboarding response
2 properties
PaymentsProgramOnboardingSteps
object
The payments program onboarding steps, status, and link.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-onboarding-api-openapi.yml Raw ↑

Other APIs eBay publishes across the network.

eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API