.\" 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. \*(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- .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 "viaKLIX 3pm" .TH viaKLIX 3pm "2007-09-26" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Business::OnlinePayment::viaKLIX \- viaKLIX backend for Business::OnlinePayment .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Business::OnlinePayment; .Ve .PP .Vb 3 \& my $tx = new Business::OnlinePayment( \& \(aqviaKLIX\(aq, \(aqdefault_ssl_user_id\(aq => \(aqwebuser\(aq, \& ); .Ve .PP .Vb 19 \& # See the module documentation for details of content() \& $tx\->content( \& type => \(aqCC\(aq, \& action => \(aqNormal Authorization\(aq, \& description => \(aqBusiness::OnlinePayment::viaKLIX test\(aq, \& amount => \(aq49.95\(aq, \& invoice_number => \(aq100100\(aq, \& customer_id => \(aqjef\(aq, \& name => \(aqJeff Finucane\(aq, \& address => \(aq123 Anystreet\(aq, \& city => \(aqAnywhere\(aq, \& state => \(aqGA\(aq, \& zip => \(aq30004\(aq, \& email => \(aqviaklix@weasellips.com\(aq, \& card_number => \(aq4111111111111111\(aq, \& expiration => \(aq12/09\(aq, \& cvv2 => \(aq123\(aq, \& order_number => \(aqstring\(aq, \& ); .Ve .PP .Vb 1 \& $tx\->submit(); .Ve .PP .Vb 14 \& if ( $tx\->is_success() ) { \& print( \& "Card processed successfully: ", $tx\->authorization, "\en", \& "order number: ", $tx\->order_number, "\en", \& "CVV2 response: ", $tx\->cvv2_response, "\en", \& "AVS code: ", $tx\->avs_code, "\en", \& ); \& } \& else { \& print( \& "Card was rejected: ", $tx\->error_message, "\en", \& "order number: ", $tx\->order_number, "\en", \& ); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is a back end driver that implements the interface specified by Business::OnlinePayment to support payment handling via viaKLIX's Internet payment solution. .PP See Business::OnlinePayment for details on the interface this modules supports. .SH "Standard methods" .IX Header "Standard methods" .IP "\fIset_defaults()\fR" 4 .IX Item "set_defaults()" This method sets the 'server' attribute to 'www.viaklix.com' and the port attribute to '443'. This method also sets up the \&\*(L"Module specific methods\*(R" described below. .IP "\fIsubmit()\fR" 4 .IX Item "submit()" .SH "Unofficial methods" .IX Header "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: .IP "\fIorder_number()\fR" 4 .IX Item "order_number()" .PD 0 .IP "\fIavs_code()\fR" 4 .IX Item "avs_code()" .IP "\fIcvv2_response()\fR" 4 .IX Item "cvv2_response()" .PD .SH "Module specific methods" .IX Header "Module specific methods" This module provides the following methods which are not currently part of the standard Business::OnlinePayment interface: .IP "\fIexpdate_mmyy()\fR" 4 .IX Item "expdate_mmyy()" .PD 0 .IP "\fIdebug()\fR" 4 .IX Item "debug()" .PD .SH "Settings" .IX Header "Settings" The following default settings exist: .IP "server" 4 .IX Item "server" www.viaklix.com .IP "port" 4 .IX Item "port" 443 .IP "path" 4 .IX Item "path" /process.asp .SH "Parameters passed to constructor" .IX Header "Parameters passed to constructor" If any of the key/value pairs passed to the constructor have a key beginning with \*(L"default_\*(R" then those values are passed to viaKLIX as a the corresponding form field (without the \*(L"default_\*(R") whenever content(%content) lacks that key. .SH "Handling of content(%content)" .IX Header "Handling of content(%content)" The following rules apply to content(%content) data: .Sh "type" .IX Subsection "type" If 'type' matches one of the following keys it is replaced by the right hand side value: .PP .Vb 4 \& \(aqvisa\(aq => \(aqCC\(aq, \& \(aqmastercard\(aq => \(aqCC\(aq, \& \(aqamerican express\(aq => \(aqCC\(aq, \& \(aqdiscover\(aq => \(aqCC\(aq, .Ve .PP The value of 'type' is used to set \fItransaction_type()\fR. Currently this module only supports the above values. .SH "Setting viaKLIX parameters from content(%content)" .IX Header "Setting viaKLIX parameters from content(%content)" The following rules are applied to map data to viaKLIX parameters from content(%content): .PP .Vb 3 \& # viaKLIX param => $content{} \& ssl_merchant_id => \(aqlogin\(aq, \& ssl_pin => \(aqpassword\(aq, .Ve .PP .Vb 8 \& ssl_amount => \(aqamount\(aq, \& ssl_card_number => \(aqcard_number\(aq, \& ssl_exp_date => \e( $month.$year ), # MM/YY from \(aqexpiration\(aq \& ssl_cvv2 => \(aqpresent\(aq whenever cvv2 data is provided \& ssl_cvv2cvc2 => \(aqcvv2\(aq, \& ssl_description => \(aqdescription\(aq, \& ssl_invoice_number=> \(aqinvoice_number\(aq, \& ssl_customer_code => \(aqcustomer_id\(aq, .Ve .PP .Vb 9 \& ssl_first_name => \(aqfirst_name\(aq, \& ssl_last_name => \(aqlast_name\(aq, \& ssl_avs_address => \(aqaddress\(aq, \& ssl_city => \(aqcity\(aq, \& ssl_state => \(aqstate\(aq, \& ssl_zip => \e$zip, # \(aqzip\(aq with non\-alphanumerics removed \& ssl_country => \(aqcountry\(aq, \& ssl_phone => \(aqphone\(aq, \& ssl_email => \(aqemail\(aq, .Ve .PP .Vb 2 \& CardHolderName => \(aqname\(aq, \& CustomerName => \(aqaccount_name\(aq, .Ve .SH "Mapping viaKLIX transaction responses to object methods" .IX Header "Mapping viaKLIX transaction responses to object methods" The following methods provides access to the transaction response data resulting from a viaKLIX request (after \fIsubmit()\fR) is called: .Sh "\fIorder_number()\fP" .IX Subsection "order_number()" This \fIorder_number()\fR method returns the ssl_txn_id field for card transactions to uniquely identify the transaction. .Sh "\fIresult_code()\fP" .IX Subsection "result_code()" The \fIresult_code()\fR method returns the ssl_result field for card transactions. It is the numeric return code indicating the outcome of the attempted transaction. .Sh "\fIerror_message()\fP" .IX Subsection "error_message()" The \fIerror_message()\fR method returns the ssl_result_message field for transactions. This provides more details about the transaction result. .Sh "\fIauthorization()\fP" .IX Subsection "authorization()" The \fIauthorization()\fR method returns the ssl_approval_code field, which is the approval code obtained from the card processing network. .Sh "\fIavs_code()\fP" .IX Subsection "avs_code()" The \fIavs_code()\fR method returns the ssl_avs_response field from the transaction result. .Sh "\fIcvv2_response()\fP" .IX Subsection "cvv2_response()" The \fIcvv2_response()\fR method returns the ssl_cvvw_response field, which is a response message returned with the transaction result. .Sh "\fIexpdate_mmyy()\fP" .IX Subsection "expdate_mmyy()" The \fIexpdate_mmyy()\fR method takes a single scalar argument (typically the value in \f(CW$content\fR{expiration}) and attempts to parse and format and put the date in \s-1MMYY\s0 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. .Sh "\fIdebug()\fP" .IX Subsection "debug()" Enable or disble debugging. The value specified here will also set \&\f(CW$Business::OnlinePayment::HTTPS::DEBUG\fR in \fIsubmit()\fR to aid in troubleshooting problems. .SH "COMPATIBILITY" .IX Header "COMPATIBILITY" This module implements an interface to the viaKLIX \s-1API\s0 version 2.0 .SH "AUTHORS" .IX Header "AUTHORS" Jeff Finucane .PP Based on Business::OnlinePayment::PayflowPro written by Ivan Kohler and Phil Lobbes. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIperl\fR\|(1), Business::OnlinePayment, Carp, and the Developer Guide to the viaKLIX Virtual Terminal.