SapientPro\EbayAccountSDK\Api\PaymentPolicyApi

All URIs are relative to https://api.ebay.com/sell/account/v1

Method	HTTP request	Description
createPaymentPolicy	POST /payment_policy
deletePaymentPolicy	DELETE /payment_policy/{payment_policy_id}
getPaymentPolicies	GET /payment_policy
getPaymentPolicy	GET /payment_policy/{payment_policy_id}
getPaymentPolicyByName	GET /payment_policy/get_by_policy_name
updatePaymentPolicy	PUT /payment_policy/{payment_policy_id}

createPaymentPolicy

SetPaymentPolicyResponse createPaymentPolicy(PaymentPolicyRequest $body): SetPaymentPolicyResponse

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. <p class="tablenote">Tip: For details on creating and using the business policies supported by the Account API, see <a href="/api-docs/sell/static/seller-accounts/business-policies.html">eBay business policies.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\PaymentPolicyApi;
use SapientPro\EbayAccountSDK\Models\PaymentPolicyRequest;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PaymentPolicyApi(
    config: $config
);
$body = PaymentPolicyRequest::fromArray([
'categoryTypes' => [
    CategoryType::fromArray([
        'name' => CategoryTypeEnum::ALL_EXCLUDING_MOTORS_VEHICLES,
        'default' => true
    ])
],
'name' => $paymentPolicyName,
'description' => 'Standard payment policy, PP & CC payments',
'marketplaceId' => MarketplaceIdEnum::EBAY_US,
'immediatePay' => false,
'paymentMethods' => [
    PaymentMethod::fromArray([
        'paymentMethodType' => PaymentMethodTypeEnum::PAYPAL,
        'recipientAccountReference' => RecipientAccountReference::fromArray([
            'referenceId' => 'l*****e@p*****m',
            'referenceType' => RecipientAccountReferenceTypeEnum::PAYPAL_EMAIL
        ])
    ]),
    PaymentMethod::fromArray([
        'paymentMethodType' => PaymentMethodTypeEnum::CREDIT_CARD,
        'brands' => [
            PaymentInstrumentBrandEnum::AMERICAN_EXPRESS,
            PaymentInstrumentBrandEnum::DISCOVER,
            PaymentInstrumentBrandEnum::MASTERCARD,
            PaymentInstrumentBrandEnum::VISA
        ]
    ])
]
]);

try {
    $result = $apiInstance->createPaymentPolicy($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentPolicyApi->createPaymentPolicy: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SapientPro\EbayAccountSDK\Models\PaymentPolicyRequest	Payment policy request

Return type

\SapientPro\EbayAccountSDK\Models\SetPaymentPolicyResponse

Authorization

api_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePaymentPolicy

deletePaymentPolicy($paymentPolicyId): void

This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\PaymentPolicyApi;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PaymentPolicyApi(
    config: $config
);
$paymentPolicyId = "payment_policy_id_example"; // string | This path parameter specifies the ID of the payment policy you want to delete.

try {
    $apiInstance->deletePaymentPolicy($paymentPolicyId);
} catch (Exception $e) {
    echo 'Exception when calling PaymentPolicyApi->deletePaymentPolicy: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
paymentPolicyId	string	This path parameter specifies the ID of the payment policy you want to delete.

Return type

void (empty response body)

Authorization

api_auth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPaymentPolicies

getPaymentPolicies(MarketplaceIdEnum $marketplaceId): PaymentPolicyResponse

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 the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\PaymentPolicyApi;
use SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PaymentPolicyApi(
    config: $config
);

try {
    $result = $apiInstance->getPaymentPolicies(MarketplaceIdEnum::EBAY_US);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentPolicyApi->getPaymentPolicies: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
marketplaceId	\SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum	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

Return type

\SapientPro\EbayAccountSDK\Models\PaymentPolicyResponse

Authorization

api_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPaymentPolicy

getPaymentPolicy(string $paymentPolicyId): PaymentPolicy

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.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\PaymentPolicyApi;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = PaymentPolicyApi(
    config: $config
);
$paymentPolicyId = "payment_policy_id_example"; // string | This path parameter specifies the ID of the payment policy you want to retrieve.

try {
    $result = $apiInstance->getPaymentPolicy($paymentPolicyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentPolicyApi->getPaymentPolicy: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
paymentPolicyId	string	This path parameter specifies the ID of the payment policy you want to retrieve.

Return type

\SapientPro\EbayAccountSDK\Models\PaymentPolicy

Authorization

api_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPaymentPolicyByName

getPaymentPolicyByName(MarketplaceIdEnum $marketplaceId, string $name): PaymentPolicy

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 <a href="/api-docs/static/rest-request-components.html#HTTP">HTTP request headers.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\PaymentPolicyApi;
use SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new PaymentPolicyApi(
    config: $config
);
$name = "name_example"; // string | This query parameter specifies the seller-defined name of the payment policy you want to retrieve.

try {
    $result = $apiInstance->getPaymentPolicyByName(MarketplaceIdEnum::EBAY_US, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentPolicyApi->getPaymentPolicyByName: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
marketplaceId	\SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum	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	string	This query parameter specifies the seller-defined name of the payment policy you want to retrieve.

Return type

\SapientPro\EbayAccountSDK\Models\PaymentPolicy

Authorization

api_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePaymentPolicy

updatePaymentPolicy(PaymentPolicyRequest $body, string $paymentPolicyId): SetPaymentPolicyResponse

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.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\PaymentPolicyApi;
use SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum;
use SapientPro\EbayAccountSDK\Models\PaymentPolicyRequest;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new EBay\Account\Api\PaymentPolicyApi(
    config: $config
);
$body = new PaymentPolicyRequest::fromArray([
'categoryTypes' => [
CategoryType::fromArray([
        'name' => CategoryTypeEnum::ALL_EXCLUDING_MOTORS_VEHICLES,
        'default' => true
    ])
],
'name' => 'paym',
'description' => 'Standard payment policy, PP & CC payments',
'marketplaceId' => MarketplaceIdEnum::EBAY_US,
'immediatePay' => false,
'paymentMethods' => [
    PaymentMethod::fromArray([
        'paymentMethodType' => PaymentMethodTypeEnum::PAYPAL,
        'recipientAccountReference' => RecipientAccountReference::fromArray([
            'referenceId' => 'l*****e@p*****m',
            'referenceType' => RecipientAccountReferenceTypeEnum::PAYPAL_EMAIL
        ])
    ]),
    PaymentMethod::fromArray([
        'paymentMethodType' => PaymentMethodTypeEnum::CREDIT_CARD,
        'brands' => [
            PaymentInstrumentBrandEnum::AMERICAN_EXPRESS,
            PaymentInstrumentBrandEnum::DISCOVER,
            PaymentInstrumentBrandEnum::MASTERCARD,
            PaymentInstrumentBrandEnum::VISA
        ]
    ])
],
];
]);
$paymentPolicyId = "payment_policy_id_example";

try {
    $result = $apiInstance->updatePaymentPolicy($body, $paymentPolicyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentPolicyApi->updatePaymentPolicy: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SapientPro\EbayAccountSDK\Models\PaymentPolicyRequest	Payment policy request
paymentPolicyId	string	This path parameter specifies the ID of the payment policy you want to update.

Return type

\SapientPro\EbayAccountSDK\Models\SetPaymentPolicyResponse

Authorization

api_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PaymentPolicyApi.md

Latest commit

History

PaymentPolicyApi.md

File metadata and controls

SapientPro\EbayAccountSDK\Api\PaymentPolicyApi

createPaymentPolicy

Example

Parameters

Return type

Authorization

HTTP request headers

deletePaymentPolicy

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentPolicies

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentPolicy

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentPolicyByName

Example

Parameters

Return type

Authorization

HTTP request headers

updatePaymentPolicy

Example

Parameters

Return type

Authorization

HTTP request headers