ePages 7.21.0 - DE_EPAGES/Ipayment/API/Database/BasketOrOrder.pm

Package package

Database Wrapper for BasketOrOrder Object

Package DE_EPAGES::Ipayment::API::Database::BasketOrOrder

Functions

LoadRootObject
extractFromBasketOrOrder
getAccountID
getAdminActionPassword
getBillingAddress
getCancelRedirectUrl
getCurrencyID
getEpagesVersion
getGUID
getGrandTotal
getGrandTotalInMinorUnits
getHiddenTriggerUrl
getIsTestTransaction
getLanguageID
getLineItemContainer
getLineItemPaymentIpayment
getPartnerId
getPaymentType
getPaymentTypeName
getPreAuthTimePeriodInSeconds
getRedirectUrl
getSelectedTransactionType
getSessionID
getShop
getSilentErrorUrl
getTransID
getTransStatus
getTransTime
getTransactionType
getUserID
getUserPassword
isInTestMode
new

LoadRootObject

Wrapper for core bindings

Syntax
$Object = LoadRootObject();
Return
(object)
root object

extractFromBasketOrOrder

Extracts the attribute values from the BasketOrOrder object

Syntax
extractFromBasketOrOrder( $BasketOrOrder );
Input
$BasketOrOrder (Object)
BasketOrOrder
Return
$WasSuccessful (boolean)
Status

getAccountID

Returns AccountID

Syntax
getAccountID( );
Return
$AccountID (String)
AccountID

getAdminActionPassword

Returns AdminActionPassword

Syntax
getAdminActionPassword( );
Return
$AdminActionPassword (String)
AdminActionPassword

getBillingAddress

get the Billing address of the BasketOrOrder

Syntax
getBillingAddress( );
Return
$BillingAdress (DE_EPAGES::Address::API::Object::Address)
BillingAdress

getCancelRedirectUrl

Gets 'Cancel' redirect URL (backlink).

Syntax
getCancelRedirectUrl( );
Return
$CancelRedirectUrl (String)
Cancel redirect URL

getCurrencyID

Returns CurrencyID

Syntax
getCurrencyID( );
Return
$CurrencyID (String)
CurrencyID

getEpagesVersion

Returns the installed ePages version

Syntax
getEpagesVersion( );
Return
(String)
ePages Version

getGUID

get the GUID of LineItemPaymentIPayment

Syntax
getGUID( );
Return
$GUID (String)
GUID of LineItemPaymentIPayment

getGrandTotal

Returns GrandTotal

Syntax
getGrandTotal( );
Return
$GrandTotal (float)
GrandTotal

getGrandTotalInMinorUnits

Returns the total amount of the order in the minor unit e.g. in Cents instead of EUR

Syntax
getGrandTotalInMinorUnits( );
Return
(integer)
Total Order amount in the minor unit

getHiddenTriggerUrl

get the hidden trigger Url

Syntax
getHiddenTriggerUrl( );
Return
$RedirectUrl (String)
get hidden trigger Url

getIsTestTransaction

Returns IsTestTransaction

Syntax
getIsTestTransaction( );
Return
$IsTestTransaction (boolean)
IsTestTransaction

getLanguageID

Returns the LanguageID of the language used in the order

Syntax
getLanguageID( );
Return
(integer)
LanguageID of the order

getLineItemContainer

Returns the LineItemContainer of the order

Syntax
getLineItemContainer( );
Return
(LineItemContainer)
The LineItemContainer of the order

getLineItemPaymentIpayment

Returns LineItemPaymentIpayment

Syntax
getLineItemPaymentIpayment( );
Return
$LineItemPaymentIpayment (DE_EPAGES::Ipayment::API::Object::LineItemPaymentIpayment)
LineItemPaymentIpayment

getPartnerId

Returns the ipayment partner ID of ePages

Syntax
getPartnerId( );
Return
(String)
partner ID

getPaymentType

Returns PaymentType

Syntax
getPaymentType( );
Return
$PaymentType (String)
PaymentType

getPaymentTypeName

Returns PaymentType Name (Name of Credit Card)

Syntax
getPaymentTypeName( );
Return
(String)
PaymentTypeName

getPreAuthTimePeriodInSeconds

Returns PreAuthTimePeriod in seconds

Syntax
getPreAuthTimePeriodInSeconds( );
Return
$PreAuthTimePeriod (Interger)
pre auth time period in seconds

getRedirectUrl

get the redirect URL

Syntax
getRedirectUrl( );
Return
$RedirectUrl (String)
redirect URL

getSelectedTransactionType

Returns the Selected Transaction Type

Syntax
getSelectedTransactionType( );
Return
(String)
$SelectedTransactionType

getSessionID

Returns the SessionID

Syntax
getSessionID( );
Return
(String)
SessionID

getShop

Returns the Shop object of the order

Syntax
getShop( );
Return
$Shop (Shop)
Shop object

getSilentErrorUrl

get the silent error Url

Syntax
getSilentErrorUrl( );
Return
$RedirectUrl (String)
silent error Url

getTransID

get the TransID of LineItemPaymentIPayment

Syntax
getTransID( );
Return
$TransID (String)
TransID of LineItemPaymentIPayment

getTransStatus

get the TransStatus of LineItemPaymentIPayment

Syntax
getTransStatus( );
Return
$TransStatus (String)
TransStatus of LineItemPaymentIPayment

getTransTime

get the transaction time from line item payment

Syntax
getTransTime( );
Return
$TransTime (String)
transaction time from line item payment

getTransactionType

Returns TransactionType

Syntax
getTransactionType( );
Return
$TransactionType (String)
TransactionType

getUserID

Returns UserID

Syntax
getUserID( );
Return
$UserID (String)
UserID

getUserPassword

Returns UserPassword

Syntax
getUserPassword( );
Return
$UserPassword (String)
UserPassword

isInTestMode

Checks if the PaymentMethod is in test mode

Syntax
isInTestMode( );
Return
$IsInTestMode (Boolean)
Boolean for test mode

new

Constructor

Syntax
new( );
Return
$self (DE_EPAGES::Ipayment::API::Database::BasketOrOrder)
self