1 package Business::OnlinePayment;
4 use vars qw($VERSION %_info_handler);
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 = ();
41 __PACKAGE__->build_subs(@methods);
46 ( my $gw = $class ) =~ s/^Business::OnlinePayment:://;
48 'info_compat' => '0.00',
49 'gateway_name' => $gw,
50 'module_notes' => "Module does not yet provide info.",
54 #allow classes to declare info in a flexible way, but return normalized info
56 'supported_types' => sub {
57 my( $class, $v ) = @_;
58 my $types = ref($v) ? $v : defined($v) ? [ $v ] : [];
59 $types = { map { $_=>1 } @$types } if ref($types) eq 'ARRAY';
62 'supported_actions' => sub {
63 my( $class, $v ) = @_;
64 return %$v if ref($v) eq 'HASH';
65 $v = [ $v ] unless ref($v);
66 my $types = $class->info('supported_types') || {};
67 ( map { $_ => $v } keys %$types );
72 my $class = shift; #class or object
73 my $info = $class->_info;
76 exists($_info_handler{$key})
77 ? &{ $_info_handler{$key} }( $class, $info->{$key} )
80 wantarray ? ( keys %$info ) : [ keys %$info ];
85 my($class,$processor,%data) = @_;
87 croak("unspecified processor") unless $processor;
89 my $subclass = "${class}::$processor";
91 croak("unknown processor $processor ($@)") if $@;
93 my $self = bless {processor => $processor}, $subclass;
95 if($self->can("set_defaults")) {
96 $self->set_defaults(%data);
101 my $value = $data{$_};
103 $self->build_subs($key);
107 # "wrap" submit with _pre_submit only once
108 unless ( $Presubmit_Added{$subclass} ) {
109 my $real_submit = $subclass->can('submit');
111 no warnings 'redefine';
114 *{"${subclass}::submit"} = sub {
116 return unless $self->_pre_submit(@_);
117 return $real_submit->($self, @_);
125 my ($self, $risk_transaction) = @_;
127 my %parent_content = $self->content();
128 $parent_content{action} = 'Fraud Detect';
129 $risk_transaction->content( %parent_content );
130 $risk_transaction->submit();
131 if ($risk_transaction->is_success()) {
132 $self->fraud_score( $risk_transaction->fraud_score );
133 $self->fraud_transaction_id( $risk_transaction->fraud_transaction_id );
134 if ( $risk_transaction->fraud_score <= $self->maximum_fraud_score()) {
137 $self->error_message('Excessive risk from risk management');
140 $self->error_message('Error in risk detection stage: ' . $risk_transaction->error_message);
142 $self->is_success(0);
146 my @Fraud_Class_Path = qw(Business::OnlinePayment Business::FraudDetect);
150 my $fraud_detection = $self->fraud_detect();
152 # early return if user does not want optional risk mgt
153 return 1 unless $fraud_detection;
155 # Search for an appropriate FD module
156 foreach my $fraud_class ( @Fraud_Class_Path ) {
157 my $subclass = $fraud_class . "::" . $fraud_detection;
158 eval "use $subclass ()";
160 croak("error loading fraud_detection module ($@)")
161 unless ( $@ =~ m/^Can\'t locate/ );
163 my $risk_tx = bless( { processor => $fraud_detection }, $subclass );
164 if ($risk_tx->can('set_defaults')) {
165 $risk_tx->set_defaults();
167 $risk_tx->_glean_parameters_from_parent($self);
168 return $self->_risk_detect($risk_tx);
171 croak("Unable to locate fraud_detection module $fraud_detection"
172 . " in \@INC under Fraud_Class_Path (\@Fraud_Class_Path"
173 . " contains: @Fraud_Class_Path) (\@INC contains: @INC)");
177 my($self,%params) = @_;
180 if($params{'type'}) { $self->transaction_type($params{'type'}); }
181 %{$self->{'_content'}} = %params;
183 return exists $self->{'_content'} ? %{$self->{'_content'}} : ();
186 sub required_fields {
187 my($self,@fields) = @_;
190 my %content = $self->content();
192 push(@missing, $_) unless exists $content{$_};
195 croak("missing required field(s): " . join(", ", @missing) . "\n")
200 my($self, @fields) = @_;
202 my %content = $self->content();
205 #foreach(@fields) { $new{$_} = $content{$_}; }
207 map { $_ => $content{$_} } grep defined $content{$_}, @fields;
213 my %content = $self->content();
214 foreach( keys %map ) {
215 $content{$map{$_}} = $content{$_};
217 $self->content(%content);
223 croak("Processor subclass did not override submit function");
229 my %content = $self->content();
231 foreach(sort keys %content) {
232 $dump .= "$_ = $content{$_}\n";
237 # didnt use AUTOLOAD because Net::SSLeay::AUTOLOAD passes right to
238 # AutoLoader::AUTOLOAD, instead of passing up the chain
243 next if($self->can($_));
244 eval "sub $_ { my \$self = shift; if(\@_) { \$self->{$_} = shift; } return \$self->{$_}; }";
251 my( $self, $value ) = @_;
252 return 1 if $value =~ /^[yt]/i;
253 return 0 if $value =~ /^[fn]/i;
254 #return 1 if $value == 1;
255 #return 0 if $value == 0;
265 Business::OnlinePayment - Perl extension for online payment processing
269 use Business::OnlinePayment;
271 my $transaction = new Business::OnlinePayment($processor, %processor_info);
272 $transaction->content(
275 card_number => '1234123412341238',
276 expiration => '06/15',
277 name => 'John Q Doe',
280 eval { $transaction->submit(); };
284 print "$processor error: $@\n";
288 if ( $transaction->is_success() ) {
289 print "Card processed successfully: ". $transaction->authorization()."\n";
291 print "Card was rejected: ". $transaction->error_message(). "\n";
298 Business::OnlinePayment is a generic module for processing payments
299 through online credit card processors, electronic cash systems, etc.
303 =head2 new($processor, %processor_options)
305 Create a new Business::OnlinePayment object, $processor is required,
306 and defines the online processor to use. If necessary, processor
307 options can be specified, currently supported options are 'Server',
308 'Port', and 'Path', which specify how to find the online processor
309 (https://server:port/path), but individual processor modules should
310 supply reasonable defaults for this information, override the defaults
311 only if absolutely necessary (especially path), as the processor
312 module was probably written with a specific target script in mind.
314 =head1 TRANSACTION SETUP METHODS
316 =head2 content(%content)
318 The information necessary for the transaction, this tends to vary a
319 little depending on the processor, so we have chosen to use a system
320 which defines specific fields in the frontend which get mapped to the
321 correct fields in the backend. The currently defined fields are:
323 =head3 PROCESSOR FIELDS
329 Your login name to use for authentication to the online processor.
333 Your password to use for authentication to the online processor.
337 =head3 REQUIRED TRANSACTION FIELDS
343 Transaction type, supported types are: CC (credit card), ECHECK
344 (electronic check) and LEC (phone bill billing). Deprecated types
345 are: Visa, MasterCard, American Express, Discover, Check. Not all
346 processors support all transaction types.
350 What action being taken by this transaction. Currently available are:
354 =item Normal Authorization
356 =item Authorization Only
358 =item Post Authorization
360 =item Reverse Authorization
366 =item Recurring Authorization
368 =item Modify Recurring Authorization
370 =item Cancel Recurring Authorization
376 The amount of the transaction. No dollar signs or currency identifiers,
377 just a whole or floating point number (i.e. 26, 26.1 or 26.13).
381 =head3 OPTIONAL TRANSACTION FIELDS
387 A description of the transaction (used by some processors to send
388 information to the client, normally not a required field).
392 An invoice number, for your use and not normally required, many
393 processors require this field to be a numeric only field.
397 Purchase order number (normally not required).
401 Tax amount (portion of amount field, not added to it).
405 Freight amount (portion of amount field, not added to it).
409 Duty amount (portion of amount field, not added to it).
413 Tax exempt flag (i.e. TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0).
417 Currency, specified as an ISO 4217 three-letter code, such as USD, CAD, EUR,
418 AUD, DKK, GBP, JPY, NZD, etc.
422 If you are prepared to handle partial authorizations
423 (see L<partial_auth_amount()|/"partial_auth_amount()">
424 in L<TRANSACTION RESULT FIELDS|/"TRANSACTION RESULT FIELDS">),
425 pass a true value in this field to enable them.
429 =head3 CUSTOMER INFO FIELDS
435 A customer identifier, again not normally required.
439 The customer's name, your processor may not require this.
445 The customer's first and last name as separate fields.
449 The customer's company name, not normally required.
453 The customer's address (your processor may not require this unless you
454 are requiring AVS Verification).
458 The customer's city (your processor may not require this unless you
459 are requiring AVS Verification).
463 The customer's state (your processor may not require this unless you
464 are requiring AVS Verification).
468 The customer's zip code (your processor may not require this unless
469 you are requiring AVS Verification).
475 =item ship_first_name
491 These shipping address fields may be accepted by your processor.
492 Refer to the description for the corresponding non-ship field for
493 general information on each field.
497 Customer's phone number.
501 Customer's fax number.
505 Customer's email address.
509 IP Address from which the transaction originated.
513 =head3 CREDIT CARD FIELDS
523 Credit card expiration, MM/YY.
527 CVV2 number (also called CVC2 or CID) is a three- or four-digit
528 security code used to reduce credit card fraud.
532 If supported by your gateway, you can pass a card_token instead of a
533 card_number and expiration.
539 #Some card_token schemes implement a challenge/response handshake. In those
540 #cases, this field is used for the response. In most cases the handshake
541 #it taken care of by the gateway module.
545 Track 1 on the magnetic stripe (Card present only)
549 Track 2 on the magnetic stripe (Card present only)
551 =item recurring_billing
553 Recurring billing flag
557 =head3 ELECTRONIC CHECK FIELDS
571 Account type. Can be (case-insensitive): B<Personal Checking>,
572 B<Personal Savings>, B<Business Checking> or B<Business Savings>.
576 Account holder's name.
596 Customer organization type.
600 Customer's social security number.
604 Customer's driver's license number.
608 Customer's date of birth.
612 =head3 RECURRING BILLING FIELDS
618 Interval expresses the amount of time between billings: digits, whitespace
619 and units (currently "days" or "months" in either singular or plural form).
623 The date of the first transaction (used for processors which allow delayed
624 start) expressed as YYYY-MM-DD.
628 The number of cycles of interval length for which billing should occur
629 (inclusive of 'trial periods' if the processor supports recurring billing
630 at more than one rate)
634 =head2 test_transaction()
636 Most processors provide a test mode, where submitted transactions will
637 not actually be charged or added to your batch, calling this function
638 with a true argument will turn that mode on if the processor supports
639 it, or generate a fatal error if the processor does not support a test
640 mode (which is probably better than accidentally making real charges).
644 Providing a true argument to this module will turn on address
645 verification (if the processor supports it).
647 =head1 TRANSACTION SUBMISSION METHOD
651 Submit the transaction to the processor for completion.
653 If there is a gateway communication error or other "meta" , the submit method
654 will throw a fatal exception. You can catch this with eval {} if you would
655 like to treat gateway co
657 =head1 TRANSACTION RESULT METHODS
661 Returns true if the transaction was approved by the gateway, false if
662 it was submitted but not approved, or undef if it has not been
665 =head2 partial_auth_amount()
667 If this transaction was a partial authorization (i.e. successful, but less than
668 the requested amount was processed), then the amount processed is returned in
671 (When is_success is true but this field is empty or 0, that indicates a normal
672 full authorization for the entire requested amount.)
674 =head2 error_message()
676 If the transaction has been submitted but was not accepted, this
677 function will return the provided error message (if any) that the
680 =head2 failure_status()
682 If the transaction failed, it can optionally return a specific failure
683 status (normalized, not gateway-specific). Currently defined statuses
684 are: "expired", "nsf" (non-sufficient funds), "stolen", "pickup",
685 "blacklisted" and "declined" (card/transaction declines only, not
688 Note that not all processor modules support this, and that if supported,
689 it may not be set for all declines.
691 =head2 authorization()
693 If the transaction has been submitted and accepted, this function will
694 provide you with the authorization code that the processor returned.
695 Store this if you would like to run inquiries or refunds on the transaction
698 =head2 order_number()
700 The unique order number for the transaction generated by the gateway. Store
701 this if you would like to run inquiries or refunds on the transaction later.
705 If supported by your gateway, a card_token can be used in a subsequent
706 transaction to refer to a card number.
710 Retrieve or change the fraud score from any Business::FraudDetect plugin
712 =head2 fraud_transaction_id()
714 Retrieve or change the transaction id from any Business::FraudDetect plugin
716 =head2 response_code()
718 =head2 response_headers()
720 =head2 response_page()
722 These three fields are set by some processors (especially those which use
723 HTTPS) when the transaction fails at the communication level rather than
726 response_code is the HTTP response code and message, i.e.
727 '500 Internal Server Error'.
729 response_headers is a hash reference of the response headers
731 response_page is the raw content.
735 Returns the precise result code that the processor returned, these are
736 normally one letter codes that don't mean much unless you understand
737 the protocol they speak, you probably don't need this, but it's there
742 =head2 cvv2_response()
744 =head1 MISCELLANEOUS INTERNAL METHODS
746 =head2 transaction_type()
748 Retrieve the transaction type (the 'type' argument to contents()).
749 Generally only used internally, but provided in case it is useful.
753 Retrieve or change the processor submission server address (CHANGE AT
758 Retrieve or change the processor submission port (CHANGE AT YOUR OWN
763 Retrieve or change the processor submission path (CHANGE AT YOUR OWN
766 =head1 HELPER METHODS FOR GATEWAY MODULE AUTHORS
768 =head2 build_subs( @sub_names )
770 Build setter/getter subroutines for new return values.
772 =head2 get_fields( @fields )
774 Get the named fields if they are defined.
776 =head2 remap_fields( %map )
778 Remap field content (and stuff it back into content).
780 =head2 required_fields( @fields )
782 Croaks if any of the required fields are not present.
786 =head2 silly_bool( $value )
788 Returns 0 if the value starts with y, Y, t or T.
789 Returns 1 if the value starts with n, N, f or F.
790 Otherwise returns the value itself.
792 Use this for handling boolean content like tax_exempt.
798 Jason Kohles, email@jasonkohles.com
802 Ivan Kohler <ivan-business-onlinepayment@420.am>
804 Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
808 Copyright (c) 1999-2004 Jason Kohles
809 Copyright (c) 2004 Ivan Kohler
810 Copyright (c) 2007-2015 Freeside Internet Services, Inc.
814 This program is free software; you can redistribute it and/or modify it under
815 the same terms as Perl itself.
819 Homepage: http://perl.business/onlinepayment
821 Development: http://perl.business/onlinepayment/ng.html
825 Please direct current development questions, patches, etc. to the mailing list:
826 http://420.am/cgi-bin/mailman/listinfo/bop-devel/
830 The code is available from our public git repository:
832 git clone git://git.freeside.biz/Business-OnlinePayment.git
836 http://freeside.biz/gitweb/?p=Business-OnlinePayment.git
838 http://freeside.biz/gitlist/Business-OnlinePayment.git
840 Many (but by no means all!) processor plugins are also available in the same
843 http://freeside.biz/gitweb/
845 http://freeside.biz/gitlist/
849 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
850 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
851 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
855 http://perl.business/onlinepayment
857 For verification of credit card checksums, see L<Business::CreditCard>.