get payments program marketplace id payments program type onboarding - sell-account API | Specway Docs

GET

/payments_program/{marketplace_id}/{payments_program_type}/onboarding

https://api.ebay.com{basePath}/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.

Access Token Required: API Key

Path Parameters

marketplace_idstringrequired

The eBay marketplace ID associated with the onboarding status to retrieve.

payments_program_typestringrequired

The type of payments program whose status is returned by the method.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://api.ebay.com{basePath}/payments_program/{marketplace_id}/{payments_program_type}/onboarding' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET