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;
20 $realtime_bop_decline_quiet = 0;
22 # 1 is mostly method/subroutine entry and options
23 # 2 traces progress of some operations
24 # 3 is even more information including possibly sensitive data
26 $me = '[FS::cust_main::Billing_Realtime]';
29 our $BOP_TESTING_SUCCESS = 1;
31 install_callback FS::UID sub {
33 #yes, need it for stuff below (prolly should be cached)
38 FS::cust_main::Billing_Realtime - Realtime billing mixin for cust_main
44 These methods are available on FS::cust_main objects.
50 =item realtime_cust_payby
54 sub realtime_cust_payby {
55 my( $self, %options ) = @_;
57 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
59 $options{amount} = $self->balance unless exists( $options{amount} );
61 my @cust_payby = $self->cust_payby('CARD','CHEK');
64 foreach my $cust_payby (@cust_payby) {
65 $error = $cust_payby->realtime_bop( %options, );
69 #XXX what about the earlier errors?
75 =item realtime_collect [ OPTION => VALUE ... ]
77 Attempt to collect the customer's current balance with a realtime credit
78 card or electronic check transaction (see realtime_bop() below).
80 Returns the result of realtime_bop(): nothing, an error message, or a
81 hashref of state information for a third-party transaction.
83 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
85 I<method> is one of: I<CC> or I<ECHECK>. If none is specified
86 then it is deduced from the customer record.
88 If no I<amount> is specified, then the customer balance is used.
90 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
91 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
92 if set, will override the value from the customer record.
94 I<description> is a free-text field passed to the gateway. It defaults to
95 the value defined by the business-onlinepayment-description configuration
96 option, or "Internet services" if that is unset.
98 If an I<invnum> is specified, this payment (if successful) is applied to the
101 I<apply> will automatically apply a resulting payment.
103 I<quiet> can be set true to suppress email decline notices.
105 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
106 resulting paynum, if any.
108 I<payunique> is a unique identifier for this payment.
110 I<session_id> is a session identifier associated with this payment.
112 I<depend_jobnum> allows payment capture to unlock export jobs
116 # Currently only used by ClientAPI
117 sub realtime_collect {
118 my( $self, %options ) = @_;
120 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
123 warn "$me realtime_collect:\n";
124 warn " $_ => $options{$_}\n" foreach keys %options;
127 $options{amount} = $self->balance unless exists( $options{amount} );
128 return '' unless $options{amount} > 0;
130 #huh, in v4, realtime_bop no longer will just process a card without passing
131 # payinfo or cust_payby...
132 if ( ! $options{'payinfo'} && ! $options{'cust_payby'} && $self->has_cust_payby_auto ) {
133 my @cust_payby = $self->cust_payby;
134 $options{'cust_payby'} = $cust_payby[0];
137 return $self->realtime_bop({%options});
141 =item realtime_bop { [ ARG => VALUE ... ] }
143 Runs a realtime credit card or ACH (electronic check) transaction
144 via a Business::OnlinePayment realtime gateway. See
145 L<http://420.am/business-onlinepayment> for supported gateways.
147 Required arguments in the hashref are I<amount> and either
148 I<cust_payby> or I<method>, I<payinfo> and (as applicable for method)
149 I<payname>, I<address1>, I<address2>, I<city>, I<state>, I<zip> and I<paydate>.
151 Available methods are: I<CC>, I<ECHECK>, or I<PAYPAL>
153 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
155 I<description> is a free-text field passed to the gateway. It defaults to
156 the value defined by the business-onlinepayment-description configuration
157 option, or "Internet services" if that is unset.
159 If an I<invnum> is specified, this payment (if successful) is applied to the
160 specified invoice. If the customer has exactly one open invoice, that
161 invoice number will be assumed. If you don't specify an I<invnum> you might
162 want to call the B<apply_payments> method or set the I<apply> option.
164 I<no_invnum> can be set to true to prevent that default invnum from being set.
166 I<apply> can be set to true to run B<apply_payments_and_credits> on success.
168 I<no_auto_apply> can be set to true to set that flag on the resulting payment
169 (prevents payment from being applied by B<apply_payments> or B<apply_payments_and_credits>,
170 but will still be applied if I<invnum> exists...use with I<no_invnum> for intended effect.)
172 I<quiet> can be set true to surpress email decline notices.
174 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
175 resulting paynum, if any.
177 I<payunique> is a unique identifier for this payment.
179 I<session_id> is a session identifier associated with this payment.
181 I<depend_jobnum> allows payment capture to unlock export jobs
183 I<discount_term> attempts to take a discount by prepaying for discount_term.
184 The payment will fail if I<amount> is incorrect for this discount term.
186 A direct (Business::OnlinePayment) transaction will return nothing on success,
187 or an error message on failure.
189 A third-party transaction will return a hashref containing:
191 - popup_url: the URL to which a browser should be redirected to complete
193 - collectitems: an arrayref of name-value pairs to be posted to popup_url.
194 - reference: a reference ID for the transaction, to show the customer.
196 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
200 # some helper routines
202 # _bop_recurring_billing: Checks whether this payment should have the
203 # recurring_billing flag used by some B:OP interfaces (IPPay, PlugnPay,
204 # vSecure, etc.). This works in two different modes:
205 # - actual_oncard (default): treat the payment as recurring if the customer
206 # has made a payment using this card before.
207 # - transaction_is_recur: treat the payment as recurring if the invoice
208 # being paid has any recurring package charges.
210 sub _bop_recurring_billing {
211 my( $self, %opt ) = @_;
213 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
215 if ( defined($method) && $method eq 'transaction_is_recur' ) {
217 return 1 if $opt{'trans_is_recur'};
221 # return 1 if the payinfo has been used for another payment
222 return $self->payinfo_used($opt{'payinfo'}); # in payinfo_Mixin
230 #can run safely as class method if opt payment_gateway already exists
231 sub _payment_gateway {
232 my ($self, $options) = @_;
234 if ( $options->{'fake_gatewaynum'} ) {
235 $options->{payment_gateway} =
236 qsearchs('payment_gateway',
237 { 'gatewaynum' => $options->{'fake_gatewaynum'}, }
241 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
242 unless exists($options->{payment_gateway});
244 $options->{payment_gateway};
252 'login' => $options->{payment_gateway}->gateway_username,
253 'password' => $options->{payment_gateway}->gateway_password,
261 $options->{payment_gateway}->gatewaynum
262 ? $options->{payment_gateway}->options
263 : @{ $options->{payment_gateway}->get('options') };
268 my ($self, $options) = @_;
270 unless ( $options->{'description'} ) {
271 if ( $conf->exists('business-onlinepayment-description') ) {
272 my $dtempl = $conf->config('business-onlinepayment-description');
274 my $agent = $self->agent->agent;
276 $options->{'description'} = eval qq("$dtempl");
278 $options->{'description'} = 'Internet services';
282 # Default invoice number if the customer has exactly one open invoice.
283 unless ( $options->{'invnum'} || $options->{'no_invnum'} ) {
284 $options->{'invnum'} = '';
285 my @open = $self->open_cust_bill;
286 $options->{'invnum'} = $open[0]->invnum if scalar(@open) == 1;
292 sub _bop_cust_payby_options {
294 my $cust_payby = $options->{'cust_payby'};
297 $options->{'method'} = FS::payby->payby2bop( $cust_payby->payby );
299 if ($cust_payby->payby =~ /^(CARD|DCRD)$/) {
300 # false laziness with cust_payby->check
301 # which might not have been run yet
303 if ( $cust_payby->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
304 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
305 } elsif ( $cust_payby->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
306 ( $m, $y ) = ( $2, "19$1" );
307 } elsif ( $cust_payby->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
308 ( $m, $y ) = ( $3, "20$2" );
310 return "Illegal expiration date: ". $cust_payby->paydate;
312 $m = sprintf('%02d',$m);
313 $options->{paydate} = "$y-$m-01";
315 $options->{paydate} = '';
318 $options->{$_} = $cust_payby->$_()
319 for qw( payinfo paycvv paymask paystart_month paystart_year
320 payissue payname paystate paytype payip );
322 if ( $cust_payby->locationnum ) {
323 my $cust_location = $cust_payby->cust_location;
324 $options->{$_} = $cust_location->$_() for qw( address1 address2 city state zip );
329 # can be called as class method,
330 # but can't load default name/phone fields as class method
332 my ($self, $options) = @_;
335 my $payip = $options->{'payip'};
336 $content{customer_ip} = $payip if length($payip);
338 $content{invoice_number} = $options->{'invnum'}
339 if exists($options->{'invnum'}) && length($options->{'invnum'});
341 $content{email_customer} =
342 ( $conf->exists('business-onlinepayment-email_customer')
343 || $conf->exists('business-onlinepayment-email-override') );
345 my ($payname, $payfirst, $paylast);
346 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
347 ($payname = $options->{payname}) =~
348 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
349 or return "Illegal payname $payname";
350 ($payfirst, $paylast) = ($1, $2);
351 } elsif (ref($self)) { # can't set payname if called as class method
352 $payfirst = $self->getfield('first');
353 $paylast = $self->getfield('last');
354 $payname = "$payfirst $paylast";
357 $content{last_name} = $paylast if $paylast;
358 $content{first_name} = $payfirst if $payfirst;
360 $content{name} = $payname if $payname;
362 $content{address} = $options->{'address1'};
363 my $address2 = $options->{'address2'};
364 $content{address} .= ", ". $address2 if length($address2);
366 $content{city} = $options->{'city'};
367 $content{state} = $options->{'state'};
368 $content{zip} = $options->{'zip'};
369 $content{country} = $options->{'country'};
371 # can't set phone if called as class method
372 $content{phone} = $self->daytime || $self->night
375 my $currency = $conf->exists('business-onlinepayment-currency')
376 && $conf->config('business-onlinepayment-currency');
377 $content{currency} = $currency if $currency;
382 # updates payinfo and cust_payby options with token from transaction
383 # can be called as a class method
385 my ($self,$transaction,$options) = @_;
386 if ( $transaction->can('card_token')
387 and $transaction->card_token
388 and !$self->tokenized($options->{'payinfo'})
390 $options->{'payinfo'} = $transaction->card_token;
391 $options->{'cust_payby'}->payinfo($transaction->card_token) if $options->{'cust_payby'};
392 return $transaction->card_token;
397 my %bop_method2payby = (
406 confess "Can't call realtime_bop within another transaction ".
407 '($FS::UID::AutoCommit is false)'
408 unless $FS::UID::AutoCommit;
410 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
412 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_bop');
415 if (ref($_[0]) eq 'HASH') {
418 my ( $method, $amount ) = ( shift, shift );
420 $options{method} = $method;
421 $options{amount} = $amount;
424 return '' unless $options{amount} > 0;
426 # set fields from passed cust_payby
427 _bop_cust_payby_options(\%options);
429 # check for banned credit card/ACH
430 my $ban = FS::banned_pay->ban_search(
431 'payby' => $bop_method2payby{$options{method}},
432 'payinfo' => $options{payinfo},
434 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
436 # possibly run a separate transaction to tokenize card number,
437 # so that we never store tokenized card info in cust_pay_pending
438 if (($options{method} eq 'CC') && !$self->tokenized($options{'payinfo'})) {
439 my $token_error = $self->realtime_tokenize(\%options);
440 return $token_error if $token_error;
441 # in theory, all cust_payby will be tokenized during original save,
442 # so we shouldn't get here with opt cust_payby...but just in case...
443 if ($options{'cust_payby'} && $self->tokenized($options{'payinfo'})) {
444 $token_error = $options{'cust_payby'}->replace;
445 return $token_error if $token_error;
450 # optional credit card surcharge
453 my $cc_surcharge = 0;
454 my $cc_surcharge_pct = 0;
455 $cc_surcharge_pct = $conf->config('credit-card-surcharge-percentage', $self->agentnum)
456 if $conf->config('credit-card-surcharge-percentage', $self->agentnum)
457 && $options{method} eq 'CC';
459 my $cc_surcharge_flat = 0;
460 $cc_surcharge_flat = $conf->config('credit-card-surcharge-flatfee', $self->agentnum)
461 if $conf->config('credit-card-surcharge-flatfee', $self->agentnum)
462 && $options{method} eq 'CC';
464 # always add cc surcharge if called from event
465 if($options{'cc_surcharge_from_event'} && ($cc_surcharge_pct > 0 || $cc_surcharge_flat > 0)) {
466 if ($options{'amount'} > 0) {
467 $cc_surcharge = ($options{'amount'} * ($cc_surcharge_pct / 100)) + $cc_surcharge_flat;
468 $options{'amount'} += $cc_surcharge;
469 $options{'amount'} = sprintf("%.2f", $options{'amount'}); # round (again)?
472 elsif($cc_surcharge_pct > 0 || $cc_surcharge_flat > 0) {
473 # we're called not from event (i.e. from a
474 # payment screen), so consider the given
475 # amount as post-surcharge
476 $cc_surcharge = $options{'amount'} - (($options{'amount'} - $cc_surcharge_flat) / ( 1 + $cc_surcharge_pct/100 )) if $options{'amount'} > 0;
479 $cc_surcharge = sprintf("%.2f",$cc_surcharge) if $cc_surcharge > 0;
480 $options{'cc_surcharge'} = $cc_surcharge;
484 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
485 warn " cc_surcharge = $cc_surcharge\n";
488 warn " $_ => $options{$_}\n" foreach keys %options;
491 return $self->fake_bop(\%options) if $options{'fake'};
493 $self->_bop_defaults(\%options);
495 return "Missing payinfo"
496 unless $options{'payinfo'};
499 # set trans_is_recur based on invnum if there is one
502 my $trans_is_recur = 0;
503 if ( $options{'invnum'} ) {
505 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
506 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
512 $cust_bill->cust_bill_pkg;
515 if grep { $_->freq ne '0' } @part_pkg;
523 my $payment_gateway = $self->_payment_gateway( \%options );
524 my $namespace = $payment_gateway->gateway_namespace;
526 eval "use $namespace";
530 # check for term discount validity
533 my $discount_term = $options{discount_term};
534 if ( $discount_term ) {
535 my $bill = ($self->cust_bill)[-1]
536 or return "Can't apply a term discount to an unbilled customer";
537 my $plan = FS::discount_plan->new(
539 months => $discount_term
540 ) or return "No discount available for term '$discount_term'";
542 if ( $plan->discounted_total != $options{amount} ) {
543 return "Incorrect term prepayment amount (term $discount_term, amount $options{amount}, requires ".$plan->discounted_total.")";
551 my $bop_content = $self->_bop_content(\%options);
552 return $bop_content unless ref($bop_content);
554 my @invoicing_list = $self->invoicing_list_emailonly;
555 if ( $conf->exists('emailinvoiceautoalways')
556 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
557 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
558 push @invoicing_list, $self->all_emails;
561 my $email = ($conf->exists('business-onlinepayment-email-override'))
562 ? $conf->config('business-onlinepayment-email-override')
563 : $invoicing_list[0];
568 if ( $namespace eq 'Business::OnlinePayment' ) {
570 if ( $options{method} eq 'CC' ) {
572 $content{card_number} = $options{payinfo};
573 $paydate = $options{'paydate'};
574 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
575 $content{expiration} = "$2/$1";
577 $content{cvv2} = $options{'paycvv'}
578 if length($options{'paycvv'});
580 my $paystart_month = $options{'paystart_month'};
581 my $paystart_year = $options{'paystart_year'};
582 $content{card_start} = "$paystart_month/$paystart_year"
583 if $paystart_month && $paystart_year;
585 my $payissue = $options{'payissue'};
586 $content{issue_number} = $payissue if $payissue;
588 if ( $self->_bop_recurring_billing(
589 'payinfo' => $options{'payinfo'},
590 'trans_is_recur' => $trans_is_recur,
594 $content{recurring_billing} = 'YES';
595 $content{acct_code} = 'rebill'
596 if $conf->exists('credit_card-recurring_billing_acct_code');
599 } elsif ( $options{method} eq 'ECHECK' ){
601 ( $content{account_number}, $content{routing_code} ) =
602 split('@', $options{payinfo});
603 $content{bank_name} = $options{payname};
604 $content{bank_state} = $options{'paystate'};
605 $content{account_type}= uc($options{'paytype'}) || 'PERSONAL CHECKING';
607 $content{company} = $self->company if $self->company;
609 if ( $content{account_type} =~ /BUSINESS/i && $self->company ) {
610 $content{account_name} = $self->company;
612 $content{account_name} = $self->getfield('first'). ' '.
613 $self->getfield('last');
616 $content{customer_org} = $self->company ? 'B' : 'I';
617 $content{state_id} = exists($options{'stateid'})
618 ? $options{'stateid'}
619 : $self->getfield('stateid');
620 $content{state_id_state} = exists($options{'stateid_state'})
621 ? $options{'stateid_state'}
622 : $self->getfield('stateid_state');
623 $content{customer_ssn} = exists($options{'ss'})
628 die "unknown method ". $options{method};
631 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
634 die "unknown namespace $namespace";
641 my $balance = exists( $options{'balance'} )
642 ? $options{'balance'}
645 warn "claiming mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
646 $self->select_for_update; #mutex ... just until we get our pending record in
647 warn "obtained mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
649 #the checks here are intended to catch concurrent payments
650 #double-form-submission prevention is taken care of in cust_pay_pending::check
653 return "The customer's balance has changed; $options{method} transaction aborted."
654 if $self->balance < $balance;
656 #also check and make sure there aren't *other* pending payments for this cust
658 my @pending = qsearch('cust_pay_pending', {
659 'custnum' => $self->custnum,
660 'status' => { op=>'!=', value=>'done' }
663 #for third-party payments only, remove pending payments if they're in the
664 #'thirdparty' (waiting for customer action) state.
665 if ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
666 foreach ( grep { $_->status eq 'thirdparty' } @pending ) {
667 my $error = $_->delete;
668 warn "error deleting unfinished third-party payment ".
669 $_->paypendingnum . ": $error\n"
672 @pending = grep { $_->status ne 'thirdparty' } @pending;
675 return "A payment is already being processed for this customer (".
676 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
677 "); $options{method} transaction aborted."
680 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
682 my $cust_pay_pending = new FS::cust_pay_pending {
683 'custnum' => $self->custnum,
684 'paid' => $options{amount},
686 'payby' => $bop_method2payby{$options{method}},
687 'payinfo' => $options{payinfo},
688 'paymask' => $options{paymask},
689 'paydate' => $paydate,
690 'recurring_billing' => $content{recurring_billing},
691 'pkgnum' => $options{'pkgnum'},
693 'gatewaynum' => $payment_gateway->gatewaynum || '',
694 'session_id' => $options{session_id} || '',
695 'jobnum' => $options{depend_jobnum} || '',
697 $cust_pay_pending->payunique( $options{payunique} )
698 if defined($options{payunique}) && length($options{payunique});
700 warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
702 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
703 return $cpp_new_err if $cpp_new_err;
705 warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
707 warn Dumper($cust_pay_pending) if $DEBUG > 2;
709 my( $action1, $action2 ) =
710 split( /\s*\,\s*/, $payment_gateway->gateway_action );
712 my $transaction = new $namespace( $payment_gateway->gateway_module,
713 _bop_options(\%options),
716 $transaction->content(
717 'type' => $options{method},
718 _bop_auth(\%options),
719 'action' => $action1,
720 'description' => $options{'description'},
721 'amount' => $options{amount},
722 #'invoice_number' => $options{'invnum'},
723 'customer_id' => $self->custnum,
725 'reference' => $cust_pay_pending->paypendingnum, #for now
726 'callback_url' => $payment_gateway->gateway_callback_url,
727 'cancel_url' => $payment_gateway->gateway_cancel_url,
732 $cust_pay_pending->status('pending');
733 my $cpp_pending_err = $cust_pay_pending->replace;
734 return $cpp_pending_err if $cpp_pending_err;
736 warn Dumper($transaction) if $DEBUG > 2;
738 unless ( $BOP_TESTING ) {
739 $transaction->test_transaction(1)
740 if $conf->exists('business-onlinepayment-test_transaction');
741 $transaction->submit();
743 if ( $BOP_TESTING_SUCCESS ) {
744 $transaction->is_success(1);
745 $transaction->authorization('fake auth');
747 $transaction->is_success(0);
748 $transaction->error_message('fake failure');
752 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
754 $cust_pay_pending->status('thirdparty');
755 my $cpp_err = $cust_pay_pending->replace;
756 return { error => $cpp_err } if $cpp_err;
757 return { reference => $cust_pay_pending->paypendingnum,
758 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
760 } elsif ( $transaction->is_success() && $action2 ) {
762 $cust_pay_pending->status('authorized');
763 my $cpp_authorized_err = $cust_pay_pending->replace;
764 return $cpp_authorized_err if $cpp_authorized_err;
766 my $auth = $transaction->authorization;
767 my $ordernum = $transaction->can('order_number')
768 ? $transaction->order_number
772 new Business::OnlinePayment( $payment_gateway->gateway_module,
773 _bop_options(\%options),
778 type => $options{method},
780 _bop_auth(\%options),
781 order_number => $ordernum,
782 amount => $options{amount},
783 authorization => $auth,
784 description => $options{'description'},
787 foreach my $field (qw( authorization_source_code returned_ACI
788 transaction_identifier validation_code
789 transaction_sequence_num local_transaction_date
790 local_transaction_time AVS_result_code )) {
791 $capture{$field} = $transaction->$field() if $transaction->can($field);
794 $capture->content( %capture );
796 $capture->test_transaction(1)
797 if $conf->exists('business-onlinepayment-test_transaction');
800 unless ( $capture->is_success ) {
801 my $e = "Authorization successful but capture failed, custnum #".
802 $self->custnum. ': '. $capture->result_code.
803 ": ". $capture->error_message;
811 # remove paycvv after initial transaction
814 # compare to FS::cust_main::save_cust_payby - check both to make sure working correctly
815 if ( length($options{'paycvv'})
816 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
818 my $error = $self->remove_cvv_from_cust_payby($options{payinfo});
820 $log->critical('Error removing cvv for cust '.$self->custnum.': '.$error);
821 #not returning error, should at least attempt to handle results of an otherwise valid transaction
822 warn "WARNING: error removing cvv: $error\n";
830 # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
831 # if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
832 if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
833 # cpp will be replaced in _realtime_bop_result
834 $cust_pay_pending->payinfo($card_token);
835 if ($options{'cust_payby'} and my $error = $options{'cust_payby'}->replace) {
836 $log->critical('Error storing token for cust '.$self->custnum.', cust_payby '.$options{'cust_payby'}->custpaybynum.': '.$error);
837 #not returning error, should at least attempt to handle results of an otherwise valid transaction
838 #this leaves real card number in cust_payby, but can't do much else if cust_payby won't replace
846 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
858 if (ref($_[0]) eq 'HASH') {
861 my ( $method, $amount ) = ( shift, shift );
863 $options{method} = $method;
864 $options{amount} = $amount;
867 if ( $options{'fake_failure'} ) {
868 return "Error: No error; test failure requested with fake_failure";
871 my $cust_pay = new FS::cust_pay ( {
872 'custnum' => $self->custnum,
873 'invnum' => $options{'invnum'},
874 'paid' => $options{amount},
876 'payby' => $bop_method2payby{$options{method}},
877 'payinfo' => '4111111111111111',
878 'paydate' => '2012-05-01',
879 'processor' => 'FakeProcessor',
881 'order_number' => '32',
883 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
886 warn "fake_bop\n cust_pay: ". Dumper($cust_pay) . "\n options: ";
887 warn " $_ => $options{$_}\n" foreach keys %options;
890 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
893 $cust_pay->invnum(''); #try again with no specific invnum
894 my $error2 = $cust_pay->insert( $options{'manual'} ?
895 ( 'manual' => 1 ) : ()
898 # gah, even with transactions.
899 my $e = 'WARNING: Card/ACH debited but database not updated - '.
900 "error inserting (fake!) payment: $error2".
901 " (previously tried insert with invnum #$options{'invnum'}" .
908 if ( $options{'paynum_ref'} ) {
909 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
917 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
919 # Wraps up processing of a realtime credit card or ACH (electronic check)
922 sub _realtime_bop_result {
923 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
925 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
928 warn "$me _realtime_bop_result: pending transaction ".
929 $cust_pay_pending->paypendingnum. "\n";
930 warn " $_ => $options{$_}\n" foreach keys %options;
933 my $payment_gateway = $options{payment_gateway}
934 or return "no payment gateway in arguments to _realtime_bop_result";
936 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
937 my $cpp_captured_err = $cust_pay_pending->replace; #also saves post-transaction tokenization, if that happens
938 return $cpp_captured_err if $cpp_captured_err;
940 if ( $transaction->is_success() ) {
942 my $order_number = $transaction->order_number
943 if $transaction->can('order_number');
945 my $cust_pay = new FS::cust_pay ( {
946 'custnum' => $self->custnum,
947 'invnum' => $options{'invnum'},
948 'paid' => $cust_pay_pending->paid,
950 'payby' => $cust_pay_pending->payby,
951 'payinfo' => $options{'payinfo'},
952 'paymask' => $options{'paymask'} || $cust_pay_pending->paymask,
953 'paydate' => $cust_pay_pending->paydate,
954 'pkgnum' => $cust_pay_pending->pkgnum,
955 'discount_term' => $options{'discount_term'},
956 'gatewaynum' => ($payment_gateway->gatewaynum || ''),
957 'processor' => $payment_gateway->gateway_module,
958 'auth' => $transaction->authorization,
959 'order_number' => $order_number || '',
960 'no_auto_apply' => $options{'no_auto_apply'} ? 'Y' : '',
962 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
963 $cust_pay->payunique( $options{payunique} )
964 if defined($options{payunique}) && length($options{payunique});
966 my $oldAutoCommit = $FS::UID::AutoCommit;
967 local $FS::UID::AutoCommit = 0;
970 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
972 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
975 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
976 $cust_pay->invnum(''); #try again with no specific invnum
977 $cust_pay->paynum('');
978 my $error2 = $cust_pay->insert( $options{'manual'} ?
979 ( 'manual' => 1 ) : ()
982 # gah. but at least we have a record of the state we had to abort in
983 # from cust_pay_pending now.
984 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
985 my $e = "WARNING: $options{method} captured but payment not recorded -".
986 " error inserting payment (". $payment_gateway->gateway_module.
988 " (previously tried insert with invnum #$options{'invnum'}" .
989 ": $error ) - pending payment saved as paypendingnum ".
990 $cust_pay_pending->paypendingnum. "\n";
996 my $jobnum = $cust_pay_pending->jobnum;
998 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1000 unless ( $placeholder ) {
1001 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1002 my $e = "WARNING: $options{method} captured but job $jobnum not ".
1003 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
1008 $error = $placeholder->delete;
1011 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1012 my $e = "WARNING: $options{method} captured but could not delete ".
1013 "job $jobnum for paypendingnum ".
1014 $cust_pay_pending->paypendingnum. ": $error\n";
1019 $cust_pay_pending->set('jobnum','');
1023 if ( $options{'paynum_ref'} ) {
1024 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
1027 $cust_pay_pending->status('done');
1028 $cust_pay_pending->statustext('captured');
1029 $cust_pay_pending->paynum($cust_pay->paynum);
1030 my $cpp_done_err = $cust_pay_pending->replace;
1032 if ( $cpp_done_err ) {
1034 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1035 my $e = "WARNING: $options{method} captured but payment not recorded - ".
1036 "error updating status for paypendingnum ".
1037 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1043 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1045 if ( $options{'apply'} ) {
1046 my $apply_error = $self->apply_payments_and_credits;
1047 if ( $apply_error ) {
1048 warn "WARNING: error applying payment: $apply_error\n";
1049 #but we still should return no error cause the payment otherwise went
1054 # have a CC surcharge portion --> one-time charge
1055 if ( $options{'cc_surcharge'} > 0 ) {
1056 # XXX: this whole block needs to be in a transaction?
1059 $invnum = $options{'invnum'} if $options{'invnum'};
1060 unless ( $invnum ) { # probably from a payment screen
1061 # do we have any open invoices? pick earliest
1062 # uses the fact that cust_main->cust_bill sorts by date ascending
1063 my @open = $self->open_cust_bill;
1064 $invnum = $open[0]->invnum if scalar(@open);
1067 unless ( $invnum ) { # still nothing? pick last closed invoice
1068 # again uses fact that cust_main->cust_bill sorts by date ascending
1069 my @closed = $self->cust_bill;
1070 $invnum = $closed[$#closed]->invnum if scalar(@closed);
1073 unless ( $invnum ) {
1074 # XXX: unlikely case - pre-paying before any invoices generated
1075 # what it should do is create a new invoice and pick it
1076 warn 'CC SURCHARGE AND NO INVOICES PICKED TO APPLY IT!';
1081 my $cc_surcharge_text = 'Credit Card Surcharge';
1082 $cc_surcharge_text = $conf->config('credit-card-surcharge-text', $self->agentnum) if $conf->exists('credit-card-surcharge-text', $self->agentnum);
1083 my $charge_error = $self->charge({
1084 'amount' => $options{'cc_surcharge'},
1085 'pkg' => $cc_surcharge_text,
1087 'cust_pkg_ref' => \$cust_pkg,
1090 warn 'Unable to add CC surcharge cust_pkg';
1094 $cust_pkg->setup(time);
1095 my $cp_error = $cust_pkg->replace;
1097 warn 'Unable to set setup time on cust_pkg for cc surcharge';
1101 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1102 unless ( $cust_bill ) {
1103 warn "race condition + invoice deletion just happened";
1108 $cust_bill->add_cc_surcharge($cust_pkg->pkgnum,$options{'cc_surcharge'});
1110 warn "cannot add CC surcharge to invoice #$invnum: $grand_error"
1114 return ''; #no error
1120 my $perror = $transaction->error_message;
1121 #$payment_gateway->gateway_module. " error: ".
1122 # removed for conciseness
1124 my $jobnum = $cust_pay_pending->jobnum;
1126 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1128 if ( $placeholder ) {
1129 my $error = $placeholder->depended_delete;
1130 $error ||= $placeholder->delete;
1131 $cust_pay_pending->set('jobnum','');
1132 warn "error removing provisioning jobs after declined paypendingnum ".
1133 $cust_pay_pending->paypendingnum. ": $error\n" if $error;
1135 my $e = "error finding job $jobnum for declined paypendingnum ".
1136 $cust_pay_pending->paypendingnum. "\n";
1142 unless ( $transaction->error_message ) {
1145 if ( $transaction->can('response_page') ) {
1147 'page' => ( $transaction->can('response_page')
1148 ? $transaction->response_page
1151 'code' => ( $transaction->can('response_code')
1152 ? $transaction->response_code
1155 'headers' => ( $transaction->can('response_headers')
1156 ? $transaction->response_headers
1162 "No additional debugging information available for ".
1163 $payment_gateway->gateway_module;
1166 $perror .= "No error_message returned from ".
1167 $payment_gateway->gateway_module. " -- ".
1168 ( ref($t_response) ? Dumper($t_response) : $t_response );
1172 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
1173 && $conf->exists('emaildecline', $self->agentnum)
1174 && grep { $_ ne 'POST' } $self->invoicing_list
1175 && ! grep { $transaction->error_message =~ /$_/ }
1176 $conf->config('emaildecline-exclude', $self->agentnum)
1179 # Send a decline alert to the customer.
1180 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
1183 # include the raw error message in the transaction state
1184 $cust_pay_pending->setfield('error', $transaction->error_message);
1185 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1186 $error = $msg_template->send( 'cust_main' => $self,
1187 'object' => $cust_pay_pending );
1191 $perror .= " (also received error sending decline notification: $error)"
1196 $cust_pay_pending->status('done');
1197 $cust_pay_pending->statustext($perror);
1198 #'declined:': no, that's failure_status
1199 if ( $transaction->can('failure_status') ) {
1200 $cust_pay_pending->failure_status( $transaction->failure_status );
1202 my $cpp_done_err = $cust_pay_pending->replace;
1203 if ( $cpp_done_err ) {
1204 my $e = "WARNING: $options{method} declined but pending payment not ".
1205 "resolved - error updating status for paypendingnum ".
1206 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1208 $perror = "$e ($perror)";
1216 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
1218 Verifies successful third party processing of a realtime credit card or
1219 ACH (electronic check) transaction via a
1220 Business::OnlineThirdPartyPayment realtime gateway. See
1221 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
1223 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
1225 The additional options I<payname>, I<city>, I<state>,
1226 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
1227 if set, will override the value from the customer record.
1229 I<description> is a free-text field passed to the gateway. It defaults to
1230 "Internet services".
1232 If an I<invnum> is specified, this payment (if successful) is applied to the
1233 specified invoice. If you don't specify an I<invnum> you might want to
1234 call the B<apply_payments> method.
1236 I<quiet> can be set true to surpress email decline notices.
1238 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
1239 resulting paynum, if any.
1241 I<payunique> is a unique identifier for this payment.
1243 Returns a hashref containing elements bill_error (which will be undefined
1244 upon success) and session_id of any associated session.
1248 sub realtime_botpp_capture {
1249 my( $self, $cust_pay_pending, %options ) = @_;
1251 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1254 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
1255 warn " $_ => $options{$_}\n" foreach keys %options;
1258 eval "use Business::OnlineThirdPartyPayment";
1262 # select the gateway
1265 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
1267 my $payment_gateway;
1268 my $gatewaynum = $cust_pay_pending->getfield('gatewaynum');
1269 $payment_gateway = $gatewaynum ? qsearchs( 'payment_gateway',
1270 { gatewaynum => $gatewaynum }
1272 : $self->agent->payment_gateway( 'method' => $method,
1273 # 'invnum' => $cust_pay_pending->invnum,
1274 # 'payinfo' => $cust_pay_pending->payinfo,
1277 $options{payment_gateway} = $payment_gateway; # for the helper subs
1283 my @invoicing_list = $self->invoicing_list_emailonly;
1284 if ( $conf->exists('emailinvoiceautoalways')
1285 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1286 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1287 push @invoicing_list, $self->all_emails;
1290 my $email = ($conf->exists('business-onlinepayment-email-override'))
1291 ? $conf->config('business-onlinepayment-email-override')
1292 : $invoicing_list[0];
1296 $content{email_customer} =
1297 ( $conf->exists('business-onlinepayment-email_customer')
1298 || $conf->exists('business-onlinepayment-email-override') );
1301 # run transaction(s)
1305 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
1306 _bop_options(\%options),
1309 $transaction->reference({ %options });
1311 $transaction->content(
1313 _bop_auth(\%options),
1314 'action' => 'Post Authorization',
1315 'description' => $options{'description'},
1316 'amount' => $cust_pay_pending->paid,
1317 #'invoice_number' => $options{'invnum'},
1318 'customer_id' => $self->custnum,
1319 'reference' => $cust_pay_pending->paypendingnum,
1321 'phone' => $self->daytime || $self->night,
1323 # plus whatever is required for bogus capture avoidance
1326 $transaction->submit();
1329 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
1331 if ( $options{'apply'} ) {
1332 my $apply_error = $self->apply_payments_and_credits;
1333 if ( $apply_error ) {
1334 warn "WARNING: error applying payment: $apply_error\n";
1339 bill_error => $error,
1340 session_id => $cust_pay_pending->session_id,
1345 =item default_payment_gateway
1347 DEPRECATED -- use agent->payment_gateway
1351 sub default_payment_gateway {
1352 my( $self, $method ) = @_;
1354 die "Real-time processing not enabled\n"
1355 unless $conf->exists('business-onlinepayment');
1357 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
1360 my $bop_config = 'business-onlinepayment';
1361 $bop_config .= '-ach'
1362 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
1363 my ( $processor, $login, $password, $action, @bop_options ) =
1364 $conf->config($bop_config);
1365 $action ||= 'normal authorization';
1366 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
1367 die "No real-time processor is enabled - ".
1368 "did you set the business-onlinepayment configuration value?\n"
1371 ( $processor, $login, $password, $action, @bop_options )
1374 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
1376 Refunds a realtime credit card or ACH (electronic check) transaction
1377 via a Business::OnlinePayment realtime gateway. See
1378 L<http://420.am/business-onlinepayment> for supported gateways.
1380 Available methods are: I<CC> or I<ECHECK>
1382 Available options are: I<amount>, I<reasonnum>, I<paynum>, I<paydate>
1384 Most gateways require a reference to an original payment transaction to refund,
1385 so you probably need to specify a I<paynum>.
1387 I<amount> defaults to the original amount of the payment if not specified.
1389 I<reasonnum> specified an existing refund reason for the refund
1391 I<paydate> specifies the expiration date for a credit card overriding the
1392 value from the customer record or the payment record. Specified as yyyy-mm-dd
1394 Implementation note: If I<amount> is unspecified or equal to the amount of the
1395 orignal payment, first an attempt is made to "void" the transaction via
1396 the gateway (to cancel a not-yet settled transaction) and then if that fails,
1397 the normal attempt is made to "refund" ("credit") the transaction via the
1398 gateway is attempted. No attempt to "void" the transaction is made if the
1399 gateway has introspection data and doesn't support void.
1401 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
1402 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
1403 #if set, will override the value from the customer record.
1405 #If an I<invnum> is specified, this payment (if successful) is applied to the
1406 #specified invoice. If you don't specify an I<invnum> you might want to
1407 #call the B<apply_payments> method.
1411 #some false laziness w/realtime_bop, not enough to make it worth merging
1412 #but some useful small subs should be pulled out
1413 sub realtime_refund_bop {
1416 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1419 if (ref($_[0]) eq 'HASH') {
1420 %options = %{$_[0]};
1424 $options{method} = $method;
1428 warn "$me realtime_refund_bop (new): $options{method} refund\n";
1429 warn " $_ => $options{$_}\n" foreach keys %options;
1432 return "No reason specified" unless $options{'reasonnum'} =~ /^\d+$/;
1437 # look up the original payment and optionally a gateway for that payment
1441 my $amount = $options{'amount'};
1443 my( $processor, $login, $password, @bop_options, $namespace ) ;
1444 my( $auth, $order_number ) = ( '', '', '' );
1445 my $gatewaynum = '';
1447 if ( $options{'paynum'} ) {
1449 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
1450 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
1451 or return "Unknown paynum $options{'paynum'}";
1452 $amount ||= $cust_pay->paid;
1454 my @cust_bill_pay = qsearch('cust_bill_pay', { paynum=>$cust_pay->paynum });
1455 $content{'invoice_number'} = $cust_bill_pay[0]->invnum if @cust_bill_pay;
1457 if ( $cust_pay->get('processor') ) {
1458 ($gatewaynum, $processor, $auth, $order_number) =
1460 $cust_pay->gatewaynum,
1461 $cust_pay->processor,
1463 $cust_pay->order_number,
1466 # this payment wasn't upgraded, which probably means this won't work,
1468 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
1469 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
1470 $cust_pay->paybatch;
1471 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
1474 my $payment_gateway;
1475 if ( $gatewaynum ) { #gateway for the payment to be refunded
1478 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
1479 die "payment gateway $gatewaynum not found"
1480 unless $payment_gateway;
1482 $processor = $payment_gateway->gateway_module;
1483 $login = $payment_gateway->gateway_username;
1484 $password = $payment_gateway->gateway_password;
1485 $namespace = $payment_gateway->gateway_namespace;
1486 @bop_options = $payment_gateway->options;
1488 } else { #try the default gateway
1492 $self->agent->payment_gateway('method' => $options{method});
1494 ( $conf_processor, $login, $password, $namespace ) =
1495 map { my $method = "gateway_$_"; $payment_gateway->$method }
1496 qw( module username password namespace );
1498 @bop_options = $payment_gateway->gatewaynum
1499 ? $payment_gateway->options
1500 : @{ $payment_gateway->get('options') };
1501 my %bop_options = @bop_options;
1503 return "processor of payment $options{'paynum'} $processor does not".
1504 " match default processor $conf_processor"
1505 unless ($processor eq $conf_processor)
1506 || (($conf_processor eq 'CardFortress') && ($processor eq $bop_options{'gateway'}));
1508 $processor = $conf_processor;
1512 # if gateway has switched to CardFortress but token_check hasn't run yet,
1513 # tokenize just this record now, so that token gets passed/set appropriately
1514 if ($cust_pay->payby eq 'CARD' && !$cust_pay->tokenized) {
1516 'payment_gateway' => $payment_gateway,
1518 'payinfo' => $cust_pay->payinfo,
1519 'paydate' => $cust_pay->paydate,
1521 my $error = $self->realtime_tokenize(\%tokenopts); # no-op unless gateway can tokenize
1522 if ($self->tokenized($tokenopts{'payinfo'})) { # implies no error
1523 warn " tokenizing cust_pay\n" if $DEBUG > 1;
1524 $cust_pay->payinfo($tokenopts{'payinfo'});
1525 $error = $cust_pay->replace;
1527 return $error if $error;
1530 } else { # didn't specify a paynum, so look for agent gateway overrides
1531 # like a normal transaction
1533 my $payment_gateway =
1534 $self->agent->payment_gateway( 'method' => $options{method} );
1535 ( $processor, $login, $password, $namespace ) =
1536 map { my $method = "gateway_$_"; $payment_gateway->$method }
1537 qw( module username password namespace );
1539 my @bop_options = $payment_gateway->gatewaynum
1540 ? $payment_gateway->options
1541 : @{ $payment_gateway->get('options') };
1544 return "neither amount nor paynum specified" unless $amount;
1546 eval "use $namespace";
1551 'type' => $options{method},
1553 'password' => $password,
1554 'order_number' => $order_number,
1555 'amount' => $amount,
1557 $content{authorization} = $auth
1558 if length($auth); #echeck/ACH transactions have an order # but no auth
1559 #(at least with authorize.net)
1561 my $currency = $conf->exists('business-onlinepayment-currency')
1562 && $conf->config('business-onlinepayment-currency');
1563 $content{currency} = $currency if $currency;
1565 my $disable_void_after;
1566 if ($conf->exists('disable_void_after')
1567 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
1568 $disable_void_after = $1;
1571 #first try void if applicable
1572 my $void = new Business::OnlinePayment( $processor, @bop_options );
1575 if ($void->can('info')) {
1577 $paytype = 'ECHECK' if $cust_pay && $cust_pay->payby eq 'CHEK';
1578 $paytype = 'CC' if $cust_pay && $cust_pay->payby eq 'CARD';
1579 my %supported_actions = $void->info('supported_actions');
1581 if ( %supported_actions && $paytype
1582 && defined($supported_actions{$paytype})
1583 && !grep{ $_ eq 'Void' } @{$supported_actions{$paytype}} );
1586 if ( $cust_pay && $cust_pay->paid == $amount
1588 ( not defined($disable_void_after) )
1589 || ( time < ($cust_pay->_date + $disable_void_after ) )
1593 warn " attempting void\n" if $DEBUG > 1;
1594 if ( $void->can('info') ) {
1595 if ( $cust_pay->payby eq 'CARD'
1596 && $void->info('CC_void_requires_card') )
1598 $content{'card_number'} = $cust_pay->payinfo;
1599 } elsif ( $cust_pay->payby eq 'CHEK'
1600 && $void->info('ECHECK_void_requires_account') )
1602 ( $content{'account_number'}, $content{'routing_code'} ) =
1603 split('@', $cust_pay->payinfo);
1604 $content{'name'} = $self->get('first'). ' '. $self->get('last');
1607 $void->content( 'action' => 'void', %content );
1608 $void->test_transaction(1)
1609 if $conf->exists('business-onlinepayment-test_transaction');
1611 if ( $void->is_success ) {
1612 # specified as a refund reason, but now we want a payment void reason
1613 # extract just the reason text, let cust_pay::void handle new_or_existing
1614 my $reason = qsearchs('reason',{ 'reasonnum' => $options{'reasonnum'} });
1616 $error = 'Reason could not be loaded' unless $reason;
1617 $error = $cust_pay->void($reason->reason) unless $error;
1619 # gah, even with transactions.
1620 my $e = 'WARNING: Card/ACH voided but database not updated - '.
1621 "error voiding payment: $error";
1625 warn " void successful\n" if $DEBUG > 1;
1630 warn " void unsuccessful, trying refund\n"
1634 my $address = $self->address1;
1635 $address .= ", ". $self->address2 if $self->address2;
1637 my($payname, $payfirst, $paylast);
1638 if ( $self->payname && $options{method} ne 'ECHECK' ) {
1639 $payname = $self->payname;
1640 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
1641 or return "Illegal payname $payname";
1642 ($payfirst, $paylast) = ($1, $2);
1644 $payfirst = $self->getfield('first');
1645 $paylast = $self->getfield('last');
1646 $payname = "$payfirst $paylast";
1649 my @invoicing_list = $self->invoicing_list_emailonly;
1650 if ( $conf->exists('emailinvoiceautoalways')
1651 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1652 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1653 push @invoicing_list, $self->all_emails;
1656 my $email = ($conf->exists('business-onlinepayment-email-override'))
1657 ? $conf->config('business-onlinepayment-email-override')
1658 : $invoicing_list[0];
1660 my $payip = exists($options{'payip'})
1663 $content{customer_ip} = $payip
1667 my $paymask = ''; # for refund record
1668 if ( $options{method} eq 'CC' ) {
1671 $content{card_number} = $payinfo = $cust_pay->payinfo;
1672 $paymask = $cust_pay->paymask;
1673 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
1674 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
1675 ($content{expiration} = "$2/$1"); # where available
1677 # this really needs a better cleanup
1678 die "Refund without paynum not supported";
1679 # $content{card_number} = $payinfo = $self->payinfo;
1680 # (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
1681 # =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1682 # $content{expiration} = "$2/$1";
1685 } elsif ( $options{method} eq 'ECHECK' ) {
1688 $payinfo = $cust_pay->payinfo;
1690 $payinfo = $self->payinfo;
1692 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
1693 $content{bank_name} = $self->payname;
1694 $content{account_type} = 'CHECKING';
1695 $content{account_name} = $payname;
1696 $content{customer_org} = $self->company ? 'B' : 'I';
1697 $content{customer_ssn} = $self->ss;
1702 my $refund = new Business::OnlinePayment( $processor, @bop_options );
1703 my %sub_content = $refund->content(
1704 'action' => 'credit',
1705 'customer_id' => $self->custnum,
1706 'last_name' => $paylast,
1707 'first_name' => $payfirst,
1709 'address' => $address,
1710 'city' => $self->city,
1711 'state' => $self->state,
1712 'zip' => $self->zip,
1713 'country' => $self->country,
1715 'phone' => $self->daytime || $self->night,
1718 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
1720 $refund->test_transaction(1)
1721 if $conf->exists('business-onlinepayment-test_transaction');
1724 return "$processor error: ". $refund->error_message
1725 unless $refund->is_success();
1727 $order_number = $refund->order_number if $refund->can('order_number');
1729 # change this to just use $cust_pay->delete_cust_bill_pay?
1730 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
1731 my @cust_bill_pay = $cust_pay->cust_bill_pay;
1732 last unless @cust_bill_pay;
1733 my $cust_bill_pay = pop @cust_bill_pay;
1734 my $error = $cust_bill_pay->delete;
1738 my $cust_refund = new FS::cust_refund ( {
1739 'custnum' => $self->custnum,
1740 'paynum' => $options{'paynum'},
1741 'source_paynum' => $options{'paynum'},
1742 'refund' => $amount,
1744 'payby' => $bop_method2payby{$options{method}},
1745 'payinfo' => $payinfo,
1746 'paymask' => $paymask,
1747 'reasonnum' => $options{'reasonnum'},
1748 'gatewaynum' => $gatewaynum, # may be null
1749 'processor' => $processor,
1750 'auth' => $refund->authorization,
1751 'order_number' => $order_number,
1753 my $error = $cust_refund->insert;
1755 $cust_refund->paynum(''); #try again with no specific paynum
1756 $cust_refund->source_paynum('');
1757 my $error2 = $cust_refund->insert;
1759 # gah, even with transactions.
1760 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
1761 "error inserting refund ($processor): $error2".
1762 " (previously tried insert with paynum #$options{'paynum'}" .
1773 =item realtime_verify_bop [ OPTION => VALUE ... ]
1775 Runs an authorization-only transaction for $1 against this credit card (if
1776 successful, immediatly reverses the authorization).
1778 Returns the empty string if the authorization was sucessful, or an error
1781 Option I<cust_payby> should be passed, even if it's not yet been inserted.
1782 Object will be tokenized if possible, but that change will not be
1783 updated in database (must be inserted/replaced afterwards.)
1785 Currently only succeeds for Business::OnlinePayment CC transactions.
1789 #some false laziness w/realtime_bop and realtime_refund_bop, not enough to make
1790 #it worth merging but some useful small subs should be pulled out
1791 sub realtime_verify_bop {
1794 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1795 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_verify_bop');
1798 if (ref($_[0]) eq 'HASH') {
1799 %options = %{$_[0]};
1805 warn "$me realtime_verify_bop\n";
1806 warn " $_ => $options{$_}\n" foreach keys %options;
1809 # set fields from passed cust_payby
1810 return "No cust_payby" unless $options{'cust_payby'};
1811 _bop_cust_payby_options(\%options);
1813 # check for banned credit card/ACH
1814 my $ban = FS::banned_pay->ban_search(
1815 'payby' => $bop_method2payby{'CC'},
1816 'payinfo' => $options{payinfo},
1818 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
1820 # possibly run a separate transaction to tokenize card number,
1821 # so that we never store tokenized card info in cust_pay_pending
1822 if (($options{method} eq 'CC') && !$self->tokenized($options{'payinfo'})) {
1823 my $token_error = $self->realtime_tokenize(\%options);
1824 return $token_error if $token_error;
1825 #important that we not replace cust_payby here,
1826 #because cust_payby->replace uses realtime_verify_bop!
1833 my $payment_gateway = $self->_payment_gateway( \%options );
1834 my $namespace = $payment_gateway->gateway_namespace;
1836 eval "use $namespace";
1843 my $bop_content = $self->_bop_content(\%options);
1844 return $bop_content unless ref($bop_content);
1846 my @invoicing_list = $self->invoicing_list_emailonly;
1847 if ( $conf->exists('emailinvoiceautoalways')
1848 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1849 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1850 push @invoicing_list, $self->all_emails;
1853 my $email = ($conf->exists('business-onlinepayment-email-override'))
1854 ? $conf->config('business-onlinepayment-email-override')
1855 : $invoicing_list[0];
1860 if ( $namespace eq 'Business::OnlinePayment' ) {
1862 if ( $options{method} eq 'CC' ) {
1864 $content{card_number} = $options{payinfo};
1865 $paydate = $options{'paydate'};
1866 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1867 $content{expiration} = "$2/$1";
1869 $content{cvv2} = $options{'paycvv'}
1870 if length($options{'paycvv'});
1872 my $paystart_month = $options{'paystart_month'};
1873 my $paystart_year = $options{'paystart_year'};
1875 $content{card_start} = "$paystart_month/$paystart_year"
1876 if $paystart_month && $paystart_year;
1878 my $payissue = $options{'payissue'};
1879 $content{issue_number} = $payissue if $payissue;
1881 } elsif ( $options{method} eq 'ECHECK' ){
1882 #cannot verify, move along (though it shouldn't be called...)
1885 return "unknown method ". $options{method};
1887 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
1888 #cannot verify, move along
1891 return "unknown namespace $namespace";
1895 # run transaction(s)
1899 my $transaction; #need this back so we can do _tokenize_card
1901 # don't mutex the customer here, because they might be uncommitted. and
1902 # this is only verification. it doesn't matter if they have other
1903 # unfinished verifications.
1905 my $cust_pay_pending = new FS::cust_pay_pending {
1906 'custnum_pending' => 1,
1909 'payby' => $bop_method2payby{'CC'},
1910 'payinfo' => $options{payinfo},
1911 'paymask' => $options{paymask},
1912 'paydate' => $paydate,
1913 'pkgnum' => $options{'pkgnum'},
1915 'gatewaynum' => $payment_gateway->gatewaynum || '',
1916 'session_id' => $options{session_id} || '',
1918 $cust_pay_pending->payunique( $options{payunique} )
1919 if defined($options{payunique}) && length($options{payunique});
1922 # open a separate handle for creating/updating the cust_pay_pending
1924 local $FS::UID::dbh = myconnect();
1925 local $FS::UID::AutoCommit = 1;
1927 # if this is an existing customer (and we can tell now because
1928 # this is a fresh transaction), it's safe to assign their custnum
1929 # to the cust_pay_pending record, and then the verification attempt
1930 # will remain linked to them even if it fails.
1931 if ( FS::cust_main->by_key($self->custnum) ) {
1932 $cust_pay_pending->set('custnum', $self->custnum);
1935 warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
1938 # if this fails, just return; everything else will still allow the
1939 # cust_pay_pending to have its custnum set later
1940 my $cpp_new_err = $cust_pay_pending->insert;
1941 return $cpp_new_err if $cpp_new_err;
1943 warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
1945 warn Dumper($cust_pay_pending) if $DEBUG > 2;
1947 $transaction = new $namespace( $payment_gateway->gateway_module,
1948 _bop_options(\%options),
1951 $transaction->content(
1953 _bop_auth(\%options),
1954 'action' => 'Authorization Only',
1955 'description' => $options{'description'},
1957 'customer_id' => $self->custnum,
1959 'reference' => $cust_pay_pending->paypendingnum, #for now
1964 $cust_pay_pending->status('pending');
1965 my $cpp_pending_err = $cust_pay_pending->replace;
1966 return $cpp_pending_err if $cpp_pending_err;
1968 warn Dumper($transaction) if $DEBUG > 2;
1970 unless ( $BOP_TESTING ) {
1971 $transaction->test_transaction(1)
1972 if $conf->exists('business-onlinepayment-test_transaction');
1973 $transaction->submit();
1975 if ( $BOP_TESTING_SUCCESS ) {
1976 $transaction->is_success(1);
1977 $transaction->authorization('fake auth');
1979 $transaction->is_success(0);
1980 $transaction->error_message('fake failure');
1984 if ( $transaction->is_success() ) {
1986 $cust_pay_pending->status('authorized');
1987 my $cpp_authorized_err = $cust_pay_pending->replace;
1988 return $cpp_authorized_err if $cpp_authorized_err;
1990 my $auth = $transaction->authorization;
1991 my $ordernum = $transaction->can('order_number')
1992 ? $transaction->order_number
1995 my $reverse = new $namespace( $payment_gateway->gateway_module,
1996 _bop_options(\%options),
1999 $reverse->content( 'action' => 'Reverse Authorization',
2000 _bop_auth(\%options),
2004 'authorization' => $transaction->authorization,
2005 'order_number' => $ordernum,
2008 'result_code' => $transaction->result_code,
2009 'txn_date' => $transaction->txn_date,
2013 $reverse->test_transaction(1)
2014 if $conf->exists('business-onlinepayment-test_transaction');
2017 if ( $reverse->is_success ) {
2019 $cust_pay_pending->status('done');
2020 $cust_pay_pending->statustext('reversed');
2021 my $cpp_reversed_err = $cust_pay_pending->replace;
2022 return $cpp_reversed_err if $cpp_reversed_err;
2026 my $e = "Authorization successful but reversal failed, custnum #".
2027 $self->custnum. ': '. $reverse->result_code.
2028 ": ". $reverse->error_message;
2035 ### Address Verification ###
2037 # Single-letter codes vary by cardtype.
2039 # Erring on the side of accepting cards if avs is not available,
2040 # only rejecting if avs occurred and there's been an explicit mismatch
2042 # Charts below taken from vSecure documentation,
2043 # shows codes for Amex/Dscv/MC/Visa
2045 # ACCEPTABLE AVS RESPONSES:
2046 # Both Address and 5-digit postal code match Y A Y Y
2047 # Both address and 9-digit postal code match Y A X Y
2048 # United Kingdom – Address and postal code match _ _ _ F
2049 # International transaction – Address and postal code match _ _ _ D/M
2051 # ACCEPTABLE, BUT ISSUE A WARNING:
2052 # Ineligible transaction; or message contains a content error _ _ _ E
2053 # System unavailable; retry R U R R
2054 # Information unavailable U W U U
2055 # Issuer does not support AVS S U S S
2056 # AVS is not applicable _ _ _ S
2057 # Incompatible formats – Not verified _ _ _ C
2058 # Incompatible formats – Address not verified; postal code matches _ _ _ P
2059 # International transaction – address not verified _ G _ G/I
2061 # UNACCEPTABLE AVS RESPONSES:
2062 # Only Address matches A Y A A
2063 # Only 5-digit postal code matches Z Z Z Z
2064 # Only 9-digit postal code matches Z Z W W
2065 # Neither address nor postal code matches N N N N
2067 if (my $avscode = uc($transaction->avs_code)) {
2069 # map codes to accept/warn/reject
2071 'American Express card' => {
2080 'Discover card' => {
2119 my $cardtype = cardtype($content{card_number});
2120 if ($avs->{$cardtype}) {
2121 my $avsact = $avs->{$cardtype}->{$avscode};
2123 if ($avsact eq 'r') {
2124 return "AVS code verification failed, cardtype $cardtype, code $avscode";
2125 } elsif ($avsact eq 'w') {
2126 $warning = "AVS did not occur, cardtype $cardtype, code $avscode";
2127 } elsif (!$avsact) {
2128 $warning = "AVS code unknown, cardtype $cardtype, code $avscode";
2129 } # else $avsact eq 'a'
2131 $log->warning($warning);
2134 } # else $cardtype avs handling not implemented
2135 } # else !$transaction->avs_code
2137 } else { # is not success
2139 # status is 'done' not 'declined', as in _realtime_bop_result
2140 $cust_pay_pending->status('done');
2141 $error = $transaction->error_message || 'Unknown error';
2142 $cust_pay_pending->statustext($error);
2143 # could also record failure_status here,
2144 # but it's not supported by B::OP::vSecureProcessing...
2145 # need a B::OP module with (reverse) auth only to test it with
2146 my $cpp_declined_err = $cust_pay_pending->replace;
2147 return $cpp_declined_err if $cpp_declined_err;
2151 } # end of IMMEDIATE; we now have our $error and $transaction
2154 # Save the custnum (as part of the main transaction, so it can reference
2158 if (!$cust_pay_pending->custnum) {
2159 $cust_pay_pending->set('custnum', $self->custnum);
2160 my $set_custnum_err = $cust_pay_pending->replace;
2161 if ($set_custnum_err) {
2162 $log->error($set_custnum_err);
2163 $error ||= $set_custnum_err;
2164 # but if there was a real verification error also, return that one
2169 # remove paycvv here? need to find out if a reversed auth
2170 # counts as an initial transaction for paycvv retention requirements
2177 # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
2178 # if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
2179 if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
2180 $cust_pay_pending->payinfo($card_token);
2181 my $cpp_token_err = $cust_pay_pending->replace;
2182 #this leaves real card number in cust_pay_pending, but can't do much else if cpp won't replace
2183 return $cpp_token_err if $cpp_token_err;
2184 #important that we not replace cust_payby here,
2185 #because cust_payby->replace uses realtime_verify_bop!
2192 # $error contains the transaction error_message, if is_success was false.
2198 =item realtime_tokenize [ OPTION => VALUE ... ]
2200 If possible and necessary, runs a tokenize transaction.
2201 In order to be possible, a credit card cust_payby record
2202 must be passed and a Business::OnlinePayment gateway capable
2203 of Tokenize transactions must be configured for this user.
2204 Is only necessary if payinfo is not yet tokenized.
2206 Returns the empty string if the authorization was sucessful
2207 or was not possible/necessary (thus allowing this to be safely called with
2208 non-tokenizable records/gateways, without having to perform separate tests),
2209 or an error message otherwise.
2211 Option I<cust_payby> may be passed, even if it's not yet been inserted.
2212 Object will be tokenized if possible, but that change will not be
2213 updated in database (must be inserted/replaced afterwards.)
2215 Otherwise, options I<method>, I<payinfo> and other cust_payby fields
2216 may be passed. If options are passed as a hashref, I<payinfo>
2217 will be updated as appropriate in the passed hashref.
2219 Can be run as a class method if option I<payment_gateway> is passed,
2220 but default customer id/name/phone can't be set in that case. This
2221 is really only intended for tokenizing old records on upgrade.
2225 # careful--might be run as a class method
2226 sub realtime_tokenize {
2229 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2230 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_tokenize');
2233 my $outoptions; #for returning cust_payby/payinfo
2234 if (ref($_[0]) eq 'HASH') {
2235 %options = %{$_[0]};
2236 $outoptions = $_[0];
2239 $outoptions = \%options;
2242 # set fields from passed cust_payby
2243 _bop_cust_payby_options(\%options);
2244 return '' unless $options{method} eq 'CC';
2245 return '' if $self->tokenized($options{payinfo}); #already tokenized
2247 # check for banned credit card/ACH
2248 my $ban = FS::banned_pay->ban_search(
2249 'payby' => $bop_method2payby{'CC'},
2250 'payinfo' => $options{payinfo},
2252 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
2258 $options{'nofatal'} = 1;
2259 my $payment_gateway = $self->_payment_gateway( \%options );
2260 return '' unless $payment_gateway;
2261 my $namespace = $payment_gateway->gateway_namespace;
2262 return '' unless $namespace eq 'Business::OnlinePayment';
2264 eval "use $namespace";
2268 # check for tokenize ability
2271 my $transaction = new $namespace( $payment_gateway->gateway_module,
2272 _bop_options(\%options),
2275 return '' unless $transaction->can('info');
2277 my %supported_actions = $transaction->info('supported_actions');
2278 return '' unless $supported_actions{'CC'} and grep(/^Tokenize$/,@{$supported_actions{'CC'}});
2284 ### Currently, cardfortress only keys in on card number and exp date.
2285 ### We pass everything we'd pass to a normal transaction,
2286 ### for ease of current and future development,
2287 ### but note, when tokenizing old records, we may only have access to payinfo/paydate
2289 my $bop_content = $self->_bop_content(\%options);
2290 return $bop_content unless ref($bop_content);
2295 $content{card_number} = $options{payinfo};
2296 $paydate = $options{'paydate'};
2297 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2298 $content{expiration} = "$2/$1";
2300 $content{cvv2} = $options{'paycvv'}
2301 if length($options{'paycvv'});
2303 my $paystart_month = $options{'paystart_month'};
2304 my $paystart_year = $options{'paystart_year'};
2306 $content{card_start} = "$paystart_month/$paystart_year"
2307 if $paystart_month && $paystart_year;
2309 my $payissue = $options{'payissue'};
2310 $content{issue_number} = $payissue if $payissue;
2312 $content{customer_id} = $self->custnum
2321 # no cust_pay_pending---this is not a financial transaction
2323 $transaction->content(
2325 _bop_auth(\%options),
2326 'action' => 'Tokenize',
2327 'description' => $options{'description'},
2332 # no $BOP_TESTING handling for this
2333 $transaction->test_transaction(1)
2334 if $conf->exists('business-onlinepayment-test_transaction');
2335 $transaction->submit();
2337 if ( $transaction->card_token() ) { # no is_success flag
2339 # realtime_tokenize should not clear paycvv at this time. it might be
2340 # needed for the first transaction, and a tokenize isn't actually a
2341 # transaction that hits the gateway. at some point in the future, card
2342 # fortress should take on the "store paycvv until first transaction"
2343 # functionality and we should fix this in freeside, but i that's a bigger
2344 # project for another time.
2346 #important that we not replace cust_payby here,
2347 #because cust_payby->replace uses realtime_tokenize!
2348 $self->_tokenize_card($transaction,$outoptions);
2352 $error = $transaction->error_message || 'Unknown error when tokenizing card';
2361 =item tokenized PAYINFO
2363 Convenience wrapper for L<FS::payinfo_Mixin/tokenized>
2365 PAYINFO is required.
2367 Can be run as class or object method, never loads from object.
2373 my $payinfo = shift;
2374 FS::cust_pay->tokenized($payinfo);
2377 =item token_check [ quiet => 1, queue => 1, daily => 1 ]
2379 NOT A METHOD. Acts on all customers. Placed here because it makes
2380 use of module-internal methods, and to keep everything that uses
2381 Billing::OnlinePayment all in one place.
2383 Tokenizes all tokenizable card numbers from payinfo in cust_payby and
2384 CARD transactions in cust_pay_pending, cust_pay, cust_pay_void and cust_refund.
2386 If the I<queue> flag is set, newly tokenized records will be immediately
2387 committed, regardless of AutoCommit, so as to release the mutex on the record.
2389 If all configured gateways have the ability to tokenize, detection of an
2390 untokenizable record will cause a fatal error. However, if the I<queue> flag
2391 is set, this will instead cause a critical error to be recorded in the log,
2392 and any other tokenizable records will still be committed.
2394 If the I<daily> flag is also set, detection of existing untokenized records will
2395 record an info message in the system log (because they should have never appeared
2396 in the first place.) Tokenization will still be attempted.
2398 If any configured gateways do NOT have the ability to tokenize, or if a
2399 default gateway is not configured, then untokenized records are not considered
2400 a threat, and no critical errors will be generated in the log.
2405 #acts on all customers
2407 my $debug = !$opt{'quiet'} || $DEBUG;
2408 my $hascritical = 0;
2410 warn "token_check called with opts\n".Dumper(\%opt) if $debug;
2412 # force some explicitness when invoking this method
2413 die "token_check must run with queue flag if run with daily flag"
2414 if $opt{'daily'} && !$opt{'queue'};
2416 my $conf = FS::Conf->new;
2418 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::token_check');
2420 my $cache = {}; #cache for module info
2422 # look for a gateway that can and can't tokenize
2423 my $require_tokenized = 1;
2424 my $someone_tokenizing = 0;
2425 foreach my $gateway (
2426 FS::payment_gateway->all_gateways(
2433 # no default gateway, no promise to tokenize
2434 # can just load other gateways as-needeed below
2435 $require_tokenized = 0;
2436 last if $someone_tokenizing;
2439 my $info = _token_check_gateway_info($cache,$gateway);
2440 die $info unless ref($info); # means it's an error message
2441 if ($info->{'can_tokenize'}) {
2442 $someone_tokenizing = 1;
2444 # a configured gateway can't tokenize, that's all we need to know right now
2445 # can just load other gateways as-needeed below
2446 $require_tokenized = 0;
2447 last if $someone_tokenizing;
2451 unless ($someone_tokenizing) { #no need to check, if no one can tokenize
2452 warn "no gateways tokenize\n" if $debug;
2456 warn "REQUIRE TOKENIZED" if $require_tokenized && $debug;
2458 # upgrade does not call this with autocommit turned on,
2459 # and autocommit will be ignored if opt queue is set,
2460 # but might as well be thorough...
2461 my $oldAutoCommit = $FS::UID::AutoCommit;
2462 local $FS::UID::AutoCommit = 0;
2465 # for retrieving data in chunks
2469 ### Tokenize cust_payby
2474 while (my $custnum = _token_check_next_recnum($dbh,'cust_main',$step,\$offset,\@recnums)) {
2475 my $cust_main = FS::cust_main->by_key($custnum);
2476 my $payment_gateway;
2477 foreach my $cust_payby ($cust_main->cust_payby('CARD','DCRD')) {
2479 # see if it's already tokenized
2480 if ($cust_payby->tokenized) {
2481 warn "cust_payby ".$cust_payby->get($cust_payby->primary_key)." already tokenized" if $debug;
2485 if ($require_tokenized && $opt{'daily'}) {
2486 $log->info("Untokenized card number detected in cust_payby ".$cust_payby->custpaybynum. '; tokenizing');
2487 $dbh->commit or die $dbh->errstr; # commit log message
2490 # only load gateway if we need to, and only need to load it once
2491 $payment_gateway ||= $cust_main->_payment_gateway({
2494 'nofatal' => 1, # handle lack of gateway smoothly below
2496 unless ($payment_gateway) {
2497 # no reason to have untokenized card numbers saved if no gateway,
2498 # but only a problem if we expected everyone to tokenize card numbers
2499 unless ($require_tokenized) {
2500 warn "Skipping cust_payby for cust_main ".$cust_main->custnum.", no payment gateway" if $debug;
2501 next CUSTLOOP; # can skip rest of customer
2503 my $error = "No gateway found for custnum ".$cust_main->custnum;
2504 if ($opt{'queue'}) {
2506 $log->critical($error);
2507 $dbh->commit or die $dbh->errstr; # commit error message
2508 next; # not next CUSTLOOP, want to record error for every cust_payby
2510 $dbh->rollback if $oldAutoCommit;
2514 my $info = _token_check_gateway_info($cache,$payment_gateway);
2515 unless (ref($info)) {
2516 # only throws error if Business::OnlinePayment won't load,
2517 # which is just cause to abort this whole process, even if queue
2518 $dbh->rollback if $oldAutoCommit;
2519 die $info; # error message
2521 # no fail here--a configured gateway can't tokenize, so be it
2522 unless ($info->{'can_tokenize'}) {
2523 warn "Skipping ".$cust_main->custnum." cannot tokenize" if $debug;
2528 $cust_payby = $cust_payby->select_for_update;
2530 'payment_gateway' => $payment_gateway,
2531 'cust_payby' => $cust_payby,
2533 my $error = $cust_main->realtime_tokenize(\%tokenopts);
2534 if ($cust_payby->tokenized) { # implies no error
2535 $error = $cust_payby->replace;
2537 $error ||= 'Unknown error';
2540 $error = "Error tokenizing cust_payby ".$cust_payby->custpaybynum.": ".$error;
2541 if ($opt{'queue'}) {
2543 $log->critical($error);
2544 $dbh->commit or die $dbh->errstr; # commit log message, release mutex
2545 next; # not next CUSTLOOP, want to record error for every cust_payby
2547 $dbh->rollback if $oldAutoCommit;
2550 $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
2551 warn "TOKENIZED cust_payby ".$cust_payby->get($cust_payby->primary_key) if $debug;
2553 warn "cust_payby upgraded for custnum ".$cust_main->custnum if $debug;
2557 ### Tokenize/mask transaction tables
2559 # allow tokenization of closed cust_pay/cust_refund records
2560 local $FS::payinfo_Mixin::allow_closed_replace = 1;
2563 # $cust_pay_pending->replace, $cust_pay->replace, $cust_pay_void->replace, $cust_refund->replace all run here
2564 foreach my $table ( qw(cust_pay_pending cust_pay cust_pay_void cust_refund) ) {
2565 warn "Checking $table" if $debug;
2567 # FS::Cursor does not seem to work over multiple commits (gives cursor not found errors)
2568 # loading only record ids, then loading individual records one at a time
2569 my $tclass = 'FS::'.$table;
2573 while (my $recnum = _token_check_next_recnum($dbh,$table,$step,\$offset,\@recnums)) {
2574 my $record = $tclass->by_key($recnum);
2575 unless ($record->payby eq 'CARD') {
2576 warn "Skipping non-card record for $table ".$record->get($record->primary_key) if $debug;
2579 if (FS::cust_main::Billing_Realtime->tokenized($record->payinfo)) {
2580 warn "Skipping tokenized record for $table ".$record->get($record->primary_key) if $debug;
2583 if (!$record->payinfo) { #shouldn't happen, but at least it's not a card number
2584 warn "Skipping blank payinfo for $table ".$record->get($record->primary_key) if $debug;
2587 if ($record->payinfo =~ /N\/A/) { # ??? Not sure why we do this, but it's not a card number
2588 warn "Skipping NA payinfo for $table ".$record->get($record->primary_key) if $debug;
2592 if ($require_tokenized && $opt{'daily'}) {
2593 $log->info("Untokenized card number detected in $table ".$record->get($record->primary_key). ';tokenizing');
2594 $dbh->commit or die $dbh->errstr; # commit log message
2597 my $cust_main = $record->cust_main;
2599 # might happen for cust_pay_pending from failed verify records,
2600 # in which case we attempt tokenization without cust_main
2601 # everything else should absolutely have a cust_main
2602 if ($table eq 'cust_pay_pending' and !$record->custnum ) {
2603 # override the usual safety check and allow the record to be
2604 # updated even without a custnum.
2605 $record->set('custnum_pending', 1);
2607 my $error = "Could not load cust_main for $table ".$record->get($record->primary_key);
2608 if ($opt{'queue'}) {
2610 $log->critical($error);
2611 $dbh->commit or die $dbh->errstr; # commit log message
2614 $dbh->rollback if $oldAutoCommit;
2621 # use the gatewaynum specified by the record if possible
2622 $gateway = FS::payment_gateway->by_key_with_namespace(
2623 'gatewaynum' => $record->gatewaynum,
2624 ) if $record->gateway;
2626 # otherwise use the cust agent gateway if possible (which realtime_refund_bop would do)
2627 # otherwise just use default gateway
2630 $gateway = $cust_main
2631 ? $cust_main->agent->payment_gateway
2632 : FS::payment_gateway->default_gateway;
2634 # check for processor mismatch
2635 unless ($table eq 'cust_pay_pending') { # has no processor table
2636 if (my $processor = $record->processor) {
2638 my $conf_processor = $gateway->gateway_module;
2639 my %bop_options = $gateway->gatewaynum
2641 : @{ $gateway->get('options') };
2643 # this is the same standard used by realtime_refund_bop
2645 ($processor eq $conf_processor) ||
2646 (($conf_processor eq 'CardFortress') && ($processor eq $bop_options{'gateway'}))
2649 # processors don't match, so refund already cannot be run on this object,
2650 # regardless of what we do now...
2651 # but unless we gotta tokenize everything, just leave well enough alone
2652 unless ($require_tokenized) {
2653 warn "Skipping mismatched processor for $table ".$record->get($record->primary_key) if $debug;
2656 ### no error--we'll tokenize using the new gateway, just to remove stored payinfo,
2657 ### because refunds are already impossible for this record, anyway
2659 } # end processor mismatch
2661 } # end record has processor
2662 } # end not cust_pay_pending
2666 # means no default gateway, no promise to tokenize, can skip
2668 warn "Skipping missing gateway for $table ".$record->get($record->primary_key) if $debug;
2672 my $info = _token_check_gateway_info($cache,$gateway);
2673 unless (ref($info)) {
2674 # only throws error if Business::OnlinePayment won't load,
2675 # which is just cause to abort this whole process, even if queue
2676 $dbh->rollback if $oldAutoCommit;
2677 die $info; # error message
2680 # a configured gateway can't tokenize, move along
2681 unless ($info->{'can_tokenize'}) {
2682 warn "Skipping, cannot tokenize $table ".$record->get($record->primary_key) if $debug;
2686 warn "ATTEMPTING GATEWAY-ONLY TOKENIZE" if $debug && !$cust_main;
2688 # if we got this far, time to mutex
2689 $record->select_for_update;
2691 # no clear record of name/address/etc used for transaction,
2692 # but will load name/phone/id from customer if run as an object method,
2693 # so we try that if we can
2695 'payment_gateway' => $gateway,
2697 'payinfo' => $record->payinfo,
2698 'paydate' => $record->paydate,
2700 my $error = $cust_main
2701 ? $cust_main->realtime_tokenize(\%tokenopts)
2702 : FS::cust_main::Billing_Realtime->realtime_tokenize(\%tokenopts);
2703 if (FS::cust_main::Billing_Realtime->tokenized($tokenopts{'payinfo'})) { # implies no error
2704 $record->payinfo($tokenopts{'payinfo'});
2705 $error = $record->replace;
2707 $error ||= 'Unknown error';
2710 $error = "Error tokenizing $table ".$record->get($record->primary_key).": ".$error;
2711 if ($opt{'queue'}) {
2713 $log->critical($error);
2714 $dbh->commit or die $dbh->errstr; # commit log message, release mutex
2717 $dbh->rollback if $oldAutoCommit;
2720 $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
2721 warn "TOKENIZED $table ".$record->get($record->primary_key) if $debug;
2726 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2728 return $hascritical ? 'Critical errors occurred on some records, see system log' : '';
2732 sub _token_check_next_recnum {
2733 my ($dbh,$table,$step,$offset,$recnums) = @_;
2734 my $recnum = shift @$recnums;
2735 return $recnum if $recnum;
2736 my $tclass = 'FS::'.$table;
2737 my $sth = $dbh->prepare(
2738 'SELECT '.$tclass->primary_key.
2740 " WHERE ( is_tokenized IS NULL OR is_tokenized = '' ) ".
2741 ' ORDER BY '.$tclass->primary_key.
2744 ) or die $dbh->errstr;
2745 $sth->execute() or die $sth->errstr;
2747 while (my $rec = $sth->fetchrow_hashref) {
2748 push @$recnums, $rec->{$tclass->primary_key};
2752 return shift @$recnums;
2756 sub _token_check_gateway_info {
2757 my ($cache,$payment_gateway) = @_;
2759 return $cache->{$payment_gateway->gateway_module}
2760 if $cache->{$payment_gateway->gateway_module};
2763 $cache->{$payment_gateway->gateway_module} = $info;
2765 my $namespace = $payment_gateway->gateway_namespace;
2766 return $info unless $namespace eq 'Business::OnlinePayment';
2767 $info->{'is_bop'} = 1;
2769 # only need to load this once,
2770 # don't want to load if nothing is_bop
2771 unless ($cache->{'Business::OnlinePayment'}) {
2772 eval "use $namespace";
2773 return "Error initializing Business:OnlinePayment: ".$@ if $@;
2774 $cache->{'Business::OnlinePayment'} = 1;
2777 my $transaction = new $namespace( $payment_gateway->gateway_module,
2778 _bop_options({ 'payment_gateway' => $payment_gateway }),
2781 return $info unless $transaction->can('info');
2782 $info->{'can_info'} = 1;
2784 my %supported_actions = $transaction->info('supported_actions');
2785 $info->{'can_tokenize'} = 1
2786 if $supported_actions{'CC'}
2787 && grep /^Tokenize$/, @{$supported_actions{'CC'}};
2789 # not using this any more, but for future reference...
2790 $info->{'void_requires_card'} = 1
2791 if $transaction->info('CC_void_requires_card');
2802 L<FS::cust_main>, L<FS::cust_main::Billing>