ePages 7.47.0 - DE_EPAGES/Paybox/API/GatewayInterface/PaymentGateway.pm

Package DE_EPAGES::Paybox::API::GatewayInterface::PaymentGateway

Abstract PaymentGateway class The class mainly publishes the contract for the subclasses

Functions

checkPaymentResponse
getConfigurator
getPayboxDirectURL
getPaymentRequestData
getPaymentRequestURL
initalize
new
processPaymentResponse

checkPaymentResponse

Process a payment backlink : browser redirect from Paybox service

Syntax
$PaymentGateway->checkPaymentResponse($hPaymentContext);
Input
$hPaymentContext (hash.ref)
The information needed to process the request
Return
$hResult (hash.ref)
the operation results

getConfigurator

Returns the PaymentGatewayConfigurator object linked to this Payment Gateway

Syntax
my $Configurator = $PaymentGateway->getConfigurator();
Return
$Configurator (object)
The $PaymentGatewayConfigurator

getPayboxDirectURL

Returns the PayboxDirect URL which can be used to perform PayboxDirect requests.

Syntax
my $PayboxDirectURL = $PaymentGateway->getPayboxDirectURL();
Return
$PayboxDirectURL (string)
PayboxDirect URL

getPaymentRequestData

Returns all the information needed to send to the GatewayPayment for a transaction

Syntax
$Data = $PaymentGateway->getPaymentRequestData($LineItemPayment);
Input
$LineItemPayment (object)
A LineItemPayment object to prepare the request data
Return
$RequestData (array.ref)
Array of N hashes containing a pair of items {Field, Value}, like:
[
{ 'Field' => 'FieldName_1', 'Value' => 'Value_1' },
{ 'Field' => 'FieldName_2', 'Value' => 'Value_2' },
...
]

getPaymentRequestURL

Returns the PaymentGateway URL to redirect the customer to start the payment process.

Syntax
my $RequestURL = $PaymentGateway->getPaymentRequestURL();
Return
$RedirectURL (string)
The GatewayPayment URL

initalize

Initialization of the PaymentGateway object

Syntax
$PaymentGateway->initalize($PaymentGatewayConfigurator);
Input
$Configurator (object)
A $PaymentGatewayConfigurator for this instance

new

Constructor. Should not be used. Use the PaymentGatewayFactory instead!

Syntax
new ($hOptions);
Input
$hOptions (hash.ref)
Hash with optional properties for the object
Return
$self (object)
A new PaymentGateway object

processPaymentResponse

Process a payment callback : direct call from Paybox service

Syntax
$PaymentGateway->processPaymentResponse($hPaymentContext);
Input
$hPaymentContext (hash.ref)
The information needed to process the request