1 package Business::OnlinePayment;
10 $VERSION = eval $VERSION; # modperlstyle: convert the string into a number
12 # Remember subclasses we have "wrapped" submit() with _pre_submit()
13 my %Presubmit_Added = ();
16 authorization => undef,
17 error_message => undef,
18 failure_status => undef,
19 fraud_detect => undef,
21 maximum_risk => undef,
27 server_response => undef,
28 test_transaction => undef,
29 transaction_type => 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);
58 # "wrap" submit with _pre_submit only once
59 unless ( $Presubmit_Added{$subclass} ) {
60 my $real_submit = $subclass->can('submit');
62 no warnings 'redefine';
65 *{"${subclass}::submit"} = sub {
67 return unless $self->_pre_submit(@_);
68 return $real_submit->($self, @_);
76 my ($self, $risk_transaction) = @_;
78 my %parent_content = $self->content();
79 $parent_content{action} = 'Fraud Detect';
80 $risk_transaction->content( %parent_content );
81 $risk_transaction->submit();
82 if ($risk_transaction->is_success()) {
83 if ( $risk_transaction->fraud_score <= $self->maximum_fraud_score()) {
86 $self->error_message('Excessive risk from risk management');
89 $self->error_message('Error in risk detection stage: ' . $risk_transaction->error_message);
95 my @Fraud_Class_Path = qw(Business::OnlinePayment Business::FraudDetect);
99 my $fraud_detection = $self->fraud_detect();
101 # early return if user does not want optional risk mgt
102 return 1 unless $fraud_detection;
104 # Search for an appropriate FD module
105 foreach my $fraud_class ( @Fraud_Class_Path ) {
106 my $subclass = $fraud_class . "::" . $fraud_detection;
107 if (!defined(&$subclass)) {
108 eval "use $subclass ()";
110 Carp::croak("error loading fraud_detection module ($@)")
111 unless ( $@ =~ m/^Can\'t locate/ );
113 my $risk_tx = bless ( { processor => $fraud_detection } , $subclass );
114 $risk_tx->build_subs(keys %fields);
115 if ($risk_tx->can('set_defaults')) {
116 $risk_tx->set_defaults();
118 $risk_tx->_glean_parameters_from_parent($self);
119 return $self->_risk_detect($risk_tx);
123 Carp::croak("Unable to locate fraud_detection module $fraud_detection"
124 . " in \@INC under Fraud_Class_Path (\@Fraud_Class_Path"
125 . " contains: @Fraud_Class_Path) (\@INC contains: @INC)");
129 my($self,%params) = @_;
132 if($params{'type'}) { $self->transaction_type($params{'type'}); }
133 %{$self->{'_content'}} = %params;
135 return exists $self->{'_content'} ? %{$self->{'_content'}} : ();
138 sub required_fields {
139 my($self,@fields) = @_;
142 my %content = $self->content();
144 push(@missing, $_) unless exists $content{$_};
147 Carp::croak("missing required field(s): " . join(", ", @missing) . "\n")
152 my($self, @fields) = @_;
154 my %content = $self->content();
157 #foreach(@fields) { $new{$_} = $content{$_}; }
159 map { $_ => $content{$_} } grep defined $content{$_}, @fields;
165 my %content = $self->content();
166 foreach( keys %map ) {
167 $content{$map{$_}} = $content{$_};
169 $self->content(%content);
175 Carp::croak("Processor subclass did not override submit function");
181 my %content = $self->content();
183 foreach(sort keys %content) {
184 $dump .= "$_ = $content{$_}\n";
189 # didnt use AUTOLOAD because Net::SSLeay::AUTOLOAD passes right to
190 # AutoLoader::AUTOLOAD, instead of passing up the chain
195 next if($self->can($_));
196 eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }";
206 Business::OnlinePayment - Perl extension for online payment processing
210 use Business::OnlinePayment;
212 my $transaction = new Business::OnlinePayment($processor, %processor_info);
213 $transaction->content(
216 card_number => '1234123412341238',
217 expiration => '0100',
218 name => 'John Q Doe',
220 $transaction->submit();
222 if($transaction->is_success()) {
223 print "Card processed successfully: ", $transaction->authorization(), "\n";
225 print "Card was rejected: ", $transaction->error_message(), "\n";
230 Business::OnlinePayment is a generic module for processing payments
231 through online credit card processors, electronic cash systems, etc.
233 =head1 METHODS AND FUNCTIONS
235 =head2 new($processor, %processor_options);
237 Create a new Business::OnlinePayment object, $processor is required,
238 and defines the online processor to use. If necessary, processor
239 options can be specified, currently supported options are 'Server',
240 'Port', and 'Path', which specify how to find the online processor
241 (https://server:port/path), but individual processor modules should
242 supply reasonable defaults for this information, override the defaults
243 only if absolutely necessary (especially path), as the processor
244 module was probably written with a specific target script in mind.
246 =head2 content(%content);
248 The information necessary for the transaction, this tends to vary a
249 little depending on the processor, so we have chosen to use a system
250 which defines specific fields in the frontend which get mapped to the
251 correct fields in the backend. The currently defined fields are:
257 Transaction type, supported types are:
258 Visa, MasterCard, American Express, Discover, Check (not all
259 processors support all these transaction types).
263 Your login name to use for authentication to the online processor.
267 Your password to use for authentication to the online processor.
271 What to do with the transaction (currently available are: Normal
272 Authorization, Authorization Only, Credit, Post Authorization)
276 A description of the transaction (used by some processors to send
277 information to the client, normally not a required field).
281 The amount of the transaction, most processors don't want dollar signs
282 and the like, just a floating point number.
284 =item * invoice_number
286 An invoice number, for your use and not normally required, many
287 processors require this field to be a numeric only field.
291 A customer identifier, again not normally required.
295 The customers name, your processor may not require this.
299 The customers address (your processor may not require this unless you
300 are requiring AVS Verification).
304 The customers city (your processor may not require this unless you are
305 requiring AVS Verification).
309 The customers state (your processor may not require this unless you
310 are requiring AVS Verification).
314 The customers zip code (your processor may not require this unless you
315 are requiring AVS Verification).
323 Customer's phone number.
327 Customer's fax number.
331 Customer's email address.
335 Credit card number (obviously not required for non-credit card
340 Credit card expiration (obviously not required for non-credit card
343 =item * account_number
345 Bank account number for electronic checks or electronic funds transfer.
349 Bank's routing code for electronic checks or electronic funds transfer.
353 Bank's name for electronic checks or electronic funds transfer.
359 Submit the transaction to the processor for completion
363 Returns true if the transaction was submitted successfully, false if
364 it failed (or undef if it has not been submitted yet).
366 =head2 failure_status();
368 If the transaction failed, it can optionally return a specific
369 failure status (normalized, not gateway-specific). Currently defined
370 statuses are: "expired", "nsf" (non-sufficient funds), "stolen",
371 "pickup", "blacklisted" and "declined" (card/transaction declines
372 only, not other errors).
374 Note that (as of Aug 2006) this is only supported by some of the
375 newest processor modules, and that, even if supported, a failure
376 status is an entirely optional field that is only set for specific
379 =head2 result_code();
381 Returns the precise result code that the processor returned, these are
382 normally one letter codes that don't mean much unless you understand
383 the protocol they speak, you probably don't need this, but it's there
386 =head2 test_transaction();
388 Most processors provide a test mode, where submitted transactions will
389 not actually be charged or added to your batch, calling this function
390 with a true argument will turn that mode on if the processor supports
391 it, or generate a fatal error if the processor does not support a test
392 mode (which is probably better than accidentally making real charges).
394 =head2 require_avs();
396 Providing a true argument to this module will turn on address
397 verification (if the processor supports it).
399 =head2 transaction_type();
401 Retrieve the transaction type (the 'type' argument to contents();).
402 Generally only used internally, but provided in case it is useful.
404 =head2 error_message();
406 If the transaction has been submitted but was not accepted, this
407 function will return the provided error message (if any) that the
410 =head2 authorization();
412 If the transaction has been submitted and accepted, this function will
413 provide you with the authorization code that the processor returned.
417 Retrieve or change the processor submission server address (CHANGE AT
422 Retrieve or change the processor submission port (CHANGE AT YOUR OWN RISK).
426 Retrieve or change the processor submission path (CHANGE AT YOUR OWN RISK).
430 Jason Kohles, email@jasonkohles.com
432 (v3 rewrite) Ivan Kohler <ivan-business-onlinepayment@420.am>
434 Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
438 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
439 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
440 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
444 http://420.am/business-onlinepayment/
446 For verification of credit card checksums, see L<Business::CreditCard>.