X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=OnlinePayment.pm;h=b4404fe19b306fb245b62fd227d6bc6b2d1ba789;hb=72783a4ae656a3d75184d0210ab81c73e22867b6;hp=a2499810d31194134408eecec895ca9253ed2912;hpb=a2a75e9852ea33b7c79bc33ee76be83f82caf637;p=Business-OnlinePayment.git diff --git a/OnlinePayment.pm b/OnlinePayment.pm index a249981..b4404fe 100644 --- a/OnlinePayment.pm +++ b/OnlinePayment.pm @@ -1,12 +1,12 @@ package Business::OnlinePayment; use strict; -use vars qw($VERSION); +use vars qw($VERSION %_info_handler); use Carp; require 5.005; -$VERSION = '3.01_01'; +$VERSION = '3.05_01'; $VERSION = eval $VERSION; # modperlstyle: convert the string into a number # Remember subclasses we have "wrapped" submit() with _pre_submit() @@ -19,6 +19,7 @@ my @methods = qw( failure_status fraud_detect is_success + partial_auth_amount maximum_risk path port @@ -33,8 +34,54 @@ my @methods = qw( response_code response_header response_page + avs_code + cvv2_response + txn_date ); +__PACKAGE__->build_subs(@methods); + +#fallback +sub _info { + my $class = shift; + ( my $gw = $class ) =~ s/^Business::OnlinePayment:://; + { + 'info_compat' => '0.00', + 'gateway_name' => $gw, + 'module_notes' => "Module does not yet provide info.", + }; +} + +#allow classes to declare info in a flexible way, but return normalized info +%_info_handler = ( + 'supported_types' => sub { + my( $class, $v ) = @_; + my $types = ref($v) ? $v : defined($v) ? [ $v ] : []; + $types = { map { $_=>1 } @$types } if ref($types) eq 'ARRAY'; + $types; + }, + 'supported_actions' => sub { + my( $class, $v ) = @_; + return %$v if ref($v) eq 'HASH'; + $v = [ $v ] unless ref($v); + my $types = $class->info('supported_types') || {}; + ( map { $_ => $v } keys %$types ); + }, +); + +sub info { + my $class = shift; #class or object + my $info = $class->_info; + if ( @_ ) { + my $key = shift; + exists($_info_handler{$key}) + ? &{ $_info_handler{$key} }( $class, $info->{$key} ) + : $info->{$key}; + } else { + wantarray ? ( keys %$info ) : [ keys %$info ]; + } +} + sub new { my($class,$processor,%data) = @_; @@ -45,7 +92,6 @@ sub new { croak("unknown processor $processor ($@)") if $@; my $self = bless {processor => $processor}, $subclass; - $self->build_subs(@methods); if($self->can("set_defaults")) { $self->set_defaults(%data); @@ -116,7 +162,6 @@ sub _pre_submit { unless ( $@ =~ m/^Can\'t locate/ ); } else { my $risk_tx = bless( { processor => $fraud_detection }, $subclass ); - $risk_tx->build_subs(@methods); if ($risk_tx->can('set_defaults')) { $risk_tx->set_defaults(); } @@ -229,15 +274,24 @@ Business::OnlinePayment - Perl extension for online payment processing type => 'Visa', amount => '49.95', card_number => '1234123412341238', - expiration => '0100', + expiration => '06/15', name => 'John Q Doe', ); - $transaction->submit(); - - if($transaction->is_success()) { - print "Card processed successfully: ", $transaction->authorization(), "\n"; + + eval { $transaction->submit(); }; + + if ( $@ ) { + + print "$processor error: $@\n"; + } else { - print "Card was rejected: ", $transaction->error_message(), "\n"; + + if ( $transaction->is_success() ) { + print "Card processed successfully: ". $transaction->authorization()."\n"; + } else { + print "Card was rejected: ". $transaction->error_message(). "\n"; + } + } =head1 DESCRIPTION @@ -294,10 +348,29 @@ processors support all transaction types. =item action -What to do with the transaction (currently available are: Normal -Authorization, Authorization Only, Credit, Post Authorization, -Recurring Authorization, Modify Recurring Authorization, -Cancel Recurring Authorization) +What action being taken by this transaction. Currently available are: + +=over 8 + +=item Normal Authorization + +=item Authorization Only + +=item Post Authorization + +=item Reverse Authorization + +=item Void + +=item Credit + +=item Recurring Authorization + +=item Modify Recurring Authorization + +=item Cancel Recurring Authorization + +=back =item amount @@ -310,6 +383,16 @@ just a whole or floating point number (i.e. 26, 26.1 or 26.13). =over 4 +=item partial_auth + +If you are prepared to handle partial authorizations +(see L + in L), +pass a true value in this field to enable them. + +If this flag is not set, a partial authorization will be immediately reversed +or voided. + =item description A description of the transaction (used by some processors to send @@ -340,6 +423,11 @@ Duty amount (portion of amount field, not added to it). Tax exempt flag (i.e. TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0). +=item currency + +Currency, specified as an ISO 4217 three-letter code, such as USD, CAD, EUR, +AUD, DKK, GBP, JPY, NZD, etc. + =back =head3 CUSTOMER INFO FIELDS @@ -434,14 +522,27 @@ IP Address from which the transaction originated. Credit card number. +=item expiration + +Credit card expiration, MM/YY. + =item cvv2 CVV2 number (also called CVC2 or CID) is a three- or four-digit security code used to reduce credit card fraud. -=item expiration +=item card_token -Credit card expiration. +If supported by your gateway, you can pass a card_token instead of a +card_number and expiration. + +=cut + +#=item card_response +# +#Some card_token schemes implement a challenge/response handshake. In those +#cases, this field is used for the response. In most cases the handshake +#it taken care of by the gateway module. =item track1 @@ -451,7 +552,7 @@ Track 1 on the magnetic stripe (Card present only) Track 2 on the magnetic stripe (Card present only) -=item recurring billing +=item recurring_billing Recurring billing flag @@ -463,32 +564,36 @@ Recurring billing flag =item account_number -Bank account number for electronic checks or electronic funds -transfer. +Bank account number =item routing_code -Bank's routing code for electronic checks or electronic funds -transfer. +Bank's routing code =item account_type -Account type for electronic checks or electronic funds transfer. Can be -(case-insensitive): B, B, -B or B. +Account type. Can be (case-insensitive): B, +B, B or B. =item account_name -Account holder's name for electronic checks or electronic funds -transfer. +Account holder's name. =item bank_name -Bank's name for electronic checks or electronic funds transfer. +Bank name. + +=item bank_city + +Bank city. + +=item bank_state + +Bank state. =item check_type -Check type for electronic checks or electronic funds transfer. +Check type. =item customer_org @@ -496,18 +601,15 @@ Customer organization type. =item customer_ssn -Customer's social security number. Typically only required for -electronic checks or electronic funds transfer. +Customer's social security number. =item license_num -Customer's driver's license number. Typically only required for -electronic checks or electronic funds transfer. +Customer's driver's license number. =item license_dob -Customer's date of birth. Typically only required for electronic -checks or electronic funds transfer. +Customer's date of birth. =back @@ -550,14 +652,28 @@ verification (if the processor supports it). =head2 submit() -Submit the transaction to the processor for completion +Submit the transaction to the processor for completion. + +If there is a gateway communication error or other "meta" , the submit method +will throw a fatal exception. You can catch this with eval {} if you would +like to treat gateway co =head1 TRANSACTION RESULT METHODS =head2 is_success() -Returns true if the transaction was submitted successfully, false if -it failed (or undef if it has not been submitted yet). +Returns true if the transaction was approved by the gateway, false if +it was submitted but not approved, or undef if it has not been +submitted yet. + +=head2 partial_auth_amount() + +If this transaction was a partial authorization (i.e. successful, but less than +the requested amount was processed), then the amount processed is returned in +this field. + +(When is_success is true but this field is empty or 0, that indicates a normal +full authorization for the entire requested amount.) =head2 error_message() @@ -573,10 +689,8 @@ are: "expired", "nsf" (non-sufficient funds), "stolen", "pickup", "blacklisted" and "declined" (card/transaction declines only, not other errors). -Note that (as of Aug 2006) this is only supported by some of the -newest processor modules, and that, even if supported, a failure -status is an entirely optional field that is only set for specific -kinds of failures. +Note that not all processor modules support this, and that if supported, +it may not be set for all declines. =head2 authorization() @@ -590,6 +704,16 @@ later. The unique order number for the transaction generated by the gateway. Store this if you would like to run inquiries or refunds on the transaction later. +=head2 card_token() + +If supported by your gateway, a card_token can be used in a subsequent +transaction to refer to a card number. + +=head2 txn_date() + +Transaction date, as returned by the gateway. Required by some gateways +for follow-up transactions. + =head2 fraud_score() Retrieve or change the fraud score from any Business::FraudDetect plugin @@ -670,25 +794,40 @@ Croaks if any of the required fields are not present. =head2 silly_bool( $value ) -Returns 0 if the value starts with y, Y, t or T. -Returns 1 if the value starts with n, N, f or F. +Returns 1 if the value starts with y, Y, t or T. +Returns 0 if the value starts with n, N, f or F. Otherwise returns the value itself. Use this for handling boolean content like tax_exempt. =head1 AUTHORS +(v2 series) + Jason Kohles, email@jasonkohles.com -(v3 rewrite) Ivan Kohler +(v3 rewrite) + +Ivan Kohler Phil Lobbes Ephil at perkpartners dot comE +=head1 COPYRIGHT + +Copyright (c) 1999-2004 Jason Kohles +Copyright (c) 2004 Ivan Kohler +Copyright (c) 2007-2015 Freeside Internet Services, Inc. + +All rights reserved. + +This program is free software; you can redistribute it and/or modify it under +the same terms as Perl itself. + =head1 HOMEPAGE -Homepage: http://420.am/business-onlinepayment/ +Homepage: http://perl.business/onlinepayment -Development: http://420.am/business-onlinepayment/ng.html +Development: http://perl.business/onlinepayment/ng.html =head1 MAILING LIST @@ -697,21 +836,22 @@ http://420.am/cgi-bin/mailman/listinfo/bop-devel/ =head1 REPOSITORY -The code is available from our public CVS repository: +The code is available from our public git repository: - export CVSROOT=":pserver:anonymous@cvs.freeside.biz:/home/cvs/cvsroot" - cvs login - # The password for the user `anonymous' is `anonymous'. - cvs checkout Business-OnlinePayment + git clone git://git.freeside.biz/Business-OnlinePayment.git Or on the web: - http://freeside.biz/cgi-bin/viewvc.cgi/Business-OnlinePayment/ + http://freeside.biz/gitweb/?p=Business-OnlinePayment.git + Or: + http://freeside.biz/gitlist/Business-OnlinePayment.git Many (but by no means all!) processor plugins are also available in the same repository, see: - http://freeside.biz/cgi-bin/viewvc.cgi/ + http://freeside.biz/gitweb/ + Or: + http://freeside.biz/gitlist/ =head1 DISCLAIMER @@ -721,7 +861,7 @@ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. =head1 SEE ALSO -http://420.am/business-onlinepayment/ +http://perl.business/onlinepayment For verification of credit card checksums, see L.