Specifying a Payment Method


Adding a Payment Method to a Listing

Determining the Payment Methods Allowed for a Category

Using Integrated Merchant Credit Card (IMCC)

Site Visibility

Requiring Immediate Payment

Note: For information about the PaisaPay payment method, see PaisaPay on the eBay India Site.

Adding a Payment Method to a Listing

Each listing must contain at least one valid (for the site and category) payment method. You can specify a payment method through the AddItem or AddFixedPriceItem calls. In the example below, PayPal is specified as a payment method. You can actually specify numerous, valid payment methods through multiple, contiguous PaymentMethods fields.

Example: Specifying a Payment Method

If a seller specifies PayPal as one of the payment methods, the seller must also supply his or her PayPal email address through the Item.PayPalEmailAddress field. This value is used to identify the seller's PayPal account as the recipient of the buyer's payment if the buyer pays for the item using PayPal. The seller may optionally enable the immediate payment feature on the item (see Requiring Immediate Payment). In a listing with immediate payment is enabled, the sole payment method must be PayPal.

When you use AddItem or AddFixedPriceItem to specify a payment method that is invalid for the target site, the invalid payment method is ignored and the item is listed (although a warning about the invalid payment method(s) is returned). If all specified payment methods are invalid for the target site, the default payment method for the site is used. If necessary, the default payment method for a site can be discovered by looking at the SiteDefaults.PaymentMethod value in the GetCategoryFeatures response.

After you list an item, you can use the values in the PaymentAllowedSite field returned by GetItem to confirm the sites on which the item can be purchased, based on the payment methods you offered.

When you revise or relist an item, rules apply for changing the existing payment methods. See Changing Payment Methods in a Relisted Item and Changing Payment Methods When Revising an Item.

Determining the Payment Methods Allowed for a Category

Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments, such as Visa, MasterCard, PayPal, etc. Also use GetCategoryFeatures to determine the default payment method for a site by looking at the SiteDefaults.PaymentMethod values. Do not use GeteBayDetails to discover the valid payment methods for a site.

For an example, see the Category Applicable Payment Methods sample.

You can use GetCategoryFeatures to determine if listings on a site must include PayPal as a payment method. Many categories require sellers to offer a safe payment method, such as PayPal, PaisaPay (India only), or one of the credit cards specified in Item.PaymentMethods. The SafePaymentRequired boolean field will be returned in GetCategoryFeatures if a safe payment method is required.

For additional information about payment methods, see the following location:

Accepted Payments Policy


Using Integrated Merchant Credit Card (IMCC)

On the US site, in AddItem and related calls, you can use the IntegratedMerchantCreditCard payment method if the seller of the item has a payment gateway account. The payment gateway account can be set up through options available to the seller in My eBay. For information about credit and debit card processing (through merchant accounts), see the following location:

Selecting payment methods (Merchant credit card drop-down)


If a seller uses the IntegratedMerchantCreditCard payment method in AddItem for a listing, it has the benefit of replacing the use of specific credit-card payment methods, such as VisaMC. If a seller uses the IntegratedMerchantCreditCard payment method for a listing, the listing displays (to potential buyers) the credit cards that the seller specified in the seller's preferences for their payment gateway account (in My eBay). Additionally, a buyer's credit card payment is integrated into eBay checkout.

In GetItem and related calls, Item.IntegratedMerchantCreditCardEnabled indicates if, on checkout, an online credit-card payment is processed through a payment gateway account.

If a payment-gateway-registered seller is using RelistItem or ReviseItem for a listing that was submitted with specific credit-card payment methods, the item will automatically be relisted/revised with the IntegratedMerchantCreditCard payment method. If a seller is not payment-gateway-registered, the IntegratedMerchantCreditCard payment method will get reset and the item will get listed with other specified payment methods (if any) other than IntegratedMerchantCreditCard. If no other payment methods were specified in the original listing, the listing will be blocked.

The User.SellerInfo.IntegratedMerchantCreditCardInfo.SupportedSite field, returned by GetUser, indicates the sites on which a seller has a payment gateway account.

Site Visibility

The payment method differences among eBay sites can affect the visibility of an item on different sites. For example, on the Australia (AU) site, only PayPal and CashOnPickup can be specified in the PaymentMethods field. If a non-AU seller specifies shipment to Australia in an item listing, but does not specify a valid payment method for the AU site, then the item will be unavailable in the search results of the AU site. If that listing contains PayPal but also contains payment methods that do not apply to the AU site, then only the PayPal payment method is shown on the AU site.

Requiring Immediate Payment

For a Buy It Now auction listing or a fixed-price listing, qualified sellers have the option of requiring a buyer to pay immediately after committing to purchase an item. This is called immediate payment.

Listings in some categories (e.g., Tickets) might lose their value if they are not sold by a particular date. For listings that contain time-sensitive (or perishable) items, eBay gives sellers the ability to specify that if the buyer pays the Buy It Now price or Fixed Price for the item, the payment must be made immediately through PayPal. Normally, eBay ends a listing and creates an order line item when a buyer agrees to purchase an item. If the seller chooses to require immediate payment, eBay ends the listing (or decrements the quantity in a multi-item listing) and creates an order line item after the payment has been processed. See the immediate payment online help on the eBay site for additional information about choosing to require immediate payment.

Understanding immediate payment


Prerequisites for Using Immediate Payment with AddItem

A seller can choose to require immediate payment for a fixed-price listing, or for an auction listing enabled with a Buy It Now option. If a Buy It Now auction listing ends as an auction (that is, if the Buy It Now option is removed due to bids being placed on the listing), the immediate payment requirement does not apply.

If a seller wants to require immediate payment, several conditions apply:

To indicate that the seller has chosen to require immediate payment, set the item's AutoPay field to true when using AddItem (or related calls).

See Requiring Immediate Payment of a Vehicle Deposit for additional rules that apply when the seller requires Immediate Payment of a US eBay Motors vehicle deposit.

Testing the Immediate Payment Feature

When testing this feature in the Sandbox, make sure AddItem (or related call) has Item.AutoPay set to true and Item.PaymentMethods set to PayPal. To test your PayPal Sandbox email address, include it in Item.PayPalEmailAddress.

Changing the Immediate Payment Requirement for an Item

When using ReviseItem or RelistItem, the default value of the Item.AutoPay flag is the value the seller used for the original listing.

To determine whether or not a seller requested immediate payment for a particular listing, use GetItem. The call returns the Item.AutoPay flag with a value of true if immediate payment was specified.

Note: The value of the AutoPay flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the AutoPay flag does not change.

If immediate payment is specified and the seller attempts to list the item in a category that does not support this feature, eBay will return an error. The seller should choose an appropriate category or remove the immediate payment requirement. (Items in certain categories may be subject to additional standard rules with respect to category changes.)

Note: If a listing does not specify immediate payment, a seller can add a requirement for immediate payment when revising the listing as long as all the conditions specified in Requirements for Using Immediate Payment with AddItem are met. The usual rules for revising a listing must also be met (that is, the listing has no bids or purchases, and the listing does not end within 12 hours). Similarly, a seller can remove a request for immediate payment from an existing listing if the usual rules for revising an item are met. In this case, set AutoPay to false. The seller can then choose additional payment methods in addition to Item.PaymentMethods value of PayPal for the item. However, the seller cannot modify the item's shipping costs.

If immediate payment was originally specified for a Buy It Now listing and the Buy It Now option no longer applies (e.g., a bid was placed), eBay automatically removes the immediate payment requirement on behalf of the seller. However, eBay does not change the value of Item.AutoPay, so it will still be returned as True by the GetItem.

Copyright © 2005–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.