ePages 7.25.0 - DE_EPAGES/Spreedly/API/Object/PaymentMethodSpreedly.pm

Package DE_EPAGES::Spreedly::API::Object::PaymentMethodSpreedly

object interface for Payment.

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

Functions

canAddToBasket
className
createNewPaymentMethodName
dbPackage
getGatewayCredentials
saveGatewayCredentials
setInShopNameLikePaymentTypeMethod
setPaymentMethodNameLikePaymentTypeMethod
uploadPaymentTypeMethodLogo
usableAtStorefront

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, USD

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

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $PaymentMethodSpreedly->className;
Return
$ClassName (String)
class name

createNewPaymentMethodName

it returns a not repeated payment method name based on increasing a counter if basename already exists

Syntax
$NewPaymentMethodName = $self->createNewPaymentMethodName($PaymentMethods, $BaseName);
Input
$PaymentMethods (ref.array)
array of payment method objects
$BaseName (string)
base name
Return
$NewPaymentMethodName (string)
resulting payment method name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $PaymentMethodSpreedly->dbPackage;
Return
$DbPackage (String)
database package name

getGatewayCredentials

It recovers from epagesj gateway credentials.

Syntax
$hCredentials = $self->getGatewayCredentials( $Shop );
Input
$Servlet (DE_EPAGES::Presentation::Servlet::BasePermission)
Servlet
Return
$hCredentials (hash ref.)
hash with gateway credentials

saveGatewayCredentials

It stores new gateway credentials.

Syntax
$self->saveGatewayCredentials( $Servlet );
Input
$Servlet (DE_EPAGES::Presentation::Servlet::BasePermission)
Servlet

setInShopNameLikePaymentTypeMethod

It renames in shop name to set payment type method name.

Syntax
$self->setInShopNameLikePaymentTypeMethod( $PaymentTypeMethodToMirror );
Input
$PaymentTypeMethodToMirror (object)
payment type method object

setPaymentMethodNameLikePaymentTypeMethod

It renames Payment method name (shown in MBO and checkout).

Syntax
$self->setPaymentMethodNameLikePaymentTypeMethod( $PaymentTypeMethodToMirror, $LanguageID );
Input
$PaymentTypeMethodToMirror (object)
Payment type method object to mirror names
$LanguageID (int)
language id

uploadPaymentTypeMethodLogo

It uploads payment type method logo for the payment method.

Syntax
$self->uploadPaymentTypeMethodLogo( $PaymentTypeMethod );
Input
$PaymentTypeMethod (object)
Payment type method object

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
$Usable (boolean)
true if payment method is usable in the storefront