1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
package FS::payinfo_Mixin;
use strict;
use Business::CreditCard;
=head1 NAME
FS::payinfo_Mixin - Mixin class for records in tables that contain payinfo.
=head1 SYNOPSIS
package FS::some_table;
use vars qw(@ISA);
@ISA = qw( FS::payinfo_Mixin FS::Record );
=head1 DESCRIPTION
This is a mixin class for records that contain payinfo.
This class handles the following functions for payinfo...
Payment Mask (Generation and Storage)
Data Validation (parent checks need to be sure to call this)
Encryption - In the Future (Pull from Record.pm)
Bad Card Stuff - In the Future (Integrate Banned Pay)
Currency - In the Future
=head1 fields
=over 4
=item payby
The following payment types (payby) are supported:
For Customers (cust_main):
'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or
'PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to I<BILL>)
For Refunds (cust_refund):
'CARD' (credit cards), 'CHEK' (electronic check/ACH),
'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash),
'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' Chargeback, or 'COMP' (free),
For Payments (cust_pay):
'CARD' (credit cards), 'CHEK' (electronic check/ACH),
'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
'CASH' (cash), 'WEST' (Western Union), or 'MCRD' (Manual credit card)
'COMP' (free) is depricated as a payment type in cust_pay
=cut
sub payby {
my($self,$payby) = @_;
if ( defined($payby) ) {
$self->setfield('payby', $payby);
}
return $self->getfield('payby')
}
=item payinfo
Payment information (payinfo) can be one of the following types:
Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
=cut
sub payinfo {
my($self,$payinfo) = @_;
if ( defined($payinfo) ) {
$self->setfield('payinfo', $payinfo); # This is okay since we are the 'setter'
$self->paymask($self->mask_payinfo());
} else {
$payinfo = $self->getfield('payinfo'); # This is okay since we are the 'getter'
return $payinfo;
}
}
=item paycvv
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
=cut
sub paycvv {
my($self,$paycvv) = @_;
# This is only allowed in cust_main... Even then it really shouldn't be stored...
if ($self->table eq 'cust_main') {
if ( defined($paycvv) ) {
$self->setfield('paycvv', $paycvv); # This is okay since we are the 'setter'
} else {
$paycvv = $self->getfield('paycvv'); # This is okay since we are the 'getter'
return $paycvv;
}
} else {
# warn "This doesn't work for other tables besides cust_main
}
}
=item paymask
=cut
sub paymask {
my($self,$paymask)=@_;
if ($paymask ne '') {
# I hate this little bit of magic... I don't expect it to cause a problem, but who knows...
# If the payinfo is passed in masked then ignore it and set it based on the payinfo
# The only guy that should call this in this way is... $self->payinfo
$self->setfield('paymask', $self->mask_payinfo());
} else {
$paymask=$self->getfield('paymask');
if (!defined($paymask) || $paymask eq '') {
# Generate it if it's blank - Note that we're not going to set it - just generate
$paymask = $self->mask_payinfo();
}
}
return $paymask;
}
=item mask_payinfo()
This method converts the payment info (credit card, bank account, etc.) into a masked string.
=cut
sub mask_payinfo {
my $self = shift;
my $paymask;
my $payinfo = $self->payinfo;
my $payby = $self->payby;
# Check to see if it's encrypted...
if ($self->is_encrypted($payinfo)) {
$paymask = 'N/A';
} else {
# if not, mask it...
if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') { # Credit Cards (Show first and last four)
$paymask = substr($payinfo,0,4). 'x'x(length($payinfo)-8). substr($payinfo,(length($payinfo)-4));
} elsif ($payby eq 'CHEK' ||
$payby eq 'DCHK' ) { # Checks (Show last 2 @ bank)
my( $account, $aba ) = split('@', $payinfo );
$paymask = 'x'x(length($account)-2). substr($account,(length($account)-2))."@".$aba;
} else { # Tie up loose ends
$paymask = $payinfo;
}
}
return $paymask;
}
=back
=head1 METHODS
=over 4
=item payinfo_check
For Customers (cust_main):
'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or
'PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to I<BILL>)
For Refunds (cust_refund):
'CARD' (credit cards), 'CHEK' (electronic check/ACH),
'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash),
'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' (Chargeback), or 'COMP' (free)
For Payments (cust_pay):
'CARD' (credit cards), 'CHEK' (electronic check/ACH),
'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card),
'CASH' (cash), 'WEST' (Western Union), or 'MCRD' (Manual credit card)
'COMP' (free) is depricated as a payment type in cust_pay
=cut
sub payinfo_check {
my $self = shift;
# Make sure it's a valid payby
$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD|PREP|CBAK)$/
or return "Illegal payby (overall payinfo_check)";
$self->payby($1);
# Okay some aren't valid depending on table
if ($self->table eq 'cust_main') {
if ($self->payby =~ /^(CASH|WEST|MCRD|PREP|CBAK)$/) {
return "Illegal payby (cust_main)";
}
} elsif ($self->table eq 'cust_refund') {
if ($self->payby =~ /^(DCRD|DCHK|PREPAY|PREP)$/) {
return "Illegal payby (cust_refund)";
}
} elsif ($self->table eq 'cust_pay') {
if ($self->payby =~ /^(DCRD|DCHK|PREPAY|CBAK)$/) {
return "Illegal payby (cust_pay)";
}
}
if ( $self->payby eq 'CARD' ) {
my $payinfo = $self->payinfo;
$payinfo =~ s/\D//g;
$self->payinfo($payinfo);
if ( $self->payinfo ) {
$self->payinfo =~ /^(\d{13,16})$/
or return "Illegal (mistyped?) credit card number (payinfo)";
$self->payinfo($1);
Business::CreditCard::validate($self->payinfo) or return "Illegal credit card number";
return "Unknown card type" if Business::CreditCard::cardtype($self->payinfo) eq "Unknown";
} else {
$self->payinfo('N/A');
}
} else {
my $error = $self->ut_textn('payinfo');
return $error if $error;
}
}
=head1 BUGS
Have to add the future items...
=head1 SEE ALSO
L<FS::Record>
=cut
1;
|
