action ebay_update_payment_policy {
label: "updatePaymentPolicy"
description: "This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload."
provider: ebay
method: PUT
path: "/payment_policy/{payment_policy_id}"
encoding: json
input: {
type: "object"
properties: {
categoryTypes: {
type: "array"
description: "This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings."
items: {
type: "object"
description: "The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings.
Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings."
properties: {
default: {
type: "boolean"
description: "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: {
type: "string"
description: "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: {
type: "object"
description: "This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing."
properties: {
amount: {
type: "object"
description: "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."
properties: {
currency: {
type: "string"
description: "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: {
type: "string"
description: "The monetary amount in the specified currency."
}
}
}
dueIn: {
type: "object"
description: "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."
properties: {
unit: {
type: "string"
description: "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: {
type: "integer"
format: "int32"
description: "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field."
}
}
}
paymentMethods: {
type: "array"
description: "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."
items: {
type: "object"
description: "This type is used by the paymentMethods container, which is used by the seller to specify one or more offline payment methods.
Note: eBay now controls all electronic payment methods available for a marketplace, so a seller will no longer use this type to specify any electronic payment methods."
properties: {
brands: {
type: "array"
description: "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. "
items: {
type: "string"
description: " For implementation help, refer to eBay API documentation"
}
}
paymentMethodType: {
type: "string"
description: "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: {
type: "object"
description: "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."
properties: {
referenceId: {
type: "string"
description: "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: {
type: "string"
description: "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: {
type: "string"
description: "A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages.
Max length: 250"
}
fullPaymentDueIn: {
type: "object"
additionalProperties: true
}
immediatePay: {
type: "boolean"
description: "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
Default: False"
}
marketplaceId: {
type: "string"
description: "The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation"
}
name: {
type: "string"
description: "A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.
Max length: 64"
}
paymentInstructions: {
type: "string"
description: "Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.
A free-form string field that allows sellers to add detailed payment instructions to their listings."
}
paymentMethods: {
type: "array"
description: "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 array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform."
items: {
type: "object"
additionalProperties: true
}
}
payment_policy_id: {
type: "string"
}
}
required: ["payment_policy_id"]
additionalProperties: false
}
output: {
type: "object"
description: "A complex type that is populated with a response containing a payment policy."
properties: {
categoryTypes: {
type: "array"
description: "This container indicates whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings."
items: {
type: "object"
description: "The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings.
Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings."
properties: {
default: {
type: "boolean"
description: "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: {
type: "string"
description: "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: {
type: "object"
description: "This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing."
properties: {
amount: {
type: "object"
description: "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."
properties: {
currency: {
type: "string"
description: "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: {
type: "string"
description: "The monetary amount in the specified currency."
}
}
}
dueIn: {
type: "object"
description: "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."
properties: {
unit: {
type: "string"
description: "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: {
type: "integer"
format: "int32"
description: "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field."
}
}
}
paymentMethods: {
type: "array"
description: "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."
items: {
type: "object"
description: "This type is used by the paymentMethods container, which is used by the seller to specify one or more offline payment methods.
Note: eBay now controls all electronic payment methods available for a marketplace, so a seller will no longer use this type to specify any electronic payment methods."
properties: {
brands: {
type: "array"
description: "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. "
items: {
type: "string"
description: " For implementation help, refer to eBay API documentation"
}
}
paymentMethodType: {
type: "string"
description: "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: {
type: "object"
description: "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."
properties: {
referenceId: {
type: "string"
description: "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: {
type: "string"
description: "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: {
type: "string"
description: "A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy.
Max length: 250"
}
fullPaymentDueIn: {
type: "object"
additionalProperties: true
}
immediatePay: {
type: "boolean"
description: "The value returned in this field will reflect the value set by the seller in the immediatePay request field. A value of true indicates that immediate payment is required 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
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: {
type: "string"
description: "The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation"
}
name: {
type: "string"
description: "A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.
Max length: 64"
}
paymentInstructions: {
type: "string"
description: "Note: NO LONGER SUPPORTED. 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.
A free-form string field that allows sellers to add detailed payment instructions to their listings."
}
paymentMethods: {
type: "array"
description: "This array shows the available payment methods that the seller has set 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."
items: {
type: "object"
additionalProperties: true
}
}
paymentPolicyId: {
type: "string"
description: "A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created."
}
warnings: {
type: "array"
description: "An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty."
items: {
type: "object"
description: "A container that defines the elements of error and warning messages."
properties: {
category: {
type: "string"
description: "The category type for this error or warning. It is a string that can have one of three values:Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as \"Seller does not ship item to Antarctica\" or \"Buyer ineligible to purchase an alcoholic item\". Business errors are not syntactical input errors.Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.
"
}
domain: {
type: "string"
description: "Name of the domain ,or primary system, of the service or application where the error occurred."
}
errorId: {
type: "integer"
format: "int32"
description: "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms."
}
inputRefIds: {
type: "array"
description: "Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation."
items: {
type: "string"
}
}
longMessage: {
type: "string"
description: "A more detailed explanation of the error than given in the message error field."
}
message: {
type: "string"
description: "Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale."
}
outputRefIds: {
type: "array"
description: "Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId."
items: {
type: "string"
}
}
parameters: {
type: "array"
description: "This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value."
items: {
type: "object"
description: "A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error."
properties: {
name: {
type: "string"
description: "Name of the parameter that caused the error."
}
value: {
type: "string"
description: "The value of the parameter that caused the error."
}
}
}
}
subdomain: {
type: "string"
description: "If present, indicates the subsystem in which the error occurred."
}
}
}
}
}
}
}