Own Compliance? Customize your docs with AI search, analytics, and more.

GET

/payments_program/{marketplace_id}/{payments_program_type}

https://api.ebay.com{basePath}/payments_program/{marketplace_id}/{payments_program_type}

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 returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.

Access Token Required: API Key

Path Parameters

marketplace_idstringrequired

This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.

payments_program_typestringrequired

This path parameter specifies the payments program whose status is returned by the call.

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}' \
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

/payments_program/{marketplace_id}/{payments_program_type}

https://api.ebay.com{basePath}/payments_program/{marketplace_id}/{payments_program_type}

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 returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.

Access Token Required: API Key

Path Parameters

marketplace_idstringrequired

This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.

payments_program_typestringrequired

This path parameter specifies the payments program whose status is returned by the call.

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}' \
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

/payments_program/{marketplace_id}/{payments_program_type}

https://api.ebay.com{basePath}/payments_program/{marketplace_id}/{payments_program_type}

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 returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.

Access Token Required: API Key

Path Parameters

marketplace_idstringrequired

This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.

payments_program_typestringrequired

This path parameter specifies the payments program whose status is returned by the call.

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}' \
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

/payments_program/{marketplace_id}/{payments_program_type}

https://api.ebay.com{basePath}/payments_program/{marketplace_id}/{payments_program_type}

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 returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.

Access Token Required: API Key

Path Parameters

marketplace_idstringrequired

This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.

payments_program_typestringrequired

This path parameter specifies the payments program whose status is returned by the call.

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}' \
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}