interchange-cvs at icdevgroup
Mar 16, 2009, 8:34 AM
Post #1 of 2
(455 views)
Permalink
|
|
interchange - markj modified lib/Vend/Payment/PayflowPro.pm
|
|
User: markj
Date: 2009-03-16 15:34:29 GMT
Added: lib/Vend/Payment PayflowPro.pm
Log:
Vend::Payment::PayflowPro - gateway module for PayPal Payflow Pro HTTPS POST
Paypal will be phasing out the use of the old Verisign pfpro interface. This
module offers (almost) a drop-in replacement for Vend::Payment::Signio. There
may be minor adjustments required to the payment route, and the gateway param
must be changed from signio (or verisign) to payflowpro.
Original framework from Tom Tucker.
Revision Changes Path
1.1 interchange/lib/Vend/Payment/PayflowPro.pm
rev 1.1, prev_rev 1.0
Index: PayflowPro.pm
===================================================================
# Vend::Payment::PayflowPro - Interchange support for PayPal Payflow Pro HTTPS POST
#
# $Id: PayflowPro.pm,v 1.1 2009-03-16 15:34:29 markj Exp $
#
# Copyright (C) 2002-2009 Interchange Development Group and others
# Copyright (C) 1999-2002 Red Hat, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public
# License along with this program; if not, write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301 USA.
package Vend::Payment::PayflowPro;
=head1 NAME
Vend::Payment::PayflowPro - Interchange support for PayPal Payflow Pro HTTPS POST
=head1 SYNOPSIS
&charge=payflowpro
or
[charge mode=payflowpro param1=value1 param2=value2]
=head1 PREREQUISITES
The following Perl modules:
LWP
Crypt::SSLeay
HTTP::Request
HTTP::Headers
OpenSSL
PayPal's Payflow Pro HTTPS POST does NOT require the proprietary binary-only
shared library that was used for the Verisign Payflow Pro service.
=head1 DESCRIPTION
The Vend::Payment::PayflowPro module implements the payflowpro() payment routine
for use with Interchange. It is compatible on a call level with the other
Interchange payment modules -- in theory (and even usually in practice) you
could switch from a different payment module to PayflowPro with a few
configuration file changes.
To enable this module, place this directive in F<interchange.cfg>:
Require module Vend::Payment::PayflowPro
This I<must> be in interchange.cfg or a file included from it.
NOTE: Make sure CreditCardAuto is off (default in Interchange demos).
The mode can be named anything, but the C<gateway> parameter must be set
to C<payflowpro>. To make it the default payment gateway for all credit
card transactions in a specific catalog, you can set in F<catalog.cfg>:
Variable MV_PAYMENT_MODE payflowpro
It uses several of the standard settings from Interchange payment. Any time
we speak of a setting, it is obtained either first from the tag/call options,
then from an Interchange order Route named for the mode, then finally a
default global payment variable. For example, the C<id> parameter would
be specified by:
[charge mode=payflowpro id=YourPayflowProID]
or
Route payflowpro id YourPayflowProID
or with only Payflow Pro as a payment provider
Variable MV_PAYMENT_ID YourPayflowProID
The active settings are:
=over 4
=item id
Your account ID, supplied by PayPal when you sign up.
Global parameter is MV_PAYMENT_ID.
=item secret
Your account password, selected by you or provided by PayPal when you sign up.
Global parameter is MV_PAYMENT_SECRET.
=item partner
Your account partner, selected by you or provided by PayPal when you
sign up. Global parameter is MV_PAYMENT_PARTNER.
=item vendor
Your account vendor, selected by you or provided by PayPal when you
sign up. Global parameter is MV_PAYMENT_VENDOR.
=item transaction
The type of transaction to be run. Valid values are:
Interchange Payflow Pro
---------------- -----------------
sale S
auth A
credit C
void V
settle D (from previous A trans)
Default is C<auth>.
=back
The following should rarely be used, as the supplied defaults are
usually correct.
=over 4
=item remap
This remaps the form variable names to the ones needed by PayPal. See
the C<Payment Settings> heading in the Interchange documentation for use.
=item host
The payment gateway host to use, to override the default.
=item check_sub
Name of a Sub or GlobalSub to be called after the result hash has been
received from PayPal. A reference to the modifiable result hash is
passed into the subroutine, and it should return true (in the Perl truth
sense) if its checks were successful, or false if not. The transaction type
is passed in as a second arg, if needed.
This can come in handy since, strangely, PayPal has no option to decline
a charge when AVS or CSC data come back negative.
If you want to fail based on a bad AVS check, make sure you're only
doing an auth -- B<not a sale>, or your customers would get charged on
orders that fail the AVS check and never get logged in your system!
Add the parameters like this:
Route payflowpro check_sub avs_check
This is a matching sample subroutine you could put in interchange.cfg:
GlobalSub <<EOR
sub avs_check {
my ($result) = @_;
my ($addr, $zip) = @{$result}{qw( AVSADDR AVSZIP )};
return 1 if $addr eq 'Y' or $zip eq 'Y';
return 1 if $addr eq 'X' and $zip eq 'X';
return 1 if $addr !~ /\S/ and $zip !~ /\S/;
$result->{RESULT} = 112;
$result->{RESPMSG} = "The billing address you entered does not match the cardholder's billing address";
return 0;
}
EOR
That would work equally well as a Sub in catalog.cfg. It will succeed if
either the address or zip is 'Y', or if both are unknown. If it fails,
it sets the result code and error message in the result hash using
PayPal's own (otherwise unused) 112 result code, meaning "Failed AVS
check".
Of course you can use this sub to do any other post-processing you
want as well.
=back
=head2 Troubleshooting
Try the instructions above, then enable test mode. A test order should
complete.
Then move to live mode and try a sale with the card number C<4111 1111
1111 1111> and a valid future expiration date. The sale should be denied,
and the reason should be in [data session payment_error].
If it doesn't work:
=over 4
=item *
Make sure you "Require"d the module in interchange.cfg:
Require module Vend::Payment::PayflowPro
=item *
Check the error logs, both catalog and global.
=item *
Make sure you set your account ID and secret properly.
=item *
Try an order, then put this code in a page:
<pre>
[calcn]
my $string = $Tag->uneval( { ref => $Session->{payment_result} });
$string =~ s/{/{\n/;
$string =~ s/,/,\n/g;
return $string;
[/calcn]
</pre>
That should show what happened.
=item *
If all else fails, consultants are available to help with
integration for a fee. You can find consultants by asking on the
C<interchange-biz [at] icdevgroup> mailing list.
=back
=head1 NOTE
There is actually nothing in the package Vend::Payment::PayflowPro.
It changes packages to Vend::Payment and places things there.
=head1 AUTHORS
Tom Tucker <tom [at] ttucker>
Mark Johnson <mark [at] endpoint>
Jordan Adler
David Christensen <david [at] endpoint>
Cameron Prince <cameronbprince [at] yahoo>
Mike Heins <mike [at] perusion>
Jon Jensen <jon [at] endpoint>
=cut
package Vend::Payment;
use Config;
use Time::HiRes;
BEGIN {
eval {
require LWP;
require HTTP::Request;
require HTTP::Headers;
require Crypt::SSLeay;
};
if ($@) {
die "Required modules for PayPal Payflow Pro HTTPS NOT found. $@\n";
}
}
sub payflowpro {
my ($user, $amount) = @_;
# Uncomment all the following lines to use the debug statement. It strips
# the arg of any sensitive credit card information and is safe
# (and recommended) to enable in production.
#
# my $debug_user = ::uneval($user);
# $debug_user =~ s{('mv_credit_card_[^']+' => ')((?:\\'|\\|[^\\']*)*)(')}{$1 . ('X' x length($2)) . $3}ge;
#::logDebug("payflowpro called\n" . $debug_user);
my ($opt, $secret);
if (ref $user) {
$opt = $user;
$user = $opt->{id} || undef;
$secret = $opt->{secret} || undef;
}
else {
$opt = {};
}
my %actual;
if ($opt->{actual}) {
%actual = %{$opt->{actual}};
}
else {
%actual = map_actual();
}
if (! $user) {
$user = charge_param('id')
or return (
MStatus => 'failure-hard',
MErrMsg => errmsg('No account id'),
);
}
#::logDebug("payflowpro user $user");
if (! $secret) {
$secret = charge_param('secret')
or return (
MStatus => 'failure-hard',
MErrMsg => errmsg('No account password'),
);
}
#::logDebug("payflowpro OrderID: |$opt->{order_id}|");
my ($server, $port);
if (! $opt->{host} and charge_param('test')) {
#::logDebug("payflowpro: setting server to pilot/test mode");
$server = 'pilot-payflowpro.paypal.com';
$port = '443';
}
else {
#::logDebug("payflowpro: setting server based on options");
$server = $opt->{host} || 'payflowpro.paypal.com';
$port = $opt->{port} || '443';
}
my $uri = "https://$server:$port/transaction";
#::logDebug("payflowpro: using uri: $uri");
$actual{mv_credit_card_exp_month} =~ s/\D//g;
$actual{mv_credit_card_exp_month} =~ s/^0+//;
$actual{mv_credit_card_exp_year} =~ s/\D//g;
$actual{mv_credit_card_exp_year} =~ s/\d\d(\d\d)/$1/;
$actual{mv_credit_card_number} =~ s/\D//g;
my $exp = sprintf '%02d%02d',
$actual{mv_credit_card_exp_month},
$actual{mv_credit_card_exp_year};
my %type_map = (qw/
sale S
auth A
authorize A
void V
settle D
settle_prior D
credit C
mauthcapture S
mauthonly A
mauthdelay D
mauthreturn C
S S
C C
D D
V V
A A
/);
my $transtype = $opt->{transaction} || charge_param('transaction') || 'A';
$transtype = $type_map{$transtype}
or return (
MStatus => 'failure-hard',
MErrMsg => errmsg('Unrecognized transaction: %s', $transtype),
);
my $orderID = $opt->{order_id};
$amount = $opt->{total_cost} if ! $amount;
if (! $amount) {
my $precision = $opt->{precision} || charge_param('precision') || 2;
my $cost = Vend::Interpolate::total_cost();
$amount = Vend::Util::round_to_frac_digits($cost, $precision);
}
my %varmap = (qw/
ACCT mv_credit_card_number
CVV2 mv_credit_card_cvv2
ZIP b_zip
STREET b_address
SHIPTOZIP zip
EMAIL email
COMMENT1 comment1
COMMENT2 comment2
/);
my %query = (
AMT => $amount,
EXPDATE => $exp,
TENDER => 'C',
PWD => $secret,
USER => $user,
TRXTYPE => $transtype,
);
$query{PARTNER} = $opt->{partner} || charge_param('partner');
$query{VENDOR} = $opt->{vendor} || charge_param('vendor');
$query{ORIGID} = $orderID if $orderID;
# We want a unique orderID for each call, to better than second granularity
( $opt->{order_id} = Time::HiRes::clock_gettime() ) =~ s/\D//g;
$orderID = gen_order_id($opt);
#::logDebug("payflowpro AUTH gen_order_id: " . $orderID);
for (keys %varmap) {
$query{$_} = $actual{$varmap{$_}} if defined $actual{$varmap{$_}};
}
# Uncomment all the following block to use the debug statement. It strips
# the arg of any sensitive credit card information and is safe
# (and recommended) to enable in production.
#
# {
# my %munged_query = %query;
# $munged_query{PWD} = 'X';
# $munged_query{ACCT} =~ s/^(\d{4})(.*)/$1 . ('X' x length($2))/e;
# $munged_query{CVV2} =~ s/./X/g;
# $munged_query{EXPDATE} =~ s/./X/g;
#::logDebug("payflowpro query: " . ::uneval(\%munged_query));
# }
my $timeout = $opt->{timeout} || 10;
die "Bad timeout value, security violation." unless $timeout && $timeout !~ /\D/;
die "Bad port value, security violation." unless $port && $port !~ /\D/;
die "Bad server value, security violation." unless $server && $server !~ /[^-\w.]/;
my $result = {};
my (@query, @debug_query);
for my $key (keys %query) {
my $val = $query{$key};
$val =~ s/["\$\n\r]//g;
my $len = length($val);
$key .= "[$len]";
push @query, "$key=$val";
$val =~ s/./X/g
if $key =~ /^(?:PWD|ACCT|CVV2|EXPDATE)\b/;
push @debug_query, "$key=$val";
}
my $string = join '&', @query;
my $debug_string = join '&', @debug_query;
my %headers = (
'Content-Type' => 'text/namevalue',
'X-VPS-Request-Id' => $orderID,
'X-VPS-Timeout' => $timeout,
'X-VPS-VIT-Client-Architecture' => $Config{archname},
'X-VPS-VIT-Client-Type' => 'Perl',
'X-VPS-VIT-Client-Version' => $VERSION,
'X-VPS-VIT-Integration-Product' => 'Interchange',
'X-VPS-VIT-Integration-Version' => $::VERSION,
'X-VPS-VIT-OS-Name' => $Config{osname},
'X-VPS-VIT-OS-Version' => $Config{osvers},
);
# Debug statement is stripped of any sensitive card data and is safe (and
# recommended) to enable in production.
#
#::logDebug(qq{--------------------\nPosting to PayflowPro: \n\t$orderID\n\t$uri "$debug_string"});
my $headers = HTTP::Headers->new(%headers);
my $request = HTTP::Request->new('POST', $uri, $headers, $string);
my $ua = LWP::UserAgent->new(timeout => $timeout);
$ua->agent('Vend::Payment::PayflowPro');
my $response = $ua->request($request);
my $resultstr = $response->content;
#::logDebug(qq{PayflowPro response:\n\t$resultstr\n--------------------});
unless ( $response->is_success ) {
return (
RESULT => -1,
RESPMSG => 'System Error',
MStatus => 'failure-hard',
MErrMsg => 'System Error',
lwp_response => $resultstr,
);
}
%$result = split /[&=]/, $resultstr;
my $decline = $result->{RESULT};
if (
$result->{RESULT}
and
my $check_sub_name = $opt->{check_sub} || charge_param('check_sub')
) {
my $check_sub = $Vend::Cfg->{Sub}{$check_sub_name}
|| $Global::GlobalSub->{$check_sub_name};
if (ref $check_sub eq 'CODE') {
$decline =
!$check_sub->(
$result,
$transtype,
);
#::logDebug(qq{payflowpro called check_sub sub=$check_sub_name decline=$decline});
}
else {
logError("payflowpro: non-existent check_sub routine %s.", $check_sub_name);
}
}
my %result_map = (qw/
MStatus ICSTATUS
pop.status ICSTATUS
order-id PNREF
pop.order-id PNREF
pop.auth-code AUTHCODE
pop.avs_code AVSZIP
pop.avs_zip AVSZIP
pop.avs_addr AVSADDR
/);
if ($decline) {
$result->{ICSTATUS} = 'failed';
my $msg = errmsg("Charge error: %s Reason: %s. Please call in your order or try again.",
$result->{RESULT} || 'no details available',
$result->{RESPMSG} || 'unknown error',
);
$result->{MErrMsg} = $result{'pop.error-message'} = $msg;
}
else {
$result->{ICSTATUS} = 'success';
}
for (keys %result_map) {
$result->{$_} = $result->{$result_map{$_}}
if defined $result->{$result_map{$_}};
}
#::logDebug('payflowpro result: ' . ::uneval($result));
return %$result;
}
package Vend::Payment::PayflowPro;
1;
_______________________________________________
interchange-cvs mailing list
interchange-cvs [at] icdevgroup
http://www.icdevgroup.org/mailman/listinfo/interchange-cvs
|
