GET/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.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
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. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
marketplaceId | MarketplaceIdEnum | The ID of the eBay marketplace to which the payment program applies. Occurrence: Always |
paymentsProgramType | PaymentsProgramType | This parameter specifies the payment program whose status is returned by the call. Occurrence: Always |
status | PaymentsProgramStatus | The enumeration value returned in this field indicates whether or not the seller's account is enabled for the payments program. Occurrence: Always |
wasPreviouslyOptedIn | boolean | If returned as 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 |
Warnings
This call has no 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: Get the opted-in status for the specified payment program.
Sellers can opt-in to the payment programs offered by eBay. This call returns the seller's status for the specified payment program in the specified marketplace.
Input
This call does not use a request payload.
GEThttps://api.sandbox.ebay.com/sell/account/v1/payments_program/EBAY_US/EBAY_PAYMENTS
Output
A successful call returns an HTTP status of "200 OK" and a payload that contains the current status of the seller with regards to the specified payment program.