X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpayby.pm;h=b8496558773f37b195bc637e3f6f231e6370348c;hp=4425df0402f728178f8b853819693024215d719a;hb=3adb46fccf9f631e188ea5383bd147b340477639;hpb=87d6769f31ddd6826211db1a9784ca8dc2297391 diff --git a/FS/FS/payby.pm b/FS/FS/payby.pm index 4425df040..b84965587 100644 --- a/FS/FS/payby.pm +++ b/FS/FS/payby.pm @@ -1,8 +1,9 @@ package FS::payby; use strict; -use vars qw(%hash); +use vars qw(%hash %payby2bop); use Tie::IxHash; +use Business::CreditCard; =head1 NAME @@ -16,6 +17,8 @@ FS::payby - Object methods for payment type records my @payby = FS::payby->payby; + my $bool = FS::payby->can_payby('cust_main', 'CARD'); + tie my %payby, 'Tie::IxHash', FS::payby->payby2longname my @cust_payby = FS::payby->cust_payby; @@ -34,61 +37,118 @@ Payment types. =cut +# paybys can be any/all of: +# - a customer saved payment type (cust_payby.payby) +# - a payment or refund type (cust_pay.payby, cust_pay_batch.payby, cust_refund.payby) + +# customer methods that start with 'D' will be interpreted as on-demand + tie %hash, 'Tie::IxHash', 'CARD' => { tinyname => 'card', shortname => 'Credit card', longname => 'Credit card (automatic)', + realtime => 1, }, 'DCRD' => { tinyname => 'card', shortname => 'Credit card', longname => 'Credit card (on-demand)', cust_pay => 'CARD', #this is a customer type only, payments are CARD... + realtime => 1, }, 'CHEK' => { tinyname => 'check', shortname => 'Electronic check', longname => 'Electronic check (automatic)', + realtime => 1, }, 'DCHK' => { tinyname => 'check', shortname => 'Electronic check', longname => 'Electronic check (on-demand)', cust_pay => 'CHEK', #this is a customer type only, payments are CHEK... - }, - 'LECB' => { - tinyname => 'phone bill', - shortname => 'Phone bill billing', - longname => 'Phone bill billing', + realtime => 1, }, 'BILL' => { tinyname => 'billing', shortname => 'Billing', + payname => 'Check', longname => 'Billing', + cust_main => '', #no longer a customer type + }, + 'PPAL' => { + tinyname => 'PayPal', + shortname => 'PayPal', + longname => 'PayPal', + cust_main => '', #not yet a customer type, but could be once we can do + # invoice presentment via paypal + }, + 'PREP' => { + tinyname => 'prepaid card', + shortname => 'Prepaid card', + longname => 'Prepaid card', + cust_main => '', #this is a payment type only }, 'CASH' => { tinyname => 'cash', shortname => 'Cash', # initial payment, then billing longname => 'Cash', - cust_main => 'BILL', #this is a payment type only, customers go to BILL... + cust_main => '', #this is a payment type only }, 'WEST' => { tinyname => 'western union', shortname => 'Western Union', # initial payment, then billing longname => 'Western Union', - cust_main => 'BILL', #this is a payment type only, customers go to BILL... + cust_main => '', #this is a payment type only + }, + 'IDTP' => { + tinyname => 'IDT', + shortname => 'IDT Payment Services', + longname => 'IDT Payment Services', + cust_main => '', #this is a payment type only }, 'MCRD' => { #not the same as DCRD tinyname => 'card', shortname => 'Manual credit card', # initial payment, then billing longname => 'Manual credit card', - cust_main => 'BILL', #this is a payment type only, customers go to BILL... + cust_main => '', #this is a payment type only }, - 'COMP' => { - tinyname => 'comp', - shortname => 'Complimentary', - longname => 'Complimentary', + 'MCHK' => { #not the same as DCHK + tinyname => 'card', + shortname => 'Manual electronic check', # initial payment, then billing + longname => 'Manual electronic check', + cust_main => '', #this is a payment type only + }, + 'APPL' => { + tinyname => 'apple store', + shortname => 'Apple Store', + longname => 'Apple Store', + cust_main => '', #this is a payment type only + }, + 'ANRD' => { + tinyname => 'android market', + shortname => 'Android Market', + longname => 'Android Market', + cust_main => '', #this is a payment type only + }, + 'EDI' => { + tinyname => 'EDI', + shortname => 'Electronic Debit (EDI)', + longname => 'Electronic Debit (EDI)', + cust_main => '', #not a customer type + }, + 'WIRE' => { + tinyname => 'Wire', + shortname => 'Wire transfer', + longname => 'Wire transfer', + cust_main => '', #not a customer type + }, + 'CBAK' => { + tinyname => 'chargeback', + shortname => 'Chargeback', + longname => 'Chargeback', + cust_main => '', # not a customer type }, ; @@ -96,26 +156,128 @@ sub payby { keys %hash; } +sub can_payby { + my( $self, $table, $payby ) = @_; + + #return "Illegal payby" unless $hash{$payby}; + return 0 unless $hash{$payby}; + + $table = 'cust_pay' if $table =~ /^cust_(pay_pending|pay_batch|pay_void|refund)$/; + return 0 if exists( $hash{$payby}->{$table} ); + + return 1; +} + +sub realtime { # can use realtime payment facilities + my( $self, $payby ) = @_; + + return 0 unless $hash{$payby}; + return 0 unless exists( $hash{$payby}->{realtime} ); + + return $hash{$payby}->{realtime}; +} + +sub payby2shortname { + my $self = shift; + map { $_ => $hash{$_}->{shortname} } $self->payby; +} + sub payby2longname { my $self = shift; map { $_ => $hash{$_}->{longname} } $self->payby; } +sub shortname { + my( $self, $payby ) = @_; + $hash{$payby}->{shortname}; +} + +sub payname { + my( $self, $payby ) = @_; + #$hash{$payby}->{payname} || $hash{$payby}->{shortname}; + exists($hash{$payby}->{payname}) + ? $hash{$payby}->{payname} + : $hash{$payby}->{shortname}; +} + +sub longname { + my( $self, $payby ) = @_; + $hash{$payby}->{longname}; +} + +%payby2bop = ( + 'CARD' => 'CC', + 'CHEK' => 'ECHECK', + 'MCRD' => 'CC', #? but doesn't MCRD mean _offline_ card? i think it got + # overloaded for third-party card payments -- but no one is + # doing those other than paypal now + 'PPAL' => 'PAYPAL', +); + +sub payby2bop { + my( $self, $payby ) = @_; + $payby2bop{ $self->payby2payment($payby) }; +} + +sub payby2payment { + my( $self, $payby ) = @_; + $hash{$payby}{'cust_pay'} || $payby; +} + sub cust_payby { my $self = shift; grep { ! exists $hash{$_}->{cust_main} } $self->payby; } +sub cust_payby2shortname { + my $self = shift; + map { $_ => $hash{$_}->{shortname} } $self->cust_payby; +} + sub cust_payby2longname { my $self = shift; map { $_ => $hash{$_}->{longname} } $self->cust_payby; } +=item payment_payby + +Returns all values of payby that can be used by payments. + +=cut + +sub payment_payby { + my $self = shift; + grep { ! exists $hash{$_}->{cust_pay} } $self->payby; +} + +=item payment_payby2longname + +Returns hash, keys are L types, values are payby longname. + +=cut + +sub payment_payby2longname { + my $self = shift; + map { $_ => $hash{$_}->{longname} } $self->payment_payby; +} + +=item payment_payby2payname + +Returns hash, keys are L types, values are payby payname. + +=cut + +sub payment_payby2payname { + my $self = shift; + map { $_ => $self->payname($_) } $self->payment_payby; +} + =back =head1 BUGS -This should eventually be an actual database table. +This should eventually be an actual database table, and all tables that +currently have a char payby field should have a foreign key into here instead. =head1 SEE ALSO