--- title: "GET /payment_policy/get_by_policy_name" method: GET path: "/payment_policy/get_by_policy_name" tags: ["payment_policy"] --- # GET /payment_policy/get_by_policy_name `GET /payment_policy/get_by_policy_name` This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters.

Marketplaces and locales

Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy 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. ## Query parameters - `marketplace_id` string, required - `name` string, required ## Response `200` Success - PaymentPolicy — This type is used by the paymentPolicy response container, a container which defines a seller's payment business policy for a specific marketplace. - `categoryTypes` CategoryType[] — This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings. - `default` boolean — 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.

- `name` string — 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. For implementation help, refer to eBay API documentation - `deposit` Deposit — This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing. - `amount` Amount — A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both currency and value fields are required, and both fields are also always returned for an amount in a response field. - `currency` string — 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. For implementation help, refer to eBay API documentation - `value` string — The monetary amount in the specified currency. - `dueIn` TimeDuration — A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned. - `unit` string — 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. For implementation help, refer to eBay API documentation - `value` integer — An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. - `paymentMethods` 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. - `brands` string[] — 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. - `paymentMethodType` string — 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.

For implementation help, refer to eBay API documentation - `recipientAccountReference` RecipientAccountReference — Note: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. - `referenceId` string — 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. - `referenceType` string — 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. For implementation help, refer to eBay API documentation - `description` string — 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 - `fullPaymentDueIn` TimeDuration — A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned. - `unit` string — 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. For implementation help, refer to eBay API documentation - `value` integer — An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field. - `immediatePay` boolean — 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. - `marketplaceId` string — The ID of the eBay marketplace to which the payment business policy applies. For implementation help, refer to eBay API documentation - `name` string — A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64 - `paymentInstructions` string — 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 - `paymentMethods` 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. - `brands` string[] — 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. - `paymentMethodType` string — 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.