eBay Payment_policy API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Payment_policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
6 operations
across 3 paths,
and defines 12 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
6 operations3 paths12 schemas1 DELETE3 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
eBay Payment_policy API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Payment_policy 6
GET
/payment_policy
This method retrieves all the payment policies configured for the marketplace you specify using the marketplaceid query parameter. Marketplaces and locales Get the correct policies for a marketplace…
getPaymentPolicies1 param→ 200400500
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 multip…
createPaymentPolicy1 parambody→ 201400500
GET
/payment_policy/{payment_policy_id}
This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.
getPaymentPolicy1 param→ 200400404500
PUT
/payment_policy/{payment_policy_id}
This method updates an existing payment policy. Specify the policy you want to update using the paymentpolicyid path parameter. Supply a complete policy payload with the updates you want to make; thi…
updatePaymentPolicy2 paramsbody→ 200400404500
DELETE
/payment_policy/{payment_policy_id}
This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter.
deletePaymentPolicy1 param→ 204400404409500
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 marketplaceid in the request query parameters. Marketplaces and locales Get the correct…
getPaymentPolicyByName2 params→ 200400500
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SetPaymentPolicyResponse (11 properties), PaymentPolicy (10 properties), PaymentPolicyRequest (9 properties), Error (9 properties). Each schema is shown below with its type and property counts.
RecipientAccountReference
object
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 e…
2 properties
SetPaymentPolicyResponse
object
Complex type that that gets populated with a response containing a payment policy.
11 properties
ErrorParameter
object
A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error.
2 properties
Deposit
object
This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing.
3 properties
PaymentPolicyRequest
object
This root container defines a seller's payment business policy for a specific marketplace and category group. This type is used when creating or updating a pay…
9 properties
Amount
object
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…
2 properties
PaymentPolicy
object
This type is used by the paymentPolicy response container, a container which defines a seller's payment business policy for a specific marketplace.
10 properties
PaymentMethod
object
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 ele…
3 properties
Error
object
A container that defines the elements of error and warning messages.
9 properties
TimeDuration
object
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 specif…
2 properties
CategoryType
object
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…
2 properties
PaymentPolicyResponse
object
The response payload for the getPaymentPolicies method. Note : Pagination has not yet been enabled for getPaymentPolicies , so all of the pagination-related fi…
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
