GET/payment_policy/get_by_policy_name
This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters.
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 query parameter specifies the eBay marketplace of the policy you want to retrieve. Occurrence: Required |
| name | string | This query parameter specifies the seller-defined name of the payment policy you want to retrieve. This value can be retrieved for a payment policy by using the getPaymentPolicies method. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Language | string | Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers. Occurrence: Conditional |
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 |
|---|---|---|
| categoryTypes | array of CategoryType | This container indicates whether the payment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. Occurrence: Always |
| categoryTypes.default | boolean | Note: This field has been deprecated and is no longer used. Occurrence: Conditional |
| categoryTypes.name | CategoryTypeEnum | The category type to which the policy applies (motor vehicles or non-motor vehicles). Occurrence: Always |
| deposit | Deposit | This container is applicable only if the categoryTypes.name field is set to Note: The due date that is specified in the deposit container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchasing the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing. Occurrence: Conditional |
| deposit.amount | Amount | This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required. Occurrence: Conditional |
| deposit.amount.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| deposit.amount.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| deposit.dueIn | TimeDuration | This value indicates the number of hours that the buyer has (after they commit to buy) to pay the initial deposit on a motor vehicle. Valid dueIn times are 24, 48, and 72 hours. Occurrence: Conditional |
| deposit.dueIn.unit | TimeDurationUnitEnum | These enum values represent the time measurement unit, such as Occurrence: Conditional |
| deposit.dueIn.value | integer | An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. Occurrence: Conditional |
| deposit.paymentMethods | array of PaymentMethod | This array is no longer applicable and should not be used since eBay now manages the electronic payment options available to buyers to pay the deposit. Occurrence: Conditional |
| deposit.paymentMethods.brands | array of PaymentInstrumentBrandEnum | Note: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted. Occurrence: Conditional |
| deposit.paymentMethods.paymentMethodType | PaymentMethodTypeEnum | This array is only applicable for listings supporting offline payment methods. See the PaymentMethodTypeEnum type for supported offline payment method enum values. If offline payments are enabled for the policy, provide at least one offline payment method. Occurrence: Conditional |
| deposit.paymentMethods.recipientAccountReference | RecipientAccountReference | Note: This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal. Occurrence: Conditional |
| deposit.paymentMethods.recipientAccountReference.referenceId | string | Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. Occurrence: Conditional |
| deposit.paymentMethods.recipientAccountReference.referenceType | RecipientAccountReferenceTypeEnum | Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. Occurrence: Conditional |
| description | string | A seller-defined description of the payment policy. This description is only for the seller's use, and is not exposed on any eBay pages. Occurrence: Conditional |
| fullPaymentDueIn | TimeDuration | This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. This value is always returned if categoryTypes is set to
MOTORS_VEHICLES) payment business policy must specify at least one of the following paymentMethods values for the final payment:
Occurrence: Conditional |
| fullPaymentDueIn.unit | TimeDurationUnitEnum | These enum values represent the time measurement unit, such as Occurrence: Conditional |
| fullPaymentDueIn.value | integer | An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. Occurrence: Conditional |
| immediatePay | boolean | If this field is returned as
It is possible for the seller to set this field as true in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller. Occurrence: Always |
| marketplaceId | MarketplaceIdEnum | The ID of the eBay marketplace to which the payment business policy applies. Occurrence: Always |
| name | string | A seller-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. Occurrence: Always |
| paymentInstructions | string | Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy. Occurrence: Conditional |
| paymentMethods | array of PaymentMethod | This container is returned to show the payment methods that are accepted for the payment business policy. Occurrence: Always |
| paymentMethods.brands | array of PaymentInstrumentBrandEnum | Note: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted. Occurrence: Conditional |
| paymentMethods.paymentMethodType | PaymentMethodTypeEnum | This array is only applicable for listings supporting offline payment methods. See the PaymentMethodTypeEnum type for supported offline payment method enum values. If offline payments are enabled for the policy, provide at least one offline payment method. Occurrence: Conditional |
| paymentMethods.recipientAccountReference | RecipientAccountReference | Note: This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal. Occurrence: Conditional |
| paymentMethods.recipientAccountReference.referenceId | string | Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. Occurrence: Conditional |
| paymentMethods.recipientAccountReference.referenceType | RecipientAccountReferenceTypeEnum | Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. Occurrence: Conditional |
| paymentPolicyId | string | A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created. 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 |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20401 | API_ACCOUNT | REQUEST | Missing field {fieldName}. {additionalInfo} |
| 20403 | API_ACCOUNT | REQUEST | Invalid {fieldName}. {additionalInfo} |
| 20404 | API_ACCOUNT | REQUEST | {fieldName} not found. |
| 20500 | API_ACCOUNT | APPLICATION | System error. |
| 20501 | API_ACCOUNT | APPLICATION | Service unavailable. Please try again in next 24 hours. |
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 Payment Policy by Name
This call retrieves the payment policy that matches the name you specify in the request.
Input
This call uses two query parameters to identify the policy you want to retrieve. Specify the name of the policy you want to retrieve using the name query parameter and supply the marketplace for the policy using the marketplace_id parameter. This call does not use a request payload.
GEThttps://api.ebay.com/sell/account/v1/payment_policy/get_by_policy_name?name=d********y"&marketplace_id=EBAY_US
Output
A successful call returns an HTTP status code of 200 OK and a response body containing the specified payment policy.