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->{$_}; }";
203 my( $self, $value ) = @_;
204 return 1 if $value =~ /^[yt]/i;
205 return 0 if $value =~ /^[fn]/i;
206 #return 1 if $value == 1;
207 #return 0 if $value == 0;
217 Business::OnlinePayment - Perl extension for online payment processing
221 use Business::OnlinePayment;
223 my $transaction = new Business::OnlinePayment($processor, %processor_info);
224 $transaction->content(
227 card_number => '1234123412341238',
228 expiration => '0100',
229 name => 'John Q Doe',
231 $transaction->submit();
233 if($transaction->is_success()) {
234 print "Card processed successfully: ", $transaction->authorization(), "\n";
236 print "Card was rejected: ", $transaction->error_message(), "\n";
241 Business::OnlinePayment is a generic module for processing payments
242 through online credit card processors, electronic cash systems, etc.
244 =head1 METHODS AND FUNCTIONS
246 =head2 new($processor, %processor_options);
248 Create a new Business::OnlinePayment object, $processor is required,
249 and defines the online processor to use. If necessary, processor
250 options can be specified, currently supported options are 'Server',
251 'Port', and 'Path', which specify how to find the online processor
252 (https://server:port/path), but individual processor modules should
253 supply reasonable defaults for this information, override the defaults
254 only if absolutely necessary (especially path), as the processor
255 module was probably written with a specific target script in mind.
257 =head2 content(%content);
259 The information necessary for the transaction, this tends to vary a
260 little depending on the processor, so we have chosen to use a system
261 which defines specific fields in the frontend which get mapped to the
262 correct fields in the backend. The currently defined fields are:
264 =head3 PROCESSOR FIELDS
270 Your login name to use for authentication to the online processor.
274 Your password to use for authentication to the online processor.
278 =head3 REQUIRED TRANSACTION FIELDS
284 Transaction type, supported types are: CC (credit card), ECHECK
285 (electronic check) and LEC (phone bill billing). Deprecated types
286 are: Visa, MasterCard, American Express, Discover, Check. Not all
287 processors support all transaction types.
291 What to do with the transaction (currently available are: Normal
292 Authorization, Authorization Only, Credit, Post Authorization,
293 Recurring Authorization, Modify Recurring Authorization,
294 Cancel Recurring Authorization)
298 The amount of the transaction. No dollar signs or currency identifiers,
299 just a whole or floating point number (i.e. 26, 26.1 or 26.13).
303 =head3 OPTIONAL TRANSACTION FIELDS
309 A description of the transaction (used by some processors to send
310 information to the client, normally not a required field).
314 An invoice number, for your use and not normally required, many
315 processors require this field to be a numeric only field.
319 Purchase order number (normally not required).
323 Tax amount (portion of amount field, not added to it).
327 Freight amount (portion of amount field, not added to it).
331 Duty amount (portion of amount field, not added to it).
335 Tax exempt flag (i.e. TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0).
339 =head3 CUSTOMER INFO FIELDS
345 A customer identifier, again not normally required.
349 The customer's name, your processor may not require this.
355 The customer's first and last name as separate fields.
359 The customer's company name, not normally required.
363 The customer's address (your processor may not require this unless you
364 are requiring AVS Verification).
368 The customer's city (your processor may not require this unless you
369 are requiring AVS Verification).
373 The customer's state (your processor may not require this unless you
374 are requiring AVS Verification).
378 The customer's zip code (your processor may not require this unless
379 you are requiring AVS Verification).
385 =item ship_first_name
401 These shipping address fields may be accepted by your processor.
402 Refer to the description for the corresponding non-ship field for
403 general information on each field.
407 Customer's phone number.
411 Customer's fax number.
415 Customer's email address.
419 IP Address from which the transaction originated.
423 =head3 CREDIT CARD FIELDS
433 CVV2 number (also called CVC2 or CID) is a three- or four-digit
434 security code used to reduce credit card fraud.
438 Credit card expiration.
442 Track 1 on the magnetic stripe (Card present only)
446 Track 2 on the magnetic stripe (Card present only)
448 =item recurring billing
450 Recurring billing flag
454 =head3 ELECTRONIC CHECK FIELDS
460 Bank account number for electronic checks or electronic funds
465 Bank's routing code for electronic checks or electronic funds
470 Account type for electronic checks or electronic funds transfer. Can be
471 (case-insensitive): B<Personal Checking>, B<Personal Savings>,
472 B<Business Checking> or B<Business Savings>.
476 Account holder's name for electronic checks or electronic funds
481 Bank's name for electronic checks or electronic funds transfer.
485 Check type for electronic checks or electronic funds transfer.
489 Customer organization type.
493 Customer's social security number. Typically only required for
494 electronic checks or electronic funds transfer.
498 Customer's driver's license number. Typically only required for
499 electronic checks or electronic funds transfer.
503 Customer's date of birth. Typically only required for electronic
504 checks or electronic funds transfer.
508 =head3 RECURRING BILLING FIELDS
514 Interval expresses the amount of time between billings: digits, whitespace
515 and units (currently "days" or "months" in either singular or plural form).
519 The date of the first transaction (used for processors which allow delayed
520 start) expressed as YYYY-MM-DD.
524 The number of cycles of interval length for which billing should occur
525 (inclusive of 'trial periods' if the processor supports recurring billing
526 at more than one rate)
532 Submit the transaction to the processor for completion
536 Returns true if the transaction was submitted successfully, false if
537 it failed (or undef if it has not been submitted yet).
539 =head2 failure_status();
541 If the transaction failed, it can optionally return a specific failure
542 status (normalized, not gateway-specific). Currently defined statuses
543 are: "expired", "nsf" (non-sufficient funds), "stolen", "pickup",
544 "blacklisted" and "declined" (card/transaction declines only, not
547 Note that (as of Aug 2006) this is only supported by some of the
548 newest processor modules, and that, even if supported, a failure
549 status is an entirely optional field that is only set for specific
552 =head2 result_code();
554 Returns the precise result code that the processor returned, these are
555 normally one letter codes that don't mean much unless you understand
556 the protocol they speak, you probably don't need this, but it's there
559 =head2 test_transaction();
561 Most processors provide a test mode, where submitted transactions will
562 not actually be charged or added to your batch, calling this function
563 with a true argument will turn that mode on if the processor supports
564 it, or generate a fatal error if the processor does not support a test
565 mode (which is probably better than accidentally making real charges).
567 =head2 require_avs();
569 Providing a true argument to this module will turn on address
570 verification (if the processor supports it).
572 =head2 transaction_type();
574 Retrieve the transaction type (the 'type' argument to contents()).
575 Generally only used internally, but provided in case it is useful.
577 =head2 error_message();
579 If the transaction has been submitted but was not accepted, this
580 function will return the provided error message (if any) that the
583 =head2 authorization();
585 If the transaction has been submitted and accepted, this function will
586 provide you with the authorization code that the processor returned.
590 Retrieve or change the processor submission server address (CHANGE AT
595 Retrieve or change the processor submission port (CHANGE AT YOUR OWN
600 Retrieve or change the processor submission path (CHANGE AT YOUR OWN
603 =head2 fraud_score();
605 Retrieve or change the fraud score from any Business::FraudDetect plugin
607 =head2 fraud_transaction_id();
609 Retrieve or change the transaction id from any Business::FraudDetect plugin
613 Jason Kohles, email@jasonkohles.com
615 (v3 rewrite) Ivan Kohler <ivan-business-onlinepayment@420.am>
617 Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
621 Homepage: http://420.am/business-onlinepayment/
623 Development: http://420.am/business-onlinepayment/ng.html
627 Please direct current development questions, patches, etc. to the mailing list:
628 http://420.am/cgi-bin/mailman/listinfo/bop-devel/
632 The code is available from our public CVS repository:
634 export CVSROOT=":pserver:anonymous@cvs.freeside.biz:/home/cvs/cvsroot"
636 # The password for the user `anonymous' is `anonymous'.
637 cvs checkout Business-OnlinePayment
641 http://freeside.biz/cgi-bin/viewvc.cgi/Business-OnlinePayment/
643 Many (but by no means all!) processor plugins are also available in the same
646 http://freeside.biz/cgi-bin/viewvc.cgi/
650 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
651 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
652 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
656 http://420.am/business-onlinepayment/
658 For verification of credit card checksums, see L<Business::CreditCard>.