ePages 6.17.40 - DE_EPAGES/DocdataPay/API/Object/RemoteDocdataPay.pm

Package DE_EPAGES::DocdataPay::API::Object::RemoteDocdataPay

Docdata communication API

Functions

MerchantName
MerchantPassword
PaymentProfile
ServiceURL
createLogger
factory
new
newPaymentCluster
paymentClusterID
paymentClusterKey
runWithLogger
setLogger
statusPaymentCluster
unparsedResponse

MerchantName

getter/setter for 'MerchantName'

Syntax
my $MerchantName = $Object->MerchantName;
$Object->MerchantName('value');
Input
$MerchantName (any)
value of MerchantName
Return
$MerchantName (any)
value of MerchantName

MerchantPassword

getter/setter for 'MerchantPassword'

Syntax
my $MerchantPassword = $Object->MerchantPassword;
$Object->MerchantPassword('value');
Input
$MerchantPassword (any)
value of MerchantPassword
Return
$MerchantPassword (any)
value of MerchantPassword

PaymentProfile

getter/setter for 'PaymentProfile'

Syntax
my $PaymentProfile = $Object->PaymentProfile;
$Object->PaymentProfile('value');
Input
$PaymentProfile (any)
value of PaymentProfile
Return
$PaymentProfile (any)
value of PaymentProfile

ServiceURL

getter/setter for 'ServiceURL'

Syntax
my $ServiceURL = $Object->ServiceURL;
$Object->ServiceURL('value');
Input
$ServiceURL (any)
value of ServiceURL
Return
$ServiceURL (any)
value of ServiceURL

createLogger

This function get the id, GUID and object path from the line item payment and store it into a hash

Syntax
Function( $LineItemPayment );
Input
$LineItemPayment (object)
line item payment object
Return
$returnHasch (refhash)
retuns values an error message or an empty hash

factory

Factory of RemoteDocdataPay

Syntax
factory( $LineItemPayment );
Example
$Object = DE_EPAGES::DocdataPay::API::Object::RemoteDocdataPay::factory( $LinteItemPayment );
Input
$LineItemPayment (object)
lineitempayment
Return
$self (object)
factored RemoteDocdataPay

new

New Docdata Payments Service Controller

Syntax
$RemoteObj = DE_EPAGES::DocdataPay::RemoteDocdataPay->new( %Options );
Example
DE_EPAGES::DocdataPay::RemoteDocdataPay->new(
           'ServiceURL' => '{Docdata_ServiceURL}',
           'IsLogging'  => 1 );
Input
%Options (hash
possible keys are:
  • ServiceURL - Service URL
  • IsLogging - Logging enabled/disa bled
  • )
    options
    Return
    $Remote (object)
    new object

    newPaymentCluster

    create new Docdata Payment Cluster

    Syntax
    $Object->newPaymentCluster( $hOptions );
    Example
    ${ReturnVariable} = $Object->newPaymentCluster( $hOptions );
    Input
    $hOptions (ref.hash)
    POST parameters
    Return
    none

    paymentClusterID

    getter/setter for 'paymentClusterID'

    Syntax
    my $paymentClusterID = $Object->paymentClusterID;
    $Object->paymentClusterID('value');
    Input
    $paymentClusterID (any)
    value of paymentClusterID
    Return
    $paymentClusterID (any)
    value of paymentClusterID

    paymentClusterKey

    getter/setter for 'paymentClusterKey'

    Syntax
    my $paymentClusterKey = $Object->paymentClusterKey;
    $Object->paymentClusterKey('value');
    Input
    $paymentClusterKey (any)
    value of paymentClusterKey
    Return
    $paymentClusterKey (any)
    value of paymentClusterKey

    runWithLogger

    Encapsulate the function which is hand over, to ensure that the needed logging data is also available if the call is not in the right context.

    Syntax
    runWithLogger( $LineItemPayment ,$sub );
    Input
    $LineItemPayment (object)
    line item payment object
    $sub (pointer)
    is a pointer to a function which should encapsulated

    setLogger

    set or unset the incoming hash to the class context

    Syntax
    setLogger( $loggingHash );
    Input
    $loggingHash (ref_hash)
    it is a hash which includes the id, GUID and path from a line item payment

    statusPaymentCluster

    create new Docdata Payment Cluster

    Syntax
    $Object->statusPaymentCluster( $hOptions );
    Example
    ${ReturnVariable} = $Object->statusPaymentCluster( $hOptions );
    Input
    $hOptions (ref.hash)
    POST parameters
    $GUID (GUID)
    LineItem GUID
    Return
    none

    unparsedResponse

    getter/setter for 'unparsedResponse'

    Syntax
    my $unparsedResponse = $Object->unparsedResponse;
    $Object->unparsedResponse('value');
    Input
    $unparsedResponse (any)
    value of unparsedResponse
    Return
    $unparsedResponse (any)
    value of unparsedResponse