account APIv1.6.0

getPaymentsProgramOnboarding

GET
/payments_program/{marketplace_id}/{payments_program_type}/onboarding
This method retrieves a seller's onboarding status of eBay managed payments for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.

Presently, the only supported payments program type is EBAY_PAYMENTS. See Managed Payments on eBay and Payments Terms of Use.

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.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/payments_program/{marketplace_id}/{payments_program_type}/onboarding

URI parameters

ParameterTypeDescription
marketplace_idMarketplaceIdEnumThe 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.

Occurrence: Required

payments_program_typePaymentsProgramTypeThe type of payments program whose status is returned by the call. Presently, the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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.

Output

HTTP response headers

Output container/fieldTypeDescription
onboardingStatusPaymentsProgramOnboardingStatusThis enumeration value indicates the eligibility of payment onboarding for the registered site.

Occurrence: Always

stepsarray of PaymentsProgramOnboardingStepsAn 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 IN_PROGRESS step. The step names are returned in sequential order.

Occurrence: Always

steps.namestringThe 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.statusPaymentsProgramOnboardingStepStatusThis enumeration value indicates the status of the associated step.

Note: Only one step can be IN_PROGRESS at a time.

Occurrence: Conditional

steps.webUrlstringThis URL provides access to the IN_PROGRESS step.

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.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20408API_ACCOUNTREQUESTNo payments program available. The user may not be registered to the specified site or the site may not be supported by the payments program.
20500API_ACCOUNTAPPLICATIONApplication error

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.
GET
https://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.