1 package FS::payinfo_Mixin;
4 use Business::CreditCard;
6 use FS::Record qw(qsearch);
8 use vars qw($ignore_masked_payinfo);
12 FS::payinfo_Mixin - Mixin class for records in tables that contain payinfo.
16 package FS::some_table;
18 @ISA = qw( FS::payinfo_Mixin FS::Record );
22 This is a mixin class for records that contain payinfo.
30 The following payment types (payby) are supported:
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>)
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), 'MCHK' (Manual electronic
42 check), 'CBAK' Chargeback, or 'COMP' (free)
45 For Payments (cust_pay):
46 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
47 'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
48 'CASH' (cash), 'WEST' (Western Union), 'MCRD' (Manual credit card), 'MCHK'
49 (Manual electronic check), 'PPAL' (PayPal)
50 'COMP' (free) is depricated as a payment type in cust_pay
56 Payment information (payinfo) can be one of the following types:
58 Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username)
59 prepayment identifier (see L<FS::prepay_credit>), PayPal transaction ID
64 my($self,$payinfo) = @_;
66 if ( defined($payinfo) ) {
67 $self->setfield('payinfo', $payinfo);
68 $self->paymask($self->mask_payinfo) unless $payinfo =~ /^99\d{14}$/; #token
70 $self->getfield('payinfo');
76 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
81 my($self,$paycvv) = @_;
82 # This is only allowed in cust_main... Even then it really shouldn't be stored...
83 if ($self->table eq 'cust_main') {
84 if ( defined($paycvv) ) {
85 $self->setfield('paycvv', $paycvv); # This is okay since we are the 'setter'
87 $paycvv = $self->getfield('paycvv'); # This is okay since we are the 'getter'
91 # warn "This doesn't work for other tables besides cust_main
101 my($self, $paymask) = @_;
103 if ( defined($paymask) ) {
104 $self->setfield('paymask', $paymask);
106 $self->getfield('paymask') || $self->mask_payinfo;
116 =item mask_payinfo [ PAYBY, PAYINFO ]
118 This method converts the payment info (credit card, bank account, etc.) into a
121 Optionally, an arbitrary payby and payinfo can be passed.
127 my $payby = scalar(@_) ? shift : $self->payby;
128 my $payinfo = scalar(@_) ? shift : $self->payinfo;
130 # Check to see if it's encrypted...
131 if ( ref($self) && $self->is_encrypted($payinfo) ) {
133 } elsif ( $payinfo =~ /^99\d{14}$/ || $payinfo eq 'N/A' ) { #token
134 return 'N/A (tokenized)'; #?
135 } else { # if not, mask it...
137 if ($payby eq 'CARD' || $payby eq 'DCRD') {
138 #|| $payby eq 'MCRD') {
139 #MCRD isn't a card in payinfo,
140 #its a record of an _offline_
145 # special handling for Local Isracards: always show last 4
146 if ( $payinfo =~ /^(\d{8,9})$/ ) {
148 return 'x'x(length($payinfo)-4).
149 substr($payinfo,(length($payinfo)-4));
153 my $conf = new FS::Conf;
154 my $mask_method = $conf->config('card_masking_method') || 'first6last4';
155 $mask_method =~ /^first(\d+)last(\d+)$/
156 or die "can't parse card_masking_method $mask_method";
157 my($first, $last) = ($1, $2);
159 return substr($payinfo,0,$first).
160 'x'x(length($payinfo)-$first-$last).
161 substr($payinfo,(length($payinfo)-$last));
163 } elsif ($payby eq 'CHEK' || $payby eq 'DCHK' ) {
165 # Checks (Show last 2 @ bank)
166 my( $account, $aba ) = split('@', $payinfo );
167 return 'x'x(length($account)-2).
168 substr($account,(length($account)-2)).
169 ( length($aba) ? "@".$aba : '');
171 } elsif ($payby eq 'EDI') {
173 # These numbers have been seen anywhere from 8 to 30 digits, and
174 # possibly more. Lacking any better idea I'm going to mask all but
176 return 'x' x (length($payinfo) - 4) . substr($payinfo, -4);
178 } else { # Tie up loose ends
182 #die "shouldn't be reached";
187 Checks payby and payinfo.
194 FS::payby->can_payby($self->table, $self->payby)
195 or return "Illegal payby: ". $self->payby;
197 if ( $self->payby eq 'CARD' && ! $self->is_encrypted($self->payinfo) ) {
198 my $payinfo = $self->payinfo;
199 if ( $ignore_masked_payinfo and $self->mask_payinfo eq $self->payinfo ) {
203 $self->payinfo($payinfo);
204 if ( $self->payinfo ) {
205 $self->payinfo =~ /^(\d{13,16}|\d{8,9})$/
206 or return "Illegal (mistyped?) credit card number (payinfo)";
208 validate($self->payinfo) or return "Illegal credit card number";
209 return "Unknown card type" if $self->payinfo !~ /^99\d{14}$/ #token
210 && cardtype($self->payinfo) eq "Unknown";
212 $self->payinfo('N/A'); #???
216 if ( $self->is_encrypted($self->payinfo) ) {
217 #something better? all it would cause is a decryption error anyway?
218 my $error = $self->ut_anything('payinfo');
219 return $error if $error;
221 my $error = $self->ut_textn('payinfo');
222 return $error if $error;
228 =item payby_payinfo_pretty [ LOCALE ]
230 Returns payment method and information (suitably masked, if applicable) as
231 a human-readable string, such as:
233 Card #54xxxxxxxxxxxx32
241 sub payby_payinfo_pretty {
244 my $lh = FS::L10N->get_handle($locale);
245 if ( $self->payby eq 'CARD' ) {
246 $lh->maketext('Card #') . $self->paymask;
247 } elsif ( $self->payby eq 'CHEK' ) {
249 #false laziness w/view/cust_main/payment_history.html::translate_payinfo
250 my( $account, $aba ) = split('@', $self->paymask );
252 if ( $aba =~ /^(\d{5})\.(\d{3})$/ ) { #blame canada
253 my($branch, $routing) = ($1, $2);
254 $lh->maketext("Routing [_1], Branch [_2], Acct [_3]",
255 $routing, $branch, $account);
257 $lh->maketext("Routing [_1], Acct [_2]", $aba, $account);
260 } elsif ( $self->payby eq 'BILL' ) {
261 $lh->maketext('Check #') . $self->payinfo;
262 } elsif ( $self->payby eq 'PREP' ) {
263 $lh->maketext('Prepaid card #') . $self->payinfo;
264 } elsif ( $self->payby eq 'CASH' ) {
265 $lh->maketext('Cash') . ' ' . $self->payinfo;
266 } elsif ( $self->payby eq 'WEST' ) {
267 # does Western Union localize their name?
268 $lh->maketext('Western Union');
269 } elsif ( $self->payby eq 'MCRD' ) {
270 $lh->maketext('Manual credit card');
271 } elsif ( $self->payby eq 'MCHK' ) {
272 $lh->maketext('Manual electronic check');
273 } elsif ( $self->payby eq 'EDI' ) {
274 $lh->maketext('EDI') . ' ' . $self->paymask;
275 } elsif ( $self->payby eq 'PPAL' ) {
276 $lh->maketext('PayPal transaction#') . $self->order_number;
278 $self->payby. ' '. $self->payinfo;
282 =item payinfo_used [ PAYINFO ]
284 Returns 1 if there's an existing payment using this payinfo. This can be
285 used to set the 'recurring payment' flag required by some processors.
291 my $payinfo = shift || $self->payinfo;
293 'custnum' => $self->custnum,
298 if qsearch('cust_pay', { %hash, 'payinfo' => $payinfo } )
299 || qsearch('cust_pay',
300 { %hash, 'paymask' => $self->mask_payinfo('CARD', $payinfo) } )
312 L<FS::payby>, L<FS::Record>