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 FS::UID qw( dbh myconnect );
10 use FS::Record qw( qsearch qsearchs );
13 use FS::cust_pay_pending;
14 use FS::cust_bill_pay;
18 $realtime_bop_decline_quiet = 0;
20 # 1 is mostly method/subroutine entry and options
21 # 2 traces progress of some operations
22 # 3 is even more information including possibly sensitive data
24 $me = '[FS::cust_main::Billing_Realtime]';
27 our $BOP_TESTING_SUCCESS = 1;
29 install_callback FS::UID sub {
31 #yes, need it for stuff below (prolly should be cached)
36 FS::cust_main::Billing_Realtime - Realtime billing mixin for cust_main
42 These methods are available on FS::cust_main objects.
48 =item realtime_cust_payby
52 sub realtime_cust_payby {
53 my( $self, %options ) = @_;
55 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
57 $options{amount} = $self->balance unless exists( $options{amount} );
59 my @cust_payby = $self->cust_payby('CARD','CHEK');
62 foreach my $cust_payby (@cust_payby) {
63 $error = $cust_payby->realtime_bop( %options, );
67 #XXX what about the earlier errors?
73 =item realtime_collect [ OPTION => VALUE ... ]
75 Attempt to collect the customer's current balance with a realtime credit
76 card or electronic check transaction (see realtime_bop() below).
78 Returns the result of realtime_bop(): nothing, an error message, or a
79 hashref of state information for a third-party transaction.
81 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
83 I<method> is one of: I<CC> or I<ECHECK>. If none is specified
84 then it is deduced from the customer record.
86 If no I<amount> is specified, then the customer balance is used.
88 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
89 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
90 if set, will override the value from the customer record.
92 I<description> is a free-text field passed to the gateway. It defaults to
93 the value defined by the business-onlinepayment-description configuration
94 option, or "Internet services" if that is unset.
96 If an I<invnum> is specified, this payment (if successful) is applied to the
99 I<apply> will automatically apply a resulting payment.
101 I<quiet> can be set true to suppress email decline notices.
103 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
104 resulting paynum, if any.
106 I<payunique> is a unique identifier for this payment.
108 I<session_id> is a session identifier associated with this payment.
110 I<depend_jobnum> allows payment capture to unlock export jobs
114 # Currently only used by ClientAPI
115 # NOT 4.x COMPATIBLE (see below)
116 sub realtime_collect {
117 my( $self, %options ) = @_;
119 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
122 warn "$me realtime_collect:\n";
123 warn " $_ => $options{$_}\n" foreach keys %options;
126 $options{amount} = $self->balance unless exists( $options{amount} );
127 return '' unless $options{amount} > 0;
129 #### NOT 4.x COMPATIBLE
130 $options{method} = FS::payby->payby2bop($self->payby)
131 unless exists( $options{method} );
133 return $self->realtime_bop({%options});
137 =item realtime_bop { [ ARG => VALUE ... ] }
139 Runs a realtime credit card or ACH (electronic check) transaction
140 via a Business::OnlinePayment realtime gateway. See
141 L<http://420.am/business-onlinepayment> for supported gateways.
143 Required arguments in the hashref are I<amount> and either
144 I<cust_payby> or I<method>, I<payinfo> and (as applicable for method)
145 I<payname>, I<address1>, I<address2>, I<city>, I<state>, I<zip> and I<paydate>.
147 Available methods are: I<CC>, I<ECHECK>, or I<PAYPAL>
149 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
151 I<description> is a free-text field passed to the gateway. It defaults to
152 the value defined by the business-onlinepayment-description configuration
153 option, or "Internet services" if that is unset.
155 If an I<invnum> is specified, this payment (if successful) is applied to the
156 specified invoice. If the customer has exactly one open invoice, that
157 invoice number will be assumed. If you don't specify an I<invnum> you might
158 want to call the B<apply_payments> method or set the I<apply> option.
160 I<no_invnum> can be set to true to prevent that default invnum from being set.
162 I<apply> can be set to true to run B<apply_payments_and_credits> on success.
164 I<no_auto_apply> can be set to true to set that flag on the resulting payment
165 (prevents payment from being applied by B<apply_payments> or B<apply_payments_and_credits>,
166 but will still be applied if I<invnum> exists...use with I<no_invnum> for intended effect.)
168 I<quiet> can be set true to surpress email decline notices.
170 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
171 resulting paynum, if any.
173 I<payunique> is a unique identifier for this payment.
175 I<session_id> is a session identifier associated with this payment.
177 I<depend_jobnum> allows payment capture to unlock export jobs
179 I<discount_term> attempts to take a discount by prepaying for discount_term.
180 The payment will fail if I<amount> is incorrect for this discount term.
182 A direct (Business::OnlinePayment) transaction will return nothing on success,
183 or an error message on failure.
185 A third-party transaction will return a hashref containing:
187 - popup_url: the URL to which a browser should be redirected to complete
189 - collectitems: an arrayref of name-value pairs to be posted to popup_url.
190 - reference: a reference ID for the transaction, to show the customer.
192 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
196 # some helper routines
198 # _bop_recurring_billing: Checks whether this payment should have the
199 # recurring_billing flag used by some B:OP interfaces (IPPay, PlugnPay,
200 # vSecure, etc.). This works in two different modes:
201 # - actual_oncard (default): treat the payment as recurring if the customer
202 # has made a payment using this card before.
203 # - transaction_is_recur: treat the payment as recurring if the invoice
204 # being paid has any recurring package charges.
206 sub _bop_recurring_billing {
207 my( $self, %opt ) = @_;
209 my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
211 if ( defined($method) && $method eq 'transaction_is_recur' ) {
213 return 1 if $opt{'trans_is_recur'};
217 # return 1 if the payinfo has been used for another payment
218 return $self->payinfo_used($opt{'payinfo'}); # in payinfo_Mixin
226 sub _payment_gateway {
227 my ($self, $options) = @_;
229 if ( $options->{'fake_gatewaynum'} ) {
230 $options->{payment_gateway} =
231 qsearchs('payment_gateway',
232 { 'gatewaynum' => $options->{'fake_gatewaynum'}, }
236 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
237 unless exists($options->{payment_gateway});
239 $options->{payment_gateway};
243 my ($self, $options) = @_;
246 'login' => $options->{payment_gateway}->gateway_username,
247 'password' => $options->{payment_gateway}->gateway_password,
252 my ($self, $options) = @_;
254 $options->{payment_gateway}->gatewaynum
255 ? $options->{payment_gateway}->options
256 : @{ $options->{payment_gateway}->get('options') };
261 my ($self, $options) = @_;
263 unless ( $options->{'description'} ) {
264 if ( $conf->exists('business-onlinepayment-description') ) {
265 my $dtempl = $conf->config('business-onlinepayment-description');
267 my $agent = $self->agent->agent;
269 $options->{'description'} = eval qq("$dtempl");
271 $options->{'description'} = 'Internet services';
275 # Default invoice number if the customer has exactly one open invoice.
276 unless ( $options->{'invnum'} || $options->{'no_invnum'} ) {
277 $options->{'invnum'} = '';
278 my @open = $self->open_cust_bill;
279 $options->{'invnum'} = $open[0]->invnum if scalar(@open) == 1;
284 sub _bop_cust_payby_options {
285 my ($self,$options) = @_;
286 my $cust_payby = $options->{'cust_payby'};
289 $options->{'method'} = FS::payby->payby2bop( $cust_payby->payby );
291 if ($cust_payby->payby =~ /^(CARD|DCRD)$/) {
292 # false laziness with cust_payby->check
293 # which might not have been run yet
295 if ( $cust_payby->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
296 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
297 } elsif ( $cust_payby->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
298 ( $m, $y ) = ( $2, "19$1" );
299 } elsif ( $cust_payby->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
300 ( $m, $y ) = ( $3, "20$2" );
302 return "Illegal expiration date: ". $cust_payby->paydate;
304 $m = sprintf('%02d',$m);
305 $options->{paydate} = "$y-$m-01";
307 $options->{paydate} = '';
310 $options->{$_} = $cust_payby->$_()
311 for qw( payinfo paycvv paymask paystart_month paystart_year
312 payissue payname paystate paytype payip );
314 if ( $cust_payby->locationnum ) {
315 my $cust_location = $cust_payby->cust_location;
316 $options->{$_} = $cust_location->$_() for qw( address1 address2 city state zip );
322 my ($self, $options) = @_;
325 my $payip = $options->{'payip'};
326 $content{customer_ip} = $payip if length($payip);
328 $content{invoice_number} = $options->{'invnum'}
329 if exists($options->{'invnum'}) && length($options->{'invnum'});
331 $content{email_customer} =
332 ( $conf->exists('business-onlinepayment-email_customer')
333 || $conf->exists('business-onlinepayment-email-override') );
335 my ($payname, $payfirst, $paylast);
336 if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
337 ($payname = $options->{payname}) =~
338 /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
339 or return "Illegal payname $payname";
340 ($payfirst, $paylast) = ($1, $2);
342 $payfirst = $self->getfield('first');
343 $paylast = $self->getfield('last');
344 $payname = "$payfirst $paylast";
347 $content{last_name} = $paylast;
348 $content{first_name} = $payfirst;
350 $content{name} = $payname;
352 $content{address} = $options->{'address1'};
353 my $address2 = $options->{'address2'};
354 $content{address} .= ", ". $address2 if length($address2);
356 $content{city} = $options->{'city'};
357 $content{state} = $options->{'state'};
358 $content{zip} = $options->{'zip'};
359 $content{country} = $options->{'country'};
361 $content{phone} = $self->daytime || $self->night;
363 my $currency = $conf->exists('business-onlinepayment-currency')
364 && $conf->config('business-onlinepayment-currency');
365 $content{currency} = $currency if $currency;
370 # updates payinfo and cust_payby options with token from transaction
372 my ($self,$transaction,$options) = @_;
373 if ( $transaction->can('card_token')
374 and $transaction->card_token
375 and !$self->tokenized($options->{'payinfo'})
377 $options->{'payinfo'} = $transaction->card_token;
378 $options->{'cust_payby'}->payinfo($transaction->card_token) if $options->{'cust_payby'};
379 return $transaction->card_token;
384 my %bop_method2payby = (
393 confess "Can't call realtime_bop within another transaction ".
394 '($FS::UID::AutoCommit is false)'
395 unless $FS::UID::AutoCommit;
397 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
399 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_bop');
402 if (ref($_[0]) eq 'HASH') {
405 my ( $method, $amount ) = ( shift, shift );
407 $options{method} = $method;
408 $options{amount} = $amount;
411 # set fields from passed cust_payby
412 $self->_bop_cust_payby_options(\%options);
414 # possibly run a separate transaction to tokenize card number,
415 # so that we never store tokenized card info in cust_pay_pending
416 if (!$self->tokenized($options{'payinfo'})) {
417 my $token_error = $self->realtime_tokenize(\%options);
418 return $token_error if $token_error;
419 # in theory, all cust_payby will be tokenized during original save,
420 # so we shouldn't get here with opt cust_payby...but just in case...
421 if ($options{'cust_payby'}) {
422 $token_error = $options{'cust_payby'}->replace;
423 return $token_error if $token_error;
428 # optional credit card surcharge
431 my $cc_surcharge = 0;
432 my $cc_surcharge_pct = 0;
433 $cc_surcharge_pct = $conf->config('credit-card-surcharge-percentage', $self->agentnum)
434 if $conf->config('credit-card-surcharge-percentage', $self->agentnum)
435 && $options{method} eq 'CC';
437 # always add cc surcharge if called from event
438 if($options{'cc_surcharge_from_event'} && $cc_surcharge_pct > 0) {
439 $cc_surcharge = $options{'amount'} * $cc_surcharge_pct / 100;
440 $options{'amount'} += $cc_surcharge;
441 $options{'amount'} = sprintf("%.2f", $options{'amount'}); # round (again)?
443 elsif($cc_surcharge_pct > 0) { # we're called not from event (i.e. from a
444 # payment screen), so consider the given
445 # amount as post-surcharge
446 $cc_surcharge = $options{'amount'} - ($options{'amount'} / ( 1 + $cc_surcharge_pct/100 ));
449 $cc_surcharge = sprintf("%.2f",$cc_surcharge) if $cc_surcharge > 0;
450 $options{'cc_surcharge'} = $cc_surcharge;
454 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
455 warn " cc_surcharge = $cc_surcharge\n";
458 warn " $_ => $options{$_}\n" foreach keys %options;
461 return $self->fake_bop(\%options) if $options{'fake'};
463 $self->_bop_defaults(\%options);
465 return "Missing payinfo"
466 unless $options{'payinfo'};
469 # set trans_is_recur based on invnum if there is one
472 my $trans_is_recur = 0;
473 if ( $options{'invnum'} ) {
475 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
476 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
482 $cust_bill->cust_bill_pkg;
485 if grep { $_->freq ne '0' } @part_pkg;
493 my $payment_gateway = $self->_payment_gateway( \%options );
494 my $namespace = $payment_gateway->gateway_namespace;
496 eval "use $namespace";
500 # check for banned credit card/ACH
503 my $ban = FS::banned_pay->ban_search(
504 'payby' => $bop_method2payby{$options{method}},
505 'payinfo' => $options{payinfo},
507 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
510 # check for term discount validity
513 my $discount_term = $options{discount_term};
514 if ( $discount_term ) {
515 my $bill = ($self->cust_bill)[-1]
516 or return "Can't apply a term discount to an unbilled customer";
517 my $plan = FS::discount_plan->new(
519 months => $discount_term
520 ) or return "No discount available for term '$discount_term'";
522 if ( $plan->discounted_total != $options{amount} ) {
523 return "Incorrect term prepayment amount (term $discount_term, amount $options{amount}, requires ".$plan->discounted_total.")";
531 my $bop_content = $self->_bop_content(\%options);
532 return $bop_content unless ref($bop_content);
534 my @invoicing_list = $self->invoicing_list_emailonly;
535 if ( $conf->exists('emailinvoiceautoalways')
536 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
537 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
538 push @invoicing_list, $self->all_emails;
541 my $email = ($conf->exists('business-onlinepayment-email-override'))
542 ? $conf->config('business-onlinepayment-email-override')
543 : $invoicing_list[0];
548 if ( $namespace eq 'Business::OnlinePayment' ) {
550 if ( $options{method} eq 'CC' ) {
552 $content{card_number} = $options{payinfo};
553 $paydate = $options{'paydate'};
554 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
555 $content{expiration} = "$2/$1";
557 $content{cvv2} = $options{'paycvv'}
558 if length($options{'paycvv'});
560 my $paystart_month = $options{'paystart_month'};
561 my $paystart_year = $options{'paystart_year'};
562 $content{card_start} = "$paystart_month/$paystart_year"
563 if $paystart_month && $paystart_year;
565 my $payissue = $options{'payissue'};
566 $content{issue_number} = $payissue if $payissue;
568 if ( $self->_bop_recurring_billing(
569 'payinfo' => $options{'payinfo'},
570 'trans_is_recur' => $trans_is_recur,
574 $content{recurring_billing} = 'YES';
575 $content{acct_code} = 'rebill'
576 if $conf->exists('credit_card-recurring_billing_acct_code');
579 } elsif ( $options{method} eq 'ECHECK' ){
581 ( $content{account_number}, $content{routing_code} ) =
582 split('@', $options{payinfo});
583 $content{bank_name} = $options{payname};
584 $content{bank_state} = $options{'paystate'};
585 $content{account_type}= uc($options{'paytype'}) || 'PERSONAL CHECKING';
587 $content{company} = $self->company if $self->company;
589 if ( $content{account_type} =~ /BUSINESS/i && $self->company ) {
590 $content{account_name} = $self->company;
592 $content{account_name} = $self->getfield('first'). ' '.
593 $self->getfield('last');
596 $content{customer_org} = $self->company ? 'B' : 'I';
597 $content{state_id} = exists($options{'stateid'})
598 ? $options{'stateid'}
599 : $self->getfield('stateid');
600 $content{state_id_state} = exists($options{'stateid_state'})
601 ? $options{'stateid_state'}
602 : $self->getfield('stateid_state');
603 $content{customer_ssn} = exists($options{'ss'})
608 die "unknown method ". $options{method};
611 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
614 die "unknown namespace $namespace";
621 my $balance = exists( $options{'balance'} )
622 ? $options{'balance'}
625 warn "claiming mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
626 $self->select_for_update; #mutex ... just until we get our pending record in
627 warn "obtained mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
629 #the checks here are intended to catch concurrent payments
630 #double-form-submission prevention is taken care of in cust_pay_pending::check
633 return "The customer's balance has changed; $options{method} transaction aborted."
634 if $self->balance < $balance;
636 #also check and make sure there aren't *other* pending payments for this cust
638 my @pending = qsearch('cust_pay_pending', {
639 'custnum' => $self->custnum,
640 'status' => { op=>'!=', value=>'done' }
643 #for third-party payments only, remove pending payments if they're in the
644 #'thirdparty' (waiting for customer action) state.
645 if ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
646 foreach ( grep { $_->status eq 'thirdparty' } @pending ) {
647 my $error = $_->delete;
648 warn "error deleting unfinished third-party payment ".
649 $_->paypendingnum . ": $error\n"
652 @pending = grep { $_->status ne 'thirdparty' } @pending;
655 return "A payment is already being processed for this customer (".
656 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
657 "); $options{method} transaction aborted."
660 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
662 my $cust_pay_pending = new FS::cust_pay_pending {
663 'custnum' => $self->custnum,
664 'paid' => $options{amount},
666 'payby' => $bop_method2payby{$options{method}},
667 'payinfo' => $options{payinfo},
668 'paymask' => $options{paymask},
669 'paydate' => $paydate,
670 'recurring_billing' => $content{recurring_billing},
671 'pkgnum' => $options{'pkgnum'},
673 'gatewaynum' => $payment_gateway->gatewaynum || '',
674 'session_id' => $options{session_id} || '',
675 'jobnum' => $options{depend_jobnum} || '',
677 $cust_pay_pending->payunique( $options{payunique} )
678 if defined($options{payunique}) && length($options{payunique});
680 warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
682 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
683 return $cpp_new_err if $cpp_new_err;
685 warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
687 warn Dumper($cust_pay_pending) if $DEBUG > 2;
689 my( $action1, $action2 ) =
690 split( /\s*\,\s*/, $payment_gateway->gateway_action );
692 my $transaction = new $namespace( $payment_gateway->gateway_module,
693 $self->_bop_options(\%options),
696 $transaction->content(
697 'type' => $options{method},
698 $self->_bop_auth(\%options),
699 'action' => $action1,
700 'description' => $options{'description'},
701 'amount' => $options{amount},
702 #'invoice_number' => $options{'invnum'},
703 'customer_id' => $self->custnum,
705 'reference' => $cust_pay_pending->paypendingnum, #for now
706 'callback_url' => $payment_gateway->gateway_callback_url,
707 'cancel_url' => $payment_gateway->gateway_cancel_url,
712 $cust_pay_pending->status('pending');
713 my $cpp_pending_err = $cust_pay_pending->replace;
714 return $cpp_pending_err if $cpp_pending_err;
716 warn Dumper($transaction) if $DEBUG > 2;
718 unless ( $BOP_TESTING ) {
719 $transaction->test_transaction(1)
720 if $conf->exists('business-onlinepayment-test_transaction');
721 $transaction->submit();
723 if ( $BOP_TESTING_SUCCESS ) {
724 $transaction->is_success(1);
725 $transaction->authorization('fake auth');
727 $transaction->is_success(0);
728 $transaction->error_message('fake failure');
732 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
734 $cust_pay_pending->status('thirdparty');
735 my $cpp_err = $cust_pay_pending->replace;
736 return { error => $cpp_err } if $cpp_err;
737 return { reference => $cust_pay_pending->paypendingnum,
738 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
740 } elsif ( $transaction->is_success() && $action2 ) {
742 $cust_pay_pending->status('authorized');
743 my $cpp_authorized_err = $cust_pay_pending->replace;
744 return $cpp_authorized_err if $cpp_authorized_err;
746 my $auth = $transaction->authorization;
747 my $ordernum = $transaction->can('order_number')
748 ? $transaction->order_number
752 new Business::OnlinePayment( $payment_gateway->gateway_module,
753 $self->_bop_options(\%options),
758 type => $options{method},
760 $self->_bop_auth(\%options),
761 order_number => $ordernum,
762 amount => $options{amount},
763 authorization => $auth,
764 description => $options{'description'},
767 foreach my $field (qw( authorization_source_code returned_ACI
768 transaction_identifier validation_code
769 transaction_sequence_num local_transaction_date
770 local_transaction_time AVS_result_code )) {
771 $capture{$field} = $transaction->$field() if $transaction->can($field);
774 $capture->content( %capture );
776 $capture->test_transaction(1)
777 if $conf->exists('business-onlinepayment-test_transaction');
780 unless ( $capture->is_success ) {
781 my $e = "Authorization successful but capture failed, custnum #".
782 $self->custnum. ': '. $capture->result_code.
783 ": ". $capture->error_message;
791 # remove paycvv after initial transaction
794 # compare to FS::cust_main::save_cust_payby - check both to make sure working correctly
795 if ( length($options{'paycvv'})
796 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
798 my $error = $self->remove_cvv_from_cust_payby($options{payinfo});
800 $log->critical('Error removing cvv for cust '.$self->custnum.': '.$error);
801 #not returning error, should at least attempt to handle results of an otherwise valid transaction
802 warn "WARNING: error removing cvv: $error\n";
810 # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
811 # if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
812 if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
813 # cpp will be replaced in _realtime_bop_result
814 $cust_pay_pending->payinfo($card_token);
815 if ($options{'cust_payby'} and my $error = $options{'cust_payby'}->replace) {
816 $log->critical('Error storing token for cust '.$self->custnum.', cust_payby '.$options{'cust_payby'}->custpaybynum.': '.$error);
817 #not returning error, should at least attempt to handle results of an otherwise valid transaction
818 #this leaves real card number in cust_payby, but can't do much else if cust_payby won't replace
826 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
838 if (ref($_[0]) eq 'HASH') {
841 my ( $method, $amount ) = ( shift, shift );
843 $options{method} = $method;
844 $options{amount} = $amount;
847 if ( $options{'fake_failure'} ) {
848 return "Error: No error; test failure requested with fake_failure";
851 my $cust_pay = new FS::cust_pay ( {
852 'custnum' => $self->custnum,
853 'invnum' => $options{'invnum'},
854 'paid' => $options{amount},
856 'payby' => $bop_method2payby{$options{method}},
857 'payinfo' => '4111111111111111',
858 'paydate' => '2012-05-01',
859 'processor' => 'FakeProcessor',
861 'order_number' => '32',
863 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
866 warn "fake_bop\n cust_pay: ". Dumper($cust_pay) . "\n options: ";
867 warn " $_ => $options{$_}\n" foreach keys %options;
870 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
873 $cust_pay->invnum(''); #try again with no specific invnum
874 my $error2 = $cust_pay->insert( $options{'manual'} ?
875 ( 'manual' => 1 ) : ()
878 # gah, even with transactions.
879 my $e = 'WARNING: Card/ACH debited but database not updated - '.
880 "error inserting (fake!) payment: $error2".
881 " (previously tried insert with invnum #$options{'invnum'}" .
888 if ( $options{'paynum_ref'} ) {
889 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
897 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
899 # Wraps up processing of a realtime credit card or ACH (electronic check)
902 sub _realtime_bop_result {
903 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
905 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
908 warn "$me _realtime_bop_result: pending transaction ".
909 $cust_pay_pending->paypendingnum. "\n";
910 warn " $_ => $options{$_}\n" foreach keys %options;
913 my $payment_gateway = $options{payment_gateway}
914 or return "no payment gateway in arguments to _realtime_bop_result";
916 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
917 my $cpp_captured_err = $cust_pay_pending->replace; #also saves post-transaction tokenization, if that happens
918 return $cpp_captured_err if $cpp_captured_err;
920 if ( $transaction->is_success() ) {
922 my $order_number = $transaction->order_number
923 if $transaction->can('order_number');
925 my $cust_pay = new FS::cust_pay ( {
926 'custnum' => $self->custnum,
927 'invnum' => $options{'invnum'},
928 'paid' => $cust_pay_pending->paid,
930 'payby' => $cust_pay_pending->payby,
931 'payinfo' => $options{'payinfo'},
932 'paymask' => $options{'paymask'} || $cust_pay_pending->paymask,
933 'paydate' => $cust_pay_pending->paydate,
934 'pkgnum' => $cust_pay_pending->pkgnum,
935 'discount_term' => $options{'discount_term'},
936 'gatewaynum' => ($payment_gateway->gatewaynum || ''),
937 'processor' => $payment_gateway->gateway_module,
938 'auth' => $transaction->authorization,
939 'order_number' => $order_number || '',
940 'no_auto_apply' => $options{'no_auto_apply'} ? 'Y' : '',
942 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
943 $cust_pay->payunique( $options{payunique} )
944 if defined($options{payunique}) && length($options{payunique});
946 my $oldAutoCommit = $FS::UID::AutoCommit;
947 local $FS::UID::AutoCommit = 0;
950 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
952 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
955 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
956 $cust_pay->invnum(''); #try again with no specific invnum
957 $cust_pay->paynum('');
958 my $error2 = $cust_pay->insert( $options{'manual'} ?
959 ( 'manual' => 1 ) : ()
962 # gah. but at least we have a record of the state we had to abort in
963 # from cust_pay_pending now.
964 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
965 my $e = "WARNING: $options{method} captured but payment not recorded -".
966 " error inserting payment (". $payment_gateway->gateway_module.
968 " (previously tried insert with invnum #$options{'invnum'}" .
969 ": $error ) - pending payment saved as paypendingnum ".
970 $cust_pay_pending->paypendingnum. "\n";
976 my $jobnum = $cust_pay_pending->jobnum;
978 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
980 unless ( $placeholder ) {
981 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
982 my $e = "WARNING: $options{method} captured but job $jobnum not ".
983 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
988 $error = $placeholder->delete;
991 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
992 my $e = "WARNING: $options{method} captured but could not delete ".
993 "job $jobnum for paypendingnum ".
994 $cust_pay_pending->paypendingnum. ": $error\n";
999 $cust_pay_pending->set('jobnum','');
1003 if ( $options{'paynum_ref'} ) {
1004 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
1007 $cust_pay_pending->status('done');
1008 $cust_pay_pending->statustext('captured');
1009 $cust_pay_pending->paynum($cust_pay->paynum);
1010 my $cpp_done_err = $cust_pay_pending->replace;
1012 if ( $cpp_done_err ) {
1014 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1015 my $e = "WARNING: $options{method} captured but payment not recorded - ".
1016 "error updating status for paypendingnum ".
1017 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1023 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1025 if ( $options{'apply'} ) {
1026 my $apply_error = $self->apply_payments_and_credits;
1027 if ( $apply_error ) {
1028 warn "WARNING: error applying payment: $apply_error\n";
1029 #but we still should return no error cause the payment otherwise went
1034 # have a CC surcharge portion --> one-time charge
1035 if ( $options{'cc_surcharge'} > 0 ) {
1036 # XXX: this whole block needs to be in a transaction?
1039 $invnum = $options{'invnum'} if $options{'invnum'};
1040 unless ( $invnum ) { # probably from a payment screen
1041 # do we have any open invoices? pick earliest
1042 # uses the fact that cust_main->cust_bill sorts by date ascending
1043 my @open = $self->open_cust_bill;
1044 $invnum = $open[0]->invnum if scalar(@open);
1047 unless ( $invnum ) { # still nothing? pick last closed invoice
1048 # again uses fact that cust_main->cust_bill sorts by date ascending
1049 my @closed = $self->cust_bill;
1050 $invnum = $closed[$#closed]->invnum if scalar(@closed);
1053 unless ( $invnum ) {
1054 # XXX: unlikely case - pre-paying before any invoices generated
1055 # what it should do is create a new invoice and pick it
1056 warn 'CC SURCHARGE AND NO INVOICES PICKED TO APPLY IT!';
1061 my $charge_error = $self->charge({
1062 'amount' => $options{'cc_surcharge'},
1063 'pkg' => 'Credit Card Surcharge',
1065 'cust_pkg_ref' => \$cust_pkg,
1068 warn 'Unable to add CC surcharge cust_pkg';
1072 $cust_pkg->setup(time);
1073 my $cp_error = $cust_pkg->replace;
1075 warn 'Unable to set setup time on cust_pkg for cc surcharge';
1079 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1080 unless ( $cust_bill ) {
1081 warn "race condition + invoice deletion just happened";
1086 $cust_bill->add_cc_surcharge($cust_pkg->pkgnum,$options{'cc_surcharge'});
1088 warn "cannot add CC surcharge to invoice #$invnum: $grand_error"
1092 return ''; #no error
1098 my $perror = $transaction->error_message;
1099 #$payment_gateway->gateway_module. " error: ".
1100 # removed for conciseness
1102 my $jobnum = $cust_pay_pending->jobnum;
1104 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1106 if ( $placeholder ) {
1107 my $error = $placeholder->depended_delete;
1108 $error ||= $placeholder->delete;
1109 $cust_pay_pending->set('jobnum','');
1110 warn "error removing provisioning jobs after declined paypendingnum ".
1111 $cust_pay_pending->paypendingnum. ": $error\n" if $error;
1113 my $e = "error finding job $jobnum for declined paypendingnum ".
1114 $cust_pay_pending->paypendingnum. "\n";
1120 unless ( $transaction->error_message ) {
1123 if ( $transaction->can('response_page') ) {
1125 'page' => ( $transaction->can('response_page')
1126 ? $transaction->response_page
1129 'code' => ( $transaction->can('response_code')
1130 ? $transaction->response_code
1133 'headers' => ( $transaction->can('response_headers')
1134 ? $transaction->response_headers
1140 "No additional debugging information available for ".
1141 $payment_gateway->gateway_module;
1144 $perror .= "No error_message returned from ".
1145 $payment_gateway->gateway_module. " -- ".
1146 ( ref($t_response) ? Dumper($t_response) : $t_response );
1150 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
1151 && $conf->exists('emaildecline', $self->agentnum)
1152 && grep { $_ ne 'POST' } $self->invoicing_list
1153 && ! grep { $transaction->error_message =~ /$_/ }
1154 $conf->config('emaildecline-exclude', $self->agentnum)
1157 # Send a decline alert to the customer.
1158 my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
1161 # include the raw error message in the transaction state
1162 $cust_pay_pending->setfield('error', $transaction->error_message);
1163 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1164 $error = $msg_template->send( 'cust_main' => $self,
1165 'object' => $cust_pay_pending );
1169 $perror .= " (also received error sending decline notification: $error)"
1174 $cust_pay_pending->status('done');
1175 $cust_pay_pending->statustext($perror);
1176 #'declined:': no, that's failure_status
1177 if ( $transaction->can('failure_status') ) {
1178 $cust_pay_pending->failure_status( $transaction->failure_status );
1180 my $cpp_done_err = $cust_pay_pending->replace;
1181 if ( $cpp_done_err ) {
1182 my $e = "WARNING: $options{method} declined but pending payment not ".
1183 "resolved - error updating status for paypendingnum ".
1184 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1186 $perror = "$e ($perror)";
1194 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
1196 Verifies successful third party processing of a realtime credit card or
1197 ACH (electronic check) transaction via a
1198 Business::OnlineThirdPartyPayment realtime gateway. See
1199 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
1201 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
1203 The additional options I<payname>, I<city>, I<state>,
1204 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
1205 if set, will override the value from the customer record.
1207 I<description> is a free-text field passed to the gateway. It defaults to
1208 "Internet services".
1210 If an I<invnum> is specified, this payment (if successful) is applied to the
1211 specified invoice. If you don't specify an I<invnum> you might want to
1212 call the B<apply_payments> method.
1214 I<quiet> can be set true to surpress email decline notices.
1216 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
1217 resulting paynum, if any.
1219 I<payunique> is a unique identifier for this payment.
1221 Returns a hashref containing elements bill_error (which will be undefined
1222 upon success) and session_id of any associated session.
1226 sub realtime_botpp_capture {
1227 my( $self, $cust_pay_pending, %options ) = @_;
1229 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1232 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
1233 warn " $_ => $options{$_}\n" foreach keys %options;
1236 eval "use Business::OnlineThirdPartyPayment";
1240 # select the gateway
1243 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
1245 my $payment_gateway;
1246 my $gatewaynum = $cust_pay_pending->getfield('gatewaynum');
1247 $payment_gateway = $gatewaynum ? qsearchs( 'payment_gateway',
1248 { gatewaynum => $gatewaynum }
1250 : $self->agent->payment_gateway( 'method' => $method,
1251 # 'invnum' => $cust_pay_pending->invnum,
1252 # 'payinfo' => $cust_pay_pending->payinfo,
1255 $options{payment_gateway} = $payment_gateway; # for the helper subs
1261 my @invoicing_list = $self->invoicing_list_emailonly;
1262 if ( $conf->exists('emailinvoiceautoalways')
1263 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1264 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1265 push @invoicing_list, $self->all_emails;
1268 my $email = ($conf->exists('business-onlinepayment-email-override'))
1269 ? $conf->config('business-onlinepayment-email-override')
1270 : $invoicing_list[0];
1274 $content{email_customer} =
1275 ( $conf->exists('business-onlinepayment-email_customer')
1276 || $conf->exists('business-onlinepayment-email-override') );
1279 # run transaction(s)
1283 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
1284 $self->_bop_options(\%options),
1287 $transaction->reference({ %options });
1289 $transaction->content(
1291 $self->_bop_auth(\%options),
1292 'action' => 'Post Authorization',
1293 'description' => $options{'description'},
1294 'amount' => $cust_pay_pending->paid,
1295 #'invoice_number' => $options{'invnum'},
1296 'customer_id' => $self->custnum,
1297 'reference' => $cust_pay_pending->paypendingnum,
1299 'phone' => $self->daytime || $self->night,
1301 # plus whatever is required for bogus capture avoidance
1304 $transaction->submit();
1307 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
1309 if ( $options{'apply'} ) {
1310 my $apply_error = $self->apply_payments_and_credits;
1311 if ( $apply_error ) {
1312 warn "WARNING: error applying payment: $apply_error\n";
1317 bill_error => $error,
1318 session_id => $cust_pay_pending->session_id,
1323 =item default_payment_gateway
1325 DEPRECATED -- use agent->payment_gateway
1329 sub default_payment_gateway {
1330 my( $self, $method ) = @_;
1332 die "Real-time processing not enabled\n"
1333 unless $conf->exists('business-onlinepayment');
1335 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
1338 my $bop_config = 'business-onlinepayment';
1339 $bop_config .= '-ach'
1340 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
1341 my ( $processor, $login, $password, $action, @bop_options ) =
1342 $conf->config($bop_config);
1343 $action ||= 'normal authorization';
1344 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
1345 die "No real-time processor is enabled - ".
1346 "did you set the business-onlinepayment configuration value?\n"
1349 ( $processor, $login, $password, $action, @bop_options )
1352 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
1354 Refunds a realtime credit card or ACH (electronic check) transaction
1355 via a Business::OnlinePayment realtime gateway. See
1356 L<http://420.am/business-onlinepayment> for supported gateways.
1358 Available methods are: I<CC> or I<ECHECK>
1360 Available options are: I<amount>, I<reasonnum>, I<paynum>, I<paydate>
1362 Most gateways require a reference to an original payment transaction to refund,
1363 so you probably need to specify a I<paynum>.
1365 I<amount> defaults to the original amount of the payment if not specified.
1367 I<reasonnum> specified an existing refund reason for the refund
1369 I<paydate> specifies the expiration date for a credit card overriding the
1370 value from the customer record or the payment record. Specified as yyyy-mm-dd
1372 Implementation note: If I<amount> is unspecified or equal to the amount of the
1373 orignal payment, first an attempt is made to "void" the transaction via
1374 the gateway (to cancel a not-yet settled transaction) and then if that fails,
1375 the normal attempt is made to "refund" ("credit") the transaction via the
1376 gateway is attempted. No attempt to "void" the transaction is made if the
1377 gateway has introspection data and doesn't support void.
1379 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
1380 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
1381 #if set, will override the value from the customer record.
1383 #If an I<invnum> is specified, this payment (if successful) is applied to the
1384 #specified invoice. If you don't specify an I<invnum> you might want to
1385 #call the B<apply_payments> method.
1389 #some false laziness w/realtime_bop, not enough to make it worth merging
1390 #but some useful small subs should be pulled out
1391 sub realtime_refund_bop {
1394 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1397 if (ref($_[0]) eq 'HASH') {
1398 %options = %{$_[0]};
1402 $options{method} = $method;
1406 warn "$me realtime_refund_bop (new): $options{method} refund\n";
1407 warn " $_ => $options{$_}\n" foreach keys %options;
1410 return "No reason specified" unless $options{'reasonnum'} =~ /^\d+$/;
1415 # look up the original payment and optionally a gateway for that payment
1419 my $amount = $options{'amount'};
1421 my( $processor, $login, $password, @bop_options, $namespace ) ;
1422 my( $auth, $order_number ) = ( '', '', '' );
1423 my $gatewaynum = '';
1425 if ( $options{'paynum'} ) {
1427 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
1428 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
1429 or return "Unknown paynum $options{'paynum'}";
1430 $amount ||= $cust_pay->paid;
1432 my @cust_bill_pay = qsearch('cust_bill_pay', { paynum=>$cust_pay->paynum });
1433 $content{'invoice_number'} = $cust_bill_pay[0]->invnum if @cust_bill_pay;
1435 if ( $cust_pay->get('processor') ) {
1436 ($gatewaynum, $processor, $auth, $order_number) =
1438 $cust_pay->gatewaynum,
1439 $cust_pay->processor,
1441 $cust_pay->order_number,
1444 # this payment wasn't upgraded, which probably means this won't work,
1446 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
1447 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
1448 $cust_pay->paybatch;
1449 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
1452 if ( $gatewaynum ) { #gateway for the payment to be refunded
1454 my $payment_gateway =
1455 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
1456 die "payment gateway $gatewaynum not found"
1457 unless $payment_gateway;
1459 $processor = $payment_gateway->gateway_module;
1460 $login = $payment_gateway->gateway_username;
1461 $password = $payment_gateway->gateway_password;
1462 $namespace = $payment_gateway->gateway_namespace;
1463 @bop_options = $payment_gateway->options;
1465 } else { #try the default gateway
1468 my $payment_gateway =
1469 $self->agent->payment_gateway('method' => $options{method});
1471 ( $conf_processor, $login, $password, $namespace ) =
1472 map { my $method = "gateway_$_"; $payment_gateway->$method }
1473 qw( module username password namespace );
1475 @bop_options = $payment_gateway->gatewaynum
1476 ? $payment_gateway->options
1477 : @{ $payment_gateway->get('options') };
1479 return "processor of payment $options{'paynum'} $processor does not".
1480 " match default processor $conf_processor"
1481 unless $processor eq $conf_processor;
1486 } else { # didn't specify a paynum, so look for agent gateway overrides
1487 # like a normal transaction
1489 my $payment_gateway =
1490 $self->agent->payment_gateway( 'method' => $options{method},
1491 #'payinfo' => $payinfo,
1493 my( $processor, $login, $password, $namespace ) =
1494 map { my $method = "gateway_$_"; $payment_gateway->$method }
1495 qw( module username password namespace );
1497 my @bop_options = $payment_gateway->gatewaynum
1498 ? $payment_gateway->options
1499 : @{ $payment_gateway->get('options') };
1502 return "neither amount nor paynum specified" unless $amount;
1504 eval "use $namespace";
1509 'type' => $options{method},
1511 'password' => $password,
1512 'order_number' => $order_number,
1513 'amount' => $amount,
1515 $content{authorization} = $auth
1516 if length($auth); #echeck/ACH transactions have an order # but no auth
1517 #(at least with authorize.net)
1519 my $currency = $conf->exists('business-onlinepayment-currency')
1520 && $conf->config('business-onlinepayment-currency');
1521 $content{currency} = $currency if $currency;
1523 my $disable_void_after;
1524 if ($conf->exists('disable_void_after')
1525 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
1526 $disable_void_after = $1;
1529 #first try void if applicable
1530 my $void = new Business::OnlinePayment( $processor, @bop_options );
1533 if ($void->can('info')) {
1535 $paytype = 'ECHECK' if $cust_pay && $cust_pay->payby eq 'CHEK';
1536 $paytype = 'CC' if $cust_pay && $cust_pay->payby eq 'CARD';
1537 my %supported_actions = $void->info('supported_actions');
1539 if ( %supported_actions && $paytype
1540 && defined($supported_actions{$paytype})
1541 && !grep{ $_ eq 'Void' } @{$supported_actions{$paytype}} );
1544 if ( $cust_pay && $cust_pay->paid == $amount
1546 ( not defined($disable_void_after) )
1547 || ( time < ($cust_pay->_date + $disable_void_after ) )
1551 warn " attempting void\n" if $DEBUG > 1;
1552 if ( $void->can('info') ) {
1553 if ( $cust_pay->payby eq 'CARD'
1554 && $void->info('CC_void_requires_card') )
1556 $content{'card_number'} = $cust_pay->payinfo;
1557 } elsif ( $cust_pay->payby eq 'CHEK'
1558 && $void->info('ECHECK_void_requires_account') )
1560 ( $content{'account_number'}, $content{'routing_code'} ) =
1561 split('@', $cust_pay->payinfo);
1562 $content{'name'} = $self->get('first'). ' '. $self->get('last');
1565 $void->content( 'action' => 'void', %content );
1566 $void->test_transaction(1)
1567 if $conf->exists('business-onlinepayment-test_transaction');
1569 if ( $void->is_success ) {
1570 # specified as a refund reason, but now we want a payment void reason
1571 # extract just the reason text, let cust_pay::void handle new_or_existing
1572 my $reason = qsearchs('reason',{ 'reasonnum' => $options{'reasonnum'} });
1574 $error = 'Reason could not be loaded' unless $reason;
1575 $error = $cust_pay->void($reason->reason) unless $error;
1577 # gah, even with transactions.
1578 my $e = 'WARNING: Card/ACH voided but database not updated - '.
1579 "error voiding payment: $error";
1583 warn " void successful\n" if $DEBUG > 1;
1588 warn " void unsuccessful, trying refund\n"
1592 my $address = $self->address1;
1593 $address .= ", ". $self->address2 if $self->address2;
1595 my($payname, $payfirst, $paylast);
1596 if ( $self->payname && $options{method} ne 'ECHECK' ) {
1597 $payname = $self->payname;
1598 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
1599 or return "Illegal payname $payname";
1600 ($payfirst, $paylast) = ($1, $2);
1602 $payfirst = $self->getfield('first');
1603 $paylast = $self->getfield('last');
1604 $payname = "$payfirst $paylast";
1607 my @invoicing_list = $self->invoicing_list_emailonly;
1608 if ( $conf->exists('emailinvoiceautoalways')
1609 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1610 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1611 push @invoicing_list, $self->all_emails;
1614 my $email = ($conf->exists('business-onlinepayment-email-override'))
1615 ? $conf->config('business-onlinepayment-email-override')
1616 : $invoicing_list[0];
1618 my $payip = exists($options{'payip'})
1621 $content{customer_ip} = $payip
1625 if ( $options{method} eq 'CC' ) {
1628 $content{card_number} = $payinfo = $cust_pay->payinfo;
1629 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
1630 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
1631 ($content{expiration} = "$2/$1"); # where available
1633 $content{card_number} = $payinfo = $self->payinfo;
1634 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
1635 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1636 $content{expiration} = "$2/$1";
1639 } elsif ( $options{method} eq 'ECHECK' ) {
1642 $payinfo = $cust_pay->payinfo;
1644 $payinfo = $self->payinfo;
1646 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
1647 $content{bank_name} = $self->payname;
1648 $content{account_type} = 'CHECKING';
1649 $content{account_name} = $payname;
1650 $content{customer_org} = $self->company ? 'B' : 'I';
1651 $content{customer_ssn} = $self->ss;
1656 my $refund = new Business::OnlinePayment( $processor, @bop_options );
1657 my %sub_content = $refund->content(
1658 'action' => 'credit',
1659 'customer_id' => $self->custnum,
1660 'last_name' => $paylast,
1661 'first_name' => $payfirst,
1663 'address' => $address,
1664 'city' => $self->city,
1665 'state' => $self->state,
1666 'zip' => $self->zip,
1667 'country' => $self->country,
1669 'phone' => $self->daytime || $self->night,
1672 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
1674 $refund->test_transaction(1)
1675 if $conf->exists('business-onlinepayment-test_transaction');
1678 return "$processor error: ". $refund->error_message
1679 unless $refund->is_success();
1681 $order_number = $refund->order_number if $refund->can('order_number');
1683 # change this to just use $cust_pay->delete_cust_bill_pay?
1684 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
1685 my @cust_bill_pay = $cust_pay->cust_bill_pay;
1686 last unless @cust_bill_pay;
1687 my $cust_bill_pay = pop @cust_bill_pay;
1688 my $error = $cust_bill_pay->delete;
1692 my $cust_refund = new FS::cust_refund ( {
1693 'custnum' => $self->custnum,
1694 'paynum' => $options{'paynum'},
1695 'source_paynum' => $options{'paynum'},
1696 'refund' => $amount,
1698 'payby' => $bop_method2payby{$options{method}},
1699 'payinfo' => $payinfo,
1700 'reasonnum' => $options{'reasonnum'},
1701 'gatewaynum' => $gatewaynum, # may be null
1702 'processor' => $processor,
1703 'auth' => $refund->authorization,
1704 'order_number' => $order_number,
1706 my $error = $cust_refund->insert;
1708 $cust_refund->paynum(''); #try again with no specific paynum
1709 $cust_refund->source_paynum('');
1710 my $error2 = $cust_refund->insert;
1712 # gah, even with transactions.
1713 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
1714 "error inserting refund ($processor): $error2".
1715 " (previously tried insert with paynum #$options{'paynum'}" .
1726 =item realtime_verify_bop [ OPTION => VALUE ... ]
1728 Runs an authorization-only transaction for $1 against this credit card (if
1729 successful, immediatly reverses the authorization).
1731 Returns the empty string if the authorization was sucessful, or an error
1734 Option I<cust_payby> should be passed, even if it's not yet been inserted.
1735 Object will be tokenized if possible, but that change will not be
1736 updated in database (must be inserted/replaced afterwards.)
1738 Currently only succeeds for Business::OnlinePayment CC transactions.
1742 #some false laziness w/realtime_bop and realtime_refund_bop, not enough to make
1743 #it worth merging but some useful small subs should be pulled out
1744 sub realtime_verify_bop {
1747 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1748 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_verify_bop');
1751 if (ref($_[0]) eq 'HASH') {
1752 %options = %{$_[0]};
1758 warn "$me realtime_verify_bop\n";
1759 warn " $_ => $options{$_}\n" foreach keys %options;
1762 # set fields from passed cust_payby
1763 return "No cust_payby" unless $options{'cust_payby'};
1764 $self->_bop_cust_payby_options(\%options);
1766 # possibly run a separate transaction to tokenize card number,
1767 # so that we never store tokenized card info in cust_pay_pending
1768 if (!$self->tokenized($options{'payinfo'})) {
1769 my $token_error = $self->realtime_tokenize(\%options);
1770 return $token_error if $token_error;
1771 #important that we not replace cust_payby here,
1772 #because cust_payby->replace uses realtime_verify_bop!
1779 my $payment_gateway = $self->_payment_gateway( \%options );
1780 my $namespace = $payment_gateway->gateway_namespace;
1782 eval "use $namespace";
1786 # check for banned credit card/ACH
1789 my $ban = FS::banned_pay->ban_search(
1790 'payby' => $bop_method2payby{'CC'},
1791 'payinfo' => $options{payinfo},
1793 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
1799 my $bop_content = $self->_bop_content(\%options);
1800 return $bop_content unless ref($bop_content);
1802 my @invoicing_list = $self->invoicing_list_emailonly;
1803 if ( $conf->exists('emailinvoiceautoalways')
1804 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1805 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1806 push @invoicing_list, $self->all_emails;
1809 my $email = ($conf->exists('business-onlinepayment-email-override'))
1810 ? $conf->config('business-onlinepayment-email-override')
1811 : $invoicing_list[0];
1816 if ( $namespace eq 'Business::OnlinePayment' ) {
1818 if ( $options{method} eq 'CC' ) {
1820 $content{card_number} = $options{payinfo};
1821 $paydate = $options{'paydate'};
1822 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1823 $content{expiration} = "$2/$1";
1825 $content{cvv2} = $options{'paycvv'}
1826 if length($options{'paycvv'});
1828 my $paystart_month = $options{'paystart_month'};
1829 my $paystart_year = $options{'paystart_year'};
1831 $content{card_start} = "$paystart_month/$paystart_year"
1832 if $paystart_month && $paystart_year;
1834 my $payissue = $options{'payissue'};
1835 $content{issue_number} = $payissue if $payissue;
1837 } elsif ( $options{method} eq 'ECHECK' ){
1838 #cannot verify, move along (though it shouldn't be called...)
1841 return "unknown method ". $options{method};
1843 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
1844 #cannot verify, move along
1847 return "unknown namespace $namespace";
1851 # run transaction(s)
1855 my $transaction; #need this back so we can do _tokenize_card
1857 # don't mutex the customer here, because they might be uncommitted. and
1858 # this is only verification. it doesn't matter if they have other
1859 # unfinished verifications.
1861 my $cust_pay_pending = new FS::cust_pay_pending {
1862 'custnum_pending' => 1,
1865 'payby' => $bop_method2payby{'CC'},
1866 'payinfo' => $options{payinfo},
1867 'paymask' => $options{paymask},
1868 'paydate' => $paydate,
1869 'pkgnum' => $options{'pkgnum'},
1871 'gatewaynum' => $payment_gateway->gatewaynum || '',
1872 'session_id' => $options{session_id} || '',
1874 $cust_pay_pending->payunique( $options{payunique} )
1875 if defined($options{payunique}) && length($options{payunique});
1878 # open a separate handle for creating/updating the cust_pay_pending
1880 local $FS::UID::dbh = myconnect();
1881 local $FS::UID::AutoCommit = 1;
1883 # if this is an existing customer (and we can tell now because
1884 # this is a fresh transaction), it's safe to assign their custnum
1885 # to the cust_pay_pending record, and then the verification attempt
1886 # will remain linked to them even if it fails.
1887 if ( FS::cust_main->by_key($self->custnum) ) {
1888 $cust_pay_pending->set('custnum', $self->custnum);
1891 warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
1894 # if this fails, just return; everything else will still allow the
1895 # cust_pay_pending to have its custnum set later
1896 my $cpp_new_err = $cust_pay_pending->insert;
1897 return $cpp_new_err if $cpp_new_err;
1899 warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
1901 warn Dumper($cust_pay_pending) if $DEBUG > 2;
1903 $transaction = new $namespace( $payment_gateway->gateway_module,
1904 $self->_bop_options(\%options),
1907 $transaction->content(
1909 $self->_bop_auth(\%options),
1910 'action' => 'Authorization Only',
1911 'description' => $options{'description'},
1913 'customer_id' => $self->custnum,
1915 'reference' => $cust_pay_pending->paypendingnum, #for now
1920 $cust_pay_pending->status('pending');
1921 my $cpp_pending_err = $cust_pay_pending->replace;
1922 return $cpp_pending_err if $cpp_pending_err;
1924 warn Dumper($transaction) if $DEBUG > 2;
1926 unless ( $BOP_TESTING ) {
1927 $transaction->test_transaction(1)
1928 if $conf->exists('business-onlinepayment-test_transaction');
1929 $transaction->submit();
1931 if ( $BOP_TESTING_SUCCESS ) {
1932 $transaction->is_success(1);
1933 $transaction->authorization('fake auth');
1935 $transaction->is_success(0);
1936 $transaction->error_message('fake failure');
1940 if ( $transaction->is_success() ) {
1942 $cust_pay_pending->status('authorized');
1943 my $cpp_authorized_err = $cust_pay_pending->replace;
1944 return $cpp_authorized_err if $cpp_authorized_err;
1946 my $auth = $transaction->authorization;
1947 my $ordernum = $transaction->can('order_number')
1948 ? $transaction->order_number
1951 my $reverse = new $namespace( $payment_gateway->gateway_module,
1952 $self->_bop_options(\%options),
1955 $reverse->content( 'action' => 'Reverse Authorization',
1956 $self->_bop_auth(\%options),
1960 'authorization' => $transaction->authorization,
1961 'order_number' => $ordernum,
1964 'result_code' => $transaction->result_code,
1965 'txn_date' => $transaction->txn_date,
1969 $reverse->test_transaction(1)
1970 if $conf->exists('business-onlinepayment-test_transaction');
1973 if ( $reverse->is_success ) {
1975 $cust_pay_pending->status('done');
1976 $cust_pay_pending->statustext('reversed');
1977 my $cpp_reversed_err = $cust_pay_pending->replace;
1978 return $cpp_reversed_err if $cpp_reversed_err;
1982 my $e = "Authorization successful but reversal failed, custnum #".
1983 $self->custnum. ': '. $reverse->result_code.
1984 ": ". $reverse->error_message;
1991 ### Address Verification ###
1993 # Single-letter codes vary by cardtype.
1995 # Erring on the side of accepting cards if avs is not available,
1996 # only rejecting if avs occurred and there's been an explicit mismatch
1998 # Charts below taken from vSecure documentation,
1999 # shows codes for Amex/Dscv/MC/Visa
2001 # ACCEPTABLE AVS RESPONSES:
2002 # Both Address and 5-digit postal code match Y A Y Y
2003 # Both address and 9-digit postal code match Y A X Y
2004 # United Kingdom – Address and postal code match _ _ _ F
2005 # International transaction – Address and postal code match _ _ _ D/M
2007 # ACCEPTABLE, BUT ISSUE A WARNING:
2008 # Ineligible transaction; or message contains a content error _ _ _ E
2009 # System unavailable; retry R U R R
2010 # Information unavailable U W U U
2011 # Issuer does not support AVS S U S S
2012 # AVS is not applicable _ _ _ S
2013 # Incompatible formats – Not verified _ _ _ C
2014 # Incompatible formats – Address not verified; postal code matches _ _ _ P
2015 # International transaction – address not verified _ G _ G/I
2017 # UNACCEPTABLE AVS RESPONSES:
2018 # Only Address matches A Y A A
2019 # Only 5-digit postal code matches Z Z Z Z
2020 # Only 9-digit postal code matches Z Z W W
2021 # Neither address nor postal code matches N N N N
2023 if (my $avscode = uc($transaction->avs_code)) {
2025 # map codes to accept/warn/reject
2027 'American Express card' => {
2036 'Discover card' => {
2075 my $cardtype = cardtype($content{card_number});
2076 if ($avs->{$cardtype}) {
2077 my $avsact = $avs->{$cardtype}->{$avscode};
2079 if ($avsact eq 'r') {
2080 return "AVS code verification failed, cardtype $cardtype, code $avscode";
2081 } elsif ($avsact eq 'w') {
2082 $warning = "AVS did not occur, cardtype $cardtype, code $avscode";
2083 } elsif (!$avsact) {
2084 $warning = "AVS code unknown, cardtype $cardtype, code $avscode";
2085 } # else $avsact eq 'a'
2087 $log->warning($warning);
2090 } # else $cardtype avs handling not implemented
2091 } # else !$transaction->avs_code
2093 } else { # is not success
2095 # status is 'done' not 'declined', as in _realtime_bop_result
2096 $cust_pay_pending->status('done');
2097 $error = $transaction->error_message || 'Unknown error';
2098 $cust_pay_pending->statustext($error);
2099 # could also record failure_status here,
2100 # but it's not supported by B::OP::vSecureProcessing...
2101 # need a B::OP module with (reverse) auth only to test it with
2102 my $cpp_declined_err = $cust_pay_pending->replace;
2103 return $cpp_declined_err if $cpp_declined_err;
2107 } # end of IMMEDIATE; we now have our $error and $transaction
2110 # Save the custnum (as part of the main transaction, so it can reference
2114 if (!$cust_pay_pending->custnum) {
2115 $cust_pay_pending->set('custnum', $self->custnum);
2116 my $set_custnum_err = $cust_pay_pending->replace;
2117 if ($set_custnum_err) {
2118 $log->error($set_custnum_err);
2119 $error ||= $set_custnum_err;
2120 # but if there was a real verification error also, return that one
2125 # remove paycvv here? need to find out if a reversed auth
2126 # counts as an initial transaction for paycvv retention requirements
2133 # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
2134 # if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
2135 if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
2136 $cust_pay_pending->payinfo($card_token);
2137 my $cpp_token_err = $cust_pay_pending->replace;
2138 #this leaves real card number in cust_pay_pending, but can't do much else if cpp won't replace
2139 return $cpp_token_err if $cpp_token_err;
2140 #important that we not replace cust_payby here,
2141 #because cust_payby->replace uses realtime_verify_bop!
2148 # $error contains the transaction error_message, if is_success was false.
2154 =item realtime_tokenize [ OPTION => VALUE ... ]
2156 If possible and necessary, runs a tokenize transaction.
2157 In order to be possible, a credit card cust_payby record
2158 must be passed and a Business::OnlinePayment gateway capable
2159 of Tokenize transactions must be configured for this user.
2160 Is only necessary if payinfo is not yet tokenized.
2162 Returns the empty string if the authorization was sucessful
2163 or was not possible/necessary (thus allowing this to be safely called with
2164 non-tokenizable records/gateways, without having to perform separate tests),
2165 or an error message otherwise.
2167 Option I<cust_payby> may be passed, even if it's not yet been inserted.
2168 Object will be tokenized if possible, but that change will not be
2169 updated in database (must be inserted/replaced afterwards.)
2171 Otherwise, options I<method>, I<payinfo> and other cust_payby fields
2172 may be passed. If options are passed as a hashref, I<payinfo>
2173 will be updated as appropriate in the passed hashref.
2177 sub realtime_tokenize {
2180 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2181 my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_tokenize');
2184 my $outoptions; #for returning cust_payby/payinfo
2185 if (ref($_[0]) eq 'HASH') {
2186 %options = %{$_[0]};
2187 $outoptions = $_[0];
2190 $outoptions = \%options;
2193 # set fields from passed cust_payby
2194 $self->_bop_cust_payby_options(\%options);
2195 return '' unless $options{method} eq 'CC';
2196 return '' if $self->tokenized($options{payinfo}); #already tokenized
2202 $options{'nofatal'} = 1;
2203 my $payment_gateway = $self->_payment_gateway( \%options );
2204 return '' unless $payment_gateway;
2205 my $namespace = $payment_gateway->gateway_namespace;
2206 return '' unless $namespace eq 'Business::OnlinePayment';
2208 eval "use $namespace";
2212 # check for tokenize ability
2215 my $transaction = new $namespace( $payment_gateway->gateway_module,
2216 $self->_bop_options(\%options),
2219 my %supported_actions = $transaction->info('supported_actions');
2220 return '' unless $supported_actions{'CC'}
2221 && grep /^Tokenize$/, @{$supported_actions{'CC'}};
2224 # check for banned credit card/ACH
2227 my $ban = FS::banned_pay->ban_search(
2228 'payby' => $bop_method2payby{'CC'},
2229 'payinfo' => $options{payinfo},
2231 return "Banned credit card" if $ban && $ban->bantype ne 'warn';
2237 my $bop_content = $self->_bop_content(\%options);
2238 return $bop_content unless ref($bop_content);
2243 $content{card_number} = $options{payinfo};
2244 $paydate = $options{'paydate'};
2245 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2246 $content{expiration} = "$2/$1";
2248 $content{cvv2} = $options{'paycvv'}
2249 if length($options{'paycvv'});
2251 my $paystart_month = $options{'paystart_month'};
2252 my $paystart_year = $options{'paystart_year'};
2254 $content{card_start} = "$paystart_month/$paystart_year"
2255 if $paystart_month && $paystart_year;
2257 my $payissue = $options{'payissue'};
2258 $content{issue_number} = $payissue if $payissue;
2266 # no cust_pay_pending---this is not a financial transaction
2268 $transaction->content(
2270 $self->_bop_auth(\%options),
2271 'action' => 'Tokenize',
2272 'description' => $options{'description'},
2273 'customer_id' => $self->custnum,
2278 # no $BOP_TESTING handling for this
2279 $transaction->test_transaction(1)
2280 if $conf->exists('business-onlinepayment-test_transaction');
2281 $transaction->submit();
2283 if ( $transaction->card_token() ) { # no is_success flag
2285 # realtime_tokenize should not clear paycvv at this time. it might be
2286 # needed for the first transaction, and a tokenize isn't actually a
2287 # transaction that hits the gateway. at some point in the future, card
2288 # fortress should take on the "store paycvv until first transaction"
2289 # functionality and we should fix this in freeside, but i that's a bigger
2290 # project for another time.
2292 #important that we not replace cust_payby here,
2293 #because cust_payby->replace uses realtime_tokenize!
2294 $self->_tokenize_card($transaction,$outoptions);
2298 $error = $transaction->error_message || 'Unknown error when tokenizing card';
2307 =item tokenized PAYINFO
2309 Convenience wrapper for L<FS::payinfo_Mixin/tokenized>
2317 my $payinfo = shift;
2318 FS::cust_pay->tokenized($payinfo);
2329 L<FS::cust_main>, L<FS::cust_main::Billing>