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,
31 fraud_transaction_id => undef,
35 my($class,$processor,%data) = @_;
37 croak("unspecified processor") unless $processor;
39 my $subclass = "${class}::$processor";
41 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(%data);
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 $self->fraud_score( $risk_transaction->fraud_score );
84 $self->fraud_transaction_id( $risk_transaction->fraud_transaction_id );
85 if ( $risk_transaction->fraud_score <= $self->maximum_fraud_score()) {
88 $self->error_message('Excessive risk from risk management');
91 $self->error_message('Error in risk detection stage: ' . $risk_transaction->error_message);
97 my @Fraud_Class_Path = qw(Business::OnlinePayment Business::FraudDetect);
101 my $fraud_detection = $self->fraud_detect();
103 # early return if user does not want optional risk mgt
104 return 1 unless $fraud_detection;
106 # Search for an appropriate FD module
107 foreach my $fraud_class ( @Fraud_Class_Path ) {
108 my $subclass = $fraud_class . "::" . $fraud_detection;
109 eval "use $subclass ()";
111 croak("error loading fraud_detection module ($@)")
112 unless ( $@ =~ m/^Can\'t locate/ );
114 my $risk_tx = bless( { processor => $fraud_detection }, $subclass );
115 $risk_tx->build_subs(keys %fields);
116 if ($risk_tx->can('set_defaults')) {
117 $risk_tx->set_defaults();
119 $risk_tx->_glean_parameters_from_parent($self);
120 return $self->_risk_detect($risk_tx);
123 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 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 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:
253 =head3 PROCESSOR FIELDS
259 Your login name to use for authentication to the online processor.
263 Your password to use for authentication to the online processor.
267 =head3 GENERAL TRANSACTION FIELDS
273 Transaction type, supported types are: CC (credit card), ECHECK
274 (electronic check) and LEC (phone bill billing). Deprecated types
275 are: Visa, MasterCard, American Express, Discover, Check (not all
276 processors support all these transaction types).
280 What to do with the transaction (currently available are: Normal
281 Authorization, Authorization Only, Credit, Post Authorization)
285 A description of the transaction (used by some processors to send
286 information to the client, normally not a required field).
290 The amount of the transaction, most processors don't want dollar signs
291 and the like, just a floating point number.
293 =item * invoice_number
295 An invoice number, for your use and not normally required, many
296 processors require this field to be a numeric only field.
300 =head3 CUSTOMER INFO FIELDS
306 A customer identifier, again not normally required.
310 The customer's name, your processor may not require this.
316 The customer's first and last name as separate fields.
320 The customer's company name, not normally required.
324 The customer's address (your processor may not require this unless you
325 are requiring AVS Verification).
329 The customer's city (your processor may not require this unless you
330 are requiring AVS Verification).
334 The customer's state (your processor may not require this unless you
335 are requiring AVS Verification).
339 The customer's zip code (your processor may not require this unless
340 you are requiring AVS Verification).
346 =item * ship_first_name
348 =item * ship_last_name
362 These shipping address fields may be accepted by your processor.
363 Refer to the description for the corresponding non-ship field for
364 general information on each field.
368 Customer's phone number.
372 Customer's fax number.
376 Customer's email address.
380 IP Address from which the transaction originated.
384 =head3 CREDIT CARD FIELDS
390 Credit card number (obviously not required for non-credit card
395 CVV2 number (also called CVC2 or CID) is a three- or four-digit
396 security code used to reduce credit card fraud.
400 Credit card expiration (obviously not required for non-credit card
403 =item * recurring billing
405 Recurring billing flag
409 =head3 ELECTRONIC CHECK FIELDS
413 =item * account_number
415 Bank account number for electronic checks or electronic funds
420 Bank's routing code for electronic checks or electronic funds
425 Account type for electronic checks or electronic funds transfer.
429 Account holder's name for electronic checks or electronic funds
434 Bank's name for electronic checks or electronic funds transfer.
438 Check type for electronic checks or electronic funds transfer.
442 Customer organization type.
446 Customer's social security number. Typically only required for
447 electronic checks or electronic funds transfer.
451 Customer's driver's license number. Typically only required for
452 electronic checks or electronic funds transfer.
456 Customer's date of birth. Typically only required for electronic
457 checks or electronic funds transfer.
463 Submit the transaction to the processor for completion
467 Returns true if the transaction was submitted successfully, false if
468 it failed (or undef if it has not been submitted yet).
470 =head2 failure_status();
472 If the transaction failed, it can optionally return a specific failure
473 status (normalized, not gateway-specific). Currently defined statuses
474 are: "expired", "nsf" (non-sufficient funds), "stolen", "pickup",
475 "blacklisted" and "declined" (card/transaction declines only, not
478 Note that (as of Aug 2006) this is only supported by some of the
479 newest processor modules, and that, even if supported, a failure
480 status is an entirely optional field that is only set for specific
483 =head2 result_code();
485 Returns the precise result code that the processor returned, these are
486 normally one letter codes that don't mean much unless you understand
487 the protocol they speak, you probably don't need this, but it's there
490 =head2 test_transaction();
492 Most processors provide a test mode, where submitted transactions will
493 not actually be charged or added to your batch, calling this function
494 with a true argument will turn that mode on if the processor supports
495 it, or generate a fatal error if the processor does not support a test
496 mode (which is probably better than accidentally making real charges).
498 =head2 require_avs();
500 Providing a true argument to this module will turn on address
501 verification (if the processor supports it).
503 =head2 transaction_type();
505 Retrieve the transaction type (the 'type' argument to contents()).
506 Generally only used internally, but provided in case it is useful.
508 =head2 error_message();
510 If the transaction has been submitted but was not accepted, this
511 function will return the provided error message (if any) that the
514 =head2 authorization();
516 If the transaction has been submitted and accepted, this function will
517 provide you with the authorization code that the processor returned.
521 Retrieve or change the processor submission server address (CHANGE AT
526 Retrieve or change the processor submission port (CHANGE AT YOUR OWN
531 Retrieve or change the processor submission path (CHANGE AT YOUR OWN
534 =head2 fraud_score();
536 Retrieve or change the fraud score from any Business::FraudDetect plugin
538 =head2 fraud_transaction_id();
540 Retrieve or change the transaction id from any Business::FraudDetect plugin
544 Jason Kohles, email@jasonkohles.com
546 (v3 rewrite) Ivan Kohler <ivan-business-onlinepayment@420.am>
548 Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
552 Please direct current development questions, patches, etc. to the mailing list:
553 http://420.am/cgi-bin/mailman/listinfo/bop-devel/
557 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
558 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
559 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
563 http://420.am/business-onlinepayment/
565 For verification of credit card checksums, see L<Business::CreditCard>.