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), 'CBAK' Chargeback, or 'COMP' (free)
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), or 'MCRD' (Manual credit card)
48 'COMP' (free) is depricated as a payment type in cust_pay
52 # was this supposed to do something?
55 # my($self,$payby) = @_;
56 # if ( defined($payby) ) {
57 # $self->setfield('payby', $payby);
59 # return $self->getfield('payby')
64 Payment information (payinfo) can be one of the following types:
66 Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
71 my($self,$payinfo) = @_;
73 if ( defined($payinfo) ) {
74 $self->setfield('payinfo', $payinfo);
75 $self->paymask($self->mask_payinfo) unless $payinfo =~ /^99\d{14}$/; #token
77 $self->getfield('payinfo');
83 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
88 my($self,$paycvv) = @_;
89 # This is only allowed in cust_main... Even then it really shouldn't be stored...
90 if ($self->table eq 'cust_main') {
91 if ( defined($paycvv) ) {
92 $self->setfield('paycvv', $paycvv); # This is okay since we are the 'setter'
94 $paycvv = $self->getfield('paycvv'); # This is okay since we are the 'getter'
98 # warn "This doesn't work for other tables besides cust_main
108 my($self, $paymask) = @_;
110 if ( defined($paymask) ) {
111 $self->setfield('paymask', $paymask);
113 $self->getfield('paymask') || $self->mask_payinfo;
123 =item mask_payinfo [ PAYBY, PAYINFO ]
125 This method converts the payment info (credit card, bank account, etc.) into a
128 Optionally, an arbitrary payby and payinfo can be passed.
134 my $payby = scalar(@_) ? shift : $self->payby;
135 my $payinfo = scalar(@_) ? shift : $self->payinfo;
137 # Check to see if it's encrypted...
138 if ( $self->is_encrypted($payinfo) ) {
140 } elsif ( $payinfo =~ /^99\d{14}$/ || $payinfo eq 'N/A' ) { #token
141 return 'N/A (tokenized)'; #?
142 } else { # if not, mask it...
144 if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') {
148 # special handling for Local Isracards: always show last 4
149 if ( $payinfo =~ /^(\d{8,9})$/ ) {
151 return 'x'x(length($payinfo)-4).
152 substr($payinfo,(length($payinfo)-4));
156 my $conf = new FS::Conf;
157 my $mask_method = $conf->config('card_masking_method') || 'first6last4';
158 $mask_method =~ /^first(\d+)last(\d+)$/
159 or die "can't parse card_masking_method $mask_method";
160 my($first, $last) = ($1, $2);
162 return substr($payinfo,0,$first).
163 'x'x(length($payinfo)-$first-$last).
164 substr($payinfo,(length($payinfo)-$last));
166 } elsif ($payby eq 'CHEK' || $payby eq 'DCHK' ) {
168 # Checks (Show last 2 @ bank)
169 my( $account, $aba ) = split('@', $payinfo );
170 return 'x'x(length($account)-2).
171 substr($account,(length($account)-2)).
172 ( length($aba) ? "@".$aba : '');
174 } else { # Tie up loose ends
178 #die "shouldn't be reached";
183 Checks payby and payinfo.
185 For Customers (cust_main):
186 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
187 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
188 'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or
189 'PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to I<BILL>)
191 For Refunds (cust_refund):
192 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
193 'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash),
194 'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' (Chargeback), or 'COMP' (free)
196 For Payments (cust_pay):
197 'CARD' (credit cards), 'CHEK' (electronic check/ACH),
198 'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
199 'CASH' (cash), 'WEST' (Western Union), or 'MCRD' (Manual credit card)
200 'COMP' (free) is depricated as a payment type in cust_pay
207 FS::payby->can_payby($self->table, $self->payby)
208 or return "Illegal payby: ". $self->payby;
210 if ( $self->payby eq 'CARD' && ! $self->is_encrypted($self->payinfo) ) {
211 my $payinfo = $self->payinfo;
212 if ( $ignore_masked_payinfo and $self->mask_payinfo eq $self->payinfo ) {
216 $self->payinfo($payinfo);
217 if ( $self->payinfo ) {
218 $self->payinfo =~ /^(\d{13,16}|\d{8,9})$/
219 or return "Illegal (mistyped?) credit card number (payinfo)";
221 validate($self->payinfo) or return "Illegal credit card number";
222 return "Unknown card type" if $self->payinfo !~ /^99\d{14}$/ #token
223 && cardtype($self->payinfo) eq "Unknown";
225 $self->payinfo('N/A'); #???
229 if ( $self->is_encrypted($self->payinfo) ) {
230 #something better? all it would cause is a decryption error anyway?
231 my $error = $self->ut_anything('payinfo');
232 return $error if $error;
234 my $error = $self->ut_textn('payinfo');
235 return $error if $error;
241 =item payby_payinfo_pretty
243 Returns payment method and information (suitably masked, if applicable) as
244 a human-readable string, such as:
246 Card #54xxxxxxxxxxxx32
254 sub payby_payinfo_pretty {
256 if ( $self->payby eq 'CARD' ) {
257 'Card #'. $self->paymask;
258 } elsif ( $self->payby eq 'CHEK' ) {
259 'E-check acct#'. $self->payinfo;
260 } elsif ( $self->payby eq 'BILL' ) {
261 'Check #'. $self->payinfo;
262 } elsif ( $self->payby eq 'PREP' ) {
263 'Prepaid card #'. $self->payinfo;
264 } elsif ( $self->payby eq 'CASH' ) {
265 'Cash '. $self->payinfo;
266 } elsif ( $self->payby eq 'WEST' ) {
267 'Western Union'; #. $self->payinfo;
268 } elsif ( $self->payby eq 'MCRD' ) {
269 'Manual credit card'; #. $self->payinfo;
271 $self->payby. ' '. $self->payinfo;
275 =item payinfo_used [ PAYINFO ]
277 Returns 1 if there's an existing payment using this payinfo. This can be
278 used to set the 'recurring payment' flag required by some processors.
284 my $payinfo = shift || $self->payinfo;
286 'custnum' => $self->custnum,
291 if qsearch('cust_pay', { %hash, 'payinfo' => $payinfo } )
292 || qsearch('cust_pay',
293 { %hash, 'paymask' => $self->mask_payinfo('CARD', $payinfo) } )
305 L<FS::payby>, L<FS::Record>