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
|
<HTML>
<HEAD>
<TITLE>FS::cust_pay_batch - Object methods for batch cards</TITLE>
<LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
</HEAD>
<BODY>
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#NAME">NAME</A>
<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
<LI><A HREF="#METHODS">METHODS</A>
<LI><A HREF="#VERSION">VERSION</A>
<LI><A HREF="#BUGS">BUGS</A>
<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
FS::cust_pay_batch - Object methods for batch cards
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
<PRE> use FS::cust_pay_batch;
</PRE>
<P>
<PRE> $record = new FS::cust_pay_batch \%hash;
$record = new FS::cust_pay_batch { 'column' => 'value' };
</PRE>
<P>
<PRE> $error = $record->insert;
</PRE>
<P>
<PRE> $error = $new_record->replace($old_record);
</PRE>
<P>
<PRE> $error = $record->delete;
</PRE>
<P>
<PRE> $error = $record->check;
</PRE>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
An FS::cust_pay_batch object represents a credit card transaction ready to
be batched (sent to a processor). FS::cust_pay_batch inherits from
FS::Record. Typically called by the collect method of an FS::cust_main
object. The following fields are currently supported:
<DL>
<DT><STRONG><A NAME="item_trancode">trancode - 77 for charges</A></STRONG><DD>
<DT><STRONG><A NAME="item_cardnum">cardnum</A></STRONG><DD>
<DT><STRONG><A NAME="item_exp">exp - card expiration</A></STRONG><DD>
<DT><STRONG><A NAME="item_amount">amount</A></STRONG><DD>
<DT><STRONG><A NAME="item_invnum">invnum - invoice</A></STRONG><DD>
<DT><STRONG><A NAME="item_custnum">custnum - customer</A></STRONG><DD>
<DT><STRONG><A NAME="item_payname">payname - name on card</A></STRONG><DD>
<DT><STRONG><A NAME="item_first">first - name</A></STRONG><DD>
<DT><STRONG><A NAME="item_last">last - name</A></STRONG><DD>
<DT><STRONG><A NAME="item_address1">address1</A></STRONG><DD>
<DT><STRONG><A NAME="item_address2">address2</A></STRONG><DD>
<DT><STRONG><A NAME="item_city">city</A></STRONG><DD>
<DT><STRONG><A NAME="item_state">state</A></STRONG><DD>
<DT><STRONG><A NAME="item_zip">zip</A></STRONG><DD>
<DT><STRONG><A NAME="item_country">country</A></STRONG><DD>
</DL>
<P>
<HR>
<H1><A NAME="METHODS">METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
<P>
Creates a new record. To add the record to the database, see <A HREF="#insert">insert</A>.
<P>
Note that this stores the hash reference, not a distinct copy of the hash
it points to. You can ask the object for a copy with the <EM>hash</EM> method.
<DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
<P>
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
<DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
<P>
Delete this record from the database. If there is an error, returns the
error, otherwise returns false.
<DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
<P>
#inactive # #Replaces the OLD_RECORD with this one in the database. If
there is an error, #returns the error, otherwise returns false.
<DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
<P>
Checks all fields to make sure this is a valid transaction. If there is an
error, returns the error, otherwise returns false. Called by the insert and
repalce methods.
</DL>
<P>
<HR>
<H1><A NAME="VERSION">VERSION</A></H1>
<P>
$Id: cust_pay_batch.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
<P>
<HR>
<H1><A NAME="BUGS">BUGS</A></H1>
<P>
There should probably be a configuration file with a list of allowed credit
card types.
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<A HREF="../FS/cust_main.html">FS::cust_main</A>, <A HREF="../FS/Record.html">FS::Record</A>
</BODY>
</HTML>
|
