3 <TITLE>FS::cust_pay_batch - Object methods for batch cards</TITLE>
4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#METHODS">METHODS</A>
17 <LI><A HREF="#VERSION">VERSION</A>
18 <LI><A HREF="#BUGS">BUGS</A>
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::cust_pay_batch - Object methods for batch cards
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <PRE> use FS::cust_pay_batch;
36 <PRE> $record = new FS::cust_pay_batch \%hash;
37 $record = new FS::cust_pay_batch { 'column' => 'value' };
40 <PRE> $error = $record->insert;
43 <PRE> $error = $new_record->replace($old_record);
46 <PRE> $error = $record->delete;
49 <PRE> $error = $record->check;
53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
55 An FS::cust_pay_batch object represents a credit card transaction ready to
56 be batched (sent to a processor). FS::cust_pay_batch inherits from
57 FS::Record. Typically called by the collect method of an FS::cust_main
58 object. The following fields are currently supported:
61 <DT><STRONG><A NAME="item_trancode">trancode - 77 for charges</A></STRONG><DD>
62 <DT><STRONG><A NAME="item_cardnum">cardnum</A></STRONG><DD>
63 <DT><STRONG><A NAME="item_exp">exp - card expiration</A></STRONG><DD>
64 <DT><STRONG><A NAME="item_amount">amount</A></STRONG><DD>
65 <DT><STRONG><A NAME="item_invnum">invnum - invoice</A></STRONG><DD>
66 <DT><STRONG><A NAME="item_custnum">custnum - customer</A></STRONG><DD>
67 <DT><STRONG><A NAME="item_payname">payname - name on card</A></STRONG><DD>
68 <DT><STRONG><A NAME="item_first">first - name</A></STRONG><DD>
69 <DT><STRONG><A NAME="item_last">last - name</A></STRONG><DD>
70 <DT><STRONG><A NAME="item_address1">address1</A></STRONG><DD>
71 <DT><STRONG><A NAME="item_address2">address2</A></STRONG><DD>
72 <DT><STRONG><A NAME="item_city">city</A></STRONG><DD>
73 <DT><STRONG><A NAME="item_state">state</A></STRONG><DD>
74 <DT><STRONG><A NAME="item_zip">zip</A></STRONG><DD>
75 <DT><STRONG><A NAME="item_country">country</A></STRONG><DD>
79 <H1><A NAME="METHODS">METHODS</A></H1>
81 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
83 Creates a new record. To add the record to the database, see <A HREF="#insert">insert</A>.
86 Note that this stores the hash reference, not a distinct copy of the hash
87 it points to. You can ask the object for a copy with the <EM>hash</EM> method.
89 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
91 Adds this record to the database. If there is an error, returns the error,
92 otherwise returns false.
94 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
96 Delete this record from the database. If there is an error, returns the
97 error, otherwise returns false.
99 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
101 #inactive # #Replaces the OLD_RECORD with this one in the database. If
102 there is an error, #returns the error, otherwise returns false.
104 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
106 Checks all fields to make sure this is a valid transaction. If there is an
107 error, returns the error, otherwise returns false. Called by the insert and
113 <H1><A NAME="VERSION">VERSION</A></H1>
115 $Id: cust_pay_batch.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
119 <H1><A NAME="BUGS">BUGS</A></H1>
121 There should probably be a configuration file with a list of allowed credit
126 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
128 <A HREF="../FS/cust_main.html">FS::cust_main</A>, <A HREF="../FS/Record.html">FS::Record</A>