{
"opencollection": "1.0.0",
"info": {
"name": "eBay Account Advertising_eligibility Payment_policy API",
"version": "v1.9.2"
},
"items": [
{
"info": {
"name": "Payment_policy",
"type": "folder"
},
"items": [
{
"info": {
"name": "getPaymentPolicies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/payment_policy",
"params": [
{
"name": "marketplace_id",
"value": "",
"type": "query",
"description": "This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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"
},
{
"info": {
"name": "createPaymentPolicy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.ebay.com{basePath}/payment_policy",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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 us"
},
{
"info": {
"name": "getPaymentPolicy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/payment_policy/:payment_policy_id",
"params": [
{
"name": "payment_policy_id",
"value": "",
"type": "path",
"description": "This path parameter specifies the ID of the payment policy you want to retrieve.
This ID can be retrieved for a payment policy by using the getPaymentPolices method."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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."
},
{
"info": {
"name": "updatePaymentPolicy",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.ebay.com{basePath}/payment_policy/:payment_policy_id",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"params": [
{
"name": "payment_policy_id",
"value": "",
"type": "path",
"description": "This path parameter specifies the ID of the payment policy you want to update.
This ID can be retrieved for a payment policy by using the getPaymentPolices method."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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."
},
{
"info": {
"name": "deletePaymentPolicy",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.ebay.com{basePath}/payment_policy/:payment_policy_id",
"params": [
{
"name": "payment_policy_id",
"value": "",
"type": "path",
"description": "This path parameter specifies the unique identifier of the payment policy you want to delete.
This ID can be retrieved for a payment policy by using the getPaymentPolices method."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. "
},
{
"info": {
"name": "getPaymentPolicyByName",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/payment_policy/get_by_policy_name",
"params": [
{
"name": "marketplace_id",
"value": "",
"type": "query",
"description": "This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "This query parameter specifies the seller-defined name of the payment policy you want to retrieve.
This value can be retrieved for a payment policy by using the getPaymentPolicies method."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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-Langu"
}
]
}
],
"bundled": true
}