convert from pod for 1.2.0 release
[freeside.git] / htdocs / docs / man / cust_pay_batch.txt
1 NAME
2     FS::cust_pay_batch - Object methods for batch cards
3
4 SYNOPSIS
5       use FS::cust_pay_batch;
6
7       $record = new FS::cust_pay_batch \%hash;
8       $record = new FS::cust_pay_batch { 'column' => 'value' };
9
10       $error = $record->insert;
11
12       $error = $new_record->replace($old_record);
13
14       $error = $record->delete;
15
16       $error = $record->check;
17
18 DESCRIPTION
19     An FS::cust_pay_batch object represents a credit card
20     transaction ready to be batched (sent to a processor).
21     FS::cust_pay_batch inherits from FS::Record. Typically called by
22     the collect method of an FS::cust_main object. The following
23     fields are currently supported:
24
25     trancode - 77 for charges
26     cardnum
27     exp - card expiration
28     amount
29     invnum - invoice
30     custnum - customer
31     payname - name on card
32     first - name
33     last - name
34     address1
35     address2
36     city
37     state
38     zip
39     country
40 METHODS
41     new HASHREF
42         Creates a new record. To add the record to the database, see
43         the section on "insert".
44
45         Note that this stores the hash reference, not a distinct
46         copy of the hash it points to. You can ask the object for a
47         copy with the *hash* method.
48
49     insert
50         Adds this record to the database. If there is an error,
51         returns the error, otherwise returns false.
52
53     delete
54         Delete this record from the database. If there is an error,
55         returns the error, otherwise returns false.
56
57     replace OLD_RECORD
58         #inactive # #Replaces the OLD_RECORD with this one in the
59         database. If there is an error, #returns the error,
60         otherwise returns false.
61
62     check
63         Checks all fields to make sure this is a valid transaction.
64         If there is an error, returns the error, otherwise returns
65         false. Called by the insert and repalce methods.
66
67 VERSION
68     $Id: cust_pay_batch.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $
69
70 BUGS
71     There should probably be a configuration file with a list of
72     allowed credit card types.
73
74 SEE ALSO
75     the FS::cust_main manpage, the FS::Record manpage
76
77 HISTORY
78     ivan@voicenet.com 97-jul-1
79
80     added hfields ivan@sisd.com 97-nov-13
81
82     $Log: cust_pay_batch.txt,v $
83     Revision 1.1  1999-04-08 13:39:32  ivan
84     convert from pod for 1.2.0 release
85  Revision 1.3 1998/12/29 11:59:44
86     ivan mostly properly OO, some work still to be done with svc_
87     stuff
88
89     Revision 1.2 1998/11/18 09:01:44 ivan i18n! i18n!
90
91     Revision 1.1 1998/11/15 05:19:58 ivan long overdue
92
93     Revision 1.3 1998/11/15 04:33:00 ivan updates for newest versoin
94
95     Revision 1.2 1998/11/15 03:48:49 ivan update for current version
96