1 package FS::cust_pay_batch;
4 use vars qw( @ISA $DEBUG );
5 use Carp qw( confess );
6 use Business::CreditCard 0.28;
7 use FS::Record qw(dbh qsearch qsearchs);
12 @ISA = qw( FS::payinfo_Mixin FS::cust_main_Mixin FS::Record );
14 # 1 is mostly method/subroutine entry and options
15 # 2 traces progress of some operations
16 # 3 is even more information including possibly sensitive data
19 #@encrypted_fields = ('payinfo');
20 sub nohistory_fields { ('payinfo'); }
24 FS::cust_pay_batch - Object methods for batch cards
28 use FS::cust_pay_batch;
30 $record = new FS::cust_pay_batch \%hash;
31 $record = new FS::cust_pay_batch { 'column' => 'value' };
33 $error = $record->insert;
35 $error = $new_record->replace($old_record);
37 $error = $record->delete;
39 $error = $record->check;
41 #deprecated# $error = $record->retriable;
45 An FS::cust_pay_batch object represents a credit card transaction ready to be
46 batched (sent to a processor). FS::cust_pay_batch inherits from FS::Record.
47 Typically called by the collect method of an FS::cust_main object. The
48 following fields are currently supported:
52 =item paybatchnum - primary key (automatically assigned)
54 =item batchnum - indentifies group in batch
56 =item payby - CARD/CHEK/LECB/BILL/COMP
60 =item exp - card expiration
64 =item invnum - invoice
66 =item custnum - customer
68 =item payname - name on card
86 =item status - 'Approved' or 'Declined'
88 =item error_message - the error returned by the gateway if any
98 Creates a new record. To add the record to the database, see L<"insert">.
100 Note that this stores the hash reference, not a distinct copy of the hash it
101 points to. You can ask the object for a copy with the I<hash> method.
105 sub table { 'cust_pay_batch'; }
109 Adds this record to the database. If there is an error, returns the error,
110 otherwise returns false.
114 Delete this record from the database. If there is an error, returns the error,
115 otherwise returns false.
117 =item replace OLD_RECORD
119 Replaces the OLD_RECORD with this one in the database. If there is an error,
120 returns the error, otherwise returns false.
124 Checks all fields to make sure this is a valid transaction. If there is
125 an error, returns the error, otherwise returns false. Called by the insert
133 my $conf = new FS::Conf;
136 $self->ut_numbern('paybatchnum')
137 || $self->ut_numbern('trancode') #deprecated
138 || $self->ut_money('amount')
139 || $self->ut_number('invnum')
140 || $self->ut_number('custnum')
141 || $self->ut_text('address1')
142 || $self->ut_textn('address2')
143 || ($conf->exists('cust_main-no_city_in_address')
144 ? $self->ut_textn('city')
145 : $self->ut_text('city'))
146 || $self->ut_textn('state')
149 return $error if $error;
151 $self->getfield('last') =~ /^([\w \,\.\-\']+)$/ or return "Illegal last name";
152 $self->setfield('last',$1);
154 $self->first =~ /^([\w \,\.\-\']+)$/ or return "Illegal first name";
157 $error = $self->payinfo_check();
158 return $error if $error;
160 if ( $self->exp eq '' ) {
161 return "Expiration date required"
162 unless $self->payby =~ /^(CHEK|DCHK|LECB|WEST)$/;
165 if ( $self->exp =~ /^(\d{4})[\/\-](\d{1,2})[\/\-](\d{1,2})$/ ) {
166 $self->exp("$1-$2-$3");
167 } elsif ( $self->exp =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
168 if ( length($2) == 4 ) {
169 $self->exp("$2-$1-01");
170 } elsif ( $2 > 98 ) { #should pry change to check for "this year"
171 $self->exp("19$2-$1-01");
173 $self->exp("20$2-$1-01");
176 return "Illegal expiration date";
180 if ( $self->payname eq '' ) {
181 $self->payname( $self->first. " ". $self->getfield('last') );
183 $self->payname =~ /^([\w \,\.\-\']+)$/
184 or return "Illegal billing name";
188 #we have lots of old zips in there... don't hork up batch results cause of em
189 $self->zip =~ /^\s*(\w[\w\-\s]{2,8}\w)\s*$/
190 or return "Illegal zip: ". $self->zip;
193 $self->country =~ /^(\w\w)$/ or return "Illegal country: ". $self->country;
196 #$error = $self->ut_zip('zip', $self->country);
197 #return $error if $error;
199 #check invnum, custnum, ?
206 Returns the customer (see L<FS::cust_main>) for this batched credit card
213 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
218 Returns the credit card expiration date in MMYY format. If this is a
219 CHEK payment, returns an empty string.
225 if ( $self->payby eq 'CARD' ) {
226 $self->get('exp') =~ /^(\d{4})-(\d{2})-(\d{2})$/;
227 return sprintf('%02u%02u', $2, ($1 % 100));
236 Returns the payment batch this payment belongs to (L<FS::pay_batch).
242 FS::pay_batch->by_key($self->batchnum);
245 #you know what, screw this in the new world of events. we should be able to
246 #get the event defs to retry (remove once.pm condition, add every.pm) without
247 #mucking about with statuses of previous cust_event records. right?
251 #Marks the corresponding event (see L<FS::cust_bill_event>) for this batched
252 #credit card payment as retriable. Useful if the corresponding financial
253 #institution account was declined for temporary reasons and/or a manual
256 #Implementation details: For the named customer's invoice, changes the
257 #statustext of the 'done' (without statustext) event to 'retriable.'
263 confess "deprecated method cust_pay_batch->retriable called; try removing ".
264 "the once condition and adding an every condition?";
268 local $SIG{HUP} = 'IGNORE'; #Hmm
269 local $SIG{INT} = 'IGNORE';
270 local $SIG{QUIT} = 'IGNORE';
271 local $SIG{TERM} = 'IGNORE';
272 local $SIG{TSTP} = 'IGNORE';
273 local $SIG{PIPE} = 'IGNORE';
275 my $oldAutoCommit = $FS::UID::AutoCommit;
276 local $FS::UID::AutoCommit = 0;
279 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
280 or return "event $self->eventnum references nonexistant invoice $self->invnum";
282 warn "cust_pay_batch->retriable working with self of " . $self->paybatchnum . " and invnum of " . $self->invnum;
283 my @cust_bill_event =
284 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
286 $_->part_bill_event->eventcode =~ /\$cust_bill->batch_card/
287 && $_->status eq 'done'
290 $cust_bill->cust_bill_event;
291 # complain loudly if scalar(@cust_bill_event) > 1 ?
292 my $error = $cust_bill_event[0]->retriable;
294 # gah, even with transactions.
295 $dbh->commit if $oldAutoCommit; #well.
296 return "error marking invoice event retriable: $error";
301 =item approve OPTIONS
303 Approve this payment. This will replace the existing record with the
304 same paybatchnum, set its status to 'Approved', and generate a payment
305 record (L<FS::cust_pay>). This should only be called from the batch
308 OPTIONS may contain "gatewaynum", "processor", "auth", and "order_number".
313 # to break up the Big Wall of Code that is import_results
316 my $paybatchnum = $new->paybatchnum;
317 my $old = qsearchs('cust_pay_batch', { paybatchnum => $paybatchnum })
318 or return "cannot approve, paybatchnum $paybatchnum not found";
319 # leave these restrictions in place until TD EFT is converted over
321 return "cannot approve paybatchnum $paybatchnum, already resolved ('".$old->status."')"
323 $new->status('Approved');
324 my $error = $new->replace($old);
326 return "error approving paybatchnum $paybatchnum: $error\n";
328 my $cust_pay = new FS::cust_pay ( {
329 'custnum' => $new->custnum,
330 'payby' => $new->payby,
331 'payinfo' => $new->payinfo || $old->payinfo,
332 'paid' => $new->paid,
333 '_date' => $new->_date,
334 'usernum' => $new->usernum,
335 'batchnum' => $new->batchnum,
336 'gatewaynum' => $opt{'gatewaynum'},
337 'processor' => $opt{'processor'},
338 'auth' => $opt{'auth'},
339 'order_number' => $opt{'order_number'}
342 $error = $cust_pay->insert;
344 return "error inserting payment for paybatchnum $paybatchnum: $error\n";
346 $cust_pay->cust_main->apply_payments;
350 =item decline [ REASON ]
352 Decline this payment. This will replace the existing record with the
353 same paybatchnum, set its status to 'Declined', and run collection events
354 as appropriate. This should only be called from the batch import process.
356 REASON is a string description of the decline reason, defaulting to
363 my $reason = shift || 'Returned payment';
364 #my $conf = new FS::Conf;
366 my $paybatchnum = $new->paybatchnum;
367 my $old = qsearchs('cust_pay_batch', { paybatchnum => $paybatchnum })
368 or return "cannot decline, paybatchnum $paybatchnum not found";
369 if ( $old->status ) {
370 # Handle the case where payments are rejected after the batch has been
371 # approved. FS::pay_batch::import_results won't allow results to be
372 # imported to a closed batch unless batch-manual_approval is enabled,
373 # so we don't check it here.
374 # if ( $conf->exists('batch-manual_approval') and
375 if ( lc($old->status) eq 'approved' ) {
377 my $cust_pay = qsearchs('cust_pay', {
378 custnum => $new->custnum,
379 batchnum => $new->batchnum
381 # these should all be migrated over, but if it's not found, look for
382 # batchnum in the 'paybatch' field also
383 $cust_pay ||= qsearchs('cust_pay', {
384 custnum => $new->custnum,
385 paybatch => $new->batchnum
388 # should never happen...
389 return "failed to revoke paybatchnum $paybatchnum, payment not found";
391 $cust_pay->void($reason);
394 # normal case: refuse to do anything
395 return "cannot decline paybatchnum $paybatchnum, already resolved ('".$old->status."')";
398 $new->status('Declined');
399 $new->error_message($reason);
400 my $error = $new->replace($old);
402 return "error declining paybatchnum $paybatchnum: $error\n";
404 my $due_cust_event = $new->cust_main->due_cust_event(
405 'eventtable' => 'cust_pay_batch',
406 'objects' => [ $new ],
408 if ( !ref($due_cust_event) ) {
409 return $due_cust_event;
411 # XXX breaks transaction integrity
412 foreach my $cust_event (@$due_cust_event) {
413 next unless $cust_event->test_conditions;
414 if ( my $error = $cust_event->do_event() ) {
421 =item request_item [ OPTIONS ]
423 Returns a L<Business::BatchPayment::Item> object for this batch payment
424 entry. This can be submitted to a processor.
426 OPTIONS can be a list of key/values to append to the attributes. The most
427 useful case of this is "process_date" to set a processing date based on the
428 date the batch is being submitted.
436 eval "use Business::BatchPayment;";
437 die "couldn't load Business::BatchPayment: $@" if $@;
439 my $cust_main = $self->cust_main;
440 my $location = $cust_main->bill_location;
441 my $pay_batch = $self->pay_batch;
444 $payment{payment_type} = FS::payby->payby2bop( $pay_batch->payby );
445 if ( $payment{payment_type} eq 'CC' ) {
446 $payment{card_number} = $self->payinfo,
447 $payment{expiration} = $self->expmmyy,
448 } elsif ( $payment{payment_type} eq 'ECHECK' ) {
449 $self->payinfo =~ /(\d+)@(\d+)/; # or else what?
450 $payment{account_number} = $1;
451 $payment{routing_code} = $2;
452 $payment{account_type} = $cust_main->paytype;
453 # XXX what if this isn't their regular payment method?
455 die "unsupported BatchPayment method: ".$pay_batch->payby;
458 Business::BatchPayment->create(Item =>
461 tid => $self->paybatchnum,
462 amount => $self->amount,
465 customer_id => $self->custnum,
466 first_name => $cust_main->first,
467 last_name => $cust_main->last,
468 company => $cust_main->company,
469 address => $location->address1,
470 ( map { $_ => $location->$_ } qw(address2 city state country zip) ),
472 invoice_number => $self->invnum,
481 There should probably be a configuration file with a list of allowed credit
486 L<FS::cust_main>, L<FS::Record>