account APIv1.6.3

PaymentPolicyRequest

This root container defines a seller's payment policy for a specific marketplace and category type. Used when creating or updating a payment policy, paymentPolicyRequest encapsulates a seller's terms for how buyers can pay for the items they buy. While each seller must define at least one payment policy for every marketplace into which they sell, sellers can define multiple payment policies for a single marketplace by specifying different configurations for the unique policies.

A successful call returns a paymentPolicyId, plus the Location response header contains the URI to the resource.

Policy instructions can be localized by providing a locale in the Content-Language HTTP request header. For example: Content-Language: de-DE.

Tip: For more on using business policies, see eBay business policies.

Types that use PaymentPolicyRequest

Not used by any types

Calls that use PaymentPolicyRequest

Fields

Field
Type
Description
categoryTypes
array of CategoryType
The CategoryTypeEnum value to which this policy applies. This container is used to discern accounts that sell motor vehicles from those that do not.

Restriction: Currently, each policy can be set to only one categoryTypes value at a time.
deposit
This container is used if the seller wants to require an initial deposit on a motor vehicle listing. In this container, the seller sets the deposit amount ($2,000 maximum) and the due date for the deposit.

For sellers who are not onboarded with eBay managed payments, a payment method must be set for the deposit in the paymentMethods array, and this payment method must be PayPal.

Note: The brands field is not applicable when setting a motor vehicle deposit. Set the paymentMethodType value to 'PayPal' and pass in the PayPal payment address in the recipientAccountReference container.

Sellers who are onboarded for managed payments do not need to specify a payment method for the deposit, as all electronic payment methods are managed by eBay.
description
An optional seller-defined description of the payment policy for internal use (this value is not displayed to end users).

Max length: 250
fullPaymentDueIn
The number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due.

Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES.

The period starts when the buyer commits to buy. The valid values, as specified with TimeDuration, are:
  • 3 DAYS
  • 7 DAYS (the default)
  • 10 DAYS
  • 14 DAYS
In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following paymentMethods values must be specified for the corresponding payment policy:
  • CASH_ON_PICKUP
  • CASHIER_CHECK
  • LOAN_CHECK
  • MONEY_ORDER
  • PAYPAL
  • PERSONAL_CHECK
Restriction: This container is not supported for sellers who opt-in to the managed payments program. Managed payments does not currently support the sale of motor vehicles.

Default: 7 DAYS (this value is supported by a compound type)
immediatePay
This field should be included and set to 'true' if the seller wants to require immediate payment from the buyer for a fixed-price item or for an auction item where the buyer is using the 'Buy it Now' option.

Sellers who are not onboarded with eBay managed payments have the following additional requirements:
  • Offer PayPal as the only payment method
  • Provide a valid PayPal payment email address in the paymentMethods.recipientAccountReference.referenceId field


Default: False
marketplaceId
The ID of the eBay marketplace to which this payment policy applies. If this value is not specified, the value defaults to the seller's eBay registration site.

Note: A limited number of sellers, on a limited number of eBay marketplaces, are currently opted-in to the eBay managed payments program. To view the eBay marketplaces where managed payments are currently supported, see the managed payments landing page.

name
A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace.

Note: eBay will create a new payment policy for sellers who opt-in to the managed payments program.

Max length: 64
paymentInstructions

Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.

A free-form string field that allows sellers to add detailed payment instructions to their listings. The payment instructions appear on eBay's View Item and Checkout pages.

eBay recommends sellers use this field to clarify payment policies for motor vehicle listings on eBay Motors. For example, sellers can include the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle.

The field allows only 500 characters as input, but due to the way the eBay web site UI treats characters, this field can return more than 500 characters in the response. For example, characters like & and ' (ampersand and single quote) count as 5 characters each.

Restriction: This container is not supported for sellers who opt-in to the managed payments program.

Max length: 1000
paymentMethods
array of PaymentMethod
This array is used to specify one or more payment methods that will be accepted for order payment.

Because available electronic payments are strictly managed by eBay for sellers who are onboarded with eBay managed payments, this array is only needed by those sellers to specify offline payments (if applicable).

For sellers who are not onboarded with managed payments, at least one electronic payment method is required. For most marketplaces and categories, this payment method is 'PAYPAL'.

For a motor vehicle payment policy, the payment policy must specify at least one of the following as an offline payment method:
  • CASH_ON_PICKUP (not available in the US)
  • CASHIER_CHECK
  • MONEY_ORDER
  • PERSONAL_CHECK