% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::banned_pay - Object methods for banned_pay records
use FS::banned_pay;
$record = new FS::banned_pay \%hash;
$record = new FS::banned_pay { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::banned_pay object represents an banned credit card or ACH account. FS::banned_pay inherits from FS::Record. The following fields are currently supported:
primary key
CARD or CHEK
fingerprint of banned card (base64-encoded MD5 or SHA512 digest)
Digest hash algorythm, currently either MD5 or SHA512. Empty implies a legacy MD5 hash.
specified as a UNIX timestamp; see "time" in perlfunc. Also see Time::Local and Date::Parse for conversion functions.
optional end date, also specified as a UNIX timestamp.
order taker (assigned automatically, see FS::access_user)
Ban type: "" or null (regular ban), "warn" (warning)
reason (text)
Creates a new ban. To add the ban to the database, see "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.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid ban. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Takes two parameters: payby and payinfo, and searches for an (un-expired) ban matching those items.
Returns the ban, or false if no ban was found.
FS::Record, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
'=item' outside of any '=over'