1 package Business::OnlinePayment;
4 use vars qw($VERSION); # @ISA @EXPORT @EXPORT_OK $AUTOLOAD);
10 #@ISA = (); #qw(Exporter AutoLoader);
15 sub VERSION { #Argument "3.00_01" isn't numeric in subroutine entry
17 UNIVERSAL::VERSION(@_);
22 failure_status => undef,
24 test_transaction => undef,
26 transaction_type => undef,
27 error_message => undef,
28 authorization => undef,
32 server_response => undef,
37 my($class,$processor,%data) = @_;
39 Carp::croak("unspecified processor") unless $processor;
41 my $subclass = "${class}::$processor";
42 if(!defined(&$subclass)) {
44 Carp::croak("unknown processor $processor ($@)") if $@;
47 my $self = bless {processor => $processor}, $subclass;
48 $self->build_subs(keys %fields);
50 if($self->can("set_defaults")) {
51 $self->set_defaults();
56 my $value = $data{$_};
58 $self->build_subs($key);
66 my($self,%params) = @_;
69 if($params{'type'}) { $self->transaction_type($params{'type'}); }
70 %{$self->{'_content'}} = %params;
72 return %{$self->{'_content'}};
76 my($self,@fields) = @_;
78 my %content = $self->content();
80 Carp::croak("missing required field $_") unless exists $content{$_};
85 my($self, @fields) = @_;
87 my %content = $self->content();
90 #foreach(@fields) { $new{$_} = $content{$_}; }
92 map { $_ => $content{$_} } grep defined $content{$_}, @fields;
98 my %content = $self->content();
99 foreach( keys %map ) {
100 $content{$map{$_}} = $content{$_};
102 $self->content(%content);
108 Carp::croak("Processor subclass did not override submit function");
114 my %content = $self->content();
116 foreach(keys %content) {
117 $dump .= "$_ = $content{$_}\n";
122 # didnt use AUTOLOAD because Net::SSLeay::AUTOLOAD passes right to
123 # AutoLoader::AUTOLOAD, instead of passing up the chain
126 no warnings 'redefine';
128 eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }";
138 Business::OnlinePayment - Perl extension for online payment processing
142 use Business::OnlinePayment;
144 my $transaction = new Business::OnlinePayment($processor, %processor_info);
145 $transaction->content(
148 cardnumber => '1234123412341238',
149 expiration => '0100',
150 name => 'John Q Doe',
152 $transaction->submit();
154 if($transaction->is_success()) {
155 print "Card processed successfully: ".$transaction->authorization()."\n";
157 print "Card was rejected: ".$transaction->error_message()."\n";
162 Business::OnlinePayment is a generic module for processing payments through
163 online credit card processors, electronic cash systems, etc.
165 =head1 METHODS AND FUNCTIONS
167 =head2 new($processor, %processor_options);
169 Create a new Business::OnlinePayment object, $processor is required, and defines the online processor to use. If necessary, processor options can be specified, currently supported options are 'Server', 'Port', and 'Path', which specify how to find the online processor (https://server:port/path), but individual processor modules should supply reasonable defaults for this information, override the defaults only if absolutely necessary (especially path), as the processor module was probably written with a specific target script in mind.
171 =head2 content(%content);
173 The information necessary for the transaction, this tends to vary a little depending on the processor, so we have chosen to use a system which defines specific fields in the frontend which get mapped to the correct fields in the backend. The currently defined fields are:
179 Transaction type, supported types are:
180 Visa, MasterCard, American Express, Discover, Check (not all processors support all these transaction types).
184 Your login name to use for authentication to the online processor.
188 Your password to use for authentication to the online processor.
192 What to do with the transaction (currently available are: Normal Authorization, Authorization Only, Credit, Post Authorization)
196 A description of the transaction (used by some processors to send information to the client, normally not a required field).
200 The amount of the transaction, most processors dont want dollar signs and the like, just a floating point number.
202 =item * invoice_number
204 An invoice number, for your use and not normally required, many processors require this field to be a numeric only field.
208 A customer identifier, again not normally required.
212 The customers name, your processor may not require this.
216 The customers address (your processor may not require this unless you are requiring AVS Verification).
220 The customers city (your processor may not require this unless you are requiring AVS Verification).
224 The customers state (your processor may not require this unless you are requiring AVS Verification).
228 The customers zip code (your processor may not require this unless you are requiring AVS Verification).
236 Customer's phone number.
240 Customer's fax number.
244 Customer's email address.
248 Credit card number (obviously not required for non-credit card transactions).
252 Credit card expiration (obviously not required for non-credit card transactions).
254 =item * account_number
256 Bank account number for electronic checks or electronic funds transfer.
260 Bank's routing code for electronic checks or electronic funds transfer.
264 Bank's name for electronic checks or electronic funds transfer.
270 Submit the transaction to the processor for completion
274 Returns true if the transaction was submitted successfully, false if it failed (or undef if it has not been submitted yet).
276 =head2 failure_status();
278 If the transactdion failed, it can optionally return a specific failure status
279 (normalized, not gateway-specific). Currently defined statuses are: "expired",
280 "nsf" (non-sufficient funds), "stolen", "pickup", "blacklisted" and
281 "declined" (card/transaction declines only, not other errors).
283 Note that (as of Aug 2006) this is only supported by some of the newest
284 processor modules, and that, even if supported, a failure status is an entirely
285 optional field that is only set for specific kinds of failures.
287 =head2 result_code();
289 Returns the precise result code that the processor returned, these are normally one letter codes that don't mean much unless you understand the protocol they speak, you probably don't need this, but it's there just in case.
291 =head2 test_transaction();
293 Most processors provide a test mode, where submitted transactions will not actually be charged or added to your batch, calling this function with a true argument will turn that mode on if the processor supports it, or generate a fatal error if the processor does not support a test mode (which is probably better than accidentally making real charges).
295 =head2 require_avs();
297 Providing a true argument to this module will turn on address verification (if the processor supports it).
299 =head2 transaction_type();
301 Retrieve the transaction type (the 'type' argument to contents();). Generally only used internally, but provided in case it is useful.
303 =head2 error_message();
305 If the transaction has been submitted but was not accepted, this function will return the provided error message (if any) that the processor returned.
307 =head2 authorization();
309 If the transaction has been submitted and accepted, this function will provide you with the authorization code that the processor returned.
313 Retrieve or change the processor submission server address (CHANGE AT YOUR OWN RISK).
317 Retrieve or change the processor submission port (CHANGE AT YOUR OWN RISK).
321 Retrieve or change the processor submission path (CHANGE AT YOUR OWN RISK).
325 Jason Kohles, email@jasonkohles.com
327 (v3 rewrite) Ivan Kohler <ivan-business-onlinepayment@420.am>
331 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
332 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
333 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
338 http://420.am/business-onlinepayment/
340 For verification of credit card checksums, see L<Business::CreditCard>.