FS/FS/payinfo_Mixin.pm

   1 package FS::payinfo_Mixin;
   2
   3 use strict;
   4 use Business::CreditCard;
   5 use FS::payby;
   6 use FS::Record qw(qsearch);
   7
   8 use vars qw($ignore_masked_payinfo);
   9
  10 =head1 NAME
  11
  12 FS::payinfo_Mixin - Mixin class for records in tables that contain payinfo.
  13
  14 =head1 SYNOPSIS
  15
  16 package FS::some_table;
  17 use vars qw(@ISA);
  18 @ISA = qw( FS::payinfo_Mixin FS::Record );
  19
  20 =head1 DESCRIPTION
  21
  22 This is a mixin class for records that contain payinfo.
  23
  24 =head1 FIELDS
  25
  26 =over 4
  27
  28 =item payby
  29
  30 The following payment types (payby) are supported:
  31
  32 For Customers (cust_main):
  33 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
  34 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
  35 'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or
  36 'PREPAY' (special billing type: applies a credit and sets billing type to I<BILL> - see L<FS::prepay_credit>)
  37
  38 For Refunds (cust_refund):
  39 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
  40 'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash),
  41 'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' Chargeback, or 'COMP' (free)
  42
  43
  44 For Payments (cust_pay):
  45 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
  46 'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
  47 'CASH' (cash), 'WEST' (Western Union), 'MCRD' (Manual credit card),
  48 'PPAL' (PayPal)
  49 'COMP' (free) is depricated as a payment type in cust_pay
  50
  51 =cut
  52
  53 =item payinfo
  54
  55 Payment information (payinfo) can be one of the following types:
  56
  57 Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username)
  58 prepayment identifier (see L<FS::prepay_credit>), PayPal transaction ID
  59
  60 =cut
  61
  62 sub payinfo {
  63   my($self,$payinfo) = @_;
  64
  65   if ( defined($payinfo) ) {
  66     $self->setfield('payinfo', $payinfo);
  67     $self->paymask($self->mask_payinfo) unless $payinfo =~ /^99\d{14}$/; #token
  68   } else {
  69     $self->getfield('payinfo');
  70   }
  71 }
  72
  73 =item paycvv
  74
  75 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
  76
  77 =cut
  78
  79 sub paycvv {
  80   my($self,$paycvv) = @_;
  81   # This is only allowed in cust_main... Even then it really shouldn't be stored...
  82   if ($self->table eq 'cust_main') {
  83     if ( defined($paycvv) ) {
  84       $self->setfield('paycvv', $paycvv); # This is okay since we are the 'setter'
  85     } else {
  86       $paycvv = $self->getfield('paycvv'); # This is okay since we are the 'getter'
  87       return $paycvv;
  88     }
  89   } else {
  90 #    warn "This doesn't work for other tables besides cust_main
  91     '';
  92   }
  93 }
  94
  95 =item paymask
  96
  97 =cut
  98
  99 sub paymask {
 100   my($self, $paymask) = @_;
 101
 102   if ( defined($paymask) ) {
 103     $self->setfield('paymask', $paymask);
 104   } else {
 105     $self->getfield('paymask') || $self->mask_payinfo;
 106   }
 107 }
 108
 109 =back
 110
 111 =head1 METHODS
 112
 113 =over 4
 114
 115 =item mask_payinfo [ PAYBY, PAYINFO ]
 116
 117 This method converts the payment info (credit card, bank account, etc.) into a
 118 masked string.
 119
 120 Optionally, an arbitrary payby and payinfo can be passed.
 121
 122 =cut
 123
 124 sub mask_payinfo {
 125   my $self = shift;
 126   my $payby   = scalar(@_) ? shift : $self->payby;
 127   my $payinfo = scalar(@_) ? shift : $self->payinfo;
 128
 129   # Check to see if it's encrypted...
 130   if ( ref($self) && $self->is_encrypted($payinfo) ) {
 131     return 'N/A';
 132   } elsif ( $payinfo =~ /^99\d{14}$/ || $payinfo eq 'N/A' ) { #token
 133     return 'N/A (tokenized)'; #?
 134   } else { # if not, mask it...
 135
 136     if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') {
 137
 138       # Credit Cards
 139
 140       # special handling for Local Isracards: always show last 4
 141       if ( $payinfo =~ /^(\d{8,9})$/ ) {
 142
 143         return 'x'x(length($payinfo)-4).
 144                substr($payinfo,(length($payinfo)-4));
 145
 146       }
 147
 148       my $conf = new FS::Conf;
 149       my $mask_method = $conf->config('card_masking_method') || 'first6last4';
 150       $mask_method =~ /^first(\d+)last(\d+)$/
 151         or die "can't parse card_masking_method $mask_method";
 152       my($first, $last) = ($1, $2);
 153
 154       return substr($payinfo,0,$first).
 155              'x'x(length($payinfo)-$first-$last).
 156              substr($payinfo,(length($payinfo)-$last));
 157
 158     } elsif ($payby eq 'CHEK' || $payby eq 'DCHK' ) {
 159
 160       # Checks (Show last 2 @ bank)
 161       my( $account, $aba ) = split('@', $payinfo );
 162       return 'x'x(length($account)-2).
 163              substr($account,(length($account)-2)).
 164              ( length($aba) ? "@".$aba : '');
 165
 166     } else { # Tie up loose ends
 167       return $payinfo;
 168     }
 169   }
 170   #die "shouldn't be reached";
 171 }
 172
 173 =item payinfo_check
 174
 175 Checks payby and payinfo.
 176
 177 For Customers (cust_main):
 178 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
 179 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
 180 'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or
 181 'PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to I<BILL>)
 182
 183 For Refunds (cust_refund):
 184 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
 185 'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash),
 186 'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' (Chargeback),  or 'COMP' (free)
 187
 188 For Payments (cust_pay):
 189 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
 190 'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
 191 'CASH' (cash), 'WEST' (Western Union), or 'MCRD' (Manual credit card)
 192 'COMP' (free) is depricated as a payment type in cust_pay
 193
 194 =cut
 195
 196 sub payinfo_check {
 197   my $self = shift;
 198
 199   FS::payby->can_payby($self->table, $self->payby)
 200     or return "Illegal payby: ". $self->payby;
 201
 202   if ( $self->payby eq 'CARD' && ! $self->is_encrypted($self->payinfo) ) {
 203     my $payinfo = $self->payinfo;
 204     if ( $ignore_masked_payinfo and $self->mask_payinfo eq $self->payinfo ) {
 205       # allow it
 206     } else {
 207       $payinfo =~ s/\D//g;
 208       $self->payinfo($payinfo);
 209       if ( $self->payinfo ) {
 210         $self->payinfo =~ /^(\d{13,16}|\d{8,9})$/
 211           or return "Illegal (mistyped?) credit card number (payinfo)";
 212         $self->payinfo($1);
 213         validate($self->payinfo) or return "Illegal credit card number";
 214         return "Unknown card type" if $self->payinfo !~ /^99\d{14}$/ #token
 215                                    && cardtype($self->payinfo) eq "Unknown";
 216       } else {
 217         $self->payinfo('N/A'); #???
 218       }
 219     }
 220   } else {
 221     if ( $self->is_encrypted($self->payinfo) ) {
 222       #something better?  all it would cause is a decryption error anyway?
 223       my $error = $self->ut_anything('payinfo');
 224       return $error if $error;
 225     } else {
 226       my $error = $self->ut_textn('payinfo');
 227       return $error if $error;
 228     }
 229   }
 230
 231 }
 232
 233 =item payby_payinfo_pretty
 234
 235 Returns payment method and information (suitably masked, if applicable) as
 236 a human-readable string, such as:
 237
 238   Card #54xxxxxxxxxxxx32
 239
 240 or
 241
 242   Check #119006
 243
 244 =cut
 245
 246 sub payby_payinfo_pretty {
 247   my $self = shift;
 248   if ( $self->payby eq 'CARD' ) {
 249     'Card #'. $self->paymask;
 250   } elsif ( $self->payby eq 'CHEK' ) {
 251     'E-check acct#'. $self->payinfo;
 252   } elsif ( $self->payby eq 'BILL' ) {
 253     'Check #'. $self->payinfo;
 254   } elsif ( $self->payby eq 'PREP' ) {
 255     'Prepaid card #'. $self->payinfo;
 256   } elsif ( $self->payby eq 'CASH' ) {
 257     'Cash '. $self->payinfo;
 258   } elsif ( $self->payby eq 'WEST' ) {
 259     'Western Union'; #. $self->payinfo;
 260   } elsif ( $self->payby eq 'MCRD' ) {
 261     'Manual credit card'; #. $self->payinfo;
 262   } elsif ( $self->payby eq 'PPAL' ) {
 263     'PayPal transaction#' . $self->order_number;
 264   } else {
 265     $self->payby. ' '. $self->payinfo;
 266   }
 267 }
 268
 269 =item payinfo_used [ PAYINFO ]
 270
 271 Returns 1 if there's an existing payment using this payinfo.  This can be
 272 used to set the 'recurring payment' flag required by some processors.
 273
 274 =cut
 275
 276 sub payinfo_used {
 277   my $self = shift;
 278   my $payinfo = shift || $self->payinfo;
 279   my %hash = (
 280     'custnum' => $self->custnum,
 281     'payby'   => 'CARD',
 282   );
 283
 284   return 1
 285   if qsearch('cust_pay', { %hash, 'payinfo' => $payinfo } )
 286   || qsearch('cust_pay',
 287     { %hash, 'paymask' => $self->mask_payinfo('CARD', $payinfo) }  )
 288   ;
 289
 290   return 0;
 291 }
 292
 293 =back
 294
 295 =head1 BUGS
 296
 297 =head1 SEE ALSO
 298
 299 L<FS::payby>, L<FS::Record>
 300
 301 =cut
 302
 303 1;
 304