htdocs/docs/man/FS/cust_pay_batch.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::cust_pay_batch - Object methods for batch cards</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#methods">METHODS</A></LI>
  18         <LI><A HREF="#version">VERSION</A></LI>
  19         <LI><A HREF="#bugs">BUGS</A></LI>
  20         <LI><A HREF="#see also">SEE ALSO</A></LI>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::cust_pay_batch - Object methods for batch cards</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::cust_pay_batch;</PRE>
  33 <PRE>
  34   $record = new FS::cust_pay_batch \%hash;
  35   $record = new FS::cust_pay_batch { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <P>
  45 <HR>
  46 <H1><A NAME="description">DESCRIPTION</A></H1>
  47 <P>An FS::cust_pay_batch object represents a credit card transaction ready to be
  48 batched (sent to a processor).  FS::cust_pay_batch inherits from FS::Record.
  49 Typically called by the collect method of an FS::cust_main object.  The
  50 following fields are currently supported:</P>
  51 <DL>
  52 <DT><STRONG><A NAME="item_trancode_%2D_77_for_charges">trancode - 77 for charges</A></STRONG><BR>
  53 <DD>
  54 <DT><STRONG><A NAME="item_cardnum">cardnum</A></STRONG><BR>
  55 <DD>
  56 <DT><STRONG><A NAME="item_exp_%2D_card_expiration">exp - card expiration</A></STRONG><BR>
  57 <DD>
  58 <DT><STRONG><A NAME="item_amount">amount</A></STRONG><BR>
  59 <DD>
  60 <DT><STRONG><A NAME="item_invnum_%2D_invoice">invnum - invoice</A></STRONG><BR>
  61 <DD>
  62 <DT><STRONG><A NAME="item_custnum_%2D_customer">custnum - customer</A></STRONG><BR>
  63 <DD>
  64 <DT><STRONG><A NAME="item_payname_%2D_name_on_card">payname - name on card</A></STRONG><BR>
  65 <DD>
  66 <DT><STRONG><A NAME="item_first_%2D_name">first - name</A></STRONG><BR>
  67 <DD>
  68 <DT><STRONG><A NAME="item_last_%2D_name">last - name</A></STRONG><BR>
  69 <DD>
  70 <DT><STRONG><A NAME="item_address1">address1</A></STRONG><BR>
  71 <DD>
  72 <DT><STRONG><A NAME="item_address2">address2</A></STRONG><BR>
  73 <DD>
  74 <DT><STRONG><A NAME="item_city">city</A></STRONG><BR>
  75 <DD>
  76 <DT><STRONG><A NAME="item_state">state</A></STRONG><BR>
  77 <DD>
  78 <DT><STRONG><A NAME="item_zip">zip</A></STRONG><BR>
  79 <DD>
  80 <DT><STRONG><A NAME="item_country">country</A></STRONG><BR>
  81 <DD>
  82 </DL>
  83 <P>
  84 <HR>
  85 <H1><A NAME="methods">METHODS</A></H1>
  86 <DL>
  87 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  88 <DD>
  89 Creates a new record.  To add the record to the database, see <A HREF="#insert">insert</A>.
  90 <P>Note that this stores the hash reference, not a distinct copy of the hash it
  91 points to.  You can ask the object for a copy with the <EM>hash</EM> method.</P>
  92 <P></P>
  93 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  94 <DD>
  95 Adds this record to the database.  If there is an error, returns the error,
  96 otherwise returns false.
  97 <P></P>
  98 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  99 <DD>
 100 Delete this record from the database.  If there is an error, returns the error,
 101 otherwise returns false.
 102 <P></P>
 103 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
 104 <DD>
 105 #inactive
 106 #
 107 #Replaces the OLD_RECORD with this one in the database.  If there is an error,
 108 #returns the error, otherwise returns false.
 109 <P></P>
 110 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
 111 <DD>
 112 Checks all fields to make sure this is a valid transaction.  If there is
 113 an error, returns the error, otherwise returns false.  Called by the insert
 114 and repalce methods.
 115 <P></P></DL>
 116 <P>
 117 <HR>
 118 <H1><A NAME="version">VERSION</A></H1>
 119 <P>$Id: cust_pay_batch.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
 120 <P>
 121 <HR>
 122 <H1><A NAME="bugs">BUGS</A></H1>
 123 <P>There should probably be a configuration file with a list of allowed credit
 124 card types.</P>
 125 <P>
 126 <HR>
 127 <H1><A NAME="see also">SEE ALSO</A></H1>
 128 <P><A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>, <A HREF=".././FS/Record.html">the FS::Record manpage</A></P>
 129
 130 </BODY>
 131
 132 </HTML>