This doc page has moved! You should be automatically redirected to the resources page for the eBay Account API. If you are not redirected automatically, follow this link to the Account API.

eBay Account APIVersion 1.2.0

SetPaymentPolicyResponse

Complex type that that gets populated with a response containing a payment policy.

Calls that use SetPaymentPolicyResponse:

Fields



categoryTypes ( array of CategoryType ) [0..?]
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.)
See the Field Index to learn which calls use categoryTypes.

deposit ( Deposit ) [0..?]
This container is applicable only if the categoryTypes.name field is set to 'MOTORS_VEHICLES'. In this case, sellers can use this field to specify amounts and due dates for deposits and full payments for motor vehicle listings on eBay Motors.
See the Field Index to learn which calls use deposit.

description ( string ) [0..?]
An optional seller-defined description of the payment policy.

Max length: 250
See the Field Index to learn which calls use description.

fullPaymentDueIn ( TimeDuration ) [0..?]
The policy for when final payment is due on invoiced items (in most cases, this payment policy applies to motor vehicles). This value is always returned if categoryTypes is set to MOTORS_VEHICLES.
See the Field Index to learn which calls use fullPaymentDueIn.

immediatePay ( boolean ) [0..?]
When this value is set to true, it indicates that payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchage an item). Your items will be available for other buyers until payment is complete. This boolean must be set in the payment policy if the seller wants to create a listing that has an "immediate payment" requirement.

Default: false
See the Field Index to learn which calls use immediatePay.

marketplaceId ( MarketplaceIdEnum ) [0..?]
The ID of the eBay marketplace to which this payment policy applies. If this value is not specified, value defaults to the seller's eBay registration site.
See the Field Index to learn which calls use marketplaceId.

name ( string ) [0..?]
A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64
See the Field Index to learn which calls use name.

paymentInstructions ( string ) [0..?]
This user-defined field allows the seller to give payment instructions to the buyer. These instructions appear on the eBay View Item and Checkout pages.

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

Max length: 500
See the Field Index to learn which calls use paymentInstructions.

paymentMethods ( array of PaymentMethod ) [0..?]
A list of the payment methods accepted by the seller. Each payment policy must specify at least one payment method.

Payment policies used with motor vehicle listings that require a deposit must have PayPal listed has a payment method (deposits require PayPal as the payment method). Also, in order for a buyer to make a full payment on a US or CA motor vehicle, the payment policy must specify at least one of the following as a payment method:
  • 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 paymentMethods.

paymentPolicyId ( string ) [0..?]
A unique eBay-assigned ID for this policy.
See the Field Index to learn which calls use paymentPolicyId.

warnings ( array of ErrorDetailV3 ) [0..?]
A list of warnings related to request. This field normally returns empty, which indicates the request did not generate any warnings.
See the Field Index to learn which calls use warnings.