Difference between revisions of "Freeside:3:Documentation:Developer/FS/agent payment gateway"

Latest revision as of 05:28, 10 February 2015

NAME

FS::agent_payment_gateway - Object methods for agent_payment_gateway records

SYNOPSIS

 use FS::agent_payment_gateway;

 $record = new FS::agent_payment_gateway \%hash;
 $record = new FS::agent_payment_gateway { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::agent_payment_gateway object represents a payment gateway override for a specific agent. FS::agent_payment_gateway inherits from FS::Record. The following fields are currently supported:

agentgatewaynum - primary key; agentnum -; gatewaynum -; cardtype -; taxclass -

METHODS

new HASHREF

Creates a new override. To add the override 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.

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.

replace OLD_RECORD

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 override. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

payment_gateway

BUGS

SEE ALSO

FS::payment_gateway, FS::agent, FS::Record, schema.html from the base documentation.