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(@_);
23 test_transaction => undef,
25 transaction_type => undef,
26 error_message => undef,
27 authorization => undef,
31 server_response => undef,
36 my($class,$processor,%data) = @_;
38 Carp::croak("unspecified processor") unless $processor;
40 my $subclass = "${class}::$processor";
41 if(!defined(&$subclass)) {
43 Carp::croak("unknown processor $processor ($@)") if $@;
46 my $self = bless {processor => $processor}, $subclass;
47 $self->build_subs(keys %fields);
49 if($self->can("set_defaults")) {
50 $self->set_defaults();
55 my $value = $data{$_};
57 $self->build_subs($key);
65 my($self,%params) = @_;
68 if($params{'type'}) { $self->transaction_type($params{'type'}); }
69 %{$self->{'_content'}} = %params;
71 return %{$self->{'_content'}};
75 my($self,@fields) = @_;
77 my %content = $self->content();
79 Carp::croak("missing required field $_") unless exists $content{$_};
84 my($self, @fields) = @_;
86 my %content = $self->content();
89 #foreach(@fields) { $new{$_} = $content{$_}; }
91 map { $_ => $content{$_} } grep defined $content{$_}, @fields;
97 my %content = $self->content();
98 foreach( keys %map ) {
99 $content{$map{$_}} = $content{$_};
101 $self->content(%content);
107 Carp::croak("Processor subclass did not override submit function");
113 my %content = $self->content();
115 foreach(keys %content) {
116 $dump .= "$_ = $content{$_}\n";
121 # didnt use AUTOLOAD because Net::SSLeay::AUTOLOAD passes right to
122 # AutoLoader::AUTOLOAD, instead of passing up the chain
125 no warnings 'redefine';
127 eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }";
137 Business::OnlinePayment - Perl extension for online payment processing
141 use Business::OnlinePayment;
143 my $transaction = new Business::OnlinePayment($processor, %processor_info);
144 $transaction->content(
147 cardnumber => '1234123412341238',
148 expiration => '0100',
149 name => 'John Q Doe',
151 $transaction->submit();
153 if($transaction->is_success()) {
154 print "Card processed successfully: ".$transaction->authorization()."\n";
156 print "Card was rejected: ".$transaction->error_message()."\n";
161 Business::OnlinePayment is a generic module for processing payments through
162 online credit card processors, electronic cash systems, etc.
164 =head1 METHODS AND FUNCTIONS
166 =head2 new($processor, %processor_options);
168 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.
170 =head2 content(%content);
172 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:
178 Transaction type, supported types are:
179 Visa, MasterCard, American Express, Discover, Check (not all processors support all these transaction types).
183 Your login name to use for authentication to the online processor.
187 Your password to use for authentication to the online processor.
191 What to do with the transaction (currently available are: Normal Authorization, Authorization Only, Credit, Post Authorization)
195 A description of the transaction (used by some processors to send information to the client, normally not a required field).
199 The amount of the transaction, most processors dont want dollar signs and the like, just a floating point number.
201 =item * invoice_number
203 An invoice number, for your use and not normally required, many processors require this field to be a numeric only field.
207 A customer identifier, again not normally required.
211 The customers name, your processor may not require this.
215 The customers address (your processor may not require this unless you are requiring AVS Verification).
219 The customers city (your processor may not require this unless you are requiring AVS Verification).
223 The customers state (your processor may not require this unless you are requiring AVS Verification).
227 The customers zip code (your processor may not require this unless you are requiring AVS Verification).
235 Customer's phone number.
239 Customer's fax number.
243 Customer's email address.
247 Credit card number (obviously not required for non-credit card transactions).
251 Credit card expiration (obviously not required for non-credit card transactions).
253 =item * account_number
255 Bank account number for electronic checks or electronic funds transfer.
259 Bank's routing code for electronic checks or electronic funds transfer.
263 Bank's name for electronic checks or electronic funds transfer.
269 Submit the transaction to the processor for completion
273 Returns true if the transaction was submitted successfully, false if it failed (or undef if it has not been submitted yet).
275 =head2 result_code();
277 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.
279 =head2 test_transaction();
281 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).
283 =head2 require_avs();
285 Providing a true argument to this module will turn on address verification (if the processor supports it).
287 =head2 transaction_type();
289 Retrieve the transaction type (the 'type' argument to contents();). Generally only used internally, but provided in case it is useful.
291 =head2 error_message();
293 If the transaction has been submitted but was not accepted, this function will return the provided error message (if any) that the processor returned.
295 =head2 authorization();
297 If the transaction has been submitted and accepted, this function will provide you with the authorization code that the processor returned.
301 Retrieve or change the processor submission server address (CHANGE AT YOUR OWN RISK).
305 Retrieve or change the processor submission port (CHANGE AT YOUR OWN RISK).
309 Retrieve or change the processor submission path (CHANGE AT YOUR OWN RISK).
313 Jason Kohles, email@jasonkohles.com
315 (v3 rewrite) Ivan Kohler <ivan-business-onlinepayment@420.am>
319 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
320 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
321 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
326 http://420.am/business-onlinepayment/
328 For verification of credit card checksums, see L<Business::CreditCard>.