Note: Managed payments availability: eBay managed payments is presently available in the US and Germany, and will roll out to Canada, UK, and Australia in July 2020.
Resource URI (production)
|marketplace_id||MarketplaceIdEnum||The eBay marketplace ID associated with the onboarding status to retrieve. Only enums for marketplaces that support or will soon support eBay managed payments are allowed. Error 20408 is returned for any other eBay marketplace. No response payload is returned with this error. |
|payments_program_type||PaymentsProgramType||The type of payments program whose status is returned by the call. Presently, the only supported payments program is |
HTTP request headers
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):
See OAuth access tokens for more information.
|onboardingStatus||PaymentsProgramOnboardingStatus||This enumeration value indicates the eligibility of payment onboarding for the registered site. |
|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 |
|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. |
|steps.status||PaymentsProgramOnboardingStepStatus||This enumeration value indicates the status of the associated step. |
Note: Only one step can be
|steps.webUrl||string||This URL provides access to the |
For more on errors, plus the codes of other common errors, see Handling errors.
|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.|
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.