.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "IPPay 3pm" .TH IPPay 3pm "2022-09-12" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Business::OnlinePayment::IPPay \- IPPay backend for Business::OnlinePayment .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Business::OnlinePayment; \& \& my $tx = \& new Business::OnlinePayment( "IPPay", \& \*(Aqdefault_Origin\*(Aq => \*(AqPHONE ORDER\*(Aq, \& ); \& $tx\->content( \& type => \*(AqVISA\*(Aq, \& login => \*(Aqtestdrive\*(Aq, \& password => \*(Aq\*(Aq, #password \& action => \*(AqNormal Authorization\*(Aq, \& description => \*(AqBusiness::OnlinePayment test\*(Aq, \& amount => \*(Aq49.95\*(Aq, \& customer_id => \*(Aqtfb\*(Aq, \& name => \*(AqTofu Beast\*(Aq, \& address => \*(Aq123 Anystreet\*(Aq, \& city => \*(AqAnywhere\*(Aq, \& state => \*(AqUT\*(Aq, \& zip => \*(Aq84058\*(Aq, \& card_number => \*(Aq4007000000027\*(Aq, \& expiration => \*(Aq09/02\*(Aq, \& cvv2 => \*(Aq1234\*(Aq, #optional \& ); \& $tx\->submit(); \& \& if($tx\->is_success()) { \& print "Card processed successfully: ".$tx\->authorization."\en"; \& } else { \& print "Card was rejected: ".$tx\->error_message."\en"; \& } .Ve .SH "SUPPORTED TRANSACTION TYPES" .IX Header "SUPPORTED TRANSACTION TYPES" .SS "\s-1CC,\s0 Visa, MasterCard, American Express, Discover" .IX Subsection "CC, Visa, MasterCard, American Express, Discover" Content required: type, login, action, amount, card_number, expiration. .SS "Check" .IX Subsection "Check" Content required: type, login, action, amount, name, account_number, routing_code. .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. .SS "result_code" .IX Subsection "result_code" Returns the response error code. .SS "error_message" .IX Subsection "error_message" Returns the response error description text. .SS "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:" .SS "action" .IX Subsection "action" The following actions are valid .PP .Vb 6 \& normal authorization \& authorization only \& reverse authorization \& post authorization \& credit \& void .Ve .SH "Setting IPPay parameters from content(%content)" .IX Header "Setting IPPay parameters from content(%content)" The following rules are applied to map data to IPPay parameters from content(%content): .PP .Vb 10 \& # param => $content{} \& TransactionType => \*(AqTransactionType\*(Aq, \& TerminalID => \*(Aqlogin\*(Aq, \& TransactionID => \*(Aqorder_number\*(Aq, \& RoutingCode => \*(AqRoutingCode\*(Aq, \& Approval => \*(Aqauthorization\*(Aq, \& BatchID => \*(AqBatchID\*(Aq, \& Origin => \*(AqOrigin\*(Aq, \& Password => \*(Aqpassword\*(Aq, \& OrderNumber => \*(Aqinvoice_number\*(Aq, \& CardNum => \*(Aqcard_number\*(Aq, \& CVV2 => \*(Aqcvv2\*(Aq, \& Issue => \*(Aqissue_number\*(Aq, \& CardExpMonth => \e( $month ), # MM from MM(\-)YY(YY) of \*(Aqexpiration\*(Aq \& CardExpYear => \e( $year ), # YY from MM(\-)YY(YY) of \*(Aqexpiration\*(Aq \& CardStartMonth => \e( $month ), # MM from MM(\-)YY(YY) of \*(Aqcard_start\*(Aq \& CardStartYear => \e( $year ), # YY from MM(\-)YY(YY) of \*(Aqcard_start\*(Aq \& Track1 => \*(Aqtrack1\*(Aq, \& Track2 => \*(Aqtrack2\*(Aq, \& ACH \& AccountNumber => \*(Aqaccount_number\*(Aq, \& ABA => \*(Aqrouting_code\*(Aq, \& CheckNumber => \*(Aqcheck_number\*(Aq, \& CardName => \*(Aqname\*(Aq, \& DispositionType => \*(AqDispositionType\*(Aq, \& TotalAmount => \*(Aqamount\*(Aq reformatted into cents \& FeeAmount => \*(AqFeeAmount\*(Aq, \& TaxAmount => \*(AqTaxAmount\*(Aq, \& BillingAddress => \*(Aqaddress\*(Aq, \& BillingCity => \*(Aqcity\*(Aq, \& BillingStateProv => \*(Aqstate\*(Aq, \& BillingPostalCode => \*(Aqzip\*(Aq, \& BillingCountry => \*(Aqcountry\*(Aq, # forced to ISO\-3166\-alpha\-3 \& BillingPhone => \*(Aqphone\*(Aq, \& Email => \*(Aqemail\*(Aq, \& UserIPAddress => \*(Aqcustomer_ip\*(Aq, \& UserHost => \*(AqUserHost\*(Aq, \& UDField1 => \*(AqUDField1\*(Aq, \& UDField2 => \*(AqUDField2\*(Aq, \& ActionCode => \*(AqActionCode\*(Aq, \& IndustryInfo \& Type => \*(AqIndustryInfo\*(Aq, \& ShippingInfo \& CustomerPO => \*(AqCustomerPO\*(Aq, \& ShippingMethod => \*(AqShippingMethod\*(Aq, \& ShippingName => \*(Aqship_name\*(Aq, \& ShippingAddr \& Address => \*(Aqship_address\*(Aq, \& City => \*(Aqship_city\*(Aq, \& StateProv => \*(Aqship_state\*(Aq, \& Country => \*(Aqship_country\*(Aq, # forced to ISO\-3166\-alpha\-3 \& Phone => \*(Aqship_phone\*(Aq, .Ve .SH "NOTE" .IX Header "NOTE" .SH "COMPATIBILITY" .IX Header "COMPATIBILITY" Version 0.07 changes the server name and path for IPPay's late 2012 update. .PP Business::OnlinePayment::IPPay uses IPPay \s-1XML\s0 Product Specifications version 1.1.2. .PP See http://www.ippay.com/ for more information. .SH "AUTHORS" .IX Header "AUTHORS" Original author: Jeff Finucane .PP Current maintainer: Ivan Kohler .PP Reverse Authorization patch from dougforpres .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (c) 1999 Jason Kohles Copyright (c) 2002\-2003 Ivan Kohler Copyright (c) 2008\-2022 Freeside Internet Services, Inc. .PP All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "ADVERTISEMENT" .IX Header "ADVERTISEMENT" Need a complete, open-source back-office and customer self-service solution? The Freeside software includes support for credit card and electronic check processing with IPPay and over 50 other gateways, invoicing, integrated trouble ticketing, and customer signup and self-service web interfaces. .PP http://freeside.biz/freeside/ .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBperl\fR\|(1). Business::OnlinePayment.