X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=PayflowPro.pm;h=e559caf4f15ed48570b08866c57107d1c7cd3a2e;hb=4a68dd973db000a9166b68301bc816efe9deb744;hp=906bce792c2fabd22a671a3d1e138600202fdd12;hpb=589764ffc76ff028f267809a65ae08e6974ef7be;p=Business-OnlinePayment-PayflowPro.git diff --git a/PayflowPro.pm b/PayflowPro.pm index 906bce7..e559caf 100644 --- a/PayflowPro.pm +++ b/PayflowPro.pm @@ -1,20 +1,15 @@ package Business::OnlinePayment::PayflowPro; use strict; -use vars qw($VERSION @ISA @EXPORT @EXPORT_OK); +use vars qw($VERSION); use Carp qw(croak); -use AutoLoader; -use Business::OnlinePayment; +use base qw(Business::OnlinePayment); -#PayflowPRO SDK from Verisign +# Payflow Pro SDK use PFProAPI qw( pfpro ); -require Exporter; - -@ISA = qw(Exporter AutoLoader Business::OnlinePayment); -@EXPORT = qw(); -@EXPORT_OK = qw(); -$VERSION = '0.02'; +$VERSION = '0.05'; +$VERSION = eval $VERSION; sub set_defaults { my $self = shift; @@ -22,287 +17,435 @@ sub set_defaults { $self->server('payflow.verisign.com'); $self->port('443'); - $self->build_subs(qw( - vendor partner order_number cert_path avs_code cvv2_code - )); - + $self->build_subs( + qw( + vendor partner cert_path order_number avs_code cvv2_code + ) + ); } sub map_fields { - my($self) = @_; + my ($self) = @_; my %content = $self->content(); #ACTION MAP - my %actions = ('normal authorization' => 'S', #Sale - 'authorization only' => 'A', #Authorization - 'credit' => 'C', #Credit (refund) - 'post authorization' => 'D', #Delayed Capture - 'void' => 'V', - ); - $content{'action'} = $actions{lc($content{'action'})} || $content{'action'}; + my %actions = ( + 'normal authorization' => 'S', # Sale transaction + 'credit' => 'C', # Credit (refund) + 'authorization only' => 'A', # Authorization + 'post authorization' => 'D', # Delayed Capture + 'void' => 'V', # Void + ); + + $content{'action'} = $actions{ lc( $content{'action'} ) } + || $content{'action'}; # TYPE MAP - my %types = ('visa' => 'C', - 'mastercard' => 'C', - 'american express' => 'C', - 'discover' => 'C', - 'cc' => 'C' - #'check' => 'ECHECK', - ); - $content{'type'} = $types{lc($content{'type'})} || $content{'type'}; - $self->transaction_type($content{'type'}); + my %types = ( + 'visa' => 'C', + 'mastercard' => 'C', + 'american express' => 'C', + 'discover' => 'C', + 'cc' => 'C', + #'check' => 'ECHECK', + ); + + $content{'type'} = $types{ lc( $content{'type'} ) } || $content{'type'}; + + $self->transaction_type( $content{'type'} ); # stuff it back into %content $self->content(%content); } -sub build_subs { - my $self = shift; - foreach(@_) { - #no warnings; #not 5.005 - local($^W)=0; - eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }"; - } -} - sub remap_fields { - my($self,%map) = @_; + my ( $self, %map ) = @_; my %content = $self->content(); - foreach(keys %map) { - $content{$map{$_}} = $content{$_}; + foreach ( keys %map ) { + $content{ $map{$_} } = $content{$_}; } $self->content(%content); } sub revmap_fields { - my($self, %map) = @_; + my ( $self, %map ) = @_; my %content = $self->content(); - foreach(keys %map) { -# warn "$_ = ". ( ref($map{$_}) -# ? ${ $map{$_} } -# : $content{$map{$_}} ). "\n"; - $content{$_} = ref($map{$_}) - ? ${ $map{$_} } - : $content{$map{$_}}; + foreach ( keys %map ) { + $content{$_} = + ref( $map{$_} ) + ? ${ $map{$_} } + : $content{ $map{$_} }; } $self->content(%content); } -sub get_fields { - my($self,@fields) = @_; - - my %content = $self->content(); - my %new = (); - foreach( grep defined $content{$_}, @fields) { $new{$_} = $content{$_}; } - return %new; -} - sub submit { - my($self) = @_; + my ($self) = @_; $self->map_fields(); my %content = $self->content; - my($month, $year, $zip); - - #unless ( $content{action} eq 'BillOrders' ) { + my ( $month, $year, $zip ); - if ( $self->transaction_type() eq 'C' ) { - } else { - Carp::croak("PayflowPro can't (yet?) handle transaction type: ". - $self->transaction_type()); - } + if ( $self->transaction_type() ne 'C' ) { + croak( "PayflowPro can't (yet?) handle transaction type: " + . $self->transaction_type() ); + } - if ( exists($content{'expiration'}) && defined($content{'expiration'}) - && length($content{'expiration'}) ) { + if ( defined( $content{'expiration'} ) && length( $content{'expiration'} ) ) + { $content{'expiration'} =~ /^(\d+)\D+\d*(\d{2})$/ or croak "unparsable expiration $content{expiration}"; ( $month, $year ) = ( $1, $2 ); - $month = '0'. $month if $month =~ /^\d$/; - } - - $zip = $content{'zip'} =~ s/\D//; - #} + $month = '0' . $month if $month =~ /^\d$/; + } - #$content{'address'} =~ /^(\S+)\s/; - #my $addrnum = $1; + ( $zip = $content{'zip'} ) =~ s/\D//g; $self->server('test-payflow.verisign.com') if $self->test_transaction; $self->revmap_fields( - ACCT => 'card_number', - EXPDATE => \( $month.$year ), - AMT => 'amount', - USER => 'login', - #VENDOR => \( $self->vendor ), - VENDOR => 'login', - PARTNER => \( $self->partner ), - PWD => 'password', - TRXTYPE => 'action', - TENDER => 'type', - - STREET => 'address', - ZIP => \$zip, - - CITY => 'city', - COMMENT1 => 'description', - COMMENT2 => 'invoice_number', - COMPANYNAME => 'company', - COUNTRY => 'country', - FIRSTNAME => 'first_name', - LASTNAME => 'last_name', - NAME => 'name', - EMAIL => 'email', - STATE => 'state', - - CVV2 => 'cvv2', - ORIGID => 'order_number' + # (BUG?) VENDOR B::OP:PayflowPro < 0.05 backward compatibility. If + # vendor not set use login (although test indicate undef vendor is ok) + VENDOR => $self->vendor ? \( $self->vendor ) : 'login', + PARTNER => \( $self->partner ), + USER => 'login', + PWD => 'password', + TRXTYPE => 'action', + TENDER => 'type', + ORIGID => 'order_number', + COMMENT1 => 'description', + COMMENT2 => 'invoice_number', + + ACCT => 'card_number', + CVV2 => 'cvv2', + EXPDATE => \( $month . $year ), # MM/YY from 'expiration' + AMT => 'amount', + + FIRSTNAME => 'first_name', + LASTNAME => 'last_name', + NAME => 'name', + EMAIL => 'email', + COMPANYNAME => 'company', + STREET => 'address', + CITY => 'city', + STATE => 'state', + ZIP => \$zip, # 'zip' with non-numbers removed + COUNTRY => 'country', ); my @required = qw( TRXTYPE TENDER PARTNER VENDOR USER PWD ); - if ( $self->transaction_type() eq 'C' ) { #credit card - if ( $self->action() =~ /^[CDV]$/ && exists($content{'ORIGID'}) - && defined($content{'ORIGID'}) && length($content{'ORIGID'}) ) { - push @required, qw(ORIGID); - } else { - push @required, qw(AMT ACCT EXPDATE); - } + if ( $self->transaction_type() eq 'C' ) { # credit card + if ( $content{'action'} =~ /^[CDV]$/ + && defined( $content{'ORIGID'} ) + && length( $content{'ORIGID'} ) ) + { + push @required, qw(ORIGID); + } + else { + # never get here, we croak above if transaction_type ne 'C' + push @required, qw(AMT ACCT EXPDATE); + } } $self->required_fields(@required); - my %params = $self->get_fields(qw( - ACCT EXPDATE AMT USER VENDOR PARTNER PWD TRXTYPE TENDER - STREET ZIP - CITY COMMENT1 COMMENT2 COMPANYNAME COUNTRY FIRSTNAME LASTNAME NAME EMAIL - STATE - CVV2 ORIGID - )); - - #print "$_ => $params{$_}\n" foreach keys %params; + my %params = $self->get_fields( + qw( + VENDOR PARTNER USER PWD TRXTYPE TENDER ORIGID COMMENT1 COMMENT2 + ACCT CVV2 EXPDATE AMT + FIRSTNAME LASTNAME NAME EMAIL COMPANYNAME + STREET CITY STATE ZIP COUNTRY + ) + ); $ENV{'PFPRO_CERT_PATH'} = $self->cert_path; - my( $response, $resultstr ) = pfpro( \%params, $self->server, $self->port ); - - #if ( $response->{'RESULT'} == 0 ) { - if ( $response->{'RESULT'} eq '0' ) { #want an explicit zero, not just - #numerically equal - $self->is_success(1); - $self->result_code( $response->{'RESULT'} ); - $self->error_message( $response->{'RESPMSG'} ); - $self->authorization( $response->{'AUTHCODE'} ); - $self->order_number( $response->{'PNREF'} ); - my $avs_code = ''; - if ( $response->{AVSADDR} eq 'Y' && $response->{AVSZIP} eq 'Y' ) { - $avs_code = 'Y'; - } elsif ( $response->{AVSADDR} eq 'Y' ) { - $avs_code = 'A'; - } elsif ( $response->{AVSZIP} eq 'Y' ) { - $avs_code = 'Z'; - } elsif ( $response->{AVSADDR} eq 'N' || $response->{AVSZIP} eq 'N' ) { - $avs_code = 'N'; - } - $self->avs_code( $avs_code ); - $self->cvv2_code( $response->{'CVV2MATCH'}); - } else { - $self->is_success(0); - $self->result_code( $response->{'RESULT'} ); - $self->error_message( $response->{'RESPMSG'} ); + my ( $response, $resultstr ) = + pfpro( \%params, $self->server, $self->port ); + + # AVS and CVS values may be set on success or failure + my $avs_code; + if ( exists $response->{AVSADDR} || exists $response->{AVSZIP} ) { + if ( $response->{AVSADDR} eq 'Y' && $response->{AVSZIP} eq 'Y' ) { + $avs_code = 'Y'; + } + elsif ( $response->{AVSADDR} eq 'Y' ) { + $avs_code = 'A'; + } + elsif ( $response->{AVSZIP} eq 'Y' ) { + $avs_code = 'Z'; + } + elsif ( $response->{AVSADDR} eq 'N' || $response->{AVSZIP} eq 'N' ) { + $avs_code = 'N'; + } + else { + $avs_code = ''; + } } + $self->avs_code($avs_code); + $self->cvv2_code( $response->{'CVV2MATCH'} ); + $self->result_code( $response->{'RESULT'} ); + $self->order_number( $response->{'PNREF'} ); + $self->error_message( $response->{'RESPMSG'} ); + $self->authorization( $response->{'AUTHCODE'} ); + + # RESULT must be an explicit zero, not just numerically equal + if ( $response->{'RESULT'} eq '0' ) { + $self->is_success(1); + } + else { + $self->is_success(0); + } } 1; + __END__ =head1 NAME -Business::OnlinePayment::PayflowPro - Verisign PayflowPro backend for Business::OnlinePayment +Business::OnlinePayment::PayflowPro - Payflow Pro backend for Business::OnlinePayment =head1 SYNOPSIS use Business::OnlinePayment; - - my $tx = new Business::OnlinePayment( 'PayflowPro', - 'vendor' => 'your_vendor', - 'partner' => 'your_partner', - 'cert_path' => '/path/to/your/certificate/file/', #just the dir + + my $tx = new Business::OnlinePayment( + 'PayflowPro', + 'vendor' => 'your_vendor', + 'partner' => 'your_partner', + 'cert_path' => '/path/to/your/certificate/file/', # just the dir ); - + + # See the module documentation for details of content() $tx->content( type => 'VISA', action => 'Normal Authorization', - description => 'Business::OnlinePayment test', + description => 'Business::OnlinePayment::PayflowPro test', amount => '49.95', invoice_number => '100100', customer_id => 'jsk', name => 'Jason Kohles', address => '123 Anystreet', city => 'Anywhere', - state => 'UT', - zip => '84058', + state => 'GA', + zip => '30004', email => 'ivan-payflowpro@420.am', - card_number => '4007000000027', - expiration => '09/04', - - #advanced params - cvv2 => '420', - order_number => 'string', # returned by $tx->order_number() from an - # "authorization only" or - # "normal authorization" action, used by a - # "credit", "void", or "post authorization" + card_number => '4111111111111111', + expiration => '12/09', + cvv2 => '123', + order_number => 'string', ); + $tx->submit(); - - if($tx->is_success()) { - print "Card processed successfully: ".$tx->authorization."\n"; - print "order number: ". $tx->order_number. "\n"; - print "AVS code: ". $tx->avs_code. "\n"; # Y - Address and ZIP match - # A - Address matches but not ZIP - # Z - ZIP matches bu tnot address - # N - no match - # E - AVS error or unsupported - # (null) - AVS error - print "CVV2 code: ". $tx->cvv2_code. "\n"; - - } else { - print "Card was rejected: ".$tx->error_message; - print " (CVV2 mismatch)" if $tx->result_code == 114; - print "\n"; + + if ( $tx->is_success() ) { + print( + "Card processed successfully: ", $tx->authorization, "\n", + "order number: ", $tx->order_number, "\n", + "CVV2 code: ", $tx->cvv2_code, "\n", + "AVS code: ", $tx->avs_code, "\n", + ); + } + else { + my $info = ""; + $info = " (CVV2 mismatch)" if ( $tx->result_code == 114 ); + + print( + "Card was rejected: ", $tx->error_message, $info, "\n", + "order number: ", $tx->order_number, "\n", + ); } -=head1 SUPPORTED TRANSACTION TYPES +=head1 DESCRIPTION -=head2 Visa, MasterCard, American Express, JCB, Discover/Novus, Carte blanche/Diners Club, CC +This module is a back end driver that implements the interface +specified by L to support payment handling +via the PayPal's Payflow Pro Internet payment solution. -=head1 SUPPORTED ACTIONS +See L for details on the interface this +modules supports. -=head2 Normal Authorization, Authorization Only, Post Authorization, Credit, Void +=head1 Module specific methods -=head1 DESCRIPTION +This module provides the following methods which are not currently +part of the standard Business::OnlinePayment interface: -For detailed information see L. +=over 4 -=head1 COMPATIBILITY +=item vendor() + +=item partner() + +=item cert_path() + +=item L -This module implements an interface to the PayflowPro Perl API, which can -be downloaded at https://manager.verisign.com/ with a valid login. +=item L -=head1 BUGS +=item L + +=back + +=head1 Settings + +The following default settings exist: + +=over 4 + +=item server + +payflow.verisign.com or test-payflow.verisign.com if +test_transaction() is TRUE + +=item port + +443 + +=back + +=head1 Handling of content(%content) + +The following rules apply to content(%content) data: + +=head2 action + +If 'action' matches one of the following keys it is replaced by the +right hand side value: + + 'normal authorization' => 'S', # Sale transaction + 'credit' => 'C', # Credit (refund) + 'authorization only' => 'A', # Authorization + 'post authorization' => 'D', # Delayed Capture + 'void' => 'V', + +If 'action' is 'C', 'D' or 'V' and 'order_number' is not set then +'amount', 'card_number' and 'expiration' must be set. + +=head2 type + +If 'type' matches one of the following keys it is replaced by the +right hand side value: + + 'visa' => 'C', + 'mastercard' => 'C', + 'american express' => 'C', + 'discover' => 'C', + 'cc' => 'C', + +The value of 'type' is used to set transaction_type(). Currently this +module only supports a transaction_type() of 'C' any other values will +cause Carp::croak() to be called in submit(). + +Note: Payflow Pro supports multiple credit card types, including: +American Express/Optima, Diners Club, Discover/Novus, Enroute, JCB, +MasterCard and Visa. + +=head1 Setting Payflow Pro parameters from content(%content) + +The following rules are applied to map data to Payflow Pro parameters +from content(%content): + + # PFP param => $content{} + VENDOR => $self->vendor ? \( $self->vendor ) : 'login', + PARTNER => \( $self->partner ), + USER => 'login', + PWD => 'password', + TRXTYPE => 'action', + TENDER => 'type', + ORIGID => 'order_number', + COMMENT1 => 'description', + COMMENT2 => 'invoice_number', + + ACCT => 'card_number', + CVV2 => 'cvv2', + EXPDATE => \( $month.$year ), # MM/YY from 'expiration' + AMT => 'amount', + + FIRSTNAME => 'first_name', + LASTNAME => 'last_name', + NAME => 'name', + EMAIL => 'email', + COMPANYNAME => 'company', + STREET => 'address', + CITY => 'city', + STATE => 'state', + ZIP => \$zip, # 'zip' with non-numbers removed + COUNTRY => 'country', + +The required Payflow Pro parameters for credit card transactions are: + + TRXTYPE TENDER PARTNER VENDOR USER PWD ORIGID + +=head1 Mapping Payflow Pro transaction responses to object methods + +The following methods provides access to the transaction response data +resulting from a Payflow Pro request (after submit()) is called: + +=head2 order_number() + +This order_number() method returns the PNREF field, also known as the +PayPal Reference ID, which is a unique number that identifies the +transaction. + +=head2 result_code() + +The result_code() method returns the RESULT field, which is the +numeric return code indicating the outcome of the attempted +transaction. + +A RESULT of 0 (zero) indicates the transaction was approved and +is_success() will return '1' (one/TRUE). Any other RESULT value +indicates a decline or error and is_success() will return '0' +(zero/FALSE). + +=head2 error_message() + +The error_message() method returns the RESPMSG field, which is a +response message returned with the transaction result. + +=head2 authorization() + +The authorization() method returns the AUTHCODE field, which is the +approval code obtained from the processing network. + +=head2 avs_code() + +The avs_code() method returns a combination of the AVSADDR and AVSZIP +fields from the transaction result. The value in avs_code is as +follows: + + Y - Address and ZIP match + A - Address matches but not ZIP + Z - ZIP matches but not address + N - no match + undef - AVS values not available + +=head2 cvv2_code() + +The cvv2_code() method returns the CVV2MATCH field, which is a +response message returned with the transaction result. + +=head1 COMPATIBILITY + +This module implements an interface to the Payflow Pro Perl API, which +can be downloaded at https://manager.paypal.com/ with a valid login. =head1 AUTHOR Ivan Kohler -Based on Busienss::OnlinePayment::AuthorizeNet written by Jason Kohles. +Based on Business::OnlinePayment::AuthorizeNet written by Jason Kohles. =head1 SEE ALSO -perl(1), L. +perl(1), L, L, and the PayPal +Integration Center Payflow Pro resources at +L =cut -