account APIv1.6.3

PaymentPolicy

Root container that defines the fields for a seller's payment policy. The paymentPolicy encapsulates a seller's payment terms and consists of payment details for the seller, the name and description of the policy, and the marketplace and category group(s) covered by the payment policy. 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.

Type that uses PaymentPolicy

Calls that use PaymentPolicy

Fields

Field
Type
Description
categoryTypes
array of CategoryType
The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
deposit
This container is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES, and is only returned if the seller requires an initial deposit on motor vehicles.

The container shows the amount due for the deposit (max is $2,000) and when it is due (within 1-3 days after commitment to purchase). PayPal is the only supported payment method for non-eBay managed payments, and eBay controls the supported electronic payment methods if the seller is enabled for managed payments.
description
An optional seller-defined description of the payment policy.

Max length: 250
fullPaymentDueIn
This field 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.

This seller-specified value indicates 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. 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
For motor vehicles sales (where categoryTypes.name is set to MOTORS_VEHICLES), the payment policy must specify at least one of the following paymentMethods values for the final payment:
  • CASH_ON_PICKUP

    Note: This payment method is only available to sellers outside the US.
  • CASHIER_CHECK
  • MONEY_ORDER
  • PERSONAL_CHECK
immediatePay
If this field is returned as true, immediate payment is required from the buyer for a fixed-price item or for an auction item where the buyer uses the 'Buy it Now' option.

It is possible for the seller to set this field as true in the payment 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.
marketplaceId
The ID of the eBay marketplace to which the payment policy applies.
name
A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64
paymentInstructions
This free-form string field gives sellers the ability 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.

Max length: 1000.
paymentMethods
array of PaymentMethod
This container is returned to show the payment methods that are accepted for the payment business policy.

Sellers enabled for managed payments do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported.
paymentPolicyId
A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.