Note: Currently, the only supported payments program is eBay Payments. For details, see:
Input
Resource URI (production)
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | MarketplaceIdEnum | This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status. Occurrence: Required |
| payments_program_type | PaymentsProgramType | This path parameter specifies the payments program whose status is returned by the call. Currently the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use. Occurrence: Required |
HTTP request headers
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
See OAuth access tokens for more information.
Output
| Output container/field | Type | Description |
|---|---|---|
| marketplaceId | MarketplaceIdEnum | The ID of the eBay marketplace to which the payment policy applies. If this value is not specified in the request, the value defaults to the seller's eBay registration site. Occurrence: Always |
| paymentsProgramType | PaymentsProgramType | This path parameter specifies the payment program whose status is returned by the call. Currently the only supported payments program is EBAY_PAYMENTS. For details on the program, see Payments Terms of Use. Occurrence: Always |
| status | PaymentsProgramStatus | Occurrence: Conditional |
| wasPreviouslyOptedIn | boolean | If set to true, the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of false indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it. It's important to note that the setting of this field does not indicate the seller's current status regarding the payment program. It is possible for this field to return true while the status field returns OPTED_IN. Occurrence: Always |
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 payment 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 |
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.