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 payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | MarketplaceIdEnum | The eBay marketplace ID associated with the onboarding status to retrieve. Occurrence: Required |
| payments_program_type | PaymentsProgramType | The type of payments program whose status is returned by the method. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.account
https://api.ebay.com/oauth/api_scope/sell.account.readonly
eBayUser
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| onboardingStatus | PaymentsProgramOnboardingStatus | This enumeration value indicates the eligibility of payment onboarding for the registered site. Occurrence: Always |
| steps | array of PaymentsProgramOnboardingSteps | An array of the active process steps for payment onboarding and the status of each step. This array includes the step name, step status, and a webUrl to the Occurrence: Always |
| steps.name | string | The name of the step in the steps array. Over time, these names are subject to change as processes change. The output sample contains example step names. Review an actual call response for updated step names. Occurrence: Conditional |
| steps.status | PaymentsProgramOnboardingStepStatus | This enumeration value indicates the status of the associated step. Note: Only one step can be Occurrence: Conditional |
| steps.webUrl | string | This URL provides access to the Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20408 | API_ACCOUNT | REQUEST | No payments program available. The user may not be registered to the specified site or the site may not be supported by the payments program. |
| 20500 | API_ACCOUNT | APPLICATION | Application error |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieves payment onboarding status for the registration site
Sellers can check their payment onboarding status. This call retrieves the payment onboarding status for the specified payments program in the specified marketplace.
Input
This call does not use a request payload.
GEThttps://api.ebay.com/sell/account/v1/payments_program/EBAY-US/EBAY_PAYMENTS/onboarding
Output
A successful call returns an HTTP status of "200 OK" and a payload that contains the current status of the seller's payment onboarding status with regards to the specified payment program. The payload contains the payments program onboarding status, steps, and the status of each step.