POST /payment_policy

This method creates a new payment policy where the policy encapsulates seller's terms for order payments.

Each policy targets a specific eBay marketplace and category group, and you can create multiple policies for each combination.

A successful request returns the getPaymentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

Servers

https://api.ebay.com{basePath}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`immediatePay`	Boolean	No	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
`name`	String	No	A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64
`paymentInstructions`	String	No	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.
`deposit`	Object	No	This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing.
`deposit.amount`	Object	No	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.
`deposit.amount.value`	String	No	The monetary amount in the specified currency.
`deposit.amount.currency`	String	No	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
`deposit.dueIn`	Object	No	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.
`deposit.dueIn.value`	Integer	No	An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.
`deposit.dueIn.unit`	String	No	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
`deposit.paymentMethods[]`	Array	No	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.
`deposit.paymentMethods[].paymentMethodType`	String	No	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
`deposit.paymentMethods[].recipientAccountReference`	Object	No	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.
`deposit.paymentMethods[].recipientAccountReference.referenceId`	String	No	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.
`deposit.paymentMethods[].recipientAccountReference.referenceType`	String	No	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
`deposit.paymentMethods[].brands[]`	Array	No	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.
`description`	String	No	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`	Object	No	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.
`fullPaymentDueIn.value`	Integer	No	An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.
`fullPaymentDueIn.unit`	String	No	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
`categoryTypes[]`	Array	No	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.
`categoryTypes[].name`	String	No	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
`categoryTypes[].default`	Boolean	No	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.
`paymentMethods[]`	Array	No	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.
`paymentMethods[].paymentMethodType`	String	No	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
`paymentMethods[].recipientAccountReference`	Object	No	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.
`paymentMethods[].recipientAccountReference.referenceId`	String	No	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.
`paymentMethods[].recipientAccountReference.referenceType`	String	No	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
`paymentMethods[].brands[]`	Array	No	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.
`marketplaceId`	String	No	The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.