1 package FS::payinfo_Mixin;
4 use Business::CreditCard;
6 use FS::Record qw(qsearch);
7 use FS::UID qw(driver_name);
9 use Time::Local qw(timelocal);
11 # allow_closed_replace only relevant to cust_pay/cust_refund, for upgrade tokenizing
12 use vars qw( $ignore_masked_payinfo $allow_closed_replace );
16 FS::payinfo_Mixin - Mixin class for records in tables that contain payinfo.
20 package FS::some_table;
22 @ISA = qw( FS::payinfo_Mixin FS::Record );
26 This is a mixin class for records that contain payinfo.
34 The following payment types (payby) are supported:
36 For Customers (cust_main):
37 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
38 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
39 'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or
40 'PREPAY' (special billing type: applies a credit and sets billing type to I<BILL> - see L<FS::prepay_credit>)
42 For Refunds (cust_refund):
43 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
44 'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash),
45 'WEST' (Western Union), 'MCRD' (Manual credit card), 'MCHK' (Manual electronic
46 check), 'CBAK' Chargeback, or 'COMP' (free)
49 For Payments (cust_pay):
50 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
51 'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
52 'CASH' (cash), 'WEST' (Western Union), 'MCRD' (Manual credit card), 'MCHK'
53 (Manual electronic check), 'PPAL' (PayPal)
54 'COMP' (free) is depricated as a payment type in cust_pay
60 Payment information (payinfo) can be one of the following types:
62 Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username)
63 prepayment identifier (see L<FS::prepay_credit>), PayPal transaction ID
68 my($self,$payinfo) = @_;
70 if ( defined($payinfo) ) {
71 $self->paymask($self->mask_payinfo) unless $self->getfield('paymask') || $self->tokenized; #make sure old mask is set
72 $self->setfield('payinfo', $payinfo);
73 $self->paymask($self->mask_payinfo) unless $self->tokenized($payinfo); #remask unless tokenizing
75 $self->getfield('payinfo');
81 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
85 #this prevents encrypting empty values on insert?
87 my($self,$paycvv) = @_;
88 # This is only allowed in cust_payby (formerly cust_main)
89 # It shouldn't be stored longer than necessary to run the first transaction
90 if ( defined($paycvv) ) {
91 $self->setfield('paycvv', $paycvv);
93 $self->getfield('paycvv');
102 my($self, $paymask) = @_;
104 if ( defined($paymask) ) {
105 $self->setfield('paymask', $paymask);
107 $self->getfield('paymask') || $self->mask_payinfo;
117 =item mask_payinfo [ PAYBY, PAYINFO ]
119 This method converts the payment info (credit card, bank account, etc.) into a
122 Optionally, an arbitrary payby and payinfo can be passed.
128 my $payby = scalar(@_) ? shift : $self->payby;
129 my $payinfo = scalar(@_) ? shift : $self->payinfo;
131 # Check to see if it's encrypted...
132 if ( ref($self) && $self->is_encrypted($payinfo) ) {
134 } elsif ( $self->tokenized($payinfo) || $payinfo eq 'N/A' ) { #token
135 return 'N/A (tokenized)'; #?
136 } else { # if not, mask it...
138 if ($payby eq 'CARD' || $payby eq 'DCRD') {
139 #|| $payby eq 'MCRD') {
140 #MCRD isn't a card in payinfo,
141 #its a record of an _offline_
146 # special handling for Local Isracards: always show last 4
147 if ( $payinfo =~ /^(\d{8,9})$/ ) {
149 return 'x'x(length($payinfo)-4).
150 substr($payinfo,(length($payinfo)-4));
154 my $conf = new FS::Conf;
155 my $mask_method = $conf->config('card_masking_method') || 'first6last4';
156 $mask_method =~ /^first(\d+)last(\d+)$/
157 or die "can't parse card_masking_method $mask_method";
158 my($first, $last) = ($1, $2);
160 return substr($payinfo,0,$first).
161 'x'x(length($payinfo)-$first-$last).
162 substr($payinfo,(length($payinfo)-$last));
164 } elsif ($payby eq 'CHEK' || $payby eq 'DCHK' ) {
166 # Checks (Show last 2 @ bank)
167 my( $account, $aba ) = split('@', $payinfo );
168 return 'x'x(length($account)-2).
169 substr($account,(length($account)-2)).
170 ( length($aba) ? "@".$aba : '');
172 } elsif ($payby eq 'EDI') {
174 # These numbers have been seen anywhere from 8 to 30 digits, and
175 # possibly more. Lacking any better idea I'm going to mask all but
177 return 'x' x (length($payinfo) - 4) . substr($payinfo, -4);
179 } else { # Tie up loose ends
183 #die "shouldn't be reached";
188 Checks payby and payinfo.
195 FS::payby->can_payby($self->table, $self->payby)
196 or return "Illegal payby: ". $self->payby;
198 if ( $self->payby eq 'CARD' && ! $self->is_encrypted($self->payinfo) ) {
200 my $payinfo = $self->payinfo;
201 my $cardtype = cardtype($payinfo);
202 $cardtype = 'Tokenized' if $self->tokenized;
203 $self->set('paycardtype', $cardtype);
205 if ( $ignore_masked_payinfo and $self->mask_payinfo eq $self->payinfo ) {
209 $self->payinfo($payinfo);
210 if ( $self->payinfo ) {
211 $self->payinfo =~ /^(\d{13,16}|\d{8,9})$/
212 or return "Illegal (mistyped?) credit card number (payinfo)";
214 validate($self->payinfo) or return "Illegal credit card number";
215 return "Unknown card type" if $cardtype eq "Unknown";
217 $self->payinfo('N/A'); #??? re-masks card
221 if ( $self->payby eq 'CARD' and $self->paymask ) {
222 # if we can't decrypt the card, at least detect the cardtype
223 $self->set('paycardtype', cardtype($self->paymask));
225 $self->set('paycardtype', '');
227 if ( $self->is_encrypted($self->payinfo) ) {
228 #something better? all it would cause is a decryption error anyway?
229 my $error = $self->ut_anything('payinfo');
230 return $error if $error;
232 my $error = $self->ut_textn('payinfo');
233 return $error if $error;
240 =item payby_payinfo_pretty [ LOCALE ]
242 Returns payment method and information (suitably masked, if applicable) as
243 a human-readable string, such as:
245 Card #54xxxxxxxxxxxx32
253 sub payby_payinfo_pretty {
256 my $lh = FS::L10N->get_handle($locale);
257 if ( $self->payby eq 'CARD' ) {
258 if ($self->paymask =~ /tokenized/) {
259 $lh->maketext('Tokenized Card');
261 $lh->maketext('Card #') . $self->paymask;
263 } elsif ( $self->payby eq 'CHEK' ) {
265 #false laziness w/view/cust_main/payment_history.html::translate_payinfo
266 my( $account, $aba ) = split('@', $self->paymask );
268 if ( $aba =~ /^(\d{5})\.(\d{3})$/ ) { #blame canada
269 my($branch, $routing) = ($1, $2);
270 $lh->maketext("Routing [_1], Branch [_2], Acct [_3]",
271 $routing, $branch, $account);
273 $lh->maketext("Routing [_1], Acct [_2]", $aba, $account);
276 } elsif ( $self->payby eq 'BILL' ) {
277 $lh->maketext('Check #') . $self->payinfo;
278 } elsif ( $self->payby eq 'PREP' ) {
279 $lh->maketext('Prepaid card #') . $self->payinfo;
280 } elsif ( $self->payby eq 'CASH' ) {
281 $lh->maketext('Cash') . ' ' . $self->payinfo;
282 } elsif ( $self->payby eq 'WEST' ) {
283 # does Western Union localize their name?
284 $lh->maketext('Western Union');
285 } elsif ( $self->payby eq 'MCRD' ) {
286 $lh->maketext('Manual credit card');
287 } elsif ( $self->payby eq 'MCHK' ) {
288 $lh->maketext('Manual electronic check');
289 } elsif ( $self->payby eq 'EDI' ) {
290 $lh->maketext('EDI') . ' ' . $self->paymask;
291 } elsif ( $self->payby eq 'PPAL' ) {
292 $lh->maketext('PayPal transaction#') . $self->order_number;
294 $self->payby. ' '. $self->payinfo;
298 =item payinfo_used [ PAYINFO ]
300 Returns 1 if there's an existing payment using this payinfo. This can be
301 used to set the 'recurring payment' flag required by some processors.
307 my $payinfo = shift || $self->payinfo;
309 'custnum' => $self->custnum,
310 'payby' => $self->payby,
314 if qsearch('cust_pay', { %hash, 'payinfo' => $payinfo } )
315 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo } )
323 For transactions that have both 'status' and 'failure_status', shows the
324 status in a single, display-friendly string.
331 'done' => 'Approved',
332 'expired' => 'Card Expired',
333 'stolen' => 'Lost/Stolen',
334 'pickup' => 'Pick Up Card',
335 'nsf' => 'Insufficient Funds',
336 'inactive' => 'Inactive Account',
337 'blacklisted' => 'Blacklisted',
338 'declined' => 'Declined',
339 'approved' => 'Approved',
341 if ( $self->failure_status ) {
342 return $status{$self->failure_status};
344 return $status{$self->status};
348 =item paydate_monthyear
350 Returns a two-element list consisting of the month and year of this customer's
351 paydate (credit card expiration date for CARD customers)
355 sub paydate_monthyear {
357 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
359 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
368 Returns the exact time in seconds corresponding to the payment method
369 expiration date. For CARD/DCRD customers this is the end of the month;
370 for others (COMP is the only other payby that uses paydate) it's the start.
371 Returns 0 if the paydate is empty or set to the far future.
377 my ($month, $year) = $self->paydate_monthyear;
378 return 0 if !$year or $year >= 2037;
379 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
381 if ( $month == 13 ) {
385 return timelocal(0,0,0,1,$month-1,$year) - 1;
388 return timelocal(0,0,0,1,$month-1,$year);
392 =item paydate_epoch_sql
394 Class method. Returns an SQL expression to obtain the payment expiration date
395 as a number of seconds.
399 # Special expiration date behavior for non-CARD/DCRD customers has been
400 # carefully preserved. Do we really use that?
401 sub paydate_epoch_sql {
403 my $table = $class->table;
405 if ( driver_name eq 'Pg' ) {
406 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
407 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
409 elsif ( lc(driver_name) eq 'mysql' ) {
410 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
411 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
414 return "CASE WHEN $table.payby IN('CARD','DCRD')
420 =item upgrade_set_cardtype
422 Find all records with a credit card payment type and no paycardtype, and
423 replace them in order to set their paycardtype.
425 This method actually just starts a queue job.
429 sub upgrade_set_cardtype {
431 my $table = $class->table or die "upgrade_set_cardtype needs a table";
433 if ( ! FS::upgrade_journal->is_done("${table}__set_cardtype") ) {
434 my $job = FS::queue->new({ job => 'FS::payinfo_Mixin::process_set_cardtype' });
435 my $error = $job->insert($table);
436 die $error if $error;
437 FS::upgrade_journal->set_done("${table}__set_cardtype");
441 sub process_set_cardtype {
444 # assign cardtypes to CARD/DCRDs that need them; check_payinfo_cardtype
445 # will do this. ignore any problems with the cards.
446 local $ignore_masked_payinfo = 1;
447 my $search = FS::Cursor->new({
449 extra_sql => q[ WHERE payby IN('CARD','DCRD') AND paycardtype IS NULL ],
451 while (my $record = $search->fetch) {
452 my $error = $record->replace;
453 die $error if $error;
457 =item tokenized [ PAYINFO ]
459 Returns true if object payinfo is tokenized
461 Optionally, an arbitrary payby and payinfo can be passed.
467 my $payinfo = scalar(@_) ? shift : $self->payinfo;
468 return 0 unless $payinfo; #avoid uninitialized value error
469 $payinfo =~ /^99\d{14}$/;
478 L<FS::payby>, L<FS::Record>