Skip to main content

GET/payment_policy

This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter.

Marketplaces and locales

Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/payment_policy?

URI parameters

ParameterTypeDescription
marketplace_idMarketplaceIdEnumThis query parameter specifies the eBay marketplace of the policies you want to retrieve.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.account

https://api.ebay.com/oauth/api_scope/sell.account.readonly

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

{ /* PaymentPolicyResponse */
"href" : "string",
"limit" : "integer",
"next" : "string",
"paymentPolicies" : [],
"prev" : "string",
}

Response fields

Output container/fieldTypeDescription
hrefstring

This field is for future use.

Occurrence: Conditional

limitinteger

This field is for future use.

Occurrence: Conditional

nextstring

This field is for future use.

Occurrence: Conditional

offsetinteger

This field is for future use.

Occurrence: Conditional

paymentPoliciesarray of PaymentPolicy

A list of all of the seller's payment business policies defined for the specified marketplace. This array will be returned as empty if no payment business policies are defined for the specified marketplace.

Occurrence: Always

paymentPolicies.categoryTypesarray of CategoryType

This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.

Occurrence: Always

paymentPolicies.categoryTypes.defaultboolean

Note: This field has been deprecated and is no longer used.

  • Do not include this field in any create or update method.
  • This field may be returned within the payload of a get method, but it can be ignored.

Occurrence: Conditional

paymentPolicies.categoryTypes.nameCategoryTypeEnum

The category type to which the policy applies (motor vehicles or non-motor vehicles).

The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles.

Occurrence: Always

paymentPolicies.depositDeposit

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 and when it is due (within 1-3 days after commitment to purchase, unless the listing requires immediate payment).

Note: The due date that is specified in the deposit container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchasing the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing.

Occurrence: Conditional

paymentPolicies.deposit.amountAmount

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.

Max: 2000.0

Occurrence: Conditional

paymentPolicies.deposit.amount.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

paymentPolicies.deposit.amount.valuestring

The monetary amount in the specified currency.

Occurrence: Conditional

paymentPolicies.deposit.dueInTimeDuration

This value indicates the number of hours that the buyer has (after they commit to buy) to pay the initial deposit on a motor vehicle. Valid dueIn times are 24, 48, and 72 hours. HOUR is set as the unit value, and 24, 48 or 72 are set in the value field.

Note: The dueIn value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle.

Min=24 (hours)Max=72 (hours), Default=48 (hours)

Occurrence: Conditional

paymentPolicies.deposit.dueIn.unitTimeDurationUnitEnum

These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units.

Occurrence: Conditional

paymentPolicies.deposit.dueIn.valueinteger

An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.

Occurrence: Conditional

paymentPolicies.deposit.paymentMethodsarray of PaymentMethod

This array is no longer applicable and should not be used since eBay now manages the electronic payment options available to buyers to pay the deposit.

Occurrence: Conditional

paymentPolicies.deposit.paymentMethods.brandsarray of PaymentInstrumentBrandEnum

Note: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted.

Occurrence: Conditional

paymentPolicies.deposit.paymentMethods.paymentMethodTypePaymentMethodTypeEnum

eBay now controls all electronic payment methods available for a marketplace, so only offline payment method enum values may be used in this field, and offline payment methods will only be applicable to listings that require or support offline payments. See the PaymentMethodTypeEnum type for supported offline payment method enum values.

Occurrence: Conditional

paymentPolicies.deposit.paymentMethods.recipientAccountReferenceRecipientAccountReference

Note: This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal.

Occurrence: Conditional

paymentPolicies.deposit.paymentMethods.recipientAccountReference.referenceIdstring

Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.

Occurrence: Conditional

paymentPolicies.deposit.paymentMethods.recipientAccountReference.referenceTypeRecipientAccountReferenceTypeEnum

Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.

Occurrence: Conditional

paymentPolicies.descriptionstring

A seller-defined description of the payment policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250

Occurrence: Conditional

paymentPolicies.fullPaymentDueInTimeDuration

This container 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 container 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
A MOTORS_VEHICLES) payment business 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

Occurrence: Conditional

paymentPolicies.fullPaymentDueIn.unitTimeDurationUnitEnum

These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units.

Occurrence: Conditional

paymentPolicies.fullPaymentDueIn.valueinteger

An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.

Occurrence: Conditional

paymentPolicies.immediatePayboolean

If this field is returned as true, immediate payment is required from the buyer for:

  • A fixed-price item
  • An auction item where the buyer uses the 'Buy it Now' option
  • A deposit for a motor vehicle listing

It is possible for the seller to set this field as true in the payment business 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.

Occurrence: Always

paymentPolicies.marketplaceIdMarketplaceIdEnum

The ID of the eBay marketplace to which the payment business policy applies.

Occurrence: Required

paymentPolicies.namestring

A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64

Occurrence: Always

paymentPolicies.paymentInstructionsstring

Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.

Max length: 1000

Occurrence: Conditional

paymentPolicies.paymentMethodsarray of PaymentMethod

This container is returned to show the payment methods that are accepted for the payment business policy.

Sellers 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.

Occurrence: Always

paymentPolicies.paymentMethods.brandsarray of PaymentInstrumentBrandEnum

Note: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted.

Occurrence: Conditional

paymentPolicies.paymentMethods.paymentMethodTypePaymentMethodTypeEnum

eBay now controls all electronic payment methods available for a marketplace, so only offline payment method enum values may be used in this field, and offline payment methods will only be applicable to listings that require or support offline payments. See the PaymentMethodTypeEnum type for supported offline payment method enum values.

Occurrence: Conditional

paymentPolicies.paymentMethods.recipientAccountReferenceRecipientAccountReference

Note: This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal.

Occurrence: Conditional

paymentPolicies.paymentMethods.recipientAccountReference.referenceIdstring

Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.

Occurrence: Conditional

paymentPolicies.paymentMethods.recipientAccountReference.referenceTypeRecipientAccountReferenceTypeEnum

Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.

Occurrence: Conditional

paymentPolicies.paymentPolicyIdstring

A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created.

Occurrence: Required

prevstring

This field is for future use.

Occurrence: Conditional

totalinteger

The total number of payment business policies retrieved in the result set.

If no payment business policies are defined for the specified marketplace, this field is returned with a value of 0.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20401API_ACCOUNTREQUESTMissing field {fieldName}. {additionalInfo}
20403API_ACCOUNTREQUESTInvalid {fieldName}. {additionalInfo}
20500API_ACCOUNTAPPLICATIONSystem error.
20501API_ACCOUNTAPPLICATIONService unavailable. Please try again in next 24 hours.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get all Payment Policies

Sellers can create one or more payment policies for a particular marketplace. This call returns all the current payment policies for the specified marketplace.

Input

Specify the marketplace for the policies you want to retrieve using the marketplace_id query parameter.

GEThttps://api.sandbox.ebay.com/sell/account/v1/payment_policy?marketplace_id=EBAY_US

Output

If the call is successful, eBay returns an HTTP status code of 200 OK and a complete list of the payment policies associated with the specified marketplace.