1 package Business::OnlinePayment;
4 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK $AUTOLOAD);
9 @ISA = qw(Exporter AutoLoader);
13 $VERSION = do { my @r=(q$Revision: 1.1 $=~/\d+/g);sprintf "%d."."%02d"x$#r,@r};
20 test_transaction => undef,
22 transaction_type => undef,
23 error_message => undef,
24 authorization => undef,
28 server_response => undef,
33 my($class,$processor,%data) = @_;
35 Carp::croak("unspecified processor") unless $processor;
37 my $subclass = "${class}::$processor";
38 if(!defined(&$subclass)) {
40 Carp::croak("unknown processor $processor ($@)") if $@;
43 my $self = bless {processor => $processor}, $subclass;
44 $self->build_subs(keys %fields);
46 if($self->can("set_defaults")) {
47 $self->set_defaults();
52 my $value = $data{$_};
54 $self->build_subs($key);
62 my($self,%params) = @_;
65 if($params{'type'}) { $self->transaction_type($params{'type'}); }
66 %{$self->{'_content'}} = %params;
68 return %{$self->{'_content'}};
72 my($self,@fields) = @_;
74 my %content = $self->content();
76 Carp::croak("missing required field $_") unless exists $content{$_};
81 my($self,@fields) = @_;
83 my %content = $self->content();
85 foreach(@fields) { $new{$_} = $content{$_}; }
92 my %content = $self->content();
94 $content{$map{$_}} = $content{$_};
96 $self->content(%content);
102 Carp::croak("Processor subclass did not override submit function");
108 my %content = $self->content();
110 foreach(keys %content) {
111 $dump .= "$_ = $content{$_}\n";
116 # didnt use AUTOLOAD because Net::SSLeay::AUTOLOAD passes right to
117 # AutoLoader::AUTOLOAD, instead of passing up the chain
121 eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }";
131 Business::OnlinePayment - Perl extension for online payment processing
135 use Business::OnlinePayment;
137 my $transaction = new Business::OnlinePayment($processor, %processor_info);
138 $transaction->content(
141 cardnumber => '1234123412341238',
142 expiration => '0100',
143 name => 'John Q Doe',
145 $transaction->submit();
147 if($transaction->is_success()) {
148 print "Card processed successfully: ".$transaction->authorization()."\n";
150 print "Card was rejected: ".$transaction->error_message()."\n";
155 Business::OnlinePayment is a generic module for processing payments through
156 online credit card processors, electronic cash systems, etc.
158 =head1 METHODS AND FUNCTIONS
160 =head2 new($processor, %processor_options);
162 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.
164 =head2 content(%content);
166 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:
172 Transaction type, supported types are:
173 Visa, MasterCard, American Express, Discover, Check (not all processors support all these transaction types).
177 Your login name to use for authentication to the online processor.
181 Your password to use for authentication to the online processor.
185 What to do with the transaction (currently available are: Normal Authorization, Authorization Only, Credit, Post Authorization)
189 A description of the transaction (used by some processors to send information to the client, normally not a required field).
193 The amount of the transaction, most processors dont want dollar signs and the like, just a floating point number.
195 =item * invoice_number
197 An invoice number, for your use and not normally required, many processors require this field to be a numeric only field.
201 A customer identifier, again not normally required.
205 The customers name, your processor may not require this.
209 The customers address (your processor may not require this unless you are requiring AVS Verification).
213 The customers city (your processor may not require this unless you are requiring AVS Verification).
217 The customers state (your processor may not require this unless you are requiring AVS Verification).
221 The customers zip code (your processor may not require this unless you are requiring AVS Verification).
229 Customer's phone number.
233 Customer's fax number.
237 Customer's email address.
241 Credit card number (obviously not required for non-credit card transactions).
245 Credit card expiration (obviously not required for non-credit card transactions).
247 =item * account_number
249 Bank account number for electronic checks or electronic funds transfer.
253 Bank's routing code for electronic checks or electronic funds transfer.
257 Bank's name for electronic checks or electronic funds transfer.
263 Submit the transaction to the processor for completion
267 Returns true if the transaction was submitted successfully, false if it failed (or undef if it has not been submitted yet).
269 =head2 result_code();
271 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.
273 =head2 test_transaction();
275 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).
277 =head2 require_avs();
279 Providing a true argument to this module will turn on address verification (if the processor supports it).
281 =head2 transaction_type();
283 Retrieve the transaction type (the 'type' argument to contents();). Generally only used internally, but provided in case it is useful.
285 =head2 error_message();
287 If the transaction has been submitted but was not accepted, this function will return the provided error message (if any) that the processor returned.
289 =head2 authorization();
291 If the transaction has been submitted and accepted, this function will provide you with the authorization code that the processor returned.
295 Retrieve or change the processor submission server address (CHANGE AT YOUR OWN RISK).
299 Retrieve or change the processor submission port (CHANGE AT YOUR OWN RISK).
303 Retrieve or change the processor submission path (CHANGE AT YOUR OWN RISK).
307 Jason Kohles, email@jasonkohles.com
311 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
312 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
313 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
318 For verification of credit card checksums, see L<Business::CreditCard>.