Added documentation about referrer field at Authorize.Net
[Business-OnlinePayment-AuthorizeNet.git] / AuthorizeNet.pm
index c48808e..40c01d9 100644 (file)
@@ -1,10 +1,11 @@
 package Business::OnlinePayment::AuthorizeNet;
 
-# $Id: AuthorizeNet.pm,v 1.3 2002-02-12 23:27:38 ivan Exp $
+# $Id: AuthorizeNet.pm,v 1.14 2002-08-16 06:53:28 ivan Exp $
 
 use strict;
+use Carp;
 use Business::OnlinePayment;
-use Net::SSLeay qw/make_form post_https/;
+use Net::SSLeay qw/make_form post_https make_headers/;
 use Text::CSV_XS;
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
 
@@ -13,7 +14,7 @@ require Exporter;
 @ISA = qw(Exporter AutoLoader Business::OnlinePayment);
 @EXPORT = qw();
 @EXPORT_OK = qw();
-$VERSION = '3.01';
+$VERSION = '3.12';
 
 sub set_defaults {
     my $self = shift;
@@ -21,6 +22,8 @@ sub set_defaults {
     $self->server('secure.authorize.net');
     $self->port('443');
     $self->path('/gateway/transact.dll');
+
+    $self->build_subs('order_number'); #no idea how it worked for jason w/o this
 }
 
 sub map_fields {
@@ -46,6 +49,10 @@ sub map_fields {
     $content{'type'} = $types{lc($content{'type'})} || $content{'type'};
     $self->transaction_type($content{'type'});
 
+    $content{'referer'} = defined( $content{'referer'} )
+                            ? make_headers( 'Referer' => $content{'referer'} )
+                            : "";
+
     # stuff it back into %content
     $self->content(%content);
 }
@@ -98,6 +105,9 @@ sub submit {
         fax            => 'x_Fax',
         email          => 'x_Email',
         company        => 'x_Company',
+       order_number   => 'x_Trans_ID',
+       cvv2           => 'x_Card_Code',
+       currency       => 'x_Currency_Code',
     );
 
     if($self->transaction_type() eq "ECHECK") {
@@ -105,8 +115,13 @@ sub submit {
                                   first_name account_number routing_code
                                   bank_name/);
     } elsif($self->transaction_type() eq 'CC' ) {
+      if ( $self->{_content}->{action} eq 'PRIOR_AUTH_CAPTURE' ) {
+        $self->required_fields(qw/type login password action amount
+                                  card_number expiration/);
+      } else {
         $self->required_fields(qw/type login password action amount last_name
                                   first_name card_number expiration/);
+      }
     } else {
         Carp::croak("AuthorizeNet can't handle transaction type: ".
                     $self->transaction_type());
@@ -120,17 +135,21 @@ sub submit {
                                          x_Last_Name x_First_Name x_Address
                                          x_City x_State x_Zip x_Country x_Phone
                                          x_Fax x_Email x_Email_Customer
-                                         x_Company x_Country/); 
+                                         x_Company x_Country x_Trans_ID
+                                         x_Card_Code /); 
     $post_data{'x_Test_Request'} = $self->test_transaction()?"TRUE":"FALSE";
     $post_data{'x_ADC_Delim_Data'} = 'TRUE';
     $post_data{'x_ADC_URL'} = 'FALSE';
-    $post_data{'x_Version'} = '3.0';
+    $post_data{'x_Version'} = '3.1';
 
     my $pd = make_form(%post_data);
     my $s = $self->server();
     my $p = $self->port();
     my $t = $self->path();
-    my($page,$server_response,%headers) = post_https($s,$p,$t,'',$pd);
+    my $r = $self->{_content}->{referer};
+    my($page,$server_response,%headers) = post_https($s,$p,$t,$r,$pd);
+    #escape NULL (binary 0x00) values
+    $page =~ s/\x00/\^0/g;
 
     my $csv = new Text::CSV_XS();
     $csv->parse($page);
@@ -141,10 +160,21 @@ sub submit {
         $self->is_success(1);
         $self->result_code($col[0]);
         $self->authorization($col[4]);
+       $self->order_number($col[6]);
     } else {
         $self->is_success(0);
         $self->result_code($col[2]);
         $self->error_message($col[3]);
+        unless ( $self->result_code() ) { #additional logging information
+          #$page =~ s/\x00/\^0/g;
+          $self->error_message($col[3].
+            " DEBUG: No x_response_code from server, ".
+            "(HTTPS response: $server_response) ".
+            "(HTTPS headers: ".
+              join(", ", map { "$_ => ". $headers{$_} } keys %headers ). ") ".
+            "(Raw HTTPS content: $page)"
+          );
+        }
     }
 }
 
@@ -176,7 +206,9 @@ Business::OnlinePayment::AuthorizeNet - AuthorizeNet backend for Business::Onlin
       state          => 'UT',
       zip            => '84058',
       card_number    => '4007000000027',
-      expiration     => '09/99',
+      expiration     => '09/02',
+      cvv2           => '1234', #optional
+      referer        => 'http://valid.referer.url/',
   );
   $tx->submit();
 
@@ -202,20 +234,52 @@ For detailed information see L<Business::OnlinePayment>.
 
 =head1 NOTE
 
-Unlike Business::OnlinePayment or previous verisons of
-Business::OnlinePayment::AuthorizeNet, 3.0 requires separate first_name and
+Unlike Business::OnlinePayment or pre-3.0 verisons of
+Business::OnlinePayment::AuthorizeNet, 3.1 requires separate first_name and
 last_name fields.
 
+Business::OnlinePayment::AuthorizeNet uses the ADC direct response method,
+and sends a username and password with every transaction.  Therefore,
+Authorize.Net's referrer "security" is not necessary.  In your Authorize.Net
+interface at https://secure.authorize.net/ make sure the list of allowable
+referers is blank.  Alternatively, set the B<referer> field in the transaction
+content.
+
+To settle an authorization-only transaction (where you set action to
+'Authorization Only'), submit the nine-digit transaction id code in
+the field "order_number" with the action set to "Post Authorization".
+You can get the transaction id from the authorization by calling the
+order_number method on the object returned from the authorization.
+You must also submit the amount field with a value less than or equal
+to the amount specified in the original authorization.
+
+Recently (February 2002), Authorize.Net has turned address
+verification on by default for all merchants.  If you do not have
+valid address information for your customer (such as in an IVR
+application), you must disable address verification in the Merchant
+Menu page at https://secure.authorize.net/ so that the transactions
+aren't denied due to a lack of address information.
+
 =head1 COMPATIBILITY
 
-This module implements Authorize.Net's API verison 3.0.
+This module implements Authorize.Net's API verison 3.1 using the ADC
+Direct Response method.  See
+https://secure.authorize.net/docs/developersguide.pml for details.
 
 =head1 AUTHOR
 
 Jason Kohles, jason@mediabang.com
 
 Ivan Kohler <ivan-authorizenet@420.am> updated it for Authorize.Net protocol
-3.0 and is the current maintainer.
+3.0/3.1 and is the current maintainer.
+
+Jason Spence <jspence@lightconsulting.com> contributed support for separate
+Authorization Only and Post Authorization steps and wrote some docs.
+OST <services@ostel.com> paid for it.
+
+T.J. Mather <tjmather@maxmind.com> sent a patch for the CVV2 field.
+
+Mike Barry <mbarry@cos.com> sent in a patch for the referer field.
 
 =head1 SEE ALSO