ePages 6.10 - DE_EPAGES/PayPalExpress/API/RemotePayPalExpress.pm

Package DE_EPAGES::PayPalExpress::API::RemotePayPalExpress

stub object for web service requests to PayPal Express

Functions

DESTROY
DoExpressCheckoutPayment
GetExpressCheckoutDetails
SetExpressCheckout
new
shop
version_req

DESTROY

destructor: cleans up the attributes when the object is destroyed

DoExpressCheckoutPayment

Implements PayPal's "Website Payment Pro" DoExpressCheckoutPayment API call. Required parameter are: Token, PayerID, OrderTotal Returns a hash containing pay information.

Syntax
$self->DoExpressCheckoutPayment ( %RequestValues );
Input
%RequestValues (hash)
Parameter as described in the PayPal "Web Services API Reference" document
Return
\%response (ref.hash)
with following keys:
  • Token
  • TransactionID
  • TransactionType
  • PaymentType
  • PaymentDate
  • GrossAmount
  • FeeAmount
  • SettleAmount
  • TaxAmount
  • ExchangeRate
  • PaymentStatus
  • PendingReason

GetExpressCheckoutDetails

Implements PayPal's "Website Payment Pro" SetExpressCheckout API call. Required parameter is: Token. This is the same token received from SetExpressCheckout. Returns a hash containing buyer details.

Syntax
$self->GetExpressCheckoutDetails ( $Token );
Input
$Token (string)
Token
Return
\%details (ref.hash)
with following keys:
  • Token
  • Custom
  • InvoiceID
  • ContactPhone
  • Payer
  • PayerID
  • PayerStatus
  • Salutation
  • FirstName
  • MiddleName
  • LastName
  • Suffix
  • PayerCountry
  • PayerBusiness
  • Name
  • Street1
  • Street2
  • CityName
  • StateOrProvince
  • PostalCode
  • Country

SetExpressCheckout

Implements PayPal's "Website Payment Pro" SetExpressCheckout API call. Required parameters are: OrderTotal, ReturnURL, CancelURL. Returns a hash containing a 'Token' key, whose value represents the PayPal transaction token.

Syntax
$self->SetExpressCheckout ( %RequestValues );
Input
%RequestValues (hash)
Parameter as described in the PayPal "Web Services API Reference" document
Return
\%response (ref.hash)
with following keys:
  • Token

new

Creates a RemotePayPalExpress object.

Syntax
my $RemotePayPalExpress = DE_EPAGES::PayPalExpress::API::RemotePayPalExpress->new(
    Username  => $Username,
    Password  => $Password,
    Signature => $Signature,
    Sandbox   => $Sandbox,
);
Input
$Username (boolean)
PayPal API Username | string
$Password | PayPal API Password) | string
$Signature | PayPal API Signature) | string
$Sandbox | Sandbox flag
Return
$RemotePayPalExpress (object
# this is an inside-out object. Make sure you 'delete' additional
# members in DESTROY() as you add them.)
remote PayPalExpress object

shop

Returns the shop object

Syntax
$shop = $self->shop;
Return
$shop (object)
shop object

version_req

Returns the SOAP data structure for request version

Syntax
$version = $self->version_req;
Return
$version (SOAP data entity)
request version