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 croak("unspecified processor") unless $processor;
37 my $subclass = "${class}::$processor";
39 croak("unknown processor $processor ($@)") if $@;
41 my $self = bless {processor => $processor}, $subclass;
42 $self->build_subs(keys %fields);
44 if($self->can("set_defaults")) {
45 $self->set_defaults(%data);
50 my $value = $data{$_};
52 $self->build_subs($key);
56 # "wrap" submit with _pre_submit only once
57 unless ( $Presubmit_Added{$subclass} ) {
58 my $real_submit = $subclass->can('submit');
60 no warnings 'redefine';
63 *{"${subclass}::submit"} = sub {
65 return unless $self->_pre_submit(@_);
66 return $real_submit->($self, @_);
74 my ($self, $risk_transaction) = @_;
76 my %parent_content = $self->content();
77 $parent_content{action} = 'Fraud Detect';
78 $risk_transaction->content( %parent_content );
79 $risk_transaction->submit();
80 if ($risk_transaction->is_success()) {
81 if ( $risk_transaction->fraud_score <= $self->maximum_fraud_score()) {
84 $self->error_message('Excessive risk from risk management');
87 $self->error_message('Error in risk detection stage: ' . $risk_transaction->error_message);
93 my @Fraud_Class_Path = qw(Business::OnlinePayment Business::FraudDetect);
97 my $fraud_detection = $self->fraud_detect();
99 # early return if user does not want optional risk mgt
100 return 1 unless $fraud_detection;
102 # Search for an appropriate FD module
103 foreach my $fraud_class ( @Fraud_Class_Path ) {
104 my $subclass = $fraud_class . "::" . $fraud_detection;
105 eval "use $subclass ()";
107 croak("error loading fraud_detection module ($@)")
108 unless ( $@ =~ m/^Can\'t locate/ );
110 my $risk_tx = bless( { processor => $fraud_detection }, $subclass );
111 $risk_tx->build_subs(keys %fields);
112 if ($risk_tx->can('set_defaults')) {
113 $risk_tx->set_defaults();
115 $risk_tx->_glean_parameters_from_parent($self);
116 return $self->_risk_detect($risk_tx);
119 croak("Unable to locate fraud_detection module $fraud_detection"
120 . " in \@INC under Fraud_Class_Path (\@Fraud_Class_Path"
121 . " contains: @Fraud_Class_Path) (\@INC contains: @INC)");
125 my($self,%params) = @_;
128 if($params{'type'}) { $self->transaction_type($params{'type'}); }
129 %{$self->{'_content'}} = %params;
131 return exists $self->{'_content'} ? %{$self->{'_content'}} : ();
134 sub required_fields {
135 my($self,@fields) = @_;
138 my %content = $self->content();
140 push(@missing, $_) unless exists $content{$_};
143 croak("missing required field(s): " . join(", ", @missing) . "\n")
148 my($self, @fields) = @_;
150 my %content = $self->content();
153 #foreach(@fields) { $new{$_} = $content{$_}; }
155 map { $_ => $content{$_} } grep defined $content{$_}, @fields;
161 my %content = $self->content();
162 foreach( keys %map ) {
163 $content{$map{$_}} = $content{$_};
165 $self->content(%content);
171 croak("Processor subclass did not override submit function");
177 my %content = $self->content();
179 foreach(sort keys %content) {
180 $dump .= "$_ = $content{$_}\n";
185 # didnt use AUTOLOAD because Net::SSLeay::AUTOLOAD passes right to
186 # AutoLoader::AUTOLOAD, instead of passing up the chain
191 next if($self->can($_));
192 eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }";
202 Business::OnlinePayment - Perl extension for online payment processing
206 use Business::OnlinePayment;
208 my $transaction = new Business::OnlinePayment($processor, %processor_info);
209 $transaction->content(
212 card_number => '1234123412341238',
213 expiration => '0100',
214 name => 'John Q Doe',
216 $transaction->submit();
218 if($transaction->is_success()) {
219 print "Card processed successfully: ", $transaction->authorization(), "\n";
221 print "Card was rejected: ", $transaction->error_message(), "\n";
226 Business::OnlinePayment is a generic module for processing payments
227 through online credit card processors, electronic cash systems, etc.
229 =head1 METHODS AND FUNCTIONS
231 =head2 new($processor, %processor_options);
233 Create a new Business::OnlinePayment object, $processor is required,
234 and defines the online processor to use. If necessary, processor
235 options can be specified, currently supported options are 'Server',
236 'Port', and 'Path', which specify how to find the online processor
237 (https://server:port/path), but individual processor modules should
238 supply reasonable defaults for this information, override the defaults
239 only if absolutely necessary (especially path), as the processor
240 module was probably written with a specific target script in mind.
242 =head2 content(%content);
244 The information necessary for the transaction, this tends to vary a
245 little depending on the processor, so we have chosen to use a system
246 which defines specific fields in the frontend which get mapped to the
247 correct fields in the backend. The currently defined fields are:
249 =head3 PROCESSOR FIELDS
255 Your login name to use for authentication to the online processor.
259 Your password to use for authentication to the online processor.
263 =head3 GENERAL TRANSACTION FIELDS
269 Transaction type, supported types are: CC (credit card), ECHECK
270 (electronic check) and LEC (phone bill billing). Deprecated types
271 are: Visa, MasterCard, American Express, Discover, Check (not all
272 processors support all these transaction types).
276 What to do with the transaction (currently available are: Normal
277 Authorization, Authorization Only, Credit, Post Authorization)
281 A description of the transaction (used by some processors to send
282 information to the client, normally not a required field).
286 The amount of the transaction, most processors don't want dollar signs
287 and the like, just a floating point number.
289 =item * invoice_number
291 An invoice number, for your use and not normally required, many
292 processors require this field to be a numeric only field.
296 =head3 CUSTOMER INFO FIELDS
302 A customer identifier, again not normally required.
306 The customer's name, your processor may not require this.
312 The customer's first and last name as separate fields.
316 The customer's company name, not normally required.
320 The customer's address (your processor may not require this unless you
321 are requiring AVS Verification).
325 The customer's city (your processor may not require this unless you
326 are requiring AVS Verification).
330 The customer's state (your processor may not require this unless you
331 are requiring AVS Verification).
335 The customer's zip code (your processor may not require this unless
336 you are requiring AVS Verification).
342 =item * ship_first_name
344 =item * ship_last_name
358 These shipping address fields may be accepted by your processor.
359 Refer to the description for the corresponding non-ship field for
360 general information on each field.
364 Customer's phone number.
368 Customer's fax number.
372 Customer's email address.
376 IP Address from which the transaction originated.
380 =head3 CREDIT CARD FIELDS
386 Credit card number (obviously not required for non-credit card
391 CVV2 number (also called CVC2 or CID) is a three- or four-digit
392 security code used to reduce credit card fraud.
396 Credit card expiration (obviously not required for non-credit card
399 =item * recurring billing
401 Recurring billing flag
405 =head3 ELECTRONIC CHECK FIELDS
409 =item * account_number
411 Bank account number for electronic checks or electronic funds
416 Bank's routing code for electronic checks or electronic funds
421 Account type for electronic checks or electronic funds transfer.
425 Account holder's name for electronic checks or electronic funds
430 Bank's name for electronic checks or electronic funds transfer.
434 Check type for electronic checks or electronic funds transfer.
438 Customer organization type.
442 Customer's social security number. Typically only required for
443 electronic checks or electronic funds transfer.
447 Customer's driver's license number. Typically only required for
448 electronic checks or electronic funds transfer.
452 Customer's date of birth. Typically only required for electronic
453 checks or electronic funds transfer.
459 Submit the transaction to the processor for completion
463 Returns true if the transaction was submitted successfully, false if
464 it failed (or undef if it has not been submitted yet).
466 =head2 failure_status();
468 If the transaction failed, it can optionally return a specific failure
469 status (normalized, not gateway-specific). Currently defined statuses
470 are: "expired", "nsf" (non-sufficient funds), "stolen", "pickup",
471 "blacklisted" and "declined" (card/transaction declines only, not
474 Note that (as of Aug 2006) this is only supported by some of the
475 newest processor modules, and that, even if supported, a failure
476 status is an entirely optional field that is only set for specific
479 =head2 result_code();
481 Returns the precise result code that the processor returned, these are
482 normally one letter codes that don't mean much unless you understand
483 the protocol they speak, you probably don't need this, but it's there
486 =head2 test_transaction();
488 Most processors provide a test mode, where submitted transactions will
489 not actually be charged or added to your batch, calling this function
490 with a true argument will turn that mode on if the processor supports
491 it, or generate a fatal error if the processor does not support a test
492 mode (which is probably better than accidentally making real charges).
494 =head2 require_avs();
496 Providing a true argument to this module will turn on address
497 verification (if the processor supports it).
499 =head2 transaction_type();
501 Retrieve the transaction type (the 'type' argument to contents()).
502 Generally only used internally, but provided in case it is useful.
504 =head2 error_message();
506 If the transaction has been submitted but was not accepted, this
507 function will return the provided error message (if any) that the
510 =head2 authorization();
512 If the transaction has been submitted and accepted, this function will
513 provide you with the authorization code that the processor returned.
517 Retrieve or change the processor submission server address (CHANGE AT
522 Retrieve or change the processor submission port (CHANGE AT YOUR OWN
527 Retrieve or change the processor submission path (CHANGE AT YOUR OWN
532 Jason Kohles, email@jasonkohles.com
534 (v3 rewrite) Ivan Kohler <ivan-business-onlinepayment@420.am>
536 Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
540 Please direct current development questions, patches, etc. to the mailing list:
541 http://420.am/cgi-bin/mailman/listinfo/bop-devel/
545 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
546 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
547 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
551 http://420.am/business-onlinepayment/
553 For verification of credit card checksums, see L<Business::CreditCard>.