FS/FS/cust_main/Billing_Realtime.pm

   1 package FS::cust_main::Billing_Realtime;
   2
   3 use strict;
   4 use vars qw( $conf $DEBUG $me );
   5 use vars qw( $realtime_bop_decline_quiet ); #ugh
   6 use Data::Dumper;
   7 use Digest::MD5 qw(md5_base64);
   8 use Business::CreditCard 0.28;
   9 use FS::UID qw( dbh );
  10 use FS::Record qw( qsearch qsearchs );
  11 use FS::Misc qw( send_email );
  12 use FS::payby;
  13 use FS::cust_pay;
  14 use FS::cust_pay_pending;
  15 use FS::cust_refund;
  16
  17 $realtime_bop_decline_quiet = 0;
  18
  19 # 1 is mostly method/subroutine entry and options
  20 # 2 traces progress of some operations
  21 # 3 is even more information including possibly sensitive data
  22 $DEBUG = 0;
  23 $me = '[FS::cust_main::Billing_Realtime]';
  24
  25 install_callback FS::UID sub {
  26   $conf = new FS::Conf;
  27   #yes, need it for stuff below (prolly should be cached)
  28 };
  29
  30 =head1 NAME
  31
  32 FS::cust_main::Billing_Realtime - Realtime billing mixin for cust_main
  33
  34 =head1 SYNOPSIS
  35
  36 =head1 DESCRIPTION
  37
  38 These methods are available on FS::cust_main objects.
  39
  40 =head1 METHODS
  41
  42 =over 4
  43
  44 =item realtime_collect [ OPTION => VALUE ... ]
  45
  46 Attempt to collect the customer's current balance with a realtime credit
  47 card, electronic check, or phone bill transaction (see realtime_bop() below).
  48
  49 Returns the result of realtime_bop(): nothing, an error message, or a
  50 hashref of state information for a third-party transaction.
  51
  52 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
  53
  54 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>.  If none is specified
  55 then it is deduced from the customer record.
  56
  57 If no I<amount> is specified, then the customer balance is used.
  58
  59 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
  60 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
  61 if set, will override the value from the customer record.
  62
  63 I<description> is a free-text field passed to the gateway.  It defaults to
  64 the value defined by the business-onlinepayment-description configuration
  65 option, or "Internet services" if that is unset.
  66
  67 If an I<invnum> is specified, this payment (if successful) is applied to the
  68 specified invoice.
  69
  70 I<apply> will automatically apply a resulting payment.
  71
  72 I<quiet> can be set true to suppress email decline notices.
  73
  74 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
  75 resulting paynum, if any.
  76
  77 I<payunique> is a unique identifier for this payment.
  78
  79 I<session_id> is a session identifier associated with this payment.
  80
  81 I<depend_jobnum> allows payment capture to unlock export jobs
  82
  83 =cut
  84
  85 sub realtime_collect {
  86   my( $self, %options ) = @_;
  87
  88   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
  89
  90   if ( $DEBUG ) {
  91     warn "$me realtime_collect:\n";
  92     warn "  $_ => $options{$_}\n" foreach keys %options;
  93   }
  94
  95   $options{amount} = $self->balance unless exists( $options{amount} );
  96   $options{method} = FS::payby->payby2bop($self->payby)
  97     unless exists( $options{method} );
  98
  99   return $self->realtime_bop({%options});
 100
 101 }
 102
 103 =item realtime_bop { [ ARG => VALUE ... ] }
 104
 105 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
 106 via a Business::OnlinePayment realtime gateway.  See
 107 L<http://420.am/business-onlinepayment> for supported gateways.
 108
 109 Required arguments in the hashref are I<method>, and I<amount>
 110
 111 Available methods are: I<CC>, I<ECHECK> and I<LEC>
 112
 113 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
 114
 115 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
 116 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
 117 if set, will override the value from the customer record.
 118
 119 I<description> is a free-text field passed to the gateway.  It defaults to
 120 the value defined by the business-onlinepayment-description configuration
 121 option, or "Internet services" if that is unset.
 122
 123 If an I<invnum> is specified, this payment (if successful) is applied to the
 124 specified invoice.  If the customer has exactly one open invoice, that
 125 invoice number will be assumed.  If you don't specify an I<invnum> you might
 126 want to call the B<apply_payments> method or set the I<apply> option.
 127
 128 I<apply> can be set to true to apply a resulting payment.
 129
 130 I<quiet> can be set true to surpress email decline notices.
 131
 132 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
 133 resulting paynum, if any.
 134
 135 I<payunique> is a unique identifier for this payment.
 136
 137 I<session_id> is a session identifier associated with this payment.
 138
 139 I<depend_jobnum> allows payment capture to unlock export jobs
 140
 141 I<discount_term> attempts to take a discount by prepaying for discount_term
 142
 143 A direct (Business::OnlinePayment) transaction will return nothing on success,
 144 or an error message on failure.
 145
 146 A third-party transaction will return a hashref containing:
 147
 148 - popup_url: the URL to which a browser should be redirected to complete
 149   the transaction.
 150 - collectitems: an arrayref of name-value pairs to be posted to popup_url.
 151 - reference: a reference ID for the transaction, to show the customer.
 152
 153 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
 154
 155 =cut
 156
 157 # some helper routines
 158 sub _bop_recurring_billing {
 159   my( $self, %opt ) = @_;
 160
 161   my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
 162
 163   if ( defined($method) && $method eq 'transaction_is_recur' ) {
 164
 165     return 1 if $opt{'trans_is_recur'};
 166
 167   } else {
 168
 169     my %hash = ( 'custnum' => $self->custnum,
 170                  'payby'   => 'CARD',
 171                );
 172
 173     return 1
 174       if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
 175       || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
 176                                                                $opt{'payinfo'} )
 177                              } );
 178
 179   }
 180
 181   return 0;
 182
 183 }
 184
 185 sub _payment_gateway {
 186   my ($self, $options) = @_;
 187
 188   if ( $options->{'selfservice'} ) {
 189     my $gatewaynum = FS::Conf->new->config('selfservice-payment_gateway');
 190     if ( $gatewaynum ) {
 191       return $options->{payment_gateway} ||=
 192           qsearchs('payment_gateway', { gatewaynum => $gatewaynum });
 193     }
 194   }
 195
 196   if ( $options->{'fake_gatewaynum'} ) {
 197         $options->{payment_gateway} =
 198             qsearchs('payment_gateway',
 199                       { 'gatewaynum' => $options->{'fake_gatewaynum'}, }
 200                     );
 201   }
 202
 203   $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
 204     unless exists($options->{payment_gateway});
 205
 206   $options->{payment_gateway};
 207 }
 208
 209 sub _bop_auth {
 210   my ($self, $options) = @_;
 211
 212   (
 213     'login'    => $options->{payment_gateway}->gateway_username,
 214     'password' => $options->{payment_gateway}->gateway_password,
 215   );
 216 }
 217
 218 sub _bop_options {
 219   my ($self, $options) = @_;
 220
 221   $options->{payment_gateway}->gatewaynum
 222     ? $options->{payment_gateway}->options
 223     : @{ $options->{payment_gateway}->get('options') };
 224
 225 }
 226
 227 sub _bop_defaults {
 228   my ($self, $options) = @_;
 229
 230   unless ( $options->{'description'} ) {
 231     if ( $conf->exists('business-onlinepayment-description') ) {
 232       my $dtempl = $conf->config('business-onlinepayment-description');
 233
 234       my $agent = $self->agent->agent;
 235       #$pkgs... not here
 236       $options->{'description'} = eval qq("$dtempl");
 237     } else {
 238       $options->{'description'} = 'Internet services';
 239     }
 240   }
 241
 242   $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
 243
 244   # Default invoice number if the customer has exactly one open invoice.
 245   if( ! $options->{'invnum'} ) {
 246     $options->{'invnum'} = '';
 247     my @open = $self->open_cust_bill;
 248     $options->{'invnum'} = $open[0]->invnum if scalar(@open) == 1;
 249   }
 250
 251   $options->{payname} = $self->payname unless exists( $options->{payname} );
 252 }
 253
 254 sub _bop_content {
 255   my ($self, $options) = @_;
 256   my %content = ();
 257
 258   my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
 259   $content{customer_ip} = $payip if length($payip);
 260
 261   $content{invoice_number} = $options->{'invnum'}
 262     if exists($options->{'invnum'}) && length($options->{'invnum'});
 263
 264   $content{email_customer} =
 265     (    $conf->exists('business-onlinepayment-email_customer')
 266       || $conf->exists('business-onlinepayment-email-override') );
 267
 268   my ($payname, $payfirst, $paylast);
 269   if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
 270     ($payname = $options->{payname}) =~
 271       /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
 272       or return "Illegal payname $payname";
 273     ($payfirst, $paylast) = ($1, $2);
 274   } else {
 275     $payfirst = $self->getfield('first');
 276     $paylast = $self->getfield('last');
 277     $payname = "$payfirst $paylast";
 278   }
 279
 280   $content{last_name} = $paylast;
 281   $content{first_name} = $payfirst;
 282
 283   $content{name} = $payname;
 284
 285   $content{address} = exists($options->{'address1'})
 286                         ? $options->{'address1'}
 287                         : $self->address1;
 288   my $address2 = exists($options->{'address2'})
 289                    ? $options->{'address2'}
 290                    : $self->address2;
 291   $content{address} .= ", ". $address2 if length($address2);
 292
 293   $content{city} = exists($options->{city})
 294                      ? $options->{city}
 295                      : $self->city;
 296   $content{state} = exists($options->{state})
 297                       ? $options->{state}
 298                       : $self->state;
 299   $content{zip} = exists($options->{zip})
 300                     ? $options->{'zip'}
 301                     : $self->zip;
 302   $content{country} = exists($options->{country})
 303                         ? $options->{country}
 304                         : $self->country;
 305
 306   $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
 307   $content{phone} = $self->daytime || $self->night;
 308
 309   \%content;
 310 }
 311
 312 my %bop_method2payby = (
 313   'CC'     => 'CARD',
 314   'ECHECK' => 'CHEK',
 315   'LEC'    => 'LECB',
 316 );
 317
 318 sub realtime_bop {
 319   my $self = shift;
 320
 321   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 322
 323   my %options = ();
 324   if (ref($_[0]) eq 'HASH') {
 325     %options = %{$_[0]};
 326   } else {
 327     my ( $method, $amount ) = ( shift, shift );
 328     %options = @_;
 329     $options{method} = $method;
 330     $options{amount} = $amount;
 331   }
 332
 333
 334   ###
 335   # optional credit card surcharge
 336   ###
 337
 338   my $cc_surcharge = 0;
 339   my $cc_surcharge_pct = 0;
 340   $cc_surcharge_pct = $conf->config('credit-card-surcharge-percentage')
 341     if $conf->config('credit-card-surcharge-percentage');
 342
 343   # always add cc surcharge if called from event
 344   if($options{'cc_surcharge_from_event'} && $cc_surcharge_pct > 0) {
 345       $cc_surcharge = $options{'amount'} * $cc_surcharge_pct / 100;
 346       $options{'amount'} += $cc_surcharge;
 347       $options{'amount'} = sprintf("%.2f", $options{'amount'}); # round (again)?
 348   }
 349   elsif($cc_surcharge_pct > 0) { # we're called not from event (i.e. from a
 350                                  # payment screen), so consider the given
 351                                  # amount as post-surcharge
 352     $cc_surcharge = $options{'amount'} - ($options{'amount'} / ( 1 + $cc_surcharge_pct/100 ));
 353   }
 354
 355   $cc_surcharge = sprintf("%.2f",$cc_surcharge) if $cc_surcharge > 0;
 356   $options{'cc_surcharge'} = $cc_surcharge;
 357
 358
 359   if ( $DEBUG ) {
 360     warn "$me realtime_bop (new): $options{method} $options{amount}\n";
 361     warn " cc_surcharge = $cc_surcharge\n";
 362     warn "  $_ => $options{$_}\n" foreach keys %options;
 363   }
 364
 365   return $self->fake_bop(\%options) if $options{'fake'};
 366
 367   $self->_bop_defaults(\%options);
 368
 369   ###
 370   # set trans_is_recur based on invnum if there is one
 371   ###
 372
 373   my $trans_is_recur = 0;
 374   if ( $options{'invnum'} ) {
 375
 376     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
 377     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
 378
 379     my @part_pkg =
 380       map  { $_->part_pkg }
 381       grep { $_ }
 382       map  { $_->cust_pkg }
 383       $cust_bill->cust_bill_pkg;
 384
 385     $trans_is_recur = 1
 386       if grep { $_->freq ne '0' } @part_pkg;
 387
 388   }
 389
 390   ###
 391   # select a gateway
 392   ###
 393
 394   my $payment_gateway =  $self->_payment_gateway( \%options );
 395   my $namespace = $payment_gateway->gateway_namespace;
 396
 397   eval "use $namespace";
 398   die $@ if $@;
 399
 400   ###
 401   # check for banned credit card/ACH
 402   ###
 403
 404   my $ban = qsearchs('banned_pay', {
 405     'payby'   => $bop_method2payby{$options{method}},
 406     'payinfo' => md5_base64($options{payinfo}),
 407   } );
 408   return "Banned credit card" if $ban;
 409
 410   ###
 411   # massage data
 412   ###
 413
 414   my $bop_content = $self->_bop_content(\%options);
 415   return $bop_content unless ref($bop_content);
 416
 417   my @invoicing_list = $self->invoicing_list_emailonly;
 418   if ( $conf->exists('emailinvoiceautoalways')
 419        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
 420        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
 421     push @invoicing_list, $self->all_emails;
 422   }
 423
 424   my $email = ($conf->exists('business-onlinepayment-email-override'))
 425               ? $conf->config('business-onlinepayment-email-override')
 426               : $invoicing_list[0];
 427
 428   my $paydate = '';
 429   my %content = ();
 430   if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
 431
 432     $content{card_number} = $options{payinfo};
 433     $paydate = exists($options{'paydate'})
 434                     ? $options{'paydate'}
 435                     : $self->paydate;
 436     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 437     $content{expiration} = "$2/$1";
 438
 439     my $paycvv = exists($options{'paycvv'})
 440                    ? $options{'paycvv'}
 441                    : $self->paycvv;
 442     $content{cvv2} = $paycvv
 443       if length($paycvv);
 444
 445     my $paystart_month = exists($options{'paystart_month'})
 446                            ? $options{'paystart_month'}
 447                            : $self->paystart_month;
 448
 449     my $paystart_year  = exists($options{'paystart_year'})
 450                            ? $options{'paystart_year'}
 451                            : $self->paystart_year;
 452
 453     $content{card_start} = "$paystart_month/$paystart_year"
 454       if $paystart_month && $paystart_year;
 455
 456     my $payissue       = exists($options{'payissue'})
 457                            ? $options{'payissue'}
 458                            : $self->payissue;
 459     $content{issue_number} = $payissue if $payissue;
 460
 461     if ( $self->_bop_recurring_billing( 'payinfo'        => $options{'payinfo'},
 462                                         'trans_is_recur' => $trans_is_recur,
 463                                       )
 464        )
 465     {
 466       $content{recurring_billing} = 'YES';
 467       $content{acct_code} = 'rebill'
 468         if $conf->exists('credit_card-recurring_billing_acct_code');
 469     }
 470
 471   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
 472     ( $content{account_number}, $content{routing_code} ) =
 473       split('@', $options{payinfo});
 474     $content{bank_name} = $options{payname};
 475     $content{bank_state} = exists($options{'paystate'})
 476                              ? $options{'paystate'}
 477                              : $self->getfield('paystate');
 478     $content{account_type}= (exists($options{'paytype'}) && $options{'paytype'})
 479                                ? uc($options{'paytype'})
 480                                : uc($self->getfield('paytype')) || 'PERSONAL CHECKING';
 481     $content{account_name} = $self->getfield('first'). ' '.
 482                              $self->getfield('last');
 483
 484     $content{customer_org} = $self->company ? 'B' : 'I';
 485     $content{state_id}       = exists($options{'stateid'})
 486                                  ? $options{'stateid'}
 487                                  : $self->getfield('stateid');
 488     $content{state_id_state} = exists($options{'stateid_state'})
 489                                  ? $options{'stateid_state'}
 490                                  : $self->getfield('stateid_state');
 491     $content{customer_ssn} = exists($options{'ss'})
 492                                ? $options{'ss'}
 493                                : $self->ss;
 494   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
 495     $content{phone} = $options{payinfo};
 496   } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
 497     #move along
 498   } else {
 499     #die an evil death
 500   }
 501
 502   ###
 503   # run transaction(s)
 504   ###
 505
 506   my $balance = exists( $options{'balance'} )
 507                   ? $options{'balance'}
 508                   : $self->balance;
 509
 510   $self->select_for_update; #mutex ... just until we get our pending record in
 511
 512   #the checks here are intended to catch concurrent payments
 513   #double-form-submission prevention is taken care of in cust_pay_pending::check
 514
 515   #check the balance
 516   return "The customer's balance has changed; $options{method} transaction aborted."
 517     if $self->balance < $balance;
 518
 519   #also check and make sure there aren't *other* pending payments for this cust
 520
 521   my @pending = qsearch('cust_pay_pending', {
 522     'custnum' => $self->custnum,
 523     'status'  => { op=>'!=', value=>'done' }
 524   });
 525   # This is a problem.  A self-service third party payment that fails somehow
 526   # can't be retried, EVER, until someone manually clears it.  Totally
 527   # arbitrary fix: if the existing payment is more than two minutes old,
 528   # kill it.  This doesn't limit how long it can take the pending payment
 529   # to complete, only how long it will obstruct new payments.
 530   my @still_pending;
 531   foreach (@pending) {
 532     if ( time - $_->_date > 120 ) {
 533       my $error = $_->delete;
 534       warn "error deleting stale pending payment ".$_->paypendingnum.": $error"
 535         if $error; # not fatal, it will fail anyway
 536     }
 537     else {
 538       push @still_pending, $_;
 539     }
 540   }
 541   @pending = @still_pending;
 542
 543   return "A payment is already being processed for this customer (".
 544          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
 545          "); $options{method} transaction aborted."
 546     if scalar(@pending);
 547
 548   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
 549
 550   my $cust_pay_pending = new FS::cust_pay_pending {
 551     'custnum'           => $self->custnum,
 552     'paid'              => $options{amount},
 553     '_date'             => '',
 554     'payby'             => $bop_method2payby{$options{method}},
 555     'payinfo'           => $options{payinfo},
 556     'paydate'           => $paydate,
 557     'recurring_billing' => $content{recurring_billing},
 558     'pkgnum'            => $options{'pkgnum'},
 559     'status'            => 'new',
 560     'gatewaynum'        => $payment_gateway->gatewaynum || '',
 561     'session_id'        => $options{session_id} || '',
 562     'jobnum'            => $options{depend_jobnum} || '',
 563   };
 564   $cust_pay_pending->payunique( $options{payunique} )
 565     if defined($options{payunique}) && length($options{payunique});
 566   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
 567   return $cpp_new_err if $cpp_new_err;
 568
 569   my( $action1, $action2 ) =
 570     split( /\s*\,\s*/, $payment_gateway->gateway_action );
 571
 572   my $transaction = new $namespace( $payment_gateway->gateway_module,
 573                                     $self->_bop_options(\%options),
 574                                   );
 575
 576   $transaction->content(
 577     'type'           => $options{method},
 578     $self->_bop_auth(\%options),
 579     'action'         => $action1,
 580     'description'    => $options{'description'},
 581     'amount'         => $options{amount},
 582     #'invoice_number' => $options{'invnum'},
 583     'customer_id'    => $self->custnum,
 584     %$bop_content,
 585     'reference'      => $cust_pay_pending->paypendingnum, #for now
 586     'callback_url'   => $payment_gateway->gateway_callback_url,
 587     'email'          => $email,
 588     %content, #after
 589   );
 590
 591   $cust_pay_pending->status('pending');
 592   my $cpp_pending_err = $cust_pay_pending->replace;
 593   return $cpp_pending_err if $cpp_pending_err;
 594
 595   #config?
 596   my $BOP_TESTING = 0;
 597   my $BOP_TESTING_SUCCESS = 1;
 598
 599   unless ( $BOP_TESTING ) {
 600     $transaction->test_transaction(1)
 601       if $conf->exists('business-onlinepayment-test_transaction');
 602     $transaction->submit();
 603   } else {
 604     if ( $BOP_TESTING_SUCCESS ) {
 605       $transaction->is_success(1);
 606       $transaction->authorization('fake auth');
 607     } else {
 608       $transaction->is_success(0);
 609       $transaction->error_message('fake failure');
 610     }
 611   }
 612
 613   if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
 614
 615     return { reference => $cust_pay_pending->paypendingnum,
 616              map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
 617
 618   } elsif ( $transaction->is_success() && $action2 ) {
 619
 620     $cust_pay_pending->status('authorized');
 621     my $cpp_authorized_err = $cust_pay_pending->replace;
 622     return $cpp_authorized_err if $cpp_authorized_err;
 623
 624     my $auth = $transaction->authorization;
 625     my $ordernum = $transaction->can('order_number')
 626                    ? $transaction->order_number
 627                    : '';
 628
 629     my $capture =
 630       new Business::OnlinePayment( $payment_gateway->gateway_module,
 631                                    $self->_bop_options(\%options),
 632                                  );
 633
 634     my %capture = (
 635       %content,
 636       type           => $options{method},
 637       action         => $action2,
 638       $self->_bop_auth(\%options),
 639       order_number   => $ordernum,
 640       amount         => $options{amount},
 641       authorization  => $auth,
 642       description    => $options{'description'},
 643     );
 644
 645     foreach my $field (qw( authorization_source_code returned_ACI
 646                            transaction_identifier validation_code
 647                            transaction_sequence_num local_transaction_date
 648                            local_transaction_time AVS_result_code          )) {
 649       $capture{$field} = $transaction->$field() if $transaction->can($field);
 650     }
 651
 652     $capture->content( %capture );
 653
 654     $capture->test_transaction(1)
 655       if $conf->exists('business-onlinepayment-test_transaction');
 656     $capture->submit();
 657
 658     unless ( $capture->is_success ) {
 659       my $e = "Authorization successful but capture failed, custnum #".
 660               $self->custnum. ': '.  $capture->result_code.
 661               ": ". $capture->error_message;
 662       warn $e;
 663       return $e;
 664     }
 665
 666   }
 667
 668   ###
 669   # remove paycvv after initial transaction
 670   ###
 671
 672   #false laziness w/misc/process/payment.cgi - check both to make sure working
 673   # correctly
 674   if ( length($self->paycvv)
 675        && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
 676   ) {
 677     my $error = $self->remove_cvv;
 678     if ( $error ) {
 679       warn "WARNING: error removing cvv: $error\n";
 680     }
 681   }
 682
 683   ###
 684   # Tokenize
 685   ###
 686
 687
 688   if ( $transaction->can('card_token') && $transaction->card_token ) {
 689
 690     $self->card_token($transaction->card_token);
 691
 692     if ( $options{'payinfo'} eq $self->payinfo ) {
 693       $self->payinfo($transaction->card_token);
 694       my $error = $self->replace;
 695       if ( $error ) {
 696         warn "WARNING: error storing token: $error, but proceeding anyway\n";
 697       }
 698     }
 699
 700   }
 701
 702   ###
 703   # result handling
 704   ###
 705
 706   $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
 707
 708 }
 709
 710 =item fake_bop
 711
 712 =cut
 713
 714 sub fake_bop {
 715   my $self = shift;
 716
 717   my %options = ();
 718   if (ref($_[0]) eq 'HASH') {
 719     %options = %{$_[0]};
 720   } else {
 721     my ( $method, $amount ) = ( shift, shift );
 722     %options = @_;
 723     $options{method} = $method;
 724     $options{amount} = $amount;
 725   }
 726
 727   if ( $options{'fake_failure'} ) {
 728      return "Error: No error; test failure requested with fake_failure";
 729   }
 730
 731   #my $paybatch = '';
 732   #if ( $payment_gateway->gatewaynum ) { # agent override
 733   #  $paybatch = $payment_gateway->gatewaynum. '-';
 734   #}
 735   #
 736   #$paybatch .= "$processor:". $transaction->authorization;
 737   #
 738   #$paybatch .= ':'. $transaction->order_number
 739   #  if $transaction->can('order_number')
 740   #  && length($transaction->order_number);
 741
 742   my $paybatch = 'FakeProcessor:54:32';
 743
 744   my $cust_pay = new FS::cust_pay ( {
 745      'custnum'  => $self->custnum,
 746      'invnum'   => $options{'invnum'},
 747      'paid'     => $options{amount},
 748      '_date'    => '',
 749      'payby'    => $bop_method2payby{$options{method}},
 750      #'payinfo'  => $payinfo,
 751      'payinfo'  => '4111111111111111',
 752      'paybatch' => $paybatch,
 753      #'paydate'  => $paydate,
 754      'paydate'  => '2012-05-01',
 755   } );
 756   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
 757
 758   if ( $DEBUG ) {
 759       warn "fake_bop\n cust_pay: ". Dumper($cust_pay) . "\n options: ";
 760       warn "  $_ => $options{$_}\n" foreach keys %options;
 761   }
 762
 763   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
 764
 765   if ( $error ) {
 766     $cust_pay->invnum(''); #try again with no specific invnum
 767     my $error2 = $cust_pay->insert( $options{'manual'} ?
 768                                     ( 'manual' => 1 ) : ()
 769                                   );
 770     if ( $error2 ) {
 771       # gah, even with transactions.
 772       my $e = 'WARNING: Card/ACH debited but database not updated - '.
 773               "error inserting (fake!) payment: $error2".
 774               " (previously tried insert with invnum #$options{'invnum'}" .
 775               ": $error )";
 776       warn $e;
 777       return $e;
 778     }
 779   }
 780
 781   if ( $options{'paynum_ref'} ) {
 782     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
 783   }
 784
 785   return ''; #no error
 786
 787 }
 788
 789
 790 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
 791 #
 792 # Wraps up processing of a realtime credit card, ACH (electronic check) or
 793 # phone bill transaction.
 794
 795 sub _realtime_bop_result {
 796   my( $self, $cust_pay_pending, $transaction, %options ) = @_;
 797
 798   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 799
 800   if ( $DEBUG ) {
 801     warn "$me _realtime_bop_result: pending transaction ".
 802       $cust_pay_pending->paypendingnum. "\n";
 803     warn "  $_ => $options{$_}\n" foreach keys %options;
 804   }
 805
 806   my $payment_gateway = $options{payment_gateway}
 807     or return "no payment gateway in arguments to _realtime_bop_result";
 808
 809   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
 810   my $cpp_captured_err = $cust_pay_pending->replace;
 811   return $cpp_captured_err if $cpp_captured_err;
 812
 813   if ( $transaction->is_success() ) {
 814
 815     my $paybatch = '';
 816     if ( $payment_gateway->gatewaynum ) { # agent override
 817       $paybatch = $payment_gateway->gatewaynum. '-';
 818     }
 819
 820     $paybatch .= $payment_gateway->gateway_module. ":".
 821       $transaction->authorization;
 822
 823     $paybatch .= ':'. $transaction->order_number
 824       if $transaction->can('order_number')
 825       && length($transaction->order_number);
 826
 827     my $cust_pay = new FS::cust_pay ( {
 828        'custnum'  => $self->custnum,
 829        'invnum'   => $options{'invnum'},
 830        'paid'     => $cust_pay_pending->paid,
 831        '_date'    => '',
 832        'payby'    => $cust_pay_pending->payby,
 833        'payinfo'  => $options{'payinfo'},
 834        'paybatch' => $paybatch,
 835        'paydate'  => $cust_pay_pending->paydate,
 836        'pkgnum'   => $cust_pay_pending->pkgnum,
 837        'discount_term' => $options{'discount_term'},
 838     } );
 839     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
 840     $cust_pay->payunique( $options{payunique} )
 841       if defined($options{payunique}) && length($options{payunique});
 842
 843     my $oldAutoCommit = $FS::UID::AutoCommit;
 844     local $FS::UID::AutoCommit = 0;
 845     my $dbh = dbh;
 846
 847     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
 848
 849     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
 850
 851     if ( $error ) {
 852       $cust_pay->invnum(''); #try again with no specific invnum
 853       $cust_pay->paynum('');
 854       my $error2 = $cust_pay->insert( $options{'manual'} ?
 855                                       ( 'manual' => 1 ) : ()
 856                                     );
 857       if ( $error2 ) {
 858         # gah.  but at least we have a record of the state we had to abort in
 859         # from cust_pay_pending now.
 860         $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 861         my $e = "WARNING: $options{method} captured but payment not recorded -".
 862                 " error inserting payment (". $payment_gateway->gateway_module.
 863                 "): $error2".
 864                 " (previously tried insert with invnum #$options{'invnum'}" .
 865                 ": $error ) - pending payment saved as paypendingnum ".
 866                 $cust_pay_pending->paypendingnum. "\n";
 867         warn $e;
 868         return $e;
 869       }
 870     }
 871
 872     my $jobnum = $cust_pay_pending->jobnum;
 873     if ( $jobnum ) {
 874        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
 875
 876        unless ( $placeholder ) {
 877          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 878          my $e = "WARNING: $options{method} captured but job $jobnum not ".
 879              "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
 880          warn $e;
 881          return $e;
 882        }
 883
 884        $error = $placeholder->delete;
 885
 886        if ( $error ) {
 887          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 888          my $e = "WARNING: $options{method} captured but could not delete ".
 889               "job $jobnum for paypendingnum ".
 890               $cust_pay_pending->paypendingnum. ": $error\n";
 891          warn $e;
 892          return $e;
 893        }
 894
 895     }
 896
 897     if ( $options{'paynum_ref'} ) {
 898       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
 899     }
 900
 901     $cust_pay_pending->status('done');
 902     $cust_pay_pending->statustext('captured');
 903     $cust_pay_pending->paynum($cust_pay->paynum);
 904     my $cpp_done_err = $cust_pay_pending->replace;
 905
 906     if ( $cpp_done_err ) {
 907
 908       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 909       my $e = "WARNING: $options{method} captured but payment not recorded - ".
 910               "error updating status for paypendingnum ".
 911               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
 912       warn $e;
 913       return $e;
 914
 915     } else {
 916
 917       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 918
 919       if ( $options{'apply'} ) {
 920         my $apply_error = $self->apply_payments_and_credits;
 921         if ( $apply_error ) {
 922           warn "WARNING: error applying payment: $apply_error\n";
 923           #but we still should return no error cause the payment otherwise went
 924           #through...
 925         }
 926       }
 927
 928       # have a CC surcharge portion --> one-time charge
 929       if ( $options{'cc_surcharge'} > 0 ) {
 930             # XXX: this whole block needs to be in a transaction?
 931
 932           my $invnum;
 933           $invnum = $options{'invnum'} if $options{'invnum'};
 934           unless ( $invnum ) { # probably from a payment screen
 935              # do we have any open invoices? pick earliest
 936              # uses the fact that cust_main->cust_bill sorts by date ascending
 937              my @open = $self->open_cust_bill;
 938              $invnum = $open[0]->invnum if scalar(@open);
 939           }
 940
 941           unless ( $invnum ) {  # still nothing? pick last closed invoice
 942              # again uses fact that cust_main->cust_bill sorts by date ascending
 943              my @closed = $self->cust_bill;
 944              $invnum = $closed[$#closed]->invnum if scalar(@closed);
 945           }
 946
 947           unless ( $invnum ) {
 948             # XXX: unlikely case - pre-paying before any invoices generated
 949             # what it should do is create a new invoice and pick it
 950                 warn 'CC SURCHARGE AND NO INVOICES PICKED TO APPLY IT!';
 951                 return '';
 952           }
 953
 954           my $cust_pkg;
 955           my $charge_error = $self->charge({
 956                                     'amount'    => $options{'cc_surcharge'},
 957                                     'pkg'       => 'Credit Card Surcharge',
 958                                     'setuptax'  => 'Y',
 959                                     'cust_pkg_ref' => \$cust_pkg,
 960                                 });
 961           if($charge_error) {
 962                 warn 'Unable to add CC surcharge cust_pkg';
 963                 return '';
 964           }
 965
 966           $cust_pkg->setup(time);
 967           my $cp_error = $cust_pkg->replace;
 968           if($cp_error) {
 969               warn 'Unable to set setup time on cust_pkg for cc surcharge';
 970             # but keep going...
 971           }
 972
 973           my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
 974           unless ( $cust_bill ) {
 975               warn "race condition + invoice deletion just happened";
 976               return '';
 977           }
 978
 979           my $grand_error =
 980             $cust_bill->add_cc_surcharge($cust_pkg->pkgnum,$options{'cc_surcharge'});
 981
 982           warn "cannot add CC surcharge to invoice #$invnum: $grand_error"
 983             if $grand_error;
 984       }
 985
 986       return ''; #no error
 987
 988     }
 989
 990   } else {
 991
 992     my $perror = $payment_gateway->gateway_module. " error: ".
 993       $transaction->error_message;
 994
 995     my $jobnum = $cust_pay_pending->jobnum;
 996     if ( $jobnum ) {
 997        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
 998
 999        if ( $placeholder ) {
1000          my $error = $placeholder->depended_delete;
1001          $error ||= $placeholder->delete;
1002          warn "error removing provisioning jobs after declined paypendingnum ".
1003            $cust_pay_pending->paypendingnum. ": $error\n";
1004        } else {
1005          my $e = "error finding job $jobnum for declined paypendingnum ".
1006               $cust_pay_pending->paypendingnum. "\n";
1007          warn $e;
1008        }
1009
1010     }
1011
1012     unless ( $transaction->error_message ) {
1013
1014       my $t_response;
1015       if ( $transaction->can('response_page') ) {
1016         $t_response = {
1017                         'page'    => ( $transaction->can('response_page')
1018                                          ? $transaction->response_page
1019                                          : ''
1020                                      ),
1021                         'code'    => ( $transaction->can('response_code')
1022                                          ? $transaction->response_code
1023                                          : ''
1024                                      ),
1025                         'headers' => ( $transaction->can('response_headers')
1026                                          ? $transaction->response_headers
1027                                          : ''
1028                                      ),
1029                       };
1030       } else {
1031         $t_response .=
1032           "No additional debugging information available for ".
1033             $payment_gateway->gateway_module;
1034       }
1035
1036       $perror .= "No error_message returned from ".
1037                    $payment_gateway->gateway_module. " -- ".
1038                  ( ref($t_response) ? Dumper($t_response) : $t_response );
1039
1040     }
1041
1042     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
1043          && $conf->exists('emaildecline', $self->agentnum)
1044          && grep { $_ ne 'POST' } $self->invoicing_list
1045          && ! grep { $transaction->error_message =~ /$_/ }
1046                    $conf->config('emaildecline-exclude', $self->agentnum)
1047     ) {
1048
1049       # Send a decline alert to the customer.
1050       my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
1051       my $error = '';
1052       if ( $msgnum ) {
1053         # include the raw error message in the transaction state
1054         $cust_pay_pending->setfield('error', $transaction->error_message);
1055         my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1056         $error = $msg_template->send( 'cust_main' => $self,
1057                                       'object'    => $cust_pay_pending );
1058       }
1059       else { #!$msgnum
1060
1061         my @templ = $conf->config('declinetemplate');
1062         my $template = new Text::Template (
1063           TYPE   => 'ARRAY',
1064           SOURCE => [ map "$_\n", @templ ],
1065         ) or return "($perror) can't create template: $Text::Template::ERROR";
1066         $template->compile()
1067           or return "($perror) can't compile template: $Text::Template::ERROR";
1068
1069         my $templ_hash = {
1070           'company_name'    =>
1071             scalar( $conf->config('company_name', $self->agentnum ) ),
1072           'company_address' =>
1073             join("\n", $conf->config('company_address', $self->agentnum ) ),
1074           'error'           => $transaction->error_message,
1075         };
1076
1077         my $error = send_email(
1078           'from'    => $conf->config('invoice_from', $self->agentnum ),
1079           'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
1080           'subject' => 'Your payment could not be processed',
1081           'body'    => [ $template->fill_in(HASH => $templ_hash) ],
1082         );
1083       }
1084
1085       $perror .= " (also received error sending decline notification: $error)"
1086         if $error;
1087
1088     }
1089
1090     $cust_pay_pending->status('done');
1091     $cust_pay_pending->statustext("declined: $perror");
1092     my $cpp_done_err = $cust_pay_pending->replace;
1093     if ( $cpp_done_err ) {
1094       my $e = "WARNING: $options{method} declined but pending payment not ".
1095               "resolved - error updating status for paypendingnum ".
1096               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1097       warn $e;
1098       $perror = "$e ($perror)";
1099     }
1100
1101     return $perror;
1102   }
1103
1104 }
1105
1106 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
1107
1108 Verifies successful third party processing of a realtime credit card,
1109 ACH (electronic check) or phone bill transaction via a
1110 Business::OnlineThirdPartyPayment realtime gateway.  See
1111 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
1112
1113 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
1114
1115 The additional options I<payname>, I<city>, I<state>,
1116 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
1117 if set, will override the value from the customer record.
1118
1119 I<description> is a free-text field passed to the gateway.  It defaults to
1120 "Internet services".
1121
1122 If an I<invnum> is specified, this payment (if successful) is applied to the
1123 specified invoice.  If you don't specify an I<invnum> you might want to
1124 call the B<apply_payments> method.
1125
1126 I<quiet> can be set true to surpress email decline notices.
1127
1128 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
1129 resulting paynum, if any.
1130
1131 I<payunique> is a unique identifier for this payment.
1132
1133 Returns a hashref containing elements bill_error (which will be undefined
1134 upon success) and session_id of any associated session.
1135
1136 =cut
1137
1138 sub realtime_botpp_capture {
1139   my( $self, $cust_pay_pending, %options ) = @_;
1140
1141   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1142
1143   if ( $DEBUG ) {
1144     warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
1145     warn "  $_ => $options{$_}\n" foreach keys %options;
1146   }
1147
1148   eval "use Business::OnlineThirdPartyPayment";
1149   die $@ if $@;
1150
1151   ###
1152   # select the gateway
1153   ###
1154
1155   my $method = FS::payby->payby2bop($cust_pay_pending->payby);
1156
1157   my $payment_gateway;
1158   my $gatewaynum = $cust_pay_pending->getfield('gatewaynum');
1159   $payment_gateway = $gatewaynum ? qsearchs( 'payment_gateway',
1160                 { gatewaynum => $gatewaynum }
1161               )
1162     : $self->agent->payment_gateway( 'method' => $method,
1163                                      # 'invnum'  => $cust_pay_pending->invnum,
1164                                      # 'payinfo' => $cust_pay_pending->payinfo,
1165                                    );
1166
1167   $options{payment_gateway} = $payment_gateway; # for the helper subs
1168
1169   ###
1170   # massage data
1171   ###
1172
1173   my @invoicing_list = $self->invoicing_list_emailonly;
1174   if ( $conf->exists('emailinvoiceautoalways')
1175        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1176        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1177     push @invoicing_list, $self->all_emails;
1178   }
1179
1180   my $email = ($conf->exists('business-onlinepayment-email-override'))
1181               ? $conf->config('business-onlinepayment-email-override')
1182               : $invoicing_list[0];
1183
1184   my %content = ();
1185
1186   $content{email_customer} =
1187     (    $conf->exists('business-onlinepayment-email_customer')
1188       || $conf->exists('business-onlinepayment-email-override') );
1189
1190   ###
1191   # run transaction(s)
1192   ###
1193
1194   my $transaction =
1195     new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
1196                                            $self->_bop_options(\%options),
1197                                          );
1198
1199   $transaction->reference({ %options });
1200
1201   $transaction->content(
1202     'type'           => $method,
1203     $self->_bop_auth(\%options),
1204     'action'         => 'Post Authorization',
1205     'description'    => $options{'description'},
1206     'amount'         => $cust_pay_pending->paid,
1207     #'invoice_number' => $options{'invnum'},
1208     'customer_id'    => $self->custnum,
1209     'referer'        => 'http://cleanwhisker.420.am/',
1210     'reference'      => $cust_pay_pending->paypendingnum,
1211     'email'          => $email,
1212     'phone'          => $self->daytime || $self->night,
1213     %content, #after
1214     # plus whatever is required for bogus capture avoidance
1215   );
1216
1217   $transaction->submit();
1218
1219   my $error =
1220     $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
1221
1222   if ( $options{'apply'} ) {
1223     my $apply_error = $self->apply_payments_and_credits;
1224     if ( $apply_error ) {
1225       warn "WARNING: error applying payment: $apply_error\n";
1226     }
1227   }
1228
1229   return {
1230     bill_error => $error,
1231     session_id => $cust_pay_pending->session_id,
1232   }
1233
1234 }
1235
1236 =item default_payment_gateway
1237
1238 DEPRECATED -- use agent->payment_gateway
1239
1240 =cut
1241
1242 sub default_payment_gateway {
1243   my( $self, $method ) = @_;
1244
1245   die "Real-time processing not enabled\n"
1246     unless $conf->exists('business-onlinepayment');
1247
1248   #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
1249
1250   #load up config
1251   my $bop_config = 'business-onlinepayment';
1252   $bop_config .= '-ach'
1253     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
1254   my ( $processor, $login, $password, $action, @bop_options ) =
1255     $conf->config($bop_config);
1256   $action ||= 'normal authorization';
1257   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
1258   die "No real-time processor is enabled - ".
1259       "did you set the business-onlinepayment configuration value?\n"
1260     unless $processor;
1261
1262   ( $processor, $login, $password, $action, @bop_options )
1263 }
1264
1265 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
1266
1267 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
1268 via a Business::OnlinePayment realtime gateway.  See
1269 L<http://420.am/business-onlinepayment> for supported gateways.
1270
1271 Available methods are: I<CC>, I<ECHECK> and I<LEC>
1272
1273 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
1274
1275 Most gateways require a reference to an original payment transaction to refund,
1276 so you probably need to specify a I<paynum>.
1277
1278 I<amount> defaults to the original amount of the payment if not specified.
1279
1280 I<reason> specifies a reason for the refund.
1281
1282 I<paydate> specifies the expiration date for a credit card overriding the
1283 value from the customer record or the payment record. Specified as yyyy-mm-dd
1284
1285 Implementation note: If I<amount> is unspecified or equal to the amount of the
1286 orignal payment, first an attempt is made to "void" the transaction via
1287 the gateway (to cancel a not-yet settled transaction) and then if that fails,
1288 the normal attempt is made to "refund" ("credit") the transaction via the
1289 gateway is attempted.
1290
1291 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
1292 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
1293 #if set, will override the value from the customer record.
1294
1295 #If an I<invnum> is specified, this payment (if successful) is applied to the
1296 #specified invoice.  If you don't specify an I<invnum> you might want to
1297 #call the B<apply_payments> method.
1298
1299 =cut
1300
1301 #some false laziness w/realtime_bop, not enough to make it worth merging
1302 #but some useful small subs should be pulled out
1303 sub realtime_refund_bop {
1304   my $self = shift;
1305
1306   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1307
1308   my %options = ();
1309   if (ref($_[0]) eq 'HASH') {
1310     %options = %{$_[0]};
1311   } else {
1312     my $method = shift;
1313     %options = @_;
1314     $options{method} = $method;
1315   }
1316
1317   if ( $DEBUG ) {
1318     warn "$me realtime_refund_bop (new): $options{method} refund\n";
1319     warn "  $_ => $options{$_}\n" foreach keys %options;
1320   }
1321
1322   ###
1323   # look up the original payment and optionally a gateway for that payment
1324   ###
1325
1326   my $cust_pay = '';
1327   my $amount = $options{'amount'};
1328
1329   my( $processor, $login, $password, @bop_options, $namespace ) ;
1330   my( $auth, $order_number ) = ( '', '', '' );
1331
1332   if ( $options{'paynum'} ) {
1333
1334     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
1335     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
1336       or return "Unknown paynum $options{'paynum'}";
1337     $amount ||= $cust_pay->paid;
1338
1339     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
1340       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
1341                 $cust_pay->paybatch;
1342     my $gatewaynum = '';
1343     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
1344
1345     if ( $gatewaynum ) { #gateway for the payment to be refunded
1346
1347       my $payment_gateway =
1348         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
1349       die "payment gateway $gatewaynum not found"
1350         unless $payment_gateway;
1351
1352       $processor   = $payment_gateway->gateway_module;
1353       $login       = $payment_gateway->gateway_username;
1354       $password    = $payment_gateway->gateway_password;
1355       $namespace   = $payment_gateway->gateway_namespace;
1356       @bop_options = $payment_gateway->options;
1357
1358     } else { #try the default gateway
1359
1360       my $conf_processor;
1361       my $payment_gateway =
1362         $self->agent->payment_gateway('method' => $options{method});
1363
1364       ( $conf_processor, $login, $password, $namespace ) =
1365         map { my $method = "gateway_$_"; $payment_gateway->$method }
1366           qw( module username password namespace );
1367
1368       @bop_options = $payment_gateway->gatewaynum
1369                        ? $payment_gateway->options
1370                        : @{ $payment_gateway->get('options') };
1371
1372       return "processor of payment $options{'paynum'} $processor does not".
1373              " match default processor $conf_processor"
1374         unless $processor eq $conf_processor;
1375
1376     }
1377
1378
1379   } else { # didn't specify a paynum, so look for agent gateway overrides
1380            # like a normal transaction
1381
1382     my $payment_gateway =
1383       $self->agent->payment_gateway( 'method'  => $options{method},
1384                                      #'payinfo' => $payinfo,
1385                                    );
1386     my( $processor, $login, $password, $namespace ) =
1387       map { my $method = "gateway_$_"; $payment_gateway->$method }
1388         qw( module username password namespace );
1389
1390     my @bop_options = $payment_gateway->gatewaynum
1391                         ? $payment_gateway->options
1392                         : @{ $payment_gateway->get('options') };
1393
1394   }
1395   return "neither amount nor paynum specified" unless $amount;
1396
1397   eval "use $namespace";
1398   die $@ if $@;
1399
1400   my %content = (
1401     'type'           => $options{method},
1402     'login'          => $login,
1403     'password'       => $password,
1404     'order_number'   => $order_number,
1405     'amount'         => $amount,
1406     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
1407   );
1408   $content{authorization} = $auth
1409     if length($auth); #echeck/ACH transactions have an order # but no auth
1410                       #(at least with authorize.net)
1411
1412   my $disable_void_after;
1413   if ($conf->exists('disable_void_after')
1414       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
1415     $disable_void_after = $1;
1416   }
1417
1418   #first try void if applicable
1419   if ( $cust_pay && $cust_pay->paid == $amount
1420     && (
1421       ( not defined($disable_void_after) )
1422       || ( time < ($cust_pay->_date + $disable_void_after ) )
1423     )
1424   ) {
1425     warn "  attempting void\n" if $DEBUG > 1;
1426     my $void = new Business::OnlinePayment( $processor, @bop_options );
1427     if ( $void->can('info') ) {
1428       if ( $cust_pay->payby eq 'CARD'
1429            && $void->info('CC_void_requires_card') )
1430       {
1431         $content{'card_number'} = $cust_pay->payinfo;
1432       } elsif ( $cust_pay->payby eq 'CHEK'
1433                 && $void->info('ECHECK_void_requires_account') )
1434       {
1435         ( $content{'account_number'}, $content{'routing_code'} ) =
1436           split('@', $cust_pay->payinfo);
1437         $content{'name'} = $self->get('first'). ' '. $self->get('last');
1438       }
1439     }
1440     $void->content( 'action' => 'void', %content );
1441     $void->test_transaction(1)
1442       if $conf->exists('business-onlinepayment-test_transaction');
1443     $void->submit();
1444     if ( $void->is_success ) {
1445       my $error = $cust_pay->void($options{'reason'});
1446       if ( $error ) {
1447         # gah, even with transactions.
1448         my $e = 'WARNING: Card/ACH voided but database not updated - '.
1449                 "error voiding payment: $error";
1450         warn $e;
1451         return $e;
1452       }
1453       warn "  void successful\n" if $DEBUG > 1;
1454       return '';
1455     }
1456   }
1457
1458   warn "  void unsuccessful, trying refund\n"
1459     if $DEBUG > 1;
1460
1461   #massage data
1462   my $address = $self->address1;
1463   $address .= ", ". $self->address2 if $self->address2;
1464
1465   my($payname, $payfirst, $paylast);
1466   if ( $self->payname && $options{method} ne 'ECHECK' ) {
1467     $payname = $self->payname;
1468     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
1469       or return "Illegal payname $payname";
1470     ($payfirst, $paylast) = ($1, $2);
1471   } else {
1472     $payfirst = $self->getfield('first');
1473     $paylast = $self->getfield('last');
1474     $payname =  "$payfirst $paylast";
1475   }
1476
1477   my @invoicing_list = $self->invoicing_list_emailonly;
1478   if ( $conf->exists('emailinvoiceautoalways')
1479        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1480        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1481     push @invoicing_list, $self->all_emails;
1482   }
1483
1484   my $email = ($conf->exists('business-onlinepayment-email-override'))
1485               ? $conf->config('business-onlinepayment-email-override')
1486               : $invoicing_list[0];
1487
1488   my $payip = exists($options{'payip'})
1489                 ? $options{'payip'}
1490                 : $self->payip;
1491   $content{customer_ip} = $payip
1492     if length($payip);
1493
1494   my $payinfo = '';
1495   if ( $options{method} eq 'CC' ) {
1496
1497     if ( $cust_pay ) {
1498       $content{card_number} = $payinfo = $cust_pay->payinfo;
1499       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
1500         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
1501         ($content{expiration} = "$2/$1");  # where available
1502     } else {
1503       $content{card_number} = $payinfo = $self->payinfo;
1504       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
1505         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1506       $content{expiration} = "$2/$1";
1507     }
1508
1509   } elsif ( $options{method} eq 'ECHECK' ) {
1510
1511     if ( $cust_pay ) {
1512       $payinfo = $cust_pay->payinfo;
1513     } else {
1514       $payinfo = $self->payinfo;
1515     }
1516     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
1517     $content{bank_name} = $self->payname;
1518     $content{account_type} = 'CHECKING';
1519     $content{account_name} = $payname;
1520     $content{customer_org} = $self->company ? 'B' : 'I';
1521     $content{customer_ssn} = $self->ss;
1522   } elsif ( $options{method} eq 'LEC' ) {
1523     $content{phone} = $payinfo = $self->payinfo;
1524   }
1525
1526   #then try refund
1527   my $refund = new Business::OnlinePayment( $processor, @bop_options );
1528   my %sub_content = $refund->content(
1529     'action'         => 'credit',
1530     'customer_id'    => $self->custnum,
1531     'last_name'      => $paylast,
1532     'first_name'     => $payfirst,
1533     'name'           => $payname,
1534     'address'        => $address,
1535     'city'           => $self->city,
1536     'state'          => $self->state,
1537     'zip'            => $self->zip,
1538     'country'        => $self->country,
1539     'email'          => $email,
1540     'phone'          => $self->daytime || $self->night,
1541     %content, #after
1542   );
1543   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
1544     if $DEBUG > 1;
1545   $refund->test_transaction(1)
1546     if $conf->exists('business-onlinepayment-test_transaction');
1547   $refund->submit();
1548
1549   return "$processor error: ". $refund->error_message
1550     unless $refund->is_success();
1551
1552   my $paybatch = "$processor:". $refund->authorization;
1553   $paybatch .= ':'. $refund->order_number
1554     if $refund->can('order_number') && $refund->order_number;
1555
1556   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
1557     my @cust_bill_pay = $cust_pay->cust_bill_pay;
1558     last unless @cust_bill_pay;
1559     my $cust_bill_pay = pop @cust_bill_pay;
1560     my $error = $cust_bill_pay->delete;
1561     last if $error;
1562   }
1563
1564   my $cust_refund = new FS::cust_refund ( {
1565     'custnum'  => $self->custnum,
1566     'paynum'   => $options{'paynum'},
1567     'refund'   => $amount,
1568     '_date'    => '',
1569     'payby'    => $bop_method2payby{$options{method}},
1570     'payinfo'  => $payinfo,
1571     'paybatch' => $paybatch,
1572     'reason'   => $options{'reason'} || 'card or ACH refund',
1573   } );
1574   my $error = $cust_refund->insert;
1575   if ( $error ) {
1576     $cust_refund->paynum(''); #try again with no specific paynum
1577     my $error2 = $cust_refund->insert;
1578     if ( $error2 ) {
1579       # gah, even with transactions.
1580       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
1581               "error inserting refund ($processor): $error2".
1582               " (previously tried insert with paynum #$options{'paynum'}" .
1583               ": $error )";
1584       warn $e;
1585       return $e;
1586     }
1587   }
1588
1589   ''; #no error
1590
1591 }
1592
1593 =back
1594
1595 =head1 BUGS
1596
1597 Not autoloaded.
1598
1599 =head1 SEE ALSO
1600
1601 L<FS::cust_main>, L<FS::cust_main::Billing>
1602
1603 =cut
1604
1605 1;