1 package FS::cust_main::Billing_Realtime;
4 use vars qw( $conf $DEBUG $me );
5 use vars qw( $realtime_bop_decline_quiet ); #ugh
8 use Business::CreditCard 0.35;
9 use Business::OnlinePayment;
10 use FS::UID qw( dbh myconnect );
11 use FS::Record qw( qsearch qsearchs );
14 use FS::cust_pay_pending;
15 use FS::cust_bill_pay;
18 use FS::payment_gateway;
19 use FS::Misc::Savepoint;
21 $realtime_bop_decline_quiet = 0;
23 # 1 is mostly method/subroutine entry and options
24 # 2 traces progress of some operations
25 # 3 is even more information including possibly sensitive data
27 $me = '[FS::cust_main::Billing_Realtime]';
30 our $BOP_TESTING_SUCCESS = 1;
31 our $BOP_TESTING_TIMESTAMP = '';
33 install_callback FS::UID sub {
35 #yes, need it for stuff below (prolly should be cached)
40 FS::cust_main::Billing_Realtime - Realtime billing mixin for cust_main
46 These methods are available on FS::cust_main objects.
52 =item realtime_cust_payby
56 sub realtime_cust_payby {
57 my( $self, %options ) = @_;
59 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
61 $options{amount} = $self->balance unless exists( $options{amount} );
63 my @cust_payby = $self->cust_payby('CARD','CHEK');
66 foreach my $cust_payby (@cust_payby) {
67 $error = $cust_payby->realtime_bop( %options, );
71 #XXX what about the earlier errors?
77 =item realtime_collect [ OPTION => VALUE ... ]
79 Attempt to collect the customer's current balance with a realtime credit
80 card or electronic check transaction (see realtime_bop() below).
82 Returns the result of realtime_bop(): nothing, an error message, or a
83 hashref of state information for a third-party transaction.
85 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
87 I<method> is one of: I<CC> or I<ECHECK>. If none is specified
88 then it is deduced from the customer record.
90 If no I<amount> is specified, then the customer balance is used.
92 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
93 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
94 if set, will override the value from the customer record.
96 I<description> is a free-text field passed to the gateway. It defaults to
97 the value defined by the business-onlinepayment-description configuration
98 option, or "Internet services" if that is unset.
100 If an I<invnum> is specified, this payment (if successful) is applied to the
103 I<apply> will automatically apply a resulting payment.
105 I<quiet> can be set true to suppress email decline notices.
107 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
108 resulting paynum, if any.
110 I<payunique> is a unique identifier for this payment.
112 I<session_id> is a session identifier associated with this payment.
114 I<depend_jobnum> allows payment capture to unlock export jobs
118 # Currently only used by ClientAPI
119 sub realtime_collect {
120 my( $self, %options ) = @_;
122 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
125 warn "$me realtime_collect:\n";
126 warn " $_ => $options{$_}\n" foreach keys %options;
129 $options{amount} = $self->balance unless exists( $options{amount} );
130 return '' unless $options{amount} > 0;
132 #huh, in v4, realtime_bop no longer will just process a card without passing
133 # payinfo or cust_payby...
134 if ( ! $options{'payinfo'} && ! $options{'cust_payby'} && $self->has_cust_payby_auto ) {
135 my @cust_payby = $self->cust_payby;
136 $options{'cust_payby'} = $cust_payby[0];
139 return $self->realtime_bop({%options});
143 =item realtime_bop { [ ARG => VALUE ... ] }
145 Runs a realtime credit card or ACH (electronic check) transaction
146 via a Business::OnlinePayment realtime gateway. See
147 L<http://420.am/business-onlinepayment> for supported gateways.
149 Required arguments in the hashref are I<amount> and either
150 I<cust_payby> or I<method>, I<payinfo> and (as applicable for method)
151 I<payname>, I<address1>, I<address2>, I<city>, I<state>, I<zip> and I<paydate>.
153 Available methods are: I<CC>, I<ECHECK>, or I<PAYPAL>
155 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
157 I<description> is a free-text field passed to the gateway. It defaults to
158 the value defined by the business-onlinepayment-description configuration
159 option, or "Internet services" if that is unset.
161 If an I<invnum> is specified, this payment (if successful) is applied to the
162 specified invoice. If the customer has exactly one open invoice, that
163 invoice number will be assumed. If you don't specify an I<invnum> you might
164 want to call the B<apply_payments> method or set the I<apply> option.
166 I<no_invnum> can be set to true to prevent that default invnum from being set.
168 I<apply> can be set to true to run B<apply_payments_and_credits> on success.
170 I<no_auto_apply> can be set to true to set that flag on the resulting payment
171 (prevents payment from being applied by B<apply_payments> or B<apply_payments_and_credits>,
172 but will still be applied if I<invnum> exists...use with I<no_invnum> for intended effect.)
174 I<quiet> can be set true to surpress email decline notices.
176 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
177 resulting paynum, if any.
179 I<payunique> is a unique identifier for this payment.
181 I<session_id> is a session identifier associated with this payment.
183 I<depend_jobnum> allows payment capture to unlock export jobs
185 I<discount_term> attempts to take a discount by prepaying for discount_term.
186 The payment will fail if I<amount> is incorrect for this discount term.
188 A direct (Business::OnlinePayment) transaction will return nothing on success,
189 or an error message on failure.
191 A third-party transaction will return a hashref containing:
193 - popup_url: the URL to which a browser should be redirected to complete
195 - collectitems: an arrayref of name-value pairs to be posted to popup_url.
196 - reference: a reference ID for the transaction, to show the customer.
198 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
202 # some helper routines
204 # _bop_recurring_billing: Checks whether this payment should have the
205 # recurring_billing flag used by some B:OP interfaces (IPPay, PlugnPay,
206 # vSecure, etc.). This works in two different modes:
207 # - actual_oncard (default): treat the payment as recurring if the customer
208 # has made a payment using this card before.
209 # - transaction_is_recur: treat the payment as recurring if the invoice
210 # being paid has any recurring package charges.
212 sub _bop_recurring_billing {
213 my( $self, %opt ) = @_;
215 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
217 if ( defined($method) && $method eq 'transaction_is_recur' ) {
219 return 1 if $opt{'trans_is_recur'};
223 # return 1 if the payinfo has been used for another payment
224 return $self->payinfo_used($opt{'payinfo'}); # in payinfo_Mixin
232 #can run safely as class method if opt payment_gateway already exists
233 sub _payment_gateway {
234 my ($self, $options) = @_;
236 if ( $options->{'fake_gatewaynum'} ) {
237 $options->{payment_gateway} =
238 qsearchs('payment_gateway',
239 { 'gatewaynum' => $options->{'fake_gatewaynum'}, }
243 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
244 unless exists($options->{payment_gateway});
246 $options->{payment_gateway};
254 'login' => $options->{payment_gateway}->gateway_username,
255 'password' => $options->{payment_gateway}->gateway_password,
263 $options->{payment_gateway}->gatewaynum
264 ? $options->{payment_gateway}->options
265 : @{ $options->{payment_gateway}->get('options') };
270 my ($self, $options) = @_;
272 unless ( $options->{'description'} ) {
273 if ( $conf->exists('business-onlinepayment-description') ) {
274 my $dtempl = $conf->config('business-onlinepayment-description');
276 my $agent = $self->agent->agent;
278 $options->{'description'} = eval qq("$dtempl");
280 $options->{'description'} = 'Internet services';
284 # Default invoice number if the customer has exactly one open invoice.
285 unless ( $options->{'invnum'} || $options->{'no_invnum'} ) {
286 $options->{'invnum'} = '';
287 my @open = $self->open_cust_bill;
288 $options->{'invnum'} = $open[0]->invnum if scalar(@open) == 1;
294 sub _bop_cust_payby_options {
296 my $cust_payby = $options->{'cust_payby'};
299 $options->{'method'} = FS::payby->payby2bop( $cust_payby->payby );
301 if ($cust_payby->payby =~ /^(CARD|DCRD)$/) {
302 # false laziness with cust_payby->check
303 # which might not have been run yet
305 if ( $cust_payby->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
306 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
307 } elsif ( $cust_payby->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
308 ( $m, $y ) = ( $2, "19$1" );
309 } elsif ( $cust_payby->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
310 ( $m, $y ) = ( $3, "20$2" );
312 return "Illegal expiration date: ". $cust_payby->paydate;
314 $m = sprintf('%02d',$m);
315 $options->{paydate} = "$y-$m-01";
317 $options->{paydate} = '';
320 $options->{$_} = $cust_payby->$_()
321 for qw( payinfo paycvv paymask paystart_month paystart_year
322 payissue payname paystate paytype payip );
324 if ( $cust_payby->locationnum ) {
325 my $cust_location = $cust_payby->cust_location;
326 $options->{$_} = $cust_location->$_()
327 for qw( address1 address2 city state zip country );
332 # can be called as class method,
333 # but can't load default name/phone fields as class method
334 # (why was this added? ah, it might get called from realtime_tokenize in this
335 # fashion "to tokenize old records on upgrade")
337 my ($self, $options) = @_;
340 my $payip = $options->{'payip'};
341 $content{customer_ip} = $payip if length($payip);
343 $content{invoice_number} = $options->{'invnum'}
344 if exists($options->{'invnum'}) && length($options->{'invnum'});
346 $content{email_customer} =
347 ( $conf->exists('business-onlinepayment-email_customer')
348 || $conf->exists('business-onlinepayment-email-override') );
350 my ($payname, $payfirst, $paylast);
351 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
352 ($payname = $options->{payname}) =~
353 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
354 or return "Illegal payname $payname";
355 ($payfirst, $paylast) = ($1, $2);
356 } elsif (ref($self)) { # can't set payname if called as class method
357 $payfirst = $self->getfield('first');
358 $paylast = $self->getfield('last');
359 $payname = "$payfirst $paylast";
362 $content{last_name} = $paylast if $paylast;
363 $content{first_name} = $payfirst if $payfirst;
365 $content{name} = $payname if $payname;
367 if ( exists($options->{'address1'}) && length($options->{'address1'}) ) {
369 $content{address} = $options->{'address1'};
370 my $address2 = $options->{'address2'};
371 $content{address} .= ", ". $address2 if length($address2);
373 $content{$_} = $options->{$_} foreach qw( city state zip country );
375 } elsif ( ref($self) ) {
377 $content{address} = $self->address1;
378 my $address2 = $self->address2;
379 $content{address} .= ", ". $address2 if length($address2);
381 $content{$_} = $self->$_() foreach qw( city state zip country );
385 # can't set phone if called as class method
386 $content{phone} = $self->daytime || $self->night
389 my $currency = $conf->exists('business-onlinepayment-currency')
390 && $conf->config('business-onlinepayment-currency');
391 $content{currency} = $currency if $currency;
396 # updates payinfo and cust_payby options with token from transaction
397 # can be called as a class method
399 my ($self,$transaction,$options) = @_;
400 if ( $transaction->can('card_token')
401 and $transaction->card_token
402 and !$self->tokenized($options->{'payinfo'})
404 $options->{'payinfo'} = $transaction->card_token;
405 $options->{'cust_payby'}->payinfo($transaction->card_token) if $options->{'cust_payby'};
406 return $transaction->card_token;
411 my %bop_method2payby = (
420 confess "Can't call realtime_bop within another transaction ".
421 '($FS::UID::AutoCommit is false)'
422 unless $FS::UID::AutoCommit || $BOP_TESTING;
424 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
426 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_bop');
429 if (ref($_[0]) eq 'HASH') {
432 my ( $method, $amount ) = ( shift, shift );
434 $options{method} = $method;
435 $options{amount} = $amount;
438 return '' unless $options{amount} > 0;
440 # set fields from passed cust_payby
441 _bop_cust_payby_options(\%options);
443 # check for banned credit card/ACH
444 my $ban = FS::banned_pay->ban_search(
445 'payby' => $bop_method2payby{$options{method}},
446 'payinfo' => $options{payinfo},
448 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
450 # possibly run a separate transaction to tokenize card number,
451 # so that we never store tokenized card info in cust_pay_pending
452 if (($options{method} eq 'CC') && !$self->tokenized($options{'payinfo'})) {
453 my $token_error = $self->realtime_tokenize(\%options);
454 return $token_error if $token_error;
455 # in theory, all cust_payby will be tokenized during original save,
456 # so we shouldn't get here with opt cust_payby...but just in case...
457 if ($options{'cust_payby'} && $self->tokenized($options{'payinfo'})) {
458 $token_error = $options{'cust_payby'}->replace;
459 return $token_error if $token_error;
464 # optional credit card surcharge
467 my $cc_surcharge = 0;
468 my $cc_surcharge_pct = 0;
469 $cc_surcharge_pct = $conf->config('credit-card-surcharge-percentage', $self->agentnum)
470 if $conf->config('credit-card-surcharge-percentage', $self->agentnum)
471 && $options{method} eq 'CC';
473 my $cc_surcharge_flat = 0;
474 $cc_surcharge_flat = $conf->config('credit-card-surcharge-flatfee', $self->agentnum)
475 if $conf->config('credit-card-surcharge-flatfee', $self->agentnum)
476 && $options{method} eq 'CC';
478 # always add cc surcharge if called from event
479 if($options{'cc_surcharge_from_event'} && ($cc_surcharge_pct > 0 || $cc_surcharge_flat > 0)) {
480 if ($options{'amount'} > 0) {
481 $cc_surcharge = ($options{'amount'} * ($cc_surcharge_pct / 100)) + $cc_surcharge_flat;
482 $options{'amount'} += $cc_surcharge;
483 $options{'amount'} = sprintf("%.2f", $options{'amount'}); # round (again)?
486 elsif($cc_surcharge_pct > 0 || $cc_surcharge_flat > 0) {
487 # we're called not from event (i.e. from a
488 # payment screen), so consider the given
489 # amount as post-surcharge-processing_fee
490 $cc_surcharge = $options{'amount'} - $options{'processing-fee'} - (($options{'amount'} - ($cc_surcharge_flat + $options{'processing-fee'})) / ( 1 + $cc_surcharge_pct/100 )) if $options{'amount'} > 0;
493 $cc_surcharge = sprintf("%.2f",$cc_surcharge) if $cc_surcharge > 0;
494 $options{'cc_surcharge'} = $cc_surcharge;
498 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
499 warn " cc_surcharge = $cc_surcharge\n";
502 warn " $_ => $options{$_}\n" foreach keys %options;
505 return $self->fake_bop(\%options) if $options{'fake'};
507 $self->_bop_defaults(\%options);
509 return "Missing payinfo"
510 unless $options{'payinfo'};
513 # set trans_is_recur based on invnum if there is one
516 my $trans_is_recur = 0;
517 if ( $options{'invnum'} ) {
519 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
520 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
526 $cust_bill->cust_bill_pkg;
529 if grep { $_->freq ne '0' } @part_pkg;
537 my $payment_gateway = $self->_payment_gateway( \%options );
538 my $namespace = $payment_gateway->gateway_namespace;
540 eval "use $namespace";
544 # check for term discount validity
547 my $discount_term = $options{discount_term};
548 if ( $discount_term ) {
549 my $bill = ($self->cust_bill)[-1]
550 or return "Can't apply a term discount to an unbilled customer";
551 my $plan = FS::discount_plan->new(
553 months => $discount_term
554 ) or return "No discount available for term '$discount_term'";
556 if ( $plan->discounted_total != $options{amount} ) {
557 return "Incorrect term prepayment amount (term $discount_term, amount $options{amount}, requires ".$plan->discounted_total.")";
565 my $bop_content = $self->_bop_content(\%options);
566 return $bop_content unless ref($bop_content);
568 my @invoicing_list = $self->invoicing_list_emailonly;
569 if ( $conf->exists('emailinvoiceautoalways')
570 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
571 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
572 push @invoicing_list, $self->all_emails;
575 my $email = ($conf->exists('business-onlinepayment-email-override'))
576 ? $conf->config('business-onlinepayment-email-override')
577 : $invoicing_list[0];
582 if ( $namespace eq 'Business::OnlinePayment' ) {
584 if ( $options{method} eq 'CC' ) {
586 $content{card_number} = $options{payinfo};
587 $paydate = $options{'paydate'};
588 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
589 $content{expiration} = "$2/$1";
591 $content{cvv2} = $options{'paycvv'}
592 if length($options{'paycvv'});
594 my $paystart_month = $options{'paystart_month'};
595 my $paystart_year = $options{'paystart_year'};
596 $content{card_start} = "$paystart_month/$paystart_year"
597 if $paystart_month && $paystart_year;
599 my $payissue = $options{'payissue'};
600 $content{issue_number} = $payissue if $payissue;
602 if ( $self->_bop_recurring_billing(
603 'payinfo' => $options{'payinfo'},
604 'trans_is_recur' => $trans_is_recur,
608 $content{recurring_billing} = 'YES';
609 $content{acct_code} = 'rebill'
610 if $conf->exists('credit_card-recurring_billing_acct_code');
613 } elsif ( $options{method} eq 'ECHECK' ){
615 ( $content{account_number}, $content{routing_code} ) =
616 split('@', $options{payinfo});
617 $content{bank_name} = $options{payname};
618 $content{bank_state} = $options{'paystate'};
619 $content{account_type}= uc($options{'paytype'}) || 'PERSONAL CHECKING';
621 $content{company} = $self->company if $self->company;
623 if ( $content{account_type} =~ /BUSINESS/i && $self->company ) {
624 $content{account_name} = $self->company;
626 $content{account_name} = $self->getfield('first'). ' '.
627 $self->getfield('last');
630 $content{customer_org} = $self->company ? 'B' : 'I';
631 $content{state_id} = exists($options{'stateid'})
632 ? $options{'stateid'}
633 : $self->getfield('stateid');
634 $content{state_id_state} = exists($options{'stateid_state'})
635 ? $options{'stateid_state'}
636 : $self->getfield('stateid_state');
637 $content{customer_ssn} = exists($options{'ss'})
642 die "unknown method ". $options{method};
645 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
648 die "unknown namespace $namespace";
655 my $balance = exists( $options{'balance'} )
656 ? $options{'balance'}
659 warn "claiming mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
660 $self->select_for_update; #mutex ... just until we get our pending record in
661 warn "obtained mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
663 #the checks here are intended to catch concurrent payments
664 #double-form-submission prevention is taken care of in cust_pay_pending::check
667 return "The customer's balance has changed; $options{method} transaction aborted."
668 if $self->balance < $balance;
670 #also check and make sure there aren't *other* pending payments for this cust
672 my @pending = qsearch('cust_pay_pending', {
673 'custnum' => $self->custnum,
674 'status' => { op=>'!=', value=>'done' }
677 #for third-party payments only, remove pending payments if they're in the
678 #'thirdparty' (waiting for customer action) state.
679 if ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
680 foreach ( grep { $_->status eq 'thirdparty' } @pending ) {
681 my $error = $_->delete;
682 warn "error deleting unfinished third-party payment ".
683 $_->paypendingnum . ": $error\n"
686 @pending = grep { $_->status ne 'thirdparty' } @pending;
689 return "A payment is already being processed for this customer (".
690 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
691 "); $options{method} transaction aborted."
694 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
696 my $cust_pay_pending = new FS::cust_pay_pending {
697 'custnum' => $self->custnum,
698 'paid' => $options{amount},
699 '_date' => $BOP_TESTING ? $BOP_TESTING_TIMESTAMP : '',
700 'payby' => $bop_method2payby{$options{method}},
701 'payinfo' => $options{payinfo},
702 'paymask' => $options{paymask},
703 'paydate' => $paydate,
704 'recurring_billing' => $content{recurring_billing},
705 'pkgnum' => $options{'pkgnum'},
707 'gatewaynum' => $payment_gateway->gatewaynum || '',
708 'session_id' => $options{session_id} || '',
709 'jobnum' => $options{depend_jobnum} || '',
711 $cust_pay_pending->payunique( $options{payunique} )
712 if defined($options{payunique}) && length($options{payunique});
714 warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
716 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
717 return $cpp_new_err if $cpp_new_err;
719 warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
721 warn Dumper($cust_pay_pending) if $DEBUG > 2;
723 my( $action1, $action2 ) =
724 split( /\s*\,\s*/, $payment_gateway->gateway_action );
726 my $transaction = new $namespace( $payment_gateway->gateway_module,
727 _bop_options(\%options),
730 $transaction->content(
731 'type' => $options{method},
732 _bop_auth(\%options),
733 'action' => $action1,
734 'description' => $options{'description'},
735 'amount' => $options{amount},
736 #'invoice_number' => $options{'invnum'},
737 'customer_id' => $self->custnum,
739 'reference' => $cust_pay_pending->paypendingnum, #for now
740 'callback_url' => $payment_gateway->gateway_callback_url,
741 'cancel_url' => $payment_gateway->gateway_cancel_url,
746 $cust_pay_pending->status('pending');
747 my $cpp_pending_err = $cust_pay_pending->replace;
748 return $cpp_pending_err if $cpp_pending_err;
750 warn Dumper($transaction) if $DEBUG > 2;
752 unless ( $BOP_TESTING ) {
753 $transaction->test_transaction(1)
754 if $conf->exists('business-onlinepayment-test_transaction');
755 $transaction->submit();
757 if ( $BOP_TESTING_SUCCESS ) {
758 $transaction->is_success(1);
759 $transaction->authorization('fake auth');
761 $transaction->is_success(0);
762 $transaction->error_message('fake failure');
766 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
768 $cust_pay_pending->status('thirdparty');
769 my $cpp_err = $cust_pay_pending->replace;
770 return { error => $cpp_err } if $cpp_err;
771 return { reference => $cust_pay_pending->paypendingnum,
772 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
774 } elsif ( !$BOP_TESTING && $transaction->is_success() && $action2 ) {
776 $cust_pay_pending->status('authorized');
777 my $cpp_authorized_err = $cust_pay_pending->replace;
778 return $cpp_authorized_err if $cpp_authorized_err;
780 my $auth = $transaction->authorization;
781 my $ordernum = $transaction->can('order_number')
782 ? $transaction->order_number
786 new Business::OnlinePayment( $payment_gateway->gateway_module,
787 _bop_options(\%options),
792 type => $options{method},
794 _bop_auth(\%options),
795 order_number => $ordernum,
796 amount => $options{amount},
797 authorization => $auth,
798 description => $options{'description'},
801 foreach my $field (qw( authorization_source_code returned_ACI
802 transaction_identifier validation_code
803 transaction_sequence_num local_transaction_date
804 local_transaction_time AVS_result_code )) {
805 $capture{$field} = $transaction->$field() if $transaction->can($field);
808 $capture->content( %capture );
810 $capture->test_transaction(1)
811 if $conf->exists('business-onlinepayment-test_transaction');
814 unless ( $capture->is_success ) {
815 my $e = "Authorization successful but capture failed, custnum #".
816 $self->custnum. ': '. $capture->result_code.
817 ": ". $capture->error_message;
825 # remove paycvv after initial transaction
828 # compare to FS::cust_main::save_cust_payby - check both to make sure working correctly
829 if ( length($options{'paycvv'})
830 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
832 my $error = $self->remove_cvv_from_cust_payby($options{payinfo});
834 $log->critical('Error removing cvv for cust '.$self->custnum.': '.$error);
835 #not returning error, should at least attempt to handle results of an otherwise valid transaction
836 warn "WARNING: error removing cvv: $error\n";
844 # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
845 # if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
846 if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
847 # cpp will be replaced in _realtime_bop_result
848 $cust_pay_pending->payinfo($card_token);
849 if ($options{'cust_payby'} and my $error = $options{'cust_payby'}->replace) {
850 $log->critical('Error storing token for cust '.$self->custnum.', cust_payby '.$options{'cust_payby'}->custpaybynum.': '.$error);
851 #not returning error, should at least attempt to handle results of an otherwise valid transaction
852 #this leaves real card number in cust_payby, but can't do much else if cust_payby won't replace
860 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
872 if (ref($_[0]) eq 'HASH') {
875 my ( $method, $amount ) = ( shift, shift );
877 $options{method} = $method;
878 $options{amount} = $amount;
881 if ( $options{'fake_failure'} ) {
882 return "Error: No error; test failure requested with fake_failure";
885 my $cust_pay = new FS::cust_pay ( {
886 'custnum' => $self->custnum,
887 'invnum' => $options{'invnum'},
888 'paid' => $options{amount},
890 'payby' => $bop_method2payby{$options{method}},
891 'payinfo' => '4111111111111111',
892 'paydate' => '2012-05-01',
893 'processor' => 'FakeProcessor',
895 'order_number' => '32',
897 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
900 warn "fake_bop\n cust_pay: ". Dumper($cust_pay) . "\n options: ";
901 warn " $_ => $options{$_}\n" foreach keys %options;
904 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
907 $cust_pay->invnum(''); #try again with no specific invnum
908 my $error2 = $cust_pay->insert( $options{'manual'} ?
909 ( 'manual' => 1 ) : ()
912 # gah, even with transactions.
913 my $e = 'WARNING: Card/ACH debited but database not updated - '.
914 "error inserting (fake!) payment: $error2".
915 " (previously tried insert with invnum #$options{'invnum'}" .
922 if ( $options{'paynum_ref'} ) {
923 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
931 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
933 # Wraps up processing of a realtime credit card or ACH (electronic check)
936 sub _realtime_bop_result {
937 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
939 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
942 warn "$me _realtime_bop_result: pending transaction ".
943 $cust_pay_pending->paypendingnum. "\n";
944 warn " $_ => $options{$_}\n" foreach keys %options;
947 my $payment_gateway = $options{payment_gateway}
948 or return "no payment gateway in arguments to _realtime_bop_result";
950 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
951 my $cpp_captured_err = $cust_pay_pending->replace; #also saves post-transaction tokenization, if that happens
952 return $cpp_captured_err if $cpp_captured_err;
954 if ( $transaction->is_success() ) {
956 my $order_number = $transaction->order_number
957 if $transaction->can('order_number');
959 my $cust_pay = new FS::cust_pay ( {
960 'custnum' => $self->custnum,
961 'invnum' => $options{'invnum'},
962 'paid' => $cust_pay_pending->paid,
963 '_date' => $BOP_TESTING ? $BOP_TESTING_TIMESTAMP : '',
964 'payby' => $cust_pay_pending->payby,
965 'payinfo' => $options{'payinfo'},
966 'paymask' => $options{'paymask'} || $cust_pay_pending->paymask,
967 'paydate' => $cust_pay_pending->paydate,
968 'pkgnum' => $cust_pay_pending->pkgnum,
969 'discount_term' => $options{'discount_term'},
970 'gatewaynum' => ($payment_gateway->gatewaynum || ''),
971 'processor' => $payment_gateway->gateway_module,
972 'auth' => $transaction->authorization,
973 'order_number' => $order_number || '',
974 'no_auto_apply' => $options{'no_auto_apply'} ? 'Y' : '',
976 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
977 $cust_pay->payunique( $options{payunique} )
978 if defined($options{payunique}) && length($options{payunique});
980 my $oldAutoCommit = $FS::UID::AutoCommit;
981 local $FS::UID::AutoCommit = 0;
984 my $savepoint_label = '_realtime_bop_result';
985 savepoint_create( $savepoint_label );
987 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
988 my $error = $cust_pay->insert(
989 $options{'manual'} ? ( 'manual' => 1 ) : (),
990 $options{'processing-fee'} > 0 ? ( 'processing-fee' => $options{'processing-fee'} ) : (),
994 savepoint_rollback( $savepoint_label );
996 $cust_pay->invnum(''); #try again with no specific invnum
997 $cust_pay->paynum('');
998 my $error2 = $cust_pay->insert(
999 $options{'manual'} ? ( 'manual' => 1 ) : (),
1000 $options{'processing-fee'} > 0 ? ( 'processing-fee' => $options{'processing-fee'} ) : (),
1003 # gah. but at least we have a record of the state we had to abort in
1004 # from cust_pay_pending now.
1005 savepoint_rollback_and_release( $savepoint_label );
1007 my $e = "WARNING: $options{method} captured but payment not recorded -".
1008 " error inserting payment (". $payment_gateway->gateway_module.
1010 " (previously tried insert with invnum #$options{'invnum'}" .
1011 ": $error ) - pending payment saved as paypendingnum ".
1012 $cust_pay_pending->paypendingnum. "\n";
1018 my $jobnum = $cust_pay_pending->jobnum;
1020 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1022 unless ( $placeholder ) {
1023 savepoint_rollback_and_release( $savepoint_label );
1025 my $e = "WARNING: $options{method} captured but job $jobnum not ".
1026 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
1031 $error = $placeholder->delete;
1034 savepoint_rollback_and_release( $savepoint_label );
1036 my $e = "WARNING: $options{method} captured but could not delete ".
1037 "job $jobnum for paypendingnum ".
1038 $cust_pay_pending->paypendingnum. ": $error\n";
1043 $cust_pay_pending->set('jobnum','');
1047 if ( $options{'paynum_ref'} ) {
1048 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
1051 $cust_pay_pending->status('done');
1052 $cust_pay_pending->statustext('captured');
1053 $cust_pay_pending->paynum($cust_pay->paynum);
1054 my $cpp_done_err = $cust_pay_pending->replace;
1056 if ( $cpp_done_err ) {
1057 savepoint_rollback_and_release( $savepoint_label );
1059 my $e = "WARNING: $options{method} captured but payment not recorded - ".
1060 "error updating status for paypendingnum ".
1061 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1066 savepoint_release( $savepoint_label );
1067 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1069 if ( $options{'apply'} ) {
1070 my $apply_error = $self->apply_payments_and_credits;
1071 if ( $apply_error ) {
1072 warn "WARNING: error applying payment: $apply_error\n";
1073 #but we still should return no error cause the payment otherwise went
1078 # have a CC surcharge portion --> one-time charge
1079 if ( $options{'cc_surcharge'} > 0 || $options{'processing-fee'} > 0) {
1080 # XXX: this whole block needs to be in a transaction?
1083 $invnum = $options{'invnum'} if $options{'invnum'};
1084 unless ( $invnum ) { # probably from a payment screen
1085 # do we have any open invoices? pick earliest
1086 # uses the fact that cust_main->cust_bill sorts by date ascending
1087 my @open = $self->open_cust_bill;
1088 $invnum = $open[0]->invnum if scalar(@open);
1091 unless ( $invnum ) { # still nothing? pick last closed invoice
1092 # again uses fact that cust_main->cust_bill sorts by date ascending
1093 my @closed = $self->cust_bill;
1094 $invnum = $closed[$#closed]->invnum if scalar(@closed);
1097 unless ( $invnum ) {
1098 # XXX: unlikely case - pre-paying before any invoices generated
1099 # what it should do is create a new invoice and pick it
1100 warn 'CC SURCHARGE OR PROCESS FEE AND NO INVOICES PICKED TO APPLY IT!';
1104 if ($options{'cc_surcharge'} > 0) {
1106 my $cc_surcharge_text = 'Credit Card Surcharge';
1107 $cc_surcharge_text = $conf->config('credit-card-surcharge-text', $self->agentnum) if $conf->exists('credit-card-surcharge-text', $self->agentnum);
1108 my $charge_error = $self->charge({
1109 'amount' => $options{'cc_surcharge'},
1110 'pkg' => $cc_surcharge_text,
1112 'cust_pkg_ref' => \$cust_pkg,
1116 warn 'Unable to add CC surcharge cust_pkg';
1120 $cust_pkg->setup(time);
1121 my $cp_error = $cust_pkg->replace;
1123 warn 'Unable to set setup time on cust_pkg for cc surcharge';
1127 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1128 unless ( $cust_bill ) {
1129 warn "race condition + invoice deletion just happened";
1134 $cust_bill->add_cc_surcharge($cust_pkg->pkgnum,$options{'cc_surcharge'});
1136 warn "cannot add CC surcharge to invoice #$invnum: $grand_error"
1138 } # end if $options{'cc_surcharge'}
1140 if ($options{'processing-fee'} > 0) {
1142 my $processing_fee_text = 'Payment Processing Fee';
1144 my $conf = new FS::Conf;
1146 my $pf_seperate_bill;
1148 if ($conf->exists('processing-fee_on_separate_invoice')) {
1149 $pf_seperate_bill = 'Y';
1153 my $pf_change_error = $self->charge({
1154 'amount' => $options{'processing-fee'},
1155 'pkg' => $processing_fee_text,
1157 'cust_pkg_ref' => \$pf_cust_pkg,
1158 'separate_bill' => $pf_seperate_bill,
1159 'bill_now' => $pf_bill_now,
1162 if($pf_change_error) {
1163 warn 'Unable to add payment processing fee';
1167 $pf_cust_pkg->setup(time);
1168 my $pf_error = $pf_cust_pkg->replace;
1170 warn 'Unable to set setup time on cust_pkg for processing fee';
1174 if ($conf->exists('processing-fee_on_separate_invoice')) {
1175 my $cust_bill_pkg = qsearchs( 'cust_bill_pkg', { 'pkgnum' => $pf_cust_pkg->pkgnum } );
1177 my $pf_cust_bill = qsearchs('cust_bill', { 'invnum' => $cust_bill_pkg->invnum });
1178 unless ( $pf_cust_bill ) {
1179 warn "no processing fee inv found!";
1183 my $pf_apply_error = $pf_cust_bill->apply_payments_and_credits;
1185 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1186 unless ( $cust_bill ) {
1187 warn "race condition + invoice deletion just happened";
1191 my $grand_pf_error = $cust_bill->apply_payments_and_credits;
1193 warn "cannot apply Processing fee to invoice #$invnum: $grand_pf_error - $pf_apply_error"
1194 if $grand_pf_error || $pf_apply_error;
1195 } ## processing-fee_on_separate_invoice
1197 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1198 unless ( $cust_bill ) {
1199 warn "race condition + invoice deletion just happened";
1203 my $grand_pf_error =
1204 $cust_bill->add_cc_surcharge($pf_cust_pkg->pkgnum,$options{'processing-fee'});
1206 warn "cannot add Processing fee to invoice #$invnum: $grand_pf_error"
1208 } ## no processing-fee_on_separate_invoice
1209 } #end if $options{'processing-fee'}
1211 } #end if ( $options{'cc_surcharge'} > 0 || $options{'processing-fee'} > 0)
1213 return ''; #no error
1219 my $perror = $transaction->error_message;
1220 #$payment_gateway->gateway_module. " error: ".
1221 # removed for conciseness
1223 my $jobnum = $cust_pay_pending->jobnum;
1225 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1227 if ( $placeholder ) {
1228 my $error = $placeholder->depended_delete;
1229 $error ||= $placeholder->delete;
1230 $cust_pay_pending->set('jobnum','');
1231 warn "error removing provisioning jobs after declined paypendingnum ".
1232 $cust_pay_pending->paypendingnum. ": $error\n" if $error;
1234 my $e = "error finding job $jobnum for declined paypendingnum ".
1235 $cust_pay_pending->paypendingnum. "\n";
1241 unless ( $transaction->error_message ) {
1244 if ( $transaction->can('response_page') ) {
1246 'page' => ( $transaction->can('response_page')
1247 ? $transaction->response_page
1250 'code' => ( $transaction->can('response_code')
1251 ? $transaction->response_code
1254 'headers' => ( $transaction->can('response_headers')
1255 ? $transaction->response_headers
1261 "No additional debugging information available for ".
1262 $payment_gateway->gateway_module;
1265 $perror .= "No error_message returned from ".
1266 $payment_gateway->gateway_module. " -- ".
1267 ( ref($t_response) ? Dumper($t_response) : $t_response );
1271 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
1272 && $conf->exists('emaildecline', $self->agentnum)
1273 && grep { $_ ne 'POST' } $self->invoicing_list
1274 && ! grep { $transaction->error_message =~ /$_/ }
1275 $conf->config('emaildecline-exclude', $self->agentnum)
1278 # Send a decline alert to the customer.
1279 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
1282 # include the raw error message in the transaction state
1283 $cust_pay_pending->setfield('error', $transaction->error_message);
1284 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1285 $error = $msg_template->send( 'cust_main' => $self,
1286 'object' => $cust_pay_pending );
1290 $perror .= " (also received error sending decline notification: $error)"
1295 $cust_pay_pending->status('done');
1296 $cust_pay_pending->statustext($perror);
1297 #'declined:': no, that's failure_status
1298 if ( $transaction->can('failure_status') ) {
1299 $cust_pay_pending->failure_status( $transaction->failure_status );
1301 my $cpp_done_err = $cust_pay_pending->replace;
1302 if ( $cpp_done_err ) {
1303 my $e = "WARNING: $options{method} declined but pending payment not ".
1304 "resolved - error updating status for paypendingnum ".
1305 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1307 $perror = "$e ($perror)";
1315 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
1317 Verifies successful third party processing of a realtime credit card or
1318 ACH (electronic check) transaction via a
1319 Business::OnlineThirdPartyPayment realtime gateway. See
1320 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
1322 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
1324 The additional options I<payname>, I<city>, I<state>,
1325 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
1326 if set, will override the value from the customer record.
1328 I<description> is a free-text field passed to the gateway. It defaults to
1329 "Internet services".
1331 If an I<invnum> is specified, this payment (if successful) is applied to the
1332 specified invoice. If you don't specify an I<invnum> you might want to
1333 call the B<apply_payments> method.
1335 I<quiet> can be set true to surpress email decline notices.
1337 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
1338 resulting paynum, if any.
1340 I<payunique> is a unique identifier for this payment.
1342 Returns a hashref containing elements bill_error (which will be undefined
1343 upon success) and session_id of any associated session.
1347 sub realtime_botpp_capture {
1348 my( $self, $cust_pay_pending, %options ) = @_;
1350 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1353 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
1354 warn " $_ => $options{$_}\n" foreach keys %options;
1357 eval "use Business::OnlineThirdPartyPayment";
1361 # select the gateway
1364 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
1366 my $payment_gateway;
1367 my $gatewaynum = $cust_pay_pending->getfield('gatewaynum');
1368 $payment_gateway = $gatewaynum ? qsearchs( 'payment_gateway',
1369 { gatewaynum => $gatewaynum }
1371 : $self->agent->payment_gateway( 'method' => $method,
1372 # 'invnum' => $cust_pay_pending->invnum,
1373 # 'payinfo' => $cust_pay_pending->payinfo,
1376 $options{payment_gateway} = $payment_gateway; # for the helper subs
1382 my @invoicing_list = $self->invoicing_list_emailonly;
1383 if ( $conf->exists('emailinvoiceautoalways')
1384 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1385 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1386 push @invoicing_list, $self->all_emails;
1389 my $email = ($conf->exists('business-onlinepayment-email-override'))
1390 ? $conf->config('business-onlinepayment-email-override')
1391 : $invoicing_list[0];
1395 $content{email_customer} =
1396 ( $conf->exists('business-onlinepayment-email_customer')
1397 || $conf->exists('business-onlinepayment-email-override') );
1400 # run transaction(s)
1404 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
1405 _bop_options(\%options),
1408 $transaction->reference({ %options });
1410 $transaction->content(
1412 _bop_auth(\%options),
1413 'action' => 'Post Authorization',
1414 'description' => $options{'description'},
1415 'amount' => $cust_pay_pending->paid,
1416 #'invoice_number' => $options{'invnum'},
1417 'customer_id' => $self->custnum,
1418 'reference' => $cust_pay_pending->paypendingnum,
1420 'phone' => $self->daytime || $self->night,
1422 # plus whatever is required for bogus capture avoidance
1425 $transaction->submit();
1428 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
1430 if ( $options{'apply'} ) {
1431 my $apply_error = $self->apply_payments_and_credits;
1432 if ( $apply_error ) {
1433 warn "WARNING: error applying payment: $apply_error\n";
1438 bill_error => $error,
1439 session_id => $cust_pay_pending->session_id,
1444 =item default_payment_gateway
1446 DEPRECATED -- use agent->payment_gateway
1450 sub default_payment_gateway {
1451 my( $self, $method ) = @_;
1453 die "Real-time processing not enabled\n"
1454 unless $conf->exists('business-onlinepayment');
1456 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
1459 my $bop_config = 'business-onlinepayment';
1460 $bop_config .= '-ach'
1461 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
1462 my ( $processor, $login, $password, $action, @bop_options ) =
1463 $conf->config($bop_config);
1464 $action ||= 'normal authorization';
1465 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
1466 die "No real-time processor is enabled - ".
1467 "did you set the business-onlinepayment configuration value?\n"
1470 ( $processor, $login, $password, $action, @bop_options )
1473 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
1475 Refunds a realtime credit card or ACH (electronic check) transaction
1476 via a Business::OnlinePayment realtime gateway. See
1477 L<http://420.am/business-onlinepayment> for supported gateways.
1479 Available methods are: I<CC> or I<ECHECK>
1481 Available options are: I<amount>, I<reasonnum>, I<paynum>, I<paydate>
1483 Most gateways require a reference to an original payment transaction to refund,
1484 so you probably need to specify a I<paynum>.
1486 I<amount> defaults to the original amount of the payment if not specified.
1488 I<reasonnum> specified an existing refund reason for the refund
1490 I<paydate> specifies the expiration date for a credit card overriding the
1491 value from the customer record or the payment record. Specified as yyyy-mm-dd
1493 Implementation note: If I<amount> is unspecified or equal to the amount of the
1494 orignal payment, first an attempt is made to "void" the transaction via
1495 the gateway (to cancel a not-yet settled transaction) and then if that fails,
1496 the normal attempt is made to "refund" ("credit") the transaction via the
1497 gateway is attempted. No attempt to "void" the transaction is made if the
1498 gateway has introspection data and doesn't support void.
1500 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
1501 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
1502 #if set, will override the value from the customer record.
1504 #If an I<invnum> is specified, this payment (if successful) is applied to the
1505 #specified invoice. If you don't specify an I<invnum> you might want to
1506 #call the B<apply_payments> method.
1510 #some false laziness w/realtime_bop, not enough to make it worth merging
1511 #but some useful small subs should be pulled out
1512 sub realtime_refund_bop {
1515 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1518 if (ref($_[0]) eq 'HASH') {
1519 %options = %{$_[0]};
1523 $options{method} = $method;
1527 warn "$me realtime_refund_bop (new): $options{method} refund\n";
1528 warn " $_ => $options{$_}\n" foreach keys %options;
1531 return "No reason specified" unless $options{'reasonnum'} =~ /^\d+$/;
1536 # look up the original payment and optionally a gateway for that payment
1540 my $amount = $options{'amount'};
1542 my( $processor, $login, $password, @bop_options, $namespace ) ;
1543 my( $auth, $order_number ) = ( '', '', '' );
1544 my $gatewaynum = '';
1546 if ( $options{'paynum'} ) {
1548 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
1549 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
1550 or return "Unknown paynum $options{'paynum'}";
1551 $amount ||= $cust_pay->paid;
1553 my @cust_bill_pay = qsearch('cust_bill_pay', { paynum=>$cust_pay->paynum });
1554 $content{'invoice_number'} = $cust_bill_pay[0]->invnum if @cust_bill_pay;
1556 if ( $cust_pay->get('processor') ) {
1557 ($gatewaynum, $processor, $auth, $order_number) =
1559 $cust_pay->gatewaynum,
1560 $cust_pay->processor,
1562 $cust_pay->order_number,
1565 # this payment wasn't upgraded, which probably means this won't work,
1567 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
1568 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
1569 $cust_pay->paybatch;
1570 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
1573 my $payment_gateway;
1574 if ( $gatewaynum ) { #gateway for the payment to be refunded
1577 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
1578 die "payment gateway $gatewaynum not found"
1579 unless $payment_gateway;
1581 $processor = $payment_gateway->gateway_module;
1582 $login = $payment_gateway->gateway_username;
1583 $password = $payment_gateway->gateway_password;
1584 $namespace = $payment_gateway->gateway_namespace;
1585 @bop_options = $payment_gateway->options;
1587 } else { #try the default gateway
1591 $self->agent->payment_gateway('method' => $options{method});
1593 ( $conf_processor, $login, $password, $namespace ) =
1594 map { my $method = "gateway_$_"; $payment_gateway->$method }
1595 qw( module username password namespace );
1597 @bop_options = $payment_gateway->gatewaynum
1598 ? $payment_gateway->options
1599 : @{ $payment_gateway->get('options') };
1600 my %bop_options = @bop_options;
1602 return "processor of payment $options{'paynum'} $processor does not".
1603 " match default processor $conf_processor"
1604 unless ($processor eq $conf_processor)
1605 || (($conf_processor eq 'CardFortress') && ($processor eq $bop_options{'gateway'}));
1607 $processor = $conf_processor;
1611 # if gateway has switched to CardFortress but token_check hasn't run yet,
1612 # tokenize just this record now, so that token gets passed/set appropriately
1613 if ($cust_pay->payby eq 'CARD' && !$cust_pay->tokenized) {
1615 'payment_gateway' => $payment_gateway,
1617 'payinfo' => $cust_pay->payinfo,
1618 'paydate' => $cust_pay->paydate,
1620 my $error = $self->realtime_tokenize(\%tokenopts); # no-op unless gateway can tokenize
1621 if ($self->tokenized($tokenopts{'payinfo'})) { # implies no error
1622 warn " tokenizing cust_pay\n" if $DEBUG > 1;
1623 $cust_pay->payinfo($tokenopts{'payinfo'});
1624 $error = $cust_pay->replace;
1626 return $error if $error;
1629 } else { # didn't specify a paynum, so look for agent gateway overrides
1630 # like a normal transaction
1632 my $payment_gateway =
1633 $self->agent->payment_gateway( 'method' => $options{method} );
1634 ( $processor, $login, $password, $namespace ) =
1635 map { my $method = "gateway_$_"; $payment_gateway->$method }
1636 qw( module username password namespace );
1638 my @bop_options = $payment_gateway->gatewaynum
1639 ? $payment_gateway->options
1640 : @{ $payment_gateway->get('options') };
1643 return "neither amount nor paynum specified" unless $amount;
1645 eval "use $namespace";
1650 'type' => $options{method},
1652 'password' => $password,
1653 'order_number' => $order_number,
1654 'amount' => $amount,
1656 $content{authorization} = $auth
1657 if length($auth); #echeck/ACH transactions have an order # but no auth
1658 #(at least with authorize.net)
1660 my $currency = $conf->exists('business-onlinepayment-currency')
1661 && $conf->config('business-onlinepayment-currency');
1662 $content{currency} = $currency if $currency;
1664 my $disable_void_after;
1665 if ($conf->exists('disable_void_after')
1666 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
1667 $disable_void_after = $1;
1670 #first try void if applicable
1671 my $void = new Business::OnlinePayment( $processor, @bop_options );
1674 if ($void->can('info')) {
1676 $paytype = 'ECHECK' if $cust_pay && $cust_pay->payby eq 'CHEK';
1677 $paytype = 'CC' if $cust_pay && $cust_pay->payby eq 'CARD';
1678 my %supported_actions = $void->info('supported_actions');
1680 if ( %supported_actions && $paytype
1681 && defined($supported_actions{$paytype})
1682 && !grep{ $_ eq 'Void' } @{$supported_actions{$paytype}} );
1685 if ( $cust_pay && $cust_pay->paid == $amount
1687 ( not defined($disable_void_after) )
1688 || ( time < ($cust_pay->_date + $disable_void_after ) )
1692 warn " attempting void\n" if $DEBUG > 1;
1693 if ( $void->can('info') ) {
1694 if ( $cust_pay->payby eq 'CARD'
1695 && $void->info('CC_void_requires_card') )
1697 $content{'card_number'} = $cust_pay->payinfo;
1698 } elsif ( $cust_pay->payby eq 'CHEK'
1699 && $void->info('ECHECK_void_requires_account') )
1701 ( $content{'account_number'}, $content{'routing_code'} ) =
1702 split('@', $cust_pay->payinfo);
1703 $content{'name'} = $self->get('first'). ' '. $self->get('last');
1706 $void->content( 'action' => 'void', %content );
1707 $void->test_transaction(1)
1708 if $conf->exists('business-onlinepayment-test_transaction');
1710 if ( $void->is_success ) {
1711 # specified as a refund reason, but now we want a payment void reason
1712 # extract just the reason text, let cust_pay::void handle new_or_existing
1713 my $reason = qsearchs('reason',{ 'reasonnum' => $options{'reasonnum'} });
1715 $error = 'Reason could not be loaded' unless $reason;
1716 $error = $cust_pay->void($reason->reason) unless $error;
1718 # gah, even with transactions.
1719 my $e = 'WARNING: Card/ACH voided but database not updated - '.
1720 "error voiding payment: $error";
1724 warn " void successful\n" if $DEBUG > 1;
1729 warn " void unsuccessful, trying refund\n"
1733 my $address = $self->address1;
1734 $address .= ", ". $self->address2 if $self->address2;
1736 my($payname, $payfirst, $paylast);
1737 if ( $self->payname && $options{method} ne 'ECHECK' ) {
1738 $payname = $self->payname;
1739 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
1740 or return "Illegal payname $payname";
1741 ($payfirst, $paylast) = ($1, $2);
1743 $payfirst = $self->getfield('first');
1744 $paylast = $self->getfield('last');
1745 $payname = "$payfirst $paylast";
1748 my @invoicing_list = $self->invoicing_list_emailonly;
1749 if ( $conf->exists('emailinvoiceautoalways')
1750 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1751 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1752 push @invoicing_list, $self->all_emails;
1755 my $email = ($conf->exists('business-onlinepayment-email-override'))
1756 ? $conf->config('business-onlinepayment-email-override')
1757 : $invoicing_list[0];
1759 my $payip = exists($options{'payip'})
1762 $content{customer_ip} = $payip
1766 my $paymask = ''; # for refund record
1767 if ( $options{method} eq 'CC' ) {
1770 $content{card_number} = $payinfo = $cust_pay->payinfo;
1771 $paymask = $cust_pay->paymask;
1772 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
1773 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
1774 ($content{expiration} = "$2/$1"); # where available
1776 # this really needs a better cleanup
1777 die "Refund without paynum not supported";
1778 # $content{card_number} = $payinfo = $self->payinfo;
1779 # (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
1780 # =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1781 # $content{expiration} = "$2/$1";
1784 } elsif ( $options{method} eq 'ECHECK' ) {
1787 $payinfo = $cust_pay->payinfo;
1789 $payinfo = $self->payinfo;
1791 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
1792 $content{bank_name} = $self->payname;
1793 $content{account_type} = 'CHECKING';
1794 $content{account_name} = $payname;
1795 $content{customer_org} = $self->company ? 'B' : 'I';
1796 $content{customer_ssn} = $self->ss;
1801 my $refund = new Business::OnlinePayment( $processor, @bop_options );
1802 my %sub_content = $refund->content(
1803 'action' => 'credit',
1804 'customer_id' => $self->custnum,
1805 'last_name' => $paylast,
1806 'first_name' => $payfirst,
1808 'address' => $address,
1809 'city' => $self->city,
1810 'state' => $self->state,
1811 'zip' => $self->zip,
1812 'country' => $self->country,
1814 'phone' => $self->daytime || $self->night,
1817 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
1819 $refund->test_transaction(1)
1820 if $conf->exists('business-onlinepayment-test_transaction');
1823 return "$processor error: ". $refund->error_message
1824 unless $refund->is_success();
1826 $order_number = $refund->order_number if $refund->can('order_number');
1828 # change this to just use $cust_pay->delete_cust_bill_pay?
1829 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
1830 my @cust_bill_pay = $cust_pay->cust_bill_pay;
1831 last unless @cust_bill_pay;
1832 my $cust_bill_pay = pop @cust_bill_pay;
1833 my $error = $cust_bill_pay->delete;
1837 my $cust_refund = new FS::cust_refund ( {
1838 'custnum' => $self->custnum,
1839 'paynum' => $options{'paynum'},
1840 'source_paynum' => $options{'paynum'},
1841 'refund' => $amount,
1843 'payby' => $bop_method2payby{$options{method}},
1844 'payinfo' => $payinfo,
1845 'paymask' => $paymask,
1846 'reasonnum' => $options{'reasonnum'},
1847 'gatewaynum' => $gatewaynum, # may be null
1848 'processor' => $processor,
1849 'auth' => $refund->authorization,
1850 'order_number' => $order_number,
1852 my $error = $cust_refund->insert;
1854 $cust_refund->paynum(''); #try again with no specific paynum
1855 $cust_refund->source_paynum('');
1856 my $error2 = $cust_refund->insert;
1858 # gah, even with transactions.
1859 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
1860 "error inserting refund ($processor): $error2".
1861 " (previously tried insert with paynum #$options{'paynum'}" .
1872 =item realtime_verify_bop [ OPTION => VALUE ... ]
1874 Runs an authorization-only transaction for $1 against this credit card (if
1875 successful, immediatly reverses the authorization).
1877 Returns the empty string if the authorization was sucessful, or an error
1880 Option I<cust_payby> should be passed, even if it's not yet been inserted.
1881 Object will be tokenized if possible, but that change will not be
1882 updated in database (must be inserted/replaced afterwards.)
1884 Currently only succeeds for Business::OnlinePayment CC transactions.
1888 #some false laziness w/realtime_bop and realtime_refund_bop, not enough to make
1889 #it worth merging but some useful small subs should be pulled out
1890 sub realtime_verify_bop {
1893 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1894 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_verify_bop');
1897 if (ref($_[0]) eq 'HASH') {
1898 %options = %{$_[0]};
1904 warn "$me realtime_verify_bop\n";
1905 warn " $_ => $options{$_}\n" foreach keys %options;
1908 # set fields from passed cust_payby
1909 return "No cust_payby" unless $options{'cust_payby'};
1910 _bop_cust_payby_options(\%options);
1912 # check for banned credit card/ACH
1913 my $ban = FS::banned_pay->ban_search(
1914 'payby' => $bop_method2payby{'CC'},
1915 'payinfo' => $options{payinfo},
1917 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
1919 # possibly run a separate transaction to tokenize card number,
1920 # so that we never store tokenized card info in cust_pay_pending
1921 if (($options{method} eq 'CC') && !$self->tokenized($options{'payinfo'})) {
1922 my $token_error = $self->realtime_tokenize(\%options);
1923 return $token_error if $token_error;
1924 #important that we not replace cust_payby here,
1925 #because cust_payby->replace uses realtime_verify_bop!
1932 my $payment_gateway = $self->_payment_gateway( \%options );
1933 my $namespace = $payment_gateway->gateway_namespace;
1935 eval "use $namespace";
1942 my $bop_content = $self->_bop_content(\%options);
1943 return $bop_content unless ref($bop_content);
1945 my @invoicing_list = $self->invoicing_list_emailonly;
1946 if ( $conf->exists('emailinvoiceautoalways')
1947 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1948 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1949 push @invoicing_list, $self->all_emails;
1952 my $email = ($conf->exists('business-onlinepayment-email-override'))
1953 ? $conf->config('business-onlinepayment-email-override')
1954 : $invoicing_list[0];
1959 if ( $namespace eq 'Business::OnlinePayment' ) {
1961 if ( $options{method} eq 'CC' ) {
1963 $content{card_number} = $options{payinfo};
1964 $paydate = $options{'paydate'};
1965 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1966 $content{expiration} = "$2/$1";
1968 $content{cvv2} = $options{'paycvv'}
1969 if length($options{'paycvv'});
1971 my $paystart_month = $options{'paystart_month'};
1972 my $paystart_year = $options{'paystart_year'};
1974 $content{card_start} = "$paystart_month/$paystart_year"
1975 if $paystart_month && $paystart_year;
1977 my $payissue = $options{'payissue'};
1978 $content{issue_number} = $payissue if $payissue;
1980 } elsif ( $options{method} eq 'ECHECK' ){
1981 #cannot verify, move along (though it shouldn't be called...)
1984 return "unknown method ". $options{method};
1986 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
1987 #cannot verify, move along
1990 return "unknown namespace $namespace";
1994 # run transaction(s)
1998 my $transaction; #need this back so we can do _tokenize_card
2000 # don't mutex the customer here, because they might be uncommitted. and
2001 # this is only verification. it doesn't matter if they have other
2002 # unfinished verifications.
2004 my $cust_pay_pending = new FS::cust_pay_pending {
2005 'custnum_pending' => 1,
2008 'payby' => $bop_method2payby{'CC'},
2009 'payinfo' => $options{payinfo},
2010 'paymask' => $options{paymask},
2011 'paydate' => $paydate,
2012 'pkgnum' => $options{'pkgnum'},
2014 'gatewaynum' => $payment_gateway->gatewaynum || '',
2015 'session_id' => $options{session_id} || '',
2017 $cust_pay_pending->payunique( $options{payunique} )
2018 if defined($options{payunique}) && length($options{payunique});
2021 # open a separate handle for creating/updating the cust_pay_pending
2023 local $FS::UID::dbh = myconnect();
2024 local $FS::UID::AutoCommit = 1;
2026 # if this is an existing customer (and we can tell now because
2027 # this is a fresh transaction), it's safe to assign their custnum
2028 # to the cust_pay_pending record, and then the verification attempt
2029 # will remain linked to them even if it fails.
2030 if ( FS::cust_main->by_key($self->custnum) ) {
2031 $cust_pay_pending->set('custnum', $self->custnum);
2034 warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
2037 # if this fails, just return; everything else will still allow the
2038 # cust_pay_pending to have its custnum set later
2039 my $cpp_new_err = $cust_pay_pending->insert;
2040 return $cpp_new_err if $cpp_new_err;
2042 warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
2044 warn Dumper($cust_pay_pending) if $DEBUG > 2;
2046 $transaction = new $namespace( $payment_gateway->gateway_module,
2047 _bop_options(\%options),
2050 $transaction->content(
2052 _bop_auth(\%options),
2053 'action' => 'Authorization Only',
2054 'description' => $options{'description'},
2056 'customer_id' => $self->custnum,
2058 'reference' => $cust_pay_pending->paypendingnum, #for now
2063 $cust_pay_pending->status('pending');
2064 my $cpp_pending_err = $cust_pay_pending->replace;
2065 return $cpp_pending_err if $cpp_pending_err;
2067 warn Dumper($transaction) if $DEBUG > 2;
2069 unless ( $BOP_TESTING ) {
2070 $transaction->test_transaction(1)
2071 if $conf->exists('business-onlinepayment-test_transaction');
2072 $transaction->submit();
2074 if ( $BOP_TESTING_SUCCESS ) {
2075 $transaction->is_success(1);
2076 $transaction->authorization('fake auth');
2078 $transaction->is_success(0);
2079 $transaction->error_message('fake failure');
2083 if ( $transaction->is_success() ) {
2085 $cust_pay_pending->status('authorized');
2086 my $cpp_authorized_err = $cust_pay_pending->replace;
2087 return $cpp_authorized_err if $cpp_authorized_err;
2089 my $auth = $transaction->authorization;
2090 my $ordernum = $transaction->can('order_number')
2091 ? $transaction->order_number
2094 my $reverse = new $namespace( $payment_gateway->gateway_module,
2095 _bop_options(\%options),
2098 $reverse->content( 'action' => 'Reverse Authorization',
2099 _bop_auth(\%options),
2103 'authorization' => $transaction->authorization,
2104 'order_number' => $ordernum,
2107 'result_code' => $transaction->result_code,
2108 'txn_date' => $transaction->txn_date,
2112 $reverse->test_transaction(1)
2113 if $conf->exists('business-onlinepayment-test_transaction');
2116 if ( $reverse->is_success ) {
2118 $cust_pay_pending->status('done');
2119 $cust_pay_pending->statustext('reversed');
2120 my $cpp_reversed_err = $cust_pay_pending->replace;
2121 return $cpp_reversed_err if $cpp_reversed_err;
2125 my $e = "Authorization successful but reversal failed, custnum #".
2126 $self->custnum. ': '. $reverse->result_code.
2127 ": ". $reverse->error_message;
2134 ### Address Verification ###
2136 # Single-letter codes vary by cardtype.
2138 # Erring on the side of accepting cards if avs is not available,
2139 # only rejecting if avs occurred and there's been an explicit mismatch
2141 # Charts below taken from vSecure documentation,
2142 # shows codes for Amex/Dscv/MC/Visa
2144 # ACCEPTABLE AVS RESPONSES:
2145 # Both Address and 5-digit postal code match Y A Y Y
2146 # Both address and 9-digit postal code match Y A X Y
2147 # United Kingdom – Address and postal code match _ _ _ F
2148 # International transaction – Address and postal code match _ _ _ D/M
2150 # ACCEPTABLE, BUT ISSUE A WARNING:
2151 # Ineligible transaction; or message contains a content error _ _ _ E
2152 # System unavailable; retry R U R R
2153 # Information unavailable U W U U
2154 # Issuer does not support AVS S U S S
2155 # AVS is not applicable _ _ _ S
2156 # Incompatible formats – Not verified _ _ _ C
2157 # Incompatible formats – Address not verified; postal code matches _ _ _ P
2158 # International transaction – address not verified _ G _ G/I
2160 # UNACCEPTABLE AVS RESPONSES:
2161 # Only Address matches A Y A A
2162 # Only 5-digit postal code matches Z Z Z Z
2163 # Only 9-digit postal code matches Z Z W W
2164 # Neither address nor postal code matches N N N N
2166 if (my $avscode = uc($transaction->avs_code)) {
2168 # map codes to accept/warn/reject
2170 'American Express card' => {
2179 'Discover card' => {
2218 my $cardtype = cardtype($content{card_number});
2219 if ($avs->{$cardtype}) {
2220 my $avsact = $avs->{$cardtype}->{$avscode};
2222 if ($avsact eq 'r') {
2223 return "AVS code verification failed, cardtype $cardtype, code $avscode";
2224 } elsif ($avsact eq 'w') {
2225 $warning = "AVS did not occur, cardtype $cardtype, code $avscode";
2226 } elsif (!$avsact) {
2227 $warning = "AVS code unknown, cardtype $cardtype, code $avscode";
2228 } # else $avsact eq 'a'
2230 $log->warning($warning);
2233 } # else $cardtype avs handling not implemented
2234 } # else !$transaction->avs_code
2236 } else { # is not success
2238 # status is 'done' not 'declined', as in _realtime_bop_result
2239 $cust_pay_pending->status('done');
2240 $error = $transaction->error_message || 'Unknown error';
2241 $cust_pay_pending->statustext($error);
2242 # could also record failure_status here,
2243 # but it's not supported by B::OP::vSecureProcessing...
2244 # need a B::OP module with (reverse) auth only to test it with
2245 my $cpp_declined_err = $cust_pay_pending->replace;
2246 return $cpp_declined_err if $cpp_declined_err;
2250 } # end of IMMEDIATE; we now have our $error and $transaction
2253 # Save the custnum (as part of the main transaction, so it can reference
2257 if (!$cust_pay_pending->custnum) {
2258 $cust_pay_pending->set('custnum', $self->custnum);
2259 my $set_custnum_err = $cust_pay_pending->replace;
2260 if ($set_custnum_err) {
2261 $log->error($set_custnum_err);
2262 $error ||= $set_custnum_err;
2263 # but if there was a real verification error also, return that one
2268 # remove paycvv here? need to find out if a reversed auth
2269 # counts as an initial transaction for paycvv retention requirements
2276 # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
2277 # if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
2278 if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
2279 $cust_pay_pending->payinfo($card_token);
2280 my $cpp_token_err = $cust_pay_pending->replace;
2281 #this leaves real card number in cust_pay_pending, but can't do much else if cpp won't replace
2282 return $cpp_token_err if $cpp_token_err;
2283 #important that we not replace cust_payby here,
2284 #because cust_payby->replace uses realtime_verify_bop!
2291 # $error contains the transaction error_message, if is_success was false.
2297 =item realtime_tokenize [ OPTION => VALUE ... ]
2299 If possible and necessary, runs a tokenize transaction.
2300 In order to be possible, a credit card cust_payby record
2301 must be passed and a Business::OnlinePayment gateway capable
2302 of Tokenize transactions must be configured for this user.
2303 Is only necessary if payinfo is not yet tokenized.
2305 Returns the empty string if the authorization was sucessful
2306 or was not possible/necessary (thus allowing this to be safely called with
2307 non-tokenizable records/gateways, without having to perform separate tests),
2308 or an error message otherwise.
2310 Option I<cust_payby> may be passed, even if it's not yet been inserted.
2311 Object will be tokenized if possible, but that change will not be
2312 updated in database (must be inserted/replaced afterwards.)
2314 Otherwise, options I<method>, I<payinfo> and other cust_payby fields
2315 may be passed. If options are passed as a hashref, I<payinfo>
2316 will be updated as appropriate in the passed hashref.
2318 Can be run as a class method if option I<payment_gateway> is passed,
2319 but default customer id/name/phone can't be set in that case. This
2320 is really only intended for tokenizing old records on upgrade.
2324 # careful--might be run as a class method
2325 sub realtime_tokenize {
2328 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2329 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_tokenize');
2332 my $outoptions; #for returning cust_payby/payinfo
2333 if (ref($_[0]) eq 'HASH') {
2334 %options = %{$_[0]};
2335 $outoptions = $_[0];
2338 $outoptions = \%options;
2341 # set fields from passed cust_payby
2342 _bop_cust_payby_options(\%options);
2343 return '' unless $options{method} eq 'CC';
2344 return '' if $self->tokenized($options{payinfo}); #already tokenized
2346 # check for banned credit card/ACH
2347 my $ban = FS::banned_pay->ban_search(
2348 'payby' => $bop_method2payby{'CC'},
2349 'payinfo' => $options{payinfo},
2351 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
2357 $options{'nofatal'} = 1;
2358 my $payment_gateway = $self->_payment_gateway( \%options );
2359 return '' unless $payment_gateway;
2360 my $namespace = $payment_gateway->gateway_namespace;
2361 return '' unless $namespace eq 'Business::OnlinePayment';
2363 eval "use $namespace";
2367 # check for tokenize ability
2370 my $transaction = new $namespace( $payment_gateway->gateway_module,
2371 _bop_options(\%options),
2374 return '' unless $transaction->can('info');
2376 my %supported_actions = $transaction->info('supported_actions');
2377 return '' unless $supported_actions{'CC'} and grep(/^Tokenize$/,@{$supported_actions{'CC'}});
2383 ### Currently, cardfortress only keys in on card number and exp date.
2384 ### We pass everything we'd pass to a normal transaction,
2385 ### for ease of current and future development,
2386 ### but note, when tokenizing old records, we may only have access to payinfo/paydate
2388 my $bop_content = $self->_bop_content(\%options);
2389 return $bop_content unless ref($bop_content);
2394 $content{card_number} = $options{payinfo};
2395 $paydate = $options{'paydate'};
2396 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2397 $content{expiration} = "$2/$1";
2399 $content{cvv2} = $options{'paycvv'}
2400 if length($options{'paycvv'});
2402 my $paystart_month = $options{'paystart_month'};
2403 my $paystart_year = $options{'paystart_year'};
2405 $content{card_start} = "$paystart_month/$paystart_year"
2406 if $paystart_month && $paystart_year;
2408 my $payissue = $options{'payissue'};
2409 $content{issue_number} = $payissue if $payissue;
2411 $content{customer_id} = $self->custnum
2420 # no cust_pay_pending---this is not a financial transaction
2422 $transaction->content(
2424 _bop_auth(\%options),
2425 'action' => 'Tokenize',
2426 'description' => $options{'description'},
2431 # no $BOP_TESTING handling for this
2432 $transaction->test_transaction(1)
2433 if $conf->exists('business-onlinepayment-test_transaction');
2434 $transaction->submit();
2436 if ( $transaction->card_token() ) { # no is_success flag
2438 # realtime_tokenize should not clear paycvv at this time. it might be
2439 # needed for the first transaction, and a tokenize isn't actually a
2440 # transaction that hits the gateway. at some point in the future, card
2441 # fortress should take on the "store paycvv until first transaction"
2442 # functionality and we should fix this in freeside, but i that's a bigger
2443 # project for another time.
2445 #important that we not replace cust_payby here,
2446 #because cust_payby->replace uses realtime_tokenize!
2447 $self->_tokenize_card($transaction,$outoptions);
2451 $error = $transaction->error_message || 'Unknown error when tokenizing card';
2460 =item tokenized PAYINFO
2462 Convenience wrapper for L<FS::payinfo_Mixin/tokenized>
2464 PAYINFO is required.
2466 Can be run as class or object method, never loads from object.
2472 my $payinfo = shift;
2473 FS::cust_pay->tokenized($payinfo);
2476 =item token_check [ quiet => 1, queue => 1, daily => 1 ]
2478 NOT A METHOD. Acts on all customers. Placed here because it makes
2479 use of module-internal methods, and to keep everything that uses
2480 Billing::OnlinePayment all in one place.
2482 Tokenizes all tokenizable card numbers from payinfo in cust_payby and
2483 CARD transactions in cust_pay_pending, cust_pay, cust_pay_void and cust_refund.
2485 If the I<queue> flag is set, newly tokenized records will be immediately
2486 committed, regardless of AutoCommit, so as to release the mutex on the record.
2488 If all configured gateways have the ability to tokenize, detection of an
2489 untokenizable record will cause a fatal error. However, if the I<queue> flag
2490 is set, this will instead cause a critical error to be recorded in the log,
2491 and any other tokenizable records will still be committed.
2493 If the I<daily> flag is also set, detection of existing untokenized records will
2494 record an info message in the system log (because they should have never appeared
2495 in the first place.) Tokenization will still be attempted.
2497 If any configured gateways do NOT have the ability to tokenize, or if a
2498 default gateway is not configured, then untokenized records are not considered
2499 a threat, and no critical errors will be generated in the log.
2504 #acts on all customers
2506 my $debug = !$opt{'quiet'} || $DEBUG;
2507 my $hascritical = 0;
2509 warn "token_check called with opts\n".Dumper(\%opt) if $debug;
2511 # force some explicitness when invoking this method
2512 die "token_check must run with queue flag if run with daily flag"
2513 if $opt{'daily'} && !$opt{'queue'};
2515 my $conf = FS::Conf->new;
2517 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::token_check');
2519 my $cache = {}; #cache for module info
2521 # look for a gateway that can and can't tokenize
2522 my $require_tokenized = 1;
2523 my $someone_tokenizing = 0;
2524 foreach my $gateway (
2525 FS::payment_gateway->all_gateways(
2532 # no default gateway, no promise to tokenize
2533 # can just load other gateways as-needeed below
2534 $require_tokenized = 0;
2535 last if $someone_tokenizing;
2538 my $info = _token_check_gateway_info($cache,$gateway);
2539 die $info unless ref($info); # means it's an error message
2540 if ($info->{'can_tokenize'}) {
2541 $someone_tokenizing = 1;
2543 # a configured gateway can't tokenize, that's all we need to know right now
2544 # can just load other gateways as-needeed below
2545 $require_tokenized = 0;
2546 last if $someone_tokenizing;
2550 unless ($someone_tokenizing) { #no need to check, if no one can tokenize
2551 warn "no gateways tokenize\n" if $debug;
2555 warn "REQUIRE TOKENIZED" if $require_tokenized && $debug;
2557 # upgrade does not call this with autocommit turned on,
2558 # and autocommit will be ignored if opt queue is set,
2559 # but might as well be thorough...
2560 my $oldAutoCommit = $FS::UID::AutoCommit;
2561 local $FS::UID::AutoCommit = 0;
2564 # for retrieving data in chunks
2568 ### Tokenize cust_payby
2573 while (my $custnum = _token_check_next_recnum($dbh,'cust_main',$step,\$offset,\@recnums)) {
2574 my $cust_main = FS::cust_main->by_key($custnum);
2575 my $payment_gateway;
2576 foreach my $cust_payby ($cust_main->cust_payby('CARD','DCRD')) {
2578 # see if it's already tokenized
2579 if ($cust_payby->tokenized) {
2580 warn "cust_payby ".$cust_payby->get($cust_payby->primary_key)." already tokenized" if $debug;
2584 if ($require_tokenized && $opt{'daily'}) {
2585 $log->info("Untokenized card number detected in cust_payby ".$cust_payby->custpaybynum. '; tokenizing');
2586 $dbh->commit or die $dbh->errstr; # commit log message
2589 # only load gateway if we need to, and only need to load it once
2590 $payment_gateway ||= $cust_main->_payment_gateway({
2593 'nofatal' => 1, # handle lack of gateway smoothly below
2595 unless ($payment_gateway) {
2596 # no reason to have untokenized card numbers saved if no gateway,
2597 # but only a problem if we expected everyone to tokenize card numbers
2598 unless ($require_tokenized) {
2599 warn "Skipping cust_payby for cust_main ".$cust_main->custnum.", no payment gateway" if $debug;
2600 next CUSTLOOP; # can skip rest of customer
2602 my $error = "No gateway found for custnum ".$cust_main->custnum;
2603 if ($opt{'queue'}) {
2605 $log->critical($error);
2606 $dbh->commit or die $dbh->errstr; # commit error message
2607 next; # not next CUSTLOOP, want to record error for every cust_payby
2609 $dbh->rollback if $oldAutoCommit;
2613 my $info = _token_check_gateway_info($cache,$payment_gateway);
2614 unless (ref($info)) {
2615 # only throws error if Business::OnlinePayment won't load,
2616 # which is just cause to abort this whole process, even if queue
2617 $dbh->rollback if $oldAutoCommit;
2618 die $info; # error message
2620 # no fail here--a configured gateway can't tokenize, so be it
2621 unless ($info->{'can_tokenize'}) {
2622 warn "Skipping ".$cust_main->custnum." cannot tokenize" if $debug;
2627 $cust_payby = $cust_payby->select_for_update;
2629 'payment_gateway' => $payment_gateway,
2630 'cust_payby' => $cust_payby,
2632 my $error = $cust_main->realtime_tokenize(\%tokenopts);
2633 if ($cust_payby->tokenized) { # implies no error
2634 $error = $cust_payby->replace;
2636 $error ||= 'Unknown error';
2639 $error = "Error tokenizing cust_payby ".$cust_payby->custpaybynum.": ".$error;
2640 if ($opt{'queue'}) {
2642 $log->critical($error);
2643 $dbh->commit or die $dbh->errstr; # commit log message, release mutex
2644 next; # not next CUSTLOOP, want to record error for every cust_payby
2646 $dbh->rollback if $oldAutoCommit;
2649 $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
2650 warn "TOKENIZED cust_payby ".$cust_payby->get($cust_payby->primary_key) if $debug;
2652 warn "cust_payby upgraded for custnum ".$cust_main->custnum if $debug;
2656 ### Tokenize/mask transaction tables
2658 # allow tokenization of closed cust_pay/cust_refund records
2659 local $FS::payinfo_Mixin::allow_closed_replace = 1;
2662 # $cust_pay_pending->replace, $cust_pay->replace, $cust_pay_void->replace, $cust_refund->replace all run here
2663 foreach my $table ( qw(cust_pay_pending cust_pay cust_pay_void cust_refund) ) {
2664 warn "Checking $table" if $debug;
2666 # FS::Cursor does not seem to work over multiple commits (gives cursor not found errors)
2667 # loading only record ids, then loading individual records one at a time
2668 my $tclass = 'FS::'.$table;
2672 while (my $recnum = _token_check_next_recnum($dbh,$table,$step,\$offset,\@recnums)) {
2673 my $record = $tclass->by_key($recnum);
2674 unless ($record->payby eq 'CARD') {
2675 warn "Skipping non-card record for $table ".$record->get($record->primary_key) if $debug;
2678 if (FS::cust_main::Billing_Realtime->tokenized($record->payinfo)) {
2679 warn "Skipping tokenized record for $table ".$record->get($record->primary_key) if $debug;
2682 if (!$record->payinfo) { #shouldn't happen, but at least it's not a card number
2683 warn "Skipping blank payinfo for $table ".$record->get($record->primary_key) if $debug;
2686 if ($record->payinfo =~ /N\/A/) { # ??? Not sure why we do this, but it's not a card number
2687 warn "Skipping NA payinfo for $table ".$record->get($record->primary_key) if $debug;
2691 if ($require_tokenized && $opt{'daily'}) {
2692 $log->info("Untokenized card number detected in $table ".$record->get($record->primary_key). ';tokenizing');
2693 $dbh->commit or die $dbh->errstr; # commit log message
2696 my $cust_main = $record->cust_main;
2698 # might happen for cust_pay_pending from failed verify records,
2699 # in which case we attempt tokenization without cust_main
2700 # everything else should absolutely have a cust_main
2701 if ($table eq 'cust_pay_pending' and !$record->custnum ) {
2702 # override the usual safety check and allow the record to be
2703 # updated even without a custnum.
2704 $record->set('custnum_pending', 1);
2706 my $error = "Could not load cust_main for $table ".$record->get($record->primary_key);
2707 if ($opt{'queue'}) {
2709 $log->critical($error);
2710 $dbh->commit or die $dbh->errstr; # commit log message
2713 $dbh->rollback if $oldAutoCommit;
2720 # use the gatewaynum specified by the record if possible
2721 $gateway = FS::payment_gateway->by_key_with_namespace(
2722 'gatewaynum' => $record->gatewaynum,
2723 ) if $record->gateway;
2725 # otherwise use the cust agent gateway if possible (which realtime_refund_bop would do)
2726 # otherwise just use default gateway
2729 $gateway = $cust_main
2730 ? $cust_main->agent->payment_gateway
2731 : FS::payment_gateway->default_gateway;
2733 # check for processor mismatch
2734 unless ($table eq 'cust_pay_pending') { # has no processor table
2735 if (my $processor = $record->processor) {
2737 my $conf_processor = $gateway->gateway_module;
2738 my %bop_options = $gateway->gatewaynum
2740 : @{ $gateway->get('options') };
2742 # this is the same standard used by realtime_refund_bop
2744 ($processor eq $conf_processor) ||
2745 (($conf_processor eq 'CardFortress') && ($processor eq $bop_options{'gateway'}))
2748 # processors don't match, so refund already cannot be run on this object,
2749 # regardless of what we do now...
2750 # but unless we gotta tokenize everything, just leave well enough alone
2751 unless ($require_tokenized) {
2752 warn "Skipping mismatched processor for $table ".$record->get($record->primary_key) if $debug;
2755 ### no error--we'll tokenize using the new gateway, just to remove stored payinfo,
2756 ### because refunds are already impossible for this record, anyway
2758 } # end processor mismatch
2760 } # end record has processor
2761 } # end not cust_pay_pending
2765 # means no default gateway, no promise to tokenize, can skip
2767 warn "Skipping missing gateway for $table ".$record->get($record->primary_key) if $debug;
2771 my $info = _token_check_gateway_info($cache,$gateway);
2772 unless (ref($info)) {
2773 # only throws error if Business::OnlinePayment won't load,
2774 # which is just cause to abort this whole process, even if queue
2775 $dbh->rollback if $oldAutoCommit;
2776 die $info; # error message
2779 # a configured gateway can't tokenize, move along
2780 unless ($info->{'can_tokenize'}) {
2781 warn "Skipping, cannot tokenize $table ".$record->get($record->primary_key) if $debug;
2785 warn "ATTEMPTING GATEWAY-ONLY TOKENIZE" if $debug && !$cust_main;
2787 # if we got this far, time to mutex
2788 $record->select_for_update;
2790 # no clear record of name/address/etc used for transaction,
2791 # but will load name/phone/id from customer if run as an object method,
2792 # so we try that if we can
2794 'payment_gateway' => $gateway,
2796 'payinfo' => $record->payinfo,
2797 'paydate' => $record->paydate,
2799 my $error = $cust_main
2800 ? $cust_main->realtime_tokenize(\%tokenopts)
2801 : FS::cust_main::Billing_Realtime->realtime_tokenize(\%tokenopts);
2802 if (FS::cust_main::Billing_Realtime->tokenized($tokenopts{'payinfo'})) { # implies no error
2803 $record->payinfo($tokenopts{'payinfo'});
2804 $error = $record->replace;
2806 $error ||= 'Unknown error';
2809 $error = "Error tokenizing $table ".$record->get($record->primary_key).": ".$error;
2810 if ($opt{'queue'}) {
2812 $log->critical($error);
2813 $dbh->commit or die $dbh->errstr; # commit log message, release mutex
2816 $dbh->rollback if $oldAutoCommit;
2819 $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
2820 warn "TOKENIZED $table ".$record->get($record->primary_key) if $debug;
2825 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2827 return $hascritical ? 'Critical errors occurred on some records, see system log' : '';
2831 sub _token_check_next_recnum {
2832 my ($dbh,$table,$step,$offset,$recnums) = @_;
2833 my $recnum = shift @$recnums;
2834 return $recnum if $recnum;
2835 my $tclass = 'FS::'.$table;
2836 my $sth = $dbh->prepare(
2837 'SELECT '.$tclass->primary_key.
2839 " WHERE ( is_tokenized IS NULL OR is_tokenized = '' ) ".
2840 ' ORDER BY '.$tclass->primary_key.
2843 ) or die $dbh->errstr;
2844 $sth->execute() or die $sth->errstr;
2846 while (my $rec = $sth->fetchrow_hashref) {
2847 push @$recnums, $rec->{$tclass->primary_key};
2851 return shift @$recnums;
2855 sub _token_check_gateway_info {
2856 my ($cache,$payment_gateway) = @_;
2858 return $cache->{$payment_gateway->gateway_module}
2859 if $cache->{$payment_gateway->gateway_module};
2862 $cache->{$payment_gateway->gateway_module} = $info;
2864 my $namespace = $payment_gateway->gateway_namespace;
2865 return $info unless $namespace eq 'Business::OnlinePayment';
2866 $info->{'is_bop'} = 1;
2868 # only need to load this once,
2869 # don't want to load if nothing is_bop
2870 unless ($cache->{'Business::OnlinePayment'}) {
2871 eval "use $namespace";
2872 return "Error initializing Business:OnlinePayment: ".$@ if $@;
2873 $cache->{'Business::OnlinePayment'} = 1;
2876 my $transaction = new $namespace( $payment_gateway->gateway_module,
2877 _bop_options({ 'payment_gateway' => $payment_gateway }),
2880 return $info unless $transaction->can('info');
2881 $info->{'can_info'} = 1;
2883 my %supported_actions = $transaction->info('supported_actions');
2884 $info->{'can_tokenize'} = 1
2885 if $supported_actions{'CC'}
2886 && grep /^Tokenize$/, @{$supported_actions{'CC'}};
2888 # not using this any more, but for future reference...
2889 $info->{'void_requires_card'} = 1
2890 if $transaction->info('CC_void_requires_card');
2901 L<FS::cust_main>, L<FS::cust_main::Billing>