NAME
WebService::PayPal::PaymentsAdvanced - A simple wrapper around the PayPal Payments Advanced web service
VERSION
version 0.000003
SYNOPSIS
use WebService::PayPal::PaymentsAdvanced;
my $payments = WebService::PayPal::PaymentsAdvanced->new(
{
password => 'seekrit',
user => 'username',
vendor => 'somevendor',
}
);
my $response = $payments->create_secure_token(
{
AMT => 100,
TRXTYPE => 'S',
VERBOSITY => 'HIGH',
BILLINGTYPE => 'MerchantInitiatedBilling',
CANCELURL => 'https://example.com/cancel',
ERRORURL => 'https://example.com/error',
L_BILLINGTYPE0 => 'MerchantInitiatedBilling',
NAME => 'Chuck Norris',
RETURNURL => 'https://example.com/return',
}
);
my $uri = $payments->hosted_form_uri( $response );
# Store token data for later use. You'll need to implement this yourself.
$foo->freeze_token_data(
token => $response->secure_token,
token_id => $response->secure_token_id,
);
# Later, when PayPal returns a silent POST or redirects the user to your
# return URL:
my $redirect_response = $payments->get_response_from_redirect(
ip_address => $ip,
params => $params,
);
# Fetch the tokens from the original request. You'll need to implement
# this yourself.
my $thawed = $foo->get_thawed_tokens(...);
# Don't do anything until you're sure the tokens are ok.
if ( $thawed->secure_token ne $redirect->secure_token
|| $thawed->secure_token_id ne $response->secure_token_id ) {
die 'Fraud!';
}
# Everything looks good. Carry on!print $response->secure_token;
DESCRIPTION
BETA BETA BETA. The interface is still subject to change.
This is a wrapper around the "PayPal Payments Advanced" (AKA "PayPal Payflow Link") hosted forms. This code does things like facilitating secure token creation, providing an URL which you can use to insert an hosted_form into your pages and processing the various kinds of response you can get from PayPal.
We also use various exception classes to make it easier for you to decide how to handle the parts that go wrong.
OBJECT INSTANTIATION
The following parameters can be supplied to new() when creating a new object.
Required Parameters
password
The value of the password field you use when logging in to the Payflow Manager. (You'll probably want to create a specific user just for API calls).
user
The value of the user field you use when logging in to the Payflow Manager.
vendor
The value of the vendor field you use when logging in to the Payflow Manager.
Optional Parameters
partner
The value of the partner field you use when logging in to the Payflow Manager. Defaults to PayPal.
payflow_pro_uri
The hostname for the Payflow Pro API. This is where token creation requests get directed. This already has a sensible (and correct) default, but it is settable so that you can more easily mock API calls when testing.
payflow_link_uri
The hostname for the Payflow Link website. This is the hosted service where users will enter their payment information. This already has a sensible (and correct) default, but it is settable in case you want to mock it while testing.
production_mode
This is a Boolean. Set this to true if when you are ready to process real transactions. Defaults to false.
ua
You may provide your own UserAgent, but it must be of the LWP::UserAgent family. If you do provide a UserAgent, be sure to set a sensible timeout value.
This can be useful for debugging. You'll be able to get detailed information about the network calls which are being made.
use LWP::ConsoleLogger::Easy qw( debug_ua );
use LWP::UserAgent;
use WebService::PayPal::PaymentsAdvanced;
my $ua = LWP::UserAgent;
debug_ua($ua);
my $payments
= WebService::PayPal::PaymentsAdvanced->new( ua => $ua, ... );
# Now fire up a console and watch your network activity.Check the tests which accompany this distribution for an example of how to mock API calls using Test::LWP::UserAgent.
validate_hosted_form_uri
Boolean. If enabled, this module will attempt to GET the uri which you'll be providing to the end user. This can help you identify issues on the PayPal side. This is helpful because you'll be able to log exceptions thrown by this method and deal with them accordingly. If you disable this option, you'll need to rely on end users to report issues which may exist within PayPal's hosted pages. Defaults to true.
Methods
create_secure_token
Create a secure token which you can use to create a hosted form uri. Returns a WebService::PayPal::PaymentsAdvanced::Response object.
use WebService::PayPal::PaymentsAdvanced;
my $payments = WebService::PayPal::PaymentsAdvanced->new(...);
my $response = $payments->create_secure_token(
{
AMT => 100,
TRXTYPE => 'S',
VERBOSITY => 'HIGH',
BILLINGTYPE => 'MerchantInitiatedBilling',
CANCELURL => 'https://example.com/cancel',
ERRORURL => 'https://example.com/error',
L_BILLINGTYPE0 => 'MerchantInitiatedBilling',
NAME => 'Chuck Norris',
RETURNURL => 'https://example.com/return'
}
);
print $response->secure_token;get_response_from_redirect
This method can be used to parse responses from PayPal to your return URL. It's essentially a wrapper around WebService::PayPal::PaymentsAdvanced::Response::FromRedirect. Returns a WebService::PayPal::PaymentsAdvanced::Response object.
my $response = $payments->get_response_from_redirect(
params => $params,
);
print $response->message;get_response_from_silent_post
This method can be used to validate responses from PayPal to your silent POST url. It's essentially a wrapper around WebService::PayPal::PaymentsAdvanced::Response::FromSilentPost. If you provide an ip_address parameter, it will be validated against a list of known IPs which PayPal provides. You're encouraged to provide an IP address in order to prevent spoofing of payment responses. See WebService::PayPal::PaymentsAdvanced::Response::FromSilentPOST for more information on this behaviour.
This method returns a WebService::PayPal::PaymentsAdvanced::Response object.
my $response = $payments->get_response_from_redirect(
ip_address => $ip,
params => $params,
);
print $response->message;hosted_form_uri
Returns a URI object which you can use either to insert an iframe into your pages or redirect the user to PayPal directly in order to make a payment.
use WebService::PayPal::PaymentsAdvanced;
my $payments = WebService::PayPal::PaymentsAdvanced->new(
validate_hosted_form_uri => 1, ... );
my $response = $payments->create_secure_token(...);
my $uri = $payments->hosted_form_uri($response);AUTHOR
Olaf Alders <olaf@wundercounter.com>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2015 by MaxMind, Inc..
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)