eBay Business Policies Management APIVersion 1.0.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..*]
Note:This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item. This field specifys one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform. If you specify multiple acceptedPaymentMethod 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. 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)
  • 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 to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings. 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)
  • PersonalCheck
See the Field Index to learn which calls use daysToFullPayment.

depositDetails ( DepositDetails ) [0..1]
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. This container is only applicable if the categoryGroup.namefield is set to 'MOTORS_VEHICLE'.
See the Field Index to learn which calls use depositDetails.

immediatePay ( boolean ) [0..1]
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
  • An auction item where the buyer is using the 'Buy it Now' option
  • A deposit for a motor vehicle listing

Note: 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.
To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:

  • 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]

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

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]

Important: This field is deprecated. Do not use this field.

See the Field Index to learn which calls use paypalEmailAddress.