File: //usr/local/share/man/man3/Business::OnlinePayment::AuthorizeNet.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AuthorizeNet 3"
.TH AuthorizeNet 3 "2010-12-19" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Business::OnlinePayment::AuthorizeNet \- AuthorizeNet backend for Business::OnlinePayment
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Business::OnlinePayment;
.Ve
.PP
.Vb 3
\& ####
\& # One step transaction, the simple case.
\& ####
.Ve
.PP
.Vb 22
\& my $tx = new Business::OnlinePayment("AuthorizeNet");
\& $tx->content(
\& type => 'VISA',
\& login => 'testdrive',
\& password => '', #password or transaction key
\& action => 'Normal Authorization',
\& description => 'Business::OnlinePayment test',
\& amount => '49.95',
\& invoice_number => '100100',
\& customer_id => 'jsk',
\& first_name => 'Jason',
\& last_name => 'Kohles',
\& address => '123 Anystreet',
\& city => 'Anywhere',
\& state => 'UT',
\& zip => '84058',
\& card_number => '4007000000027',
\& expiration => '09/02',
\& cvv2 => '1234', #optional
\& referer => 'http://valid.referer.url/',
\& );
\& $tx->submit();
.Ve
.PP
.Vb 5
\& if($tx->is_success()) {
\& print "Card processed successfully: ".$tx->authorization."\en";
\& } else {
\& print "Card was rejected: ".$tx->error_message."\en";
\& }
.Ve
.PP
.Vb 5
\& ####
\& # Two step transaction, authorization and capture.
\& # If you don't need to review order before capture, you can
\& # process in one step as above.
\& ####
.Ve
.PP
.Vb 22
\& my $tx = new Business::OnlinePayment("AuthorizeNet");
\& $tx->content(
\& type => 'VISA',
\& login => 'testdrive',
\& password => '', #password or transaction key
\& action => 'Authorization Only',
\& description => 'Business::OnlinePayment test',
\& amount => '49.95',
\& invoice_number => '100100',
\& customer_id => 'jsk',
\& first_name => 'Jason',
\& last_name => 'Kohles',
\& address => '123 Anystreet',
\& city => 'Anywhere',
\& state => 'UT',
\& zip => '84058',
\& card_number => '4007000000027',
\& expiration => '09/02',
\& cvv2 => '1234', #optional
\& referer => 'http://valid.referer.url/',
\& );
\& $tx->submit();
.Ve
.PP
.Vb 9
\& if($tx->is_success()) {
\& # get information about authorization
\& $authorization = $tx->authorization
\& $ordernum = $tx->order_number;
\& $avs_code = $tx->avs_code; # AVS Response Code
\& $cvv2_response = $tx->cvv2_response; # CVV2/CVC2/CID Response Code
\& $cavv_response = $tx->cavv_response; # Cardholder Authentication
\& # Verification Value (CAVV) Response
\& # Code
.Ve
.PP
.Vb 2
\& # now capture transaction
\& my $capture = new Business::OnlinePayment("AuthorizeNet");
.Ve
.PP
.Vb 8
\& $capture->content(
\& type => 'CC',
\& action => 'Post Authorization',
\& login => 'YOURLOGIN
\& password => 'YOURPASSWORD', #or transaction key
\& order_number => $ordernum,
\& amount => '49.95',
\& );
.Ve
.PP
.Vb 1
\& $capture->submit();
.Ve
.PP
.Vb 5
\& if($capture->is_success()) {
\& print "Card captured successfully: ".$capture->authorization."\en";
\& } else {
\& print "Card was rejected: ".$capture->error_message."\en";
\& }
.Ve
.PP
.Vb 3
\& } else {
\& print "Card was rejected: ".$tx->error_message."\en";
\& }
.Ve
.PP
.Vb 3
\& ####
\& # One step subscription, the simple case.
\& ####
.Ve
.PP
.Vb 25
\& my $tx = new Business::OnlinePayment("AuthorizeNet::ARB");
\& $tx->content(
\& type => 'CC',
\& login => 'testdrive',
\& password => 'testpass', #or transaction key
\& action => 'Recurring Authorization',
\& interval => '7 days',
\& start => '2008-3-10',
\& periods => '16',
\& amount => '99.95',
\& trialperiods => '4',
\& trialamount => '0',
\& description => 'Business::OnlinePayment test',
\& invoice_number => '1153B33F',
\& customer_id => 'vip',
\& first_name => 'Tofu',
\& last_name => 'Beast',
\& address => '123 Anystreet',
\& city => 'Anywhere',
\& state => 'GA',
\& zip => '84058',
\& card_number => '4111111111111111',
\& expiration => '09/02',
\& );
\& $tx->submit();
.Ve
.PP
.Vb 6
\& if($tx->is_success()) {
\& print "Card processed successfully: ".$tx->order_number."\en";
\& } else {
\& print "Card was rejected: ".$tx->error_message."\en";
\& }
\& my $subscription = $tx->order_number
.Ve
.PP
.Vb 3
\& ####
\& # Subscription change. Modestly more complicated.
\& ####
.Ve
.PP
.Vb 25
\& $tx->content(
\& type => 'CC',
\& subscription => '99W2C',
\& login => 'testdrive',
\& password => 'testpass', #or transaction key
\& action => 'Modify Recurring Authorization',
\& interval => '7 days',
\& start => '2008-3-10',
\& periods => '16',
\& amount => '29.95',
\& trialperiods => '4',
\& trialamount => '0',
\& description => 'Business::OnlinePayment test',
\& invoice_number => '1153B340',
\& customer_id => 'vip',
\& first_name => 'Tofu',
\& last_name => 'Beast',
\& address => '123 Anystreet',
\& city => 'Anywhere',
\& state => 'GA',
\& zip => '84058',
\& card_number => '4111111111111111',
\& expiration => '09/02',
\& );
\& $tx->submit();
.Ve
.PP
.Vb 12
\& if($tx->is_success()) {
\& print "Update processed successfully."\en";
\& } else {
\& print "Update was rejected: ".$tx->error_message."\en";
\& }
\& $tx->content(
\& subscription => '99W2D',
\& login => 'testdrive',
\& password => 'testpass', # or transaction key
\& action => 'Cancel Recurring Authorization',
\& );
\& $tx->submit();
.Ve
.PP
.Vb 3
\& ####
\& # Subscription cancellation. It happens.
\& ####
.Ve
.PP
.Vb 5
\& if($tx->is_success()) {
\& print "Cancellation processed successfully."\en";
\& } else {
\& print "Cancellation was rejected: ".$tx->error_message."\en";
\& }
.Ve
.SH "SUPPORTED TRANSACTION TYPES"
.IX Header "SUPPORTED TRANSACTION TYPES"
.Sh "\s-1CC\s0, Visa, MasterCard, American Express, Discover"
.IX Subsection "CC, Visa, MasterCard, American Express, Discover"
Content required: type, login, password, action, amount, first_name, last_name, card_number, expiration.
.Sh "Check"
.IX Subsection "Check"
Content required: type, login, password, action, amount, first_name, last_name, account_number, routing_code, bank_name (non\-subscription), account_type (subscription), check_type (subscription).
.Sh "Subscriptions"
.IX Subsection "Subscriptions"
Additional content required: interval, start, periods.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
For detailed information see Business::OnlinePayment.
.SH "METHODS AND FUNCTIONS"
.IX Header "METHODS AND FUNCTIONS"
See Business::OnlinePayment for the complete list. The following methods either override the methods in Business::OnlinePayment or provide additional functions.
.Sh "result_code"
.IX Subsection "result_code"
Returns the response reason code (from the message.code field for subscriptions).
.Sh "error_message"
.IX Subsection "error_message"
Returns the response reason text (from the message.text field for subscriptions.
.Sh "server_response"
.IX Subsection "server_response"
Returns the complete response from the server.
.SH "Handling of content(%content) data:"
.IX Header "Handling of content(%content) data:"
.Sh "action"
.IX Subsection "action"
The following actions are valid
.PP
.Vb 8
\& normal authorization
\& authorization only
\& credit
\& post authorization
\& void
\& recurring authorization
\& modify recurring authorization
\& cancel recurring authorization
.Ve
.Sh "interval"
.IX Subsection "interval"
.Vb 1
\& Interval contains a number of digits, whitespace, and the units of days or months in either singular or plural form.
.Ve
.SH "Setting AuthorizeNet ARB parameters from content(%content)"
.IX Header "Setting AuthorizeNet ARB parameters from content(%content)"
The following rules are applied to map data to AuthorizeNet \s-1ARB\s0 parameters
from content(%content):
.PP
.Vb 56
\& # ARB param => $content{<key>}
\& merchantAuthentication
\& name => 'login',
\& transactionKey => 'password',
\& subscription
\& paymentSchedule
\& interval
\& length => \e( the digits in 'interval' ),
\& unit => \e( days or months gleaned from 'interval' ), startDate => 'start',
\& totalOccurrences => 'periods',
\& trialOccurrences => 'trialperiods',
\& amount => 'amount',
\& trialAmount => 'trialamount',
\& payment
\& creditCard
\& cardNumber => 'card_number',
\& expiration => \e( $year.'-'.$month ), # YYYY-MM from 'expiration'
\& bankAccount
\& accountType => 'account_type',
\& routingNumber => 'routing_code',
\& accountNumber => 'account_number,
\& nameOnAccount => 'name',
\& bankName => 'bank_name',
\& echeckType => 'check_type',
\& order
\& invoiceNumber => 'invoice_number',
\& description => 'description',
\& customer
\& type => 'customer_org',
\& id => 'customer_id',
\& email => 'email',
\& phoneNumber => 'phone',
\& faxNumber => 'fax',
\& driversLicense
\& number => 'license_num',
\& state => 'license_state',
\& dateOfBirth => 'license_dob',
\& taxid => 'customer_ssn',
\& billTo
\& firstName => 'first_name',
\& lastName => 'last_name',
\& company => 'company',
\& address => 'address',
\& city => 'city',
\& state => 'state',
\& zip => 'zip',
\& country => 'country',
\& shipTo
\& firstName => 'ship_first_name',
\& lastName => 'ship_last_name',
\& company => 'ship_company',
\& address => 'ship_address',
\& city => 'ship_city',
\& state => 'ship_state',
\& zip => 'ship_zip',
\& country => 'ship_country',
.Ve
.SH "NOTES"
.IX Header "NOTES"
Use your transaction key in the password field.
.PP
Unlike Business::OnlinePayment or pre\-3.0 verisons of
Business::OnlinePayment::AuthorizeNet, 3.1 requires separate first_name and
last_name fields.
.PP
Business::OnlinePayment::AuthorizeNet uses Authorize.Net's \*(L"Advanced
Integration Method (\s-1AIM\s0) (formerly known as \s-1ADC\s0 direct response)\*(R" and
\&\*(L"Automatic Recurring Billing (\s-1ARB\s0)\*(R", sending a username and password (or
transaction key as password) with every transaction. Therefore,
Authorize.Net's referrer \*(L"security\*(R" 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 \fBreferer\fR field in the transaction
content.
.PP
To settle an authorization-only transaction (where you set action to
\&'Authorization Only'), submit the nine-digit transaction id code in
the field \*(L"order_number\*(R" with the action set to \*(L"Post Authorization\*(R".
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.
.PP
For the subscription actions an authorization code is never returned by
the module. Instead it returns the value of subscriptionId in order_number.
This is the value to use for changing or cancelling subscriptions.
.PP
Authorize.Net has turned address verification on by default for all merchants
since 2002. If you do not have valid address information for your customer
(such as in an \s-1IVR\s0 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.
.SH "COMPATIBILITY"
.IX Header "COMPATIBILITY"
This module implements Authorize.Net's \s-1API\s0 using the Advanced Integration
Method (\s-1AIM\s0) version 3.1, formerly known as \s-1ADC\s0 Direct Response and the
Automatic Recurring Billing version 1.0 using the \s-1XML\s0 interface. See
http://www.authorize.net/support/AIM_guide.pdf and http://www.authorize.net/support/ARB_guide.pdf for details.
.SH "AUTHORS"
.IX Header "AUTHORS"
Original author: Jason Kohles, jason@mediabang.com
.PP
Ivan Kohler <ivan\-authorizenet@freeside.biz> updated it for Authorize.Net
protocol 3.0/3.1 and is the current maintainer. Please see the next section
for for information on contributing.
.PP
Jason Spence <jspence@lightconsulting.com> contributed support for separate
Authorization Only and Post Authorization steps and wrote some docs.
\&\s-1OST\s0 <services@ostel.com> paid for it.
.PP
Jeff Finucane <authorizenetarb@weasellips.com> added the \s-1ARB\s0 support.
\&\s-1ARB\s0 support sponsored by Plus Three, \s-1LP\s0. <http://www.plusthree.com>.
.PP
T.J. Mather <tjmather@maxmind.com> sent a number of \s-1CVV2\s0 patches.
.PP
Mike Barry <mbarry@cos.com> sent in a patch for the referer field and a fix for
ship_company.
.PP
Yuri V. Mkrtumyan <yuramk@novosoft.ru> sent in a patch to add the void action.
.PP
Paul Zimmer <AuthorizeNetpm@pzimmer.box.bepress.com> sent in a patch for
card-less post authorizations.
.PP
Daemmon Hughes <daemmon@daemmonhughes.com> sent in a patch for \*(L"transaction
key\*(R" authentication as well support for the recurring_billing flag and the md5
method that returns the \s-1MD5\s0 hash which is returned by the gateway.
.PP
Steve Simitzis contributed a patch for better compatibility with
eProcessingNetwork's AuthorizeNet compatability mode.
.PP
Michael G. Schwern contributed cleanups, test fixes, and more.
.PP
Erik Hollensbe implemented card-present data (track1/track2), the
duplicate_window parameter, and test fixes.
.PP
Paul Timmins added the check_number field.
.PP
Nate Nuss implemented the (\*(L"Additional Shipping Information (Level 2 Data)\*(R"
fields: tax, freight, duty, tax_exempt, po_number.
.PP
Michael Peters fixed a bug in email address handling.
.PP
Thomas Sibley <trs@bestpractical.com> wrote B:OP:AuthorizeNet::AIM::ErrorCodes
which was borged and used to provide more descriptive error messages.
.SH "CONTRIBUTIONS AND REPOSITORY"
.IX Header "CONTRIBUTIONS AND REPOSITORY"
Please send patches as unified diffs (diff \-u) to (in order of preference):
.IP "\s-1CPAN\s0 \s-1RT\s0" 4
.IX Item "CPAN RT"
http://rt.cpan.org/Public/Bug/Report.html?Queue=Business\-OnlinePayment\-AuthorizeNet
.IP "The bop-devel mailing list" 4
.IX Item "The bop-devel mailing list"
http://420.am/cgi\-bin/mailman/listinfo/bop\-devel
.IP "Ivan" 4
.IX Item "Ivan"
Ivan Kohler <ivan\-authorizenet@freeside.biz>
.PP
The code is available from our public \s-1CVS\s0 repository:
.PP
.Vb 4
\& export CVSROOT=":pserver:anonymous@cvs.freeside.biz:/home/cvs/cvsroot"
\& cvs login
\& # The password for the user `anonymous' is `anonymous'.
\& cvs checkout Business-OnlinePayment-AuthorizeNet
.Ve
.PP
Or on the web:
.PP
.Vb 1
\& http://freeside.biz/cgi-bin/viewvc.cgi/Business-OnlinePayment-AuthorizeNet/
.Ve
.SH "A WORD FROM OUR SPONSOR"
.IX Header "A WORD FROM OUR SPONSOR"
This module and the Business::OnlinePayment framework are maintained by by
Freeside Internet Services. If you need a complete, open-source web-based
application to manage your customers, billing and trouble ticketing, please
visit http://freeside.biz/
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2010 Freeside Internet Services, Inc.
Copyright 2008 Thomas Sibley
All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1). Business::OnlinePayment.