diff options
Diffstat (limited to 'htdocs/docs/man/cust_pay_batch.txt')
-rw-r--r-- | htdocs/docs/man/cust_pay_batch.txt | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/htdocs/docs/man/cust_pay_batch.txt b/htdocs/docs/man/cust_pay_batch.txt new file mode 100644 index 000000000..2d6267843 --- /dev/null +++ b/htdocs/docs/man/cust_pay_batch.txt @@ -0,0 +1,96 @@ +NAME + FS::cust_pay_batch - Object methods for batch cards + +SYNOPSIS + use FS::cust_pay_batch; + + $record = new FS::cust_pay_batch \%hash; + $record = new FS::cust_pay_batch { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +DESCRIPTION + 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: + + trancode - 77 for charges + cardnum + exp - card expiration + amount + invnum - invoice + custnum - customer + payname - name on card + first - name + last - name + address1 + address2 + city + state + zip + country +METHODS + new HASHREF + Creates a new record. To add the record to the database, see + the section on "insert". + + 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 *hash* method. + + insert + Adds this record to the database. If there is an error, + returns the error, otherwise returns false. + + delete + Delete this record from the database. If there is an error, + returns the error, otherwise returns false. + + replace OLD_RECORD + #inactive # #Replaces the OLD_RECORD with this one in the + database. If there is an error, #returns the error, + otherwise returns false. + + check + 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. + +VERSION + $Id: cust_pay_batch.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $ + +BUGS + There should probably be a configuration file with a list of + allowed credit card types. + +SEE ALSO + the FS::cust_main manpage, the FS::Record manpage + +HISTORY + ivan@voicenet.com 97-jul-1 + + added hfields ivan@sisd.com 97-nov-13 + + $Log: cust_pay_batch.txt,v $ + Revision 1.1 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.3 1998/12/29 11:59:44 + ivan mostly properly OO, some work still to be done with svc_ + stuff + + Revision 1.2 1998/11/18 09:01:44 ivan i18n! i18n! + + Revision 1.1 1998/11/15 05:19:58 ivan long overdue + + Revision 1.3 1998/11/15 04:33:00 ivan updates for newest versoin + + Revision 1.2 1998/11/15 03:48:49 ivan update for current version + |