use Carp qw(carp croak);
use CGI;
use Digest::MD5;
+use Business::OnlinePayment::HTTPS 0.06;
use base qw(Business::OnlinePayment::HTTPS);
-$VERSION = '0.07_01';
+$VERSION = '0.07_06';
$VERSION = eval $VERSION;
$DEBUG = 0;
+# return current request_id or generate a new one if not yet set
sub request_id {
my $self = shift;
- my $md5 = Digest::MD5->new();
- $md5->add( $$, time(), rand(time) );
- return $md5->hexdigest();
-}
-
-sub param {
- my $self = shift;
- my @args = @_;
-
- $self->{__PARAM} ||= {};
- my $param = $self->{__PARAM};
-
- if (@args) {
- if ( @args % 2 == 0 ) {
- %$param = ( %$param, @args );
- }
- elsif ( @args == 1 ) {
- my $arg = shift;
- if ( ref($arg) eq "HASH" ) {
- %$param = ( %$param, %$arg );
- return keys %$arg;
- }
- else {
- return $param->{$arg};
- }
- }
- else {
- croak("param: invalid arguments: @_\n");
- }
+ if ( ref($self) ) {
+ $self->{"__request_id"} = shift if (@_); # allow value change/reset
+ $self->{"__request_id"} = $self->_new_request_id()
+ unless ( $self->{"__request_id"} );
+ return $self->{"__request_id"};
}
else {
- return ( keys %$param );
+ return $self->_new_request_id();
}
}
+sub _new_request_id {
+ my $self = shift;
+ my $md5 = Digest::MD5->new();
+ $md5->add( $$, time(), rand(time) );
+ return $md5->hexdigest();
+}
+
sub debug {
my $self = shift;
return ref($self) ? ( $self->{"__DEBUG"} || $DEBUG ) : $DEBUG;
}
-sub cert_path {
- carp( __PACKAGE__ . " cert_path method is deprecated" );
- return undef;
-}
-
-# maybe get rid of build_subs() someday and use param()?
-sub vendor { my $self = shift; return $self->param( "vendor", @_ ); }
-sub partner { my $self = shift; return $self->param( "partner", @_ ); }
-sub order_number {
- my $self = shift;
- return $self->param( "order_number", @_ );
-}
-sub avs_code { my $self = shift; return $self->param( "avs_code", @_ ); }
-sub cvv2_code { my $self = shift; return $self->param( "cvv2_code", @_ ); }
+# cvv2_code: support legacy code and but deprecate method
+sub cvv2_code { shift->cvv2_response(@_); }
sub set_defaults {
my $self = shift;
my %opts = @_;
- $self->server("payflow.verisign.com");
+ # standard B::OP methods/data
+ #$self->server("payflow.verisign.com");
+ $self->server("payflowpro.verisign.com");
$self->port("443");
- $self->path(""); # PayflowPro uses /transaction and /commit
+ $self->path("/transaction");
+
+ $self->build_subs(qw(
+ partner vendor
+ client_certification_id client_timeout
+ headers test_server
+ cert_path
+ order_number avs_code cvv2_response
+ response_page response_code response_headers
+ ));
+
+ # module specific data
if ( $opts{debug} ) {
$self->debug( $opts{debug} );
delete $opts{debug};
}
- $self->param(
- "path_transaction" => "/transaction",
- "path_commit" => "/commit",
- %opts
- );
+
+ # HTTPS Interface Dev Guide: must be set but will be removed in future
+ $self->client_certification_id("ClientCertificationIdNotSet");
+
+ # required: 45 secs recommended by HTTPS Interface Dev Guide
+ $self->client_timeout(45);
+
+ $self->test_server( "pilot-payflowpro.verisign.com" );
}
sub _map_fields {
my $zip = $content{'zip'};
$zip =~ s/[^[:alnum:]]//g;
- $self->server('pilot-payflowpro.verisign.com') if $self->test_transaction;
+ $self->server( $self->test_server ) if $self->test_transaction;
my $vendor = $self->vendor;
my $partner = $self->partner;
+
$self->_revmap_fields(
# BUG?: VENDOR B::OP:PayflowPro < 0.05 backward compatibility. If
)
);
- # get header data, get request_id from %content if defined for ease of use
- my %req_headers = %{ $self->param("headers") || {} };
+ # get header data
+ my %req_headers = %{ $self->headers || {} };
+
+ # get request_id from %content if defined for ease of use
if ( defined $content{"request_id"} ) {
- $req_headers{"X-VPS-REQUEST-ID"} = $content{"request_id"};
+ $self->request_id( $content{"request_id"} );
+ }
+
+ unless ( defined( $req_headers{"X-VPS-Request-ID"} ) ) {
+ $req_headers{"X-VPS-Request-ID"} = $self->request_id();
}
- unless ( defined( $req_headers{"X-VPS-REQUEST-ID"} ) ) {
- $req_headers{"X-VPS-REQUEST-ID"} = $self->request_id();
+
+ unless ( defined( $req_headers{"X-VPS-VIT-Client-Certification-Id"} ) ) {
+ $req_headers{"X-VPS-VIT-Client-Certification-Id"} =
+ $self->client_certification_id;
+ }
+
+ unless ( defined( $req_headers{"X-VPS-Client-Timeout"} ) ) {
+ $req_headers{"X-VPS-Client-Timeout"} = $self->client_timeout();
}
my %options = (
"headers" => \%req_headers,
);
- $self->path( $self->param("path_transaction") );
- my ( $tpage, $tresp, %tresp_headers ) =
+ my ( $page, $resp, %resp_headers ) =
$self->https_post( \%options, \%params );
- $self->param(
- "transaction_response" => {
- page => $tpage,
- response => $tresp,
- headers => \%tresp_headers,
- },
- );
-
- # $tpage should contain name=value[[&name=value]...] pairs
- my $cgi = CGI->new("$tpage");
+ $self->response_code( $resp );
+ $self->response_page( $page );
+ $self->response_headers( \%resp_headers );
- if ( $cgi->param("RESULT") eq "0" ) {
- my $response_id = $tresp_headers{"X-VPS-RESPONSE-ID"};
- $options{headers}->{"X-VPS-RESPONSE-ID"} = $response_id;
- $self->path( $self->param("path_commit") );
- my ( $cpage, $cresp, %cresp_headers ) =
- $self->https_post( \%options, \%params );
- $self->param(
- "commit_response" => {
- page => $cpage,
- response => $cresp,
- headers => \%cresp_headers,
- },
- );
- my $comcgi = CGI->new("$cpage");
-
- # merge commit results with transaction
- foreach my $p ( $comcgi->param() ) {
- $cgi->param( $p => $comcgi->param($p) );
- }
- }
+ # $page should contain name=value[[&name=value]...] pairs
+ my $cgi = CGI->new("$page");
# AVS and CVS values may be set on success or failure
my $avs_code;
}
$self->avs_code($avs_code);
- $self->cvv2_code( $cgi->param("CVV2MATCH") );
+ $self->cvv2_response( $cgi->param("CVV2MATCH") );
$self->result_code( $cgi->param("RESULT") );
$self->order_number( $cgi->param("PNREF") );
$self->error_message( $cgi->param("RESPMSG") );
my $tx = new Business::OnlinePayment(
'PayflowPro',
- 'vendor' => 'your_vendor',
- 'partner' => 'your_partner',
+ 'vendor' => 'your_vendor',
+ 'partner' => 'your_partner',
+ 'client_certification_id' => 'GuidUpTo32Chars',
);
# See the module documentation for details of content()
expiration => '12/09',
cvv2 => '123',
order_number => 'string',
+ request_id => 'unique_identifier_for_transaction',
);
$tx->submit();
print(
"Card processed successfully: ", $tx->authorization, "\n",
"order number: ", $tx->order_number, "\n",
- "CVV2 code: ", $tx->cvv2_code, "\n",
+ "CVV2 response: ", $tx->cvv2_response, "\n",
"AVS code: ", $tx->avs_code, "\n",
);
}
=item set_defaults()
-This method sets the 'server' attribute to 'payflow.verisign.com' and
-the port attribute to '443'. This method also sets up the
+This method sets the 'server' attribute to 'payflowpro.verisign.com'
+and the port attribute to '443'. This method also sets up the
L</Module specific methods> described below.
=item submit()
=back
+=head1 Unofficial methods
+
+This module provides the following methods which are not officially
+part of the standard Business::OnlinePayment interface (as of 3.00_06)
+but are nevertheless supported by multiple gateways modules and
+expected to be standardized soon:
+
+=over 4
+
+=item L<order_number()|/order_number()>
+
+=item L<avs_code()|/avs_code()>
+
+=item L<cvv2_response()|/cvv2_response()>
+
+=back
+
=head1 Module specific methods
This module provides the following methods which are not currently
part of the standard Business::OnlinePayment interface:
-=over 4
+=head2 client_certification_id()
-=item vendor()
+This gets/sets the X-VPS-VITCLIENTCERTIFICATION-ID which is REQUIRED
+and defaults to "ClientCertificationIdNotSet". This is described in
+Website Payments Pro HTTPS Interface Developer's Guide as follows:
-=item partner()
+"A random globally unique identifier (GUID) that is currently
+required. This requirement will be removed in the future. At this
+time, you can send any alpha-numeric ID up to 32 characters in length.
-=item L<order_number()|/order_number()>
+NOTE: Once you have created this ID, do not change it. Use the same ID
+for every transaction."
-=item L<avs_code()|/avs_code()>
+=head2 client_timeout()
-=item L<cvv2_code()|/cvv2_code()>
+Timeout value, in seconds, after which this transaction should be
+aborted. Defaults to 45, the value recommended by the Website
+Payments Pro HTTPS Interface Developer's Guide.
-=item L<expdate_mmyy()|/expdate_mmyy()>
+=head2 debug()
-=item L<requeset_id()/request_id()>
+Enable or disble debugging. The value specified here will also set
+$Business::OnlinePayment::HTTPS::DEBUG in submit() to aid in
+troubleshooting problems.
-=item L<param()|/param()>
+=head2 expdate_mmyy()
-=item L<debug()|/debug()>
+The expdate_mmyy() method takes a single scalar argument (typically
+the value in $content{expiration}) and attempts to parse and format
+and put the date in MMYY format as required by PayflowPro
+specification. If unable to parse the expiration date simply leave it
+as is and let the PayflowPro system attempt to handle it as-is.
+
+=head2 request_id()
+
+It is recommended that you specify your own unique request_id for each
+transaction in %content. A request_id is REQUIRED by the PayflowPro
+processor. If a request_id is not set, then Digest::MD5 is used to
+attempt to generate a request_id for a transaction.
+
+=head2 Deprecated methods
+
+The following methods are deprecated and may be removed in a future
+release. Values for vendor and partner should now be set as arguments
+to Business::OnlinePayment->new(). The value for cert_path was used
+to support passing a path to PFProAPI.pm (a Perl module/SDK from
+Verisign/Paypal) which is no longer used.
+
+=over 4
+
+=item vendor()
+
+=item partner()
=item cert_path()
-This method is deprecated and will be removed in the next release.
-This method was used to support passing a path to PFProAPI.pm (a Perl
-module/SDK from Verisign/Paypal) which is no longer used.
+=item cvv2_code()
=back
=item server
-payflow.verisign.com or test-payflow.verisign.com if
+payflowpro.verisign.com or pilot-payflowpro.verisign.com if
test_transaction() is TRUE
=item port
N - no match
undef - AVS values not available
-=head2 cvv2_code()
+=head2 cvv2_response()
-The cvv2_code() method returns the CVV2MATCH field, which is a
+The cvv2_response() method returns the CVV2MATCH field, which is a
response message returned with the transaction result.
-=head2 expdate_mmyy()
-
-The expdate_mmyy() method takes a single scalar argument (typically
-the value in $content{expiration}) and attempts to parse and format
-and put the date in MMYY format as required by PayflowPro
-specification. If unable to parse the expiration date simply leave it
-as is and let the PayflowPro system attempt to handle it as-is.
-
-=head2 request_id()
-
-The request_id() method uses Digest::MD5 to attempt to generate a
-request_id for a transaction. It is recommended that you specify your
-own unique request_id for each transaction in %content. A request_id
-is REQUIRED by the PayflowPro processor.
-
-=head2 param()
-
-The param() method is used to get/set object parameters. The param()
-method may be called in several different ways:
-
-Get the value of 'myparam':
-
- my $value_or_reference = $self->param('myparam');
-
-Get a list of all parameters that exist:
-
- my @params = $self->param();
-
-Set multiple parameters at the same time:
-
- $self->param(
- 'key1' => 'val1',
- 'key2' => 'val2',
- );
-
-=head2 debug()
-
-Enable or disble debugging. The value specified here will also set
-$Business::OnlinePayment::HTTPS::DEBUG in submit() to aid in
-troubleshooting problems.
-
=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.
+As of 0.07, this module communicates with the Payflow gateway directly
+and no longer requires the Payflow Pro SDK or other download. Thanks
+to Phil Lobbes for this great work.
=head1 AUTHORS
projects / Business-OnlinePayment-PayflowPro.git / blobdiff