ePages 7.37.0 - DE_EPAGES/PayPalPlus/API/Object/PaymentMethodPayPalPlus.pm

Package DE_EPAGES::PayPalPlus::API::Object::PaymentMethodPayPalPlus

Object interface for the PayPalPlus PaymentMethod.

Base
DE_EPAGES::Order::API::Object::ContainerPaymentMethod

Functions

areMandatoryFieldsSet
canAddToBasket
featureName
getMerchantClientId
getOnboardingUrl
getPartnerAccountId
getPartnerClientId
getPartnerClientSecret
getPayPalPartnerAttributionId
getTrackingId
isInTestMode
isMerchantAddressSet
usableAtStorefront

areMandatoryFieldsSet

Determines if all necessary address fields are set as mandatory.

Syntax
$AreMandatoryFieldsSet = $PaymentMethod->areMandatoryFieldsSet();
Return
(boolean)
True if all necessary fields are set as mandatory,
otherwise False is returned.

canAddToBasket

Tests if a payment method can be added to the basket with the given currency. Overrides function DE_EPAGES::Order::API::Object::ContainerPaymentMethod::canAddToBasket Valid currencies are: EUR, GBP

Syntax
if ($PaymentMethod->canAddToBasket($hVars)) {...
Input
$hVars (ref.hash)
  • CurrencyID - alpha currency code (ISO 4217) - char(3)
  • TaxModel - gross or net price - int
Return
(boolean)
true if payment method can be used for the given currency

featureName

Returns the feature name 'PayPalPlus'.

Syntax
$FeatureName = $PaymentMethod->featureName;
Return
$FeatureName (String)
feature name (undef means no feature count)

getMerchantClientId

Gets the merchant client id that allows us to authorize our calls against the PayPal API of the merchants paypal account.

Syntax
getMerchantClientId();
Return
string

getOnboardingUrl

Gets the onboarding url of the shop that is needed for the oauth authentication with PayPal. In case the passed shop is a marked as 'internal-test-shop' sandbox urls is returned; otherwise live url will be returned.

Syntax
getOnboardingUrl();
Return
string

getPartnerAccountId

Gets the partner account id of the shop that is needed for the oauth authentication with PayPal. In case the passed shop is a marked as 'internal-test-shop' sandbox credentials are returned; otherwise live credentials will be returned.

Syntax
getPartnerAccountId();
Return
string

getPartnerClientId

Gets the partner client id of the shop that is needed for the oauth authentication with PayPal. In case the passed shop is a marked as 'internal-test-shop' sandbox credentials are returned; otherwise live credentials will be returned.

Syntax
getPartnerClientId();
Return
string

getPartnerClientSecret

Gets the partner client secret of the shop that is needed for the oauth authentication with PayPal. In case the passed shop is a marked as 'internal-test-shop' sandbox credentials are returned; otherwise live credentials will be returned.

Syntax
getPartnerClientSecret();
Return
string

getPayPalPartnerAttributionId

Gets the partner attribution id that is used to track transactions for our revenue share with PayPal.

Syntax
getPayPalPartnerAttributionId();
Return
string

getTrackingId

Gets the tracking id of the shop that is needed for the oauth authentication with PayPal. We use the GUID of a shop for the oauth tracking.

Syntax
getTrackingId();
Return
string

isInTestMode

Determines if the payment method is used in test or live mode.

Syntax
isInTestMode();
Return
1 if payment methods uses sandbox; 0 otherwise.

isMerchantAddressSet

Determines if all necessary fields of the shop address contain a valid value.

Syntax
$IsMerchantAddressSet = $PaymentMethod->isMerchantAddressSet();
Return
(boolean)
True if the address information is set,
otherwise False is returned.

usableAtStorefront

Tests if a payment method is visible in the storefront. Overrides function DE_EPAGES::Payment::API::Object::PaymentMethod::usableAtStorefront to evaluate if payment method is configured

Syntax
$Usable = $PaymentMethod->usableAtStorefront($hVars);
Input
$hVars (ref.hash)
  • CurrencyID - alpha currency code (ISO 4217) - char(3)
  • TaxModel - gross or net price - int
Return
(boolean)
true if payment method is usable in the storefront