eBay Business Policies Management APIVersion 1.1.0

PaymentInfo

Type defining the PaymentInfo container, which contains payment information related to the corresponding payment policy.

Type that uses PaymentInfo:

Calls that use PaymentInfo:

Fields



acceptedPaymentMethod ( token ) [0..*]
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. At least one payment method is required to be specified in each payment policy. If you specify multiple acceptablePaymentMethod fields, the repeating fields must be contiguous.

Note: Required or allowed payment methods vary by site and category. To retrieve a list of valid payment methods for your site and category, call GetCategoryFeatures, specifying 'PaymentMethods' as a FeatureID value in the call request, and then look for the Category.PaymentMethod values in the call response.
For motor vehicle payment policies (CategoryGroup.name=MOTORS_VEHICLE), 'PayPal' must be one of acceptedPaymentMethod values if a deposit is required (the paymentInfo.depositDetails container exist for the payment policy), and in order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified:
  • CashOnPickup
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (payment instructions are in the paymentInstructions field)
  • PersonalCheck
See the Field Index to learn which calls use acceptedPaymentMethod.

daysToFullPayment ( int ) [0..1]
This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'.

In order for a buyer to make a full payment on a US or CA motor vehicle, at least one of the following acceptedPaymentMethod values must be specified for the corresponding payment business policy:
  • CashOnPickup
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (payment instructions are in the item's description)
  • PersonalCheck
See the Field Index to learn which calls use daysToFullPayment.

depositDetails ( DepositDetails ) [0..1]
This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings on eBay Motors (US and CA). This container is only applicable if the categoryGroup.name field is set to 'MOTORS_VEHICLE'.
See the Field Index to learn which calls use depositDetails.

immediatePay ( boolean ) [0..1]
To create an immediate payment requirement that can be applied to a listing, immediatePay must be included and set to 'true' for the payment policy. If the seller does not want to apply an immediate payment requirement for an item, this field is either omitted, or included and set to 'false'. The seller can change the immediate payment requirement at any time during the lifecyle of a listing.

In the Trading API calls that return the AutoPay field (immediatePay equivalent), be aware that the field's appearance in the output does not necessarily indicate that the listing qualifies for immediate payment, but only that the seller attempted to create (by including and setting immediatePay to 'true' in the payment policy) an immediate payment requirement.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account;
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal payments;
  • the category supports PayPal payments;
  • the listing type is fixed-price or auction (with Buy It Now option).
To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid paymentProfile.paymentInfo.paypalEmailAddress value;
  • seller must offer PayPal as the only payment method;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the shippingProfileDiscountInfo container values if promotional shipping discounts will be used;
See the Field Index to learn which calls use immediatePay.

paymentInstructions ( string ) [0..1]
This free-form string field allows the seller to give payment instructions to the buyer. These instructions will appear on eBay's View Item and Checkout pages. This field allows 1000 characters.

It is recommended that the seller use this field for motor vehicles (eBay Motors US and CA) payment policies to clarify the specifics on the deposit (if required), pickup/delivery arrangements, and full payment details on the vehicle.
See the Field Index to learn which calls use paymentInstructions.

paypalEmailAddress ( token ) [0..1]
The valid email address linked to the seller's PayPal account. This field is required in the payment policy if 'PayPal' is one of the acceptedPaymentMethod values in the payment policy. eBay uses this email address to identify the correct PayPal account when the buyer pays via PayPal during the checkout process.

For digital listings, sellers must use an email address that is associated with a PayPal Premier or Business account.
See the Field Index to learn which calls use paypalEmailAddress.