ePages 7.47.0 - DE_EPAGES/SIA/API/Object/PaymentMethodSIA.pm

Package DE_EPAGES::SIA::API::Object::PaymentMethodSIA

object interface for Payment.

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

Functions

canAddToBasket
existsCurrentRegistrationTransaction
featureName
getCancelRedirectURL
getConfig
getCurrentRegistrationTransaction
getRefundRedirectURL
getSaleRedirectURL
hasAcceptedCurrentTransaction
hasDeclinedCurrentTransaction
hasPendingCurrentTransaction
isInTestMode
provideRegistrationTransactionData
saveRegistrationTransaction
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

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

existsCurrentRegistrationTransaction

exists a registration transation for the paymentmethod

Syntax
$PaymentMethod->existsCurrentRegistrationTransaction;
Return
$Exists (boolean)
exists current registration transaction

featureName

Returns the feature name 'SIA'.

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

getCancelRedirectURL

returns the cancel redirect url for the payment

Syntax
$PaymentMethod->getCancelRedirectURL;
Return
$CancelWebserviceEndpointURL (string)
cancel rest url

getConfig

createa a new siaonfig object dependent from payment testmode

Syntax
$PaymentMethod->getConfig;
Return
$SiaConfig (object)
sia config

getCurrentRegistrationTransaction

gives back the current registration transaction which is used for the merchant registration

Syntax
$PaymentMethod->getCurrentRegistrationTransaction;
Return
$Transaction (object)
actual merchant registration transaction

getRefundRedirectURL

returns the refund redirect url for the payment

Syntax
$PaymentMethod->getRefundRedirectURL;
Return
$RefundWebserviceEndpointURL (string)
refund rest url

getSaleRedirectURL

returns the sale redirect url for the payment

Syntax
$PaymentMethod->getSaleRedirectURL;
Return
$SaleWebserviceEndpointURL (string)
sale redirect url

hasAcceptedCurrentTransaction

returns true if the current registration transaction is accepted

Syntax
$PaymentMethod->hasAcceptedCurrentTransaction;
Return
hasAcceptedCurrentTransaction (boolean)
has accepted current transaction

hasDeclinedCurrentTransaction

returns true if the current registration transaction is declined

Syntax
$PaymentMethod->hasDeclinedCurrentTransaction;
Return
hasDeclinedCurrentTransaction (boolean)
has declined current transaction

hasPendingCurrentTransaction

returns true if the current registration transaction is still pending

Syntax
$PaymentMethod->hasPendingCurrentTransaction;
Return
hasPendingCurrentTransaction (boolean)
has pending current transaction

isInTestMode

returns if payment is in test mode

Syntax
$PaymentMethod->isInTestMode;
Return
$isInTestMode (boolean)
ispayment in testmode

provideRegistrationTransactionData

provide the values which are needed for merchant registration

Syntax
$PaymentMethod->provideRegistrationTransactionData( $PaymentNetwork,
                                                    $MerchantID,
                                                    $TerminalNumber,
                                                    $MerchantTaxID);
example       $PaymentMethod->provideRegistrationTransactionData('Adyen','123123123123123','12312312','9486948');
Input
$PaymentNetwork (Int)
payment network which was entered by merchant
$MerchantID (String)
merchant id which was entered by merchant
$TerminalNumber (String)
terminal number id which was entered by merchant
$MerchantTaxID (String)
merchant tax id which was entered by merchant
Return
$hRegistrationTransaction (hash.ref)
dynamic values for emrchant registration

saveRegistrationTransaction

saves a new registration transaction on payment and sets it as current transaction

Syntax
$PaymentMethod->saveRegistrationTransaction;
Input
$hRegistrationTransaction (ref.hash)
registration transaction
Return
$RegistrationTransaction (object)
registration transaction

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