require 5.005;
-$VERSION = '3.01_04';
+$VERSION = '3.05';
$VERSION = eval $VERSION; # modperlstyle: convert the string into a number
# Remember subclasses we have "wrapped" submit() with _pre_submit()
failure_status
fraud_detect
is_success
+ partial_auth_amount
maximum_risk
path
port
response_code
response_header
response_page
+ avs_code
+ cvv2_response
+ txn_date
);
+__PACKAGE__->build_subs(@methods);
+
#fallback
sub _info {
my $class = shift;
%_info_handler = (
'supported_types' => sub {
my( $class, $v ) = @_;
- my $types = ref($v) ? $v : [ $v ];
- $types = { map { $_=>1 } @$types } if ref($v) eq 'ARRAY';
+ 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';
+ return %$v if ref($v) eq 'HASH';
$v = [ $v ] unless ref($v);
- my $types = $class->info('supported_types');
- { map { $_ => $v } keys %$types };
+ my $types = $class->info('supported_types') || {};
+ ( map { $_ => $v } keys %$types );
},
);
croak("unknown processor $processor ($@)") if $@;
my $self = bless {processor => $processor}, $subclass;
- $self->build_subs(@methods);
if($self->can("set_defaults")) {
$self->set_defaults(%data);
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();
}
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
=item Post Authorization
+=item Reverse Authorization
+
=item Void
=item Credit
+=item Tokenize
+
=item Recurring Authorization
=item Modify Recurring Authorization
=over 4
+=item partial_auth
+
+If you are prepared to handle partial authorizations
+(see L<partial_auth_amount()|/"partial_auth_amount()">
+ in L<TRANSACTION RESULT FIELDS|/"TRANSACTION RESULT FIELDS">),
+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
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
=item expiration
-Credit card expiration.
+Credit card expiration, MM/YY.
=item cvv2
Track 2 on the magnetic stripe (Card present only)
-=item recurring billing
+=item recurring_billing
Recurring billing flag
Account type. Can be (case-insensitive): B<Personal Checking>,
B<Personal Savings>, B<Business Checking> or B<Business Savings>.
+=item nacha_sec_code
+
+NACHA SEC Code for US ACH transactions. 'PPD' indicates customer signed a form
+giving authorization for the charge, 'CCD' same for a business checking/savings
+account, 'WEB' for online transactions where a box was checked authorizing the
+charge, and 'TEL' for authorization via recorded phone call (NACHA script
+required).
+
=item account_name
Account holder's name.
=back
+=head3 FOLLOW-UP TRANSACTION FIELDS
+
+These fields are used in follow-up transactions related to an original
+transaction (Post Authorization, Reverse Authorization, Void, Credit).
+
+=over 4
+
+=item authorization
+
+=item order_number
+
+=item txn_date
+
+=back
+
=head3 RECURRING BILLING FIELDS
=over 4
=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()
"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()
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. Store this if you would like to run inquiries or
+refunds on the transaction later.
+
=head2 fraud_score()
Retrieve or change the fraud score from any Business::FraudDetect plugin
=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.
Phil Lobbes E<lt>phil at perkpartners dot comE<gt>
+=head1 COPYRIGHT
+
+Copyright (c) 1999-2004 Jason Kohles
+Copyright (c) 2004 Ivan Kohler
+Copyright (c) 2007-2018 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
Please direct current development questions, patches, etc. to the mailing list:
-http://420.am/cgi-bin/mailman/listinfo/bop-devel/
+http://mail.freeside.biz/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://git.freeside.biz/gitweb/?p=Business-OnlinePayment.git
+ Or:
+ http://git.freeside.biz/cgit/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://git.freeside.biz/gitweb/
+ Or:
+ http://git.freeside.biz/cgit/
=head1 DISCLAIMER
=head1 SEE ALSO
-http://420.am/business-onlinepayment/
+http://perl.business/onlinepayment
For verification of credit card checksums, see L<Business::CreditCard>.
projects / Business-OnlinePayment.git / blobdiff