add payby types for apple store, android market and EDI (bill pay), RT#15309

[freeside.git] / FS / FS / payby.pm

diff --git a/FS/FS/payby.pm b/FS/FS/payby.pm
index 72a8766..bee787c 100644 (file)
--- a/FS/FS/payby.pm
+++ b/FS/FS/payby.pm
@@ -1,8 +1,10 @@
 package FS::payby;
 
 use strict;
-use vars qw(%hash);
+use vars qw(%hash %payby2bop);
 use Tie::IxHash;
+use Business::CreditCard;
+
 
 =head1 NAME
 
@@ -16,6 +18,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,39 +38,56 @@ Payment types.
 
 =cut
 
+# paybys can be any/all of:
+# - a customer payment type (cust_main.payby)
+# - a payment or refund type (cust_pay.payby, cust_pay_batch.payby, cust_refund.payby)
+# - an event type (part_bill_event.payby)
+
 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...
+    realtime  => 1,
   },
   'LECB' => {
     tinyname  => 'phone bill',
     shortname => 'Phone bill billing',
     longname  => 'Phone bill billing',
+    realtime  => 1,
   },
   'BILL' => {
     tinyname  => 'billing',
     shortname => 'Billing',
+    payname   => 'Check',
     longname  => 'Billing',
   },
+  'PREP' => {
+    tinyname  => 'prepaid card',
+    shortname => 'Prepaid card',
+    longname  => 'Prepaid card',
+    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+  },
   'CASH' => {
     tinyname  => 'cash',
     shortname => 'Cash', # initial payment, then billing
@@ -85,15 +106,35 @@ tie %hash, 'Tie::IxHash',
     longname  => 'Manual credit card', 
     cust_main => 'BILL', #this is a payment type only, customers go to BILL...
   },
+  'APPL' => {
+    tinyname  => 'apple store',
+    shortname => 'Apple Store',
+    longname  => 'Apple Store',
+    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+  },
+  'ANRD' => {
+    tinyname  => 'android market',
+    shortname => 'Android Market',
+    longname  => 'Android Market',
+    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+  },
+  'EDI' => {
+    tinyname  => 'EDI',
+    shortname => 'Electronic Debit',
+    longname  => 'Electronic Debit',
+    cust_main => '', #not a customer type
+  },
   'COMP' => {
     tinyname  => 'comp',
     shortname => 'Complimentary',
     longname  => 'Complimentary',
+    cust_pay  => '', # (free) is depricated as a payment type in cust_pay
   },
-  'DCLN' => {  # This is only an event.
-    tinyname  => 'declined',
-    shortname => 'Declined payment',
-    longname  => 'Declined payment',
+  'CBAK' => {
+    tinyname  => 'chargeback',
+    shortname => 'Chargeback',
+    longname  => 'Chargeback',
+    cust_main => '', # not a customer type
   },
 ;
 
@@ -101,11 +142,66 @@ 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 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',
+);
+
+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;