List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Protected Member Functions | Protected Slots | Static Protected Member Functions | Static Protected Attributes
CreditCardProcessor Class Reference

This is a generic class that defines the interface between xTuple ERP and credit card processing services. More...

#include <creditcardprocessor.h>

Classes

class  FraudCheckResult
 

Public Types

enum  CCTransaction {
  Authorize, Reverse, Capture, Charge,
  Credit, Void
}
 
enum  FraudCheck {
  Match = 0x0000, NoMatch = 0x0001, NotAvail = 0x0002, Address = 0x0004,
  PostalCode = 0x0008, Name = 0x0010, NotProcessed = 0x0020, Invalid = 0x0040,
  ServiceUnavailable = 0x0080, IssuerNotCertified = 0x0100, Suspicious = 0x0200, Unsupported = 0x0400
}
 

Public Member Functions

virtual ~CreditCardProcessor ()
 
virtual int authorize (const int pccardid, const QString &pcvv, const double pamount, double ptax, bool ptaxexempt, double pfreight, double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, QString preftype, int &prefid)
 Processes pre-authorization transactions. More...
 
virtual int charge (const int pccardid, const QString &pcvv, const double pamount, const double ptax, const bool ptaxexempt, const double pfreight, const double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, QString preftype, int &prefid)
 Processes charge transactions. More...
 
virtual int chargePreauthorized (const QString &pcvv, const double pamount, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid)
 Processes 'capture' transactions, or charges against a prior preauthorization. More...
 
virtual int credit (const int pccardid, const QString &pcvv, const double pamount, const double ptax, const bool ptaxexempt, const double pfreight, const double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, QString preftype, int &prefid)
 Processes credit transactions. More...
 
virtual Q_INVOKABLE int defaultPort (bool=false)
 Return the default port expected by the subclass. More...
 
virtual Q_INVOKABLE QString defaultServer ()
 Return the default server expected by the subclass. More...
 
virtual Q_INVOKABLE bool handlesChecks ()
 Returns whether the subclass handles checks. More...
 
virtual Q_INVOKABLE bool handlesCreditCards ()
 Returns whether the subclass handles credit cards. More...
 
virtual Q_INVOKABLE bool isLive ()
 Returns whether credit card processing is configured in live mode. More...
 
virtual Q_INVOKABLE bool isTest ()
 Returns whether credit card processing is configured in test mode. More...
 
virtual Q_INVOKABLE void reset ()
 Reset error handling internal settings so previous transactions don't interfere with new transactions. More...
 
virtual int reversePreauthorized (const double pamount, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, QString preftype, int prefid)
 Reverse a preauthorization. More...
 
virtual Q_INVOKABLE int testConfiguration ()
 Test whether common credit card processing configuration options are consistent. More...
 
virtual int voidPrevious (int &)
 Processes void transactions. More...
 

Static Public Member Functions

static Q_INVOKABLE ParameterList authorize (const ParameterList &)
 Processes pre-authorization transactions. More...
 
static Q_INVOKABLE ParameterList charge (const ParameterList &)
 Processes charge transactions. More...
 
static Q_INVOKABLE ParameterList chargePreauthorized (const ParameterList &)
 Captures preauthorized transactions. More...
 
static Q_INVOKABLE ParameterList credit (const ParameterList &)
 Processes credit transactions. More...
 
static Q_INVOKABLE QString errorMsg ()
 Returns the most recent error message set by CreditCardProcessor or one of its subclasses. More...
 
static Q_INVOKABLE QString errorMsg (const int)
 Returns the error message associated with the given pcode. More...
 
static Q_INVOKABLE CreditCardProcessorgetProcessor (const QString=QString())
 Get a new instance of a specific CreditCardProcessor subclass. More...
 
static Q_INVOKABLE int printReceipt (const int)
 Print the CCReceipt report for a credit card transaction. More...
 
static Q_INVOKABLE QString typeToCode (CCTransaction ptranstype)
 
static Q_INVOKABLE ParameterList voidPrevious (const ParameterList &)
 Processes void transactions. More...
 

Protected Attributes

QList< FraudCheckResult * > _avsCodes
 
QString _company
 
QList< FraudCheckResult * > _cvvCodes
 
int _defaultLivePort
 
QString _defaultLiveServer
 
int _defaultTestPort
 
QString _defaultTestServer
 
QList< QPair< QString, QString > > _extraHeaders
 
QHttp * _http
 
bool _ignoreSslErrors
 
bool _passedAvs
 
bool _passedCvv
 
QString _plogin
 
QString _ppassword
 
QString _pport
 
QString _pserver
 

Protected Member Functions

 CreditCardProcessor ()
 Construct and initialize a default CreditCardProcessor. More...
 
virtual FraudCheckResultavsCodeLookup (QChar pcode)
 
virtual QString buildURL (const QString, const QString, const bool)
 Construct a valid URL from the information in the configuration. More...
 
virtual int checkCreditCard (const int pccid, const QString &pcvv, QString &pccard_x)
 Check if the given credit card is consistent and active. More...
 
virtual int checkCreditCardProcessor ()
 
virtual FraudCheckResultcvvCodeLookup (QChar pcode)
 
virtual int doAuthorize (const int pccardid, const QString &pcvv, double &pamount, const double ptax, const bool ptaxexempt, const double pfreight, const double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, ParameterList &pparams)
 Placeholder for subclasses to override. More...
 
virtual int doCharge (const int pccardid, const QString &pcvv, const double pamount, const double ptax, const bool ptaxexempt, const double pfreight, const double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, ParameterList &pparams)
 Placeholder for subclasses to override. More...
 
virtual int doChargePreauthorized (const int pccardid, const QString &pcvv, const double pamount, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, ParameterList &pparams)
 Placeholder for subclasses to override. More...
 
virtual int doCredit (const int pccardid, const QString &pcvv, const double pamount, const double ptax, const bool ptaxexempt, const double pfreight, const double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, ParameterList &pparams)
 Placeholder for subclasses to override. More...
 
virtual int doReversePreauthorized (const double pamount, const int pcurrid, QString &pneworder, QString &preforder, int pccpayid, ParameterList &pparams)
 Placeholder for subclasses to override. More...
 
virtual int doTestConfiguration ()
 Placeholder for subclasses to override. More...
 
virtual int doVoidPrevious (const int pccardid, const QString &pcvv, const double pamount, const int pcurrid, QString &pneworder, QString &preforder, QString &papproval, int &pccpayid, ParameterList &pparams)
 Placeholder for subclasses to override. More...
 
virtual int fraudChecks ()
 Handle fraud checking as determined by the system configuration. More...
 
virtual int sendViaHTTP (const QString &, QString &)
 Send an HTTP request to the configured credit card service and wait for its response. More...
 
virtual int updateCCPay (int &, ParameterList &)
 Insert into or update the ccpay table based on parameters extracted from the credit card processing service' response to a transaction request. More...
 

Protected Slots

void sslErrors (const QList< QSslError > &errors)
 

Static Protected Member Functions

static double currToCurr (const int, const int, const double, int *=0)
 Convert between two currencies. More...
 

Static Protected Attributes

static QString _errorMsg = ""
 
static QHash< int, QString > _msgHash
 

Detailed Description

This is a generic class that defines the interface between xTuple ERP and credit card processing services.

CreditCardProcessor encapsulates the common functionality shared across different services, including interaction with the database server and the proper stored procedures to call.

It should be subclassed once for each credit card processing company to be supported. Subclasses should override the following methods:

Subclasses should also set

It is the subclass' responsibility to ensure that all of the configuration options available on the Credit Card Configuration window are implemented either here or in the subclass. An example of an option that must be implemented in each subclass is CCTestResult since the method for requesting error responses from the credit card processing service is different for every service.

In addition to subclassing CreditCardProcessor, alternate credit card processing services require changing CreditCardProcessor::getProcessor and configureCC, and to subclass ConfigCreditCardProcessor. CreditCardProcessor::getProcessor must be modified to instantiate the right subclass of CreditCardProcessor based on the CCCompany metric or its QString argument. configureCC must be modified to store the service-specific CCCompany value checked by getProcessor and to instantiate a ConfigCreditCardProcessor, which allows editing and saving service-specific metrics

Error handling:

The following rules are followed by CreditCardProcessor, which also expects its subclasses to follow them. It is the subclass' responsibility to follow these conventions. If they are not followed, the database will not represent what really happened and the user will not be informed of problems.

Each method in CreditCardProcessor and its subclasses involved in processing credit card transactions is expected to return an integer conforming to the following pattern and set _errorMsg to the string associated with this integer in the _msgHash:

If the function returns:It means this:
greater than 0 The interaction with the credit card processing service was successful but either there is a warning from the service, like the credit card processing company denied the transaction, or local post-processing generated an error, such as a database failure
0 the transaction succeeded in its entirety
less than 0 preprocessing failed or the credit card company returned an error, like a malformed message or communications could not be established to process the transaction

Error codes between -100 and 100 inclusive are reserved for the CreditCardProcessor class itself. Values less than -100 or greater than 100 are available for use by subclasses and should be loaded into _msgHash in the subclass' constructor.

See also
AuthorizeDotNetProcessor
CyberSourceProcessor
ExternalCCProcessor
PaymentechProcessor
YourPayProcessor
configureCC
Todo:

expose portions of this in the scriptapi doxygen module

use qabstractmessagehandler instead of qmessagebox

Member Enumeration Documentation

Enumerator
Authorize 
Reverse 
Capture 
Charge 
Credit 
Void 
Enumerator
Match 
NoMatch 
NotAvail 
Address 
PostalCode 
Name 
NotProcessed 
Invalid 
ServiceUnavailable 
IssuerNotCertified 
Suspicious 
Unsupported 

Constructor & Destructor Documentation

CreditCardProcessor::~CreditCardProcessor ( )
virtual
CreditCardProcessor::CreditCardProcessor ( )
protected

Construct and initialize a default CreditCardProcessor.

This should never be called except by the constructor of a subclass. This should always be called by the constructor of a subclass. This constructor initializes _msgHash as well as some private and protected fields.

Member Function Documentation

int CreditCardProcessor::authorize ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
double  ptax,
bool  ptaxexempt,
double  pfreight,
double  pduty,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
QString  preftype,
int &  prefid 
)
virtual

Processes pre-authorization transactions.

This method performs application-level error checking and all of the database work required to handle a pre-authorization transaction. It calls doAuthorize to handle the direct communication with the service.

Warning
This method should never be overridden. Service-specific functionality should be implemented in the doAuthorize method of the service' subclass.
Parameters
[in]pccardidThe internal id of the credit card to preauthorize
[in]pcvvThe CVV/CCV code of the credit card to preauthorize
[in]pamountThe total amount to preauthorize. If the credit card processor does not preauthorize the full amount requested, the database will store the actual amount that was authorized If this occurs, the application will display an error if the amount authorized is 0 or a warning if the amount authorized is greater than 0.
[in]ptaxThe subportion of the total which is tax
[in]ptaxexemptWhether or not this transaction is tax exempt
[in]pfreightThe subportion of the total which is freight
[in]pdutyThe subportion of the total which is customs duty
[in]pcurridThe currency of the amount to preauthorize
[in,out]pneworderThe order number associated with this preauthorization
[out]preforderThe reference number associated with this preauthorization (may be required to 'capture' the preauthorization)
[out]pccpayidThe ccpay_id of the record created by this transaction
[in]preftypeEither cohead or cashrcpt or blank
[in,out]prefidThe cashrcpt_id or cohead_id associated with this transaction
Returns
An index into _errMsg; 0 indicates success
ParameterList CreditCardProcessor::authorize ( const ParameterList &  pinput)
static

Processes pre-authorization transactions.

This version of authorize is intended for use by scripts. Instead of passing all of the arguments in order, this method allows creating a QtScript object and setting properties on this object by name. Then the script can pass this object to authorize(const int pccardid, const int pcvv, const double pamount, double ptax, bool ptaxexempt, double pfreight, double pduty, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, QString preftype, int &prefid):

var params = new Object;
params.ccard_id = _ccardid;
params.cvv = _cvv.text;
...
var processor = toolbox.getProcessor();
var result = processor.authorize(params);
if (result.returnVal < 0)
// handle errors
else if (result.returnVal > 0)
// handle warnings
...
Parameters
pinputThe parameter list to unpack and use to call authorize
Returns
A parameter list containing the output parameters, plus one called returnVal holding the return value of authorize
CreditCardProcessor::FraudCheckResult * CreditCardProcessor::avsCodeLookup ( QChar  pcode)
protectedvirtual
QString CreditCardProcessor::buildURL ( const QString  pserver,
const QString  pport,
const bool  pinclport 
)
protectedvirtual

Construct a valid URL from the information in the configuration.

Handle the case where someone leaves off a piece of the URL when entering the basic configuration. Note that a lot of people are used to typing in web browsers, which fill in some parts for them.

If the user did not enter values for the server or the port on the configuration, use the defaults provided by the service' subclass.

Parameters
pserverUse this server, or the defaultServer if blank
pportUse this port, or the defaultPort if blank
pinclportFlag whether the port should be part of the constructed URL or not
See also
defaultServer
defaultPort
int CreditCardProcessor::charge ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
const double  ptax,
const bool  ptaxexempt,
const double  pfreight,
const double  pduty,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
QString  preftype,
int &  prefid 
)
virtual

Processes charge transactions.

This method performs application-level error checking and all of the database work required to handle a credit card charge transaction. It calls doCharge to handle the direct communication with the service.

Warning
This method should never be overridden. Service-specific functionality should be implemented in the doCharge method of the service' subclass.
Parameters
[in]pccardidThe internal id of the credit card to charge
[in]pcvvThe CVV/CCV code of the credit card to charge
[in]pamountThe total amount to charge
[in]ptaxThe subportion of the total which is tax
[in]ptaxexemptWhether or not this transaction is tax exempt
[in]pfreightThe subportion of the total which is freight
[in]pdutyThe subportion of the total which is customs duty
[in]pcurridThe currency of the amount to charge
[in,out]pneworderThe order number associated with this charge
[out]preforderThe reference number associated with this charge
[out]pccpayidThe ccpay_id of the record created by this transaction
[in]preftypeEither cohead or cashrcpt or blank
[in,out]prefidThe cashrcpt_id or cohead_id associated with this transaction
Returns
An index into _errMsg; 0 indicates success
ParameterList CreditCardProcessor::charge ( const ParameterList &  pinput)
static

Processes charge transactions.

This version of charge is intended for use by scripts. Instead of passing all of the arguments in order, this method allows creating a QtScript object and setting properties on this object by name. Then the script can pass this object to charge.

Parameters
pinputThe parameter list to unpack and use to call charge
Returns
A parameter list containing the output parameters, plus one called returnVal holding the return value of charge
See also
authorize(const ParameterList &pinput)
int CreditCardProcessor::chargePreauthorized ( const QString &  pcvv,
const double  pamount,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid 
)
virtual

Processes 'capture' transactions, or charges against a prior preauthorization.

This method performs application-level error checking and all of the database work required to 'capture' or complete the charge against a prior preauthorization. It calls doChargePreauthorized to handle the direct communication with the service.

Warning
This method should never be overridden. Service-specific functionality should be implemented in the doChargePreauthorized method of the service' subclass.
Parameters
[in]pcvvThe CVV/CCV code of the credit card to charge
[in]pamountThe total amount to charge
[in]pcurridThe currency of the amount to charge
[in,out]pneworderThe order number associated with this charge
[in,out]preforderThe reference number (preforder) generated by the preauthorization transaction
[in,out]pccpayidWhen calling the method, pccpayid should be the ccpay_id of the preauthorization record. On return, this is the ccpay_id of the charge record, which may be the same as the preauthorization record.
Returns
An index into _errMsg; 0 indicates success
ParameterList CreditCardProcessor::chargePreauthorized ( const ParameterList &  pinput)
static

Captures preauthorized transactions.

This version of chargePreauthorized is intended for use by scripts. Instead of passing all of the arguments in order, this method allows creating a QtScript object and setting properties on this object by name. Then the script can pass this object to chargePreauthorized.

Parameters
pinputThe parameter list to unpack and use to call chargePreauthorized
Returns
A parameter list containing the output parameters, plus one called returnVal holding the return value of chargePreauthorized
See also
authorize(const ParameterList &pinput)
int CreditCardProcessor::checkCreditCard ( const int  pccid,
const QString &  pcvv,
QString &  pccard_x 
)
protectedvirtual

Check if the given credit card is consistent and active.

This consistency check is used in a number of places before executing a credit card transaction. It confirms that the given card is marked as active in the system and has not expired. If the card has expired based on the expiration month and year, then it is marked as expired in the database. It also makes sure that the CVV has been entered if the system is configured to require it.

Parameters
pccidThe ccard_id of the credit card to check
pcvvThe CVV from the card holder, -1 if not known, -2 if the caller knows it is not required or available (such as for void transactions).
[out]pccard_xThe credit card number, with most of the digits replaced with X. Used for reporting errors.
virtual int CreditCardProcessor::checkCreditCardProcessor ( )
inlineprotectedvirtual
int CreditCardProcessor::credit ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
const double  ptax,
const bool  ptaxexempt,
const double  pfreight,
const double  pduty,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
QString  preftype,
int &  prefid 
)
virtual

Processes credit transactions.

This method performs application-level error checking and all of the database work required to credit a prior charge. It calls doCredit to handle the direct communication with the service.

Warning
This method should never be overridden. Service-specific functionality should be implemented in the doCredit method of the service' subclass.
Parameters
[in]pccardidThe internal id of the credit card to credit
[in]pcvvThe CVV/CCV code of the credit card to credit
[in]pamountThe total amount to credit
[in]ptaxThe subportion of the total which is tax
[in]ptaxexemptWhether or not this transaction is tax exempt
[in]pfreightThe subportion of the total which is freight
[in]pdutyThe subportion of the total which is customs duty
[in]pcurridThe currency of the amount to credit
[in,out]pneworderThe order number associated with this credit
[in,out]preforderThe reference number (preforder) generated by the charge transaction
[in,out]pccpayidWhen calling the method, pccpayid should be the ccpay_id of the original charge record. On return, this is the ccpay_id of the credit record.
[in]preftypeEither cohead or cashrcpt or blank
[in,out]prefidThe cashrcpt_id or cohead_id associated with this transaction
Returns
An index into _errMsg; 0 indicates success
ParameterList CreditCardProcessor::credit ( const ParameterList &  pinput)
static

Processes credit transactions.

This version of credit is intended for use by scripts. Instead of passing all of the arguments in order, this method allows creating a QtScript object and setting properties on this object by name. Then the script can pass this object to credit.

Parameters
pinputThe parameter list to unpack and use to call credit
Returns
A parameter list containing the output parameters, plus one called returnVal holding the return value of credit
See also
authorize(const ParameterList &pinput)
double CreditCardProcessor::currToCurr ( const int  pfrom,
const int  pto,
const double  pamount,
int *  perror = 0 
)
staticprotected

Convert between two currencies.

This is slightly different than the version in the CurrDisplay widget because credit card processing has special error reporting needs.

Parameters
pfromThe source currency
ptoThe destination currency
pamountThe value of the transaction in the source currency
[out]perrorThe CreditCardProcessor error code for a failed conversion
Returns
The value of the transaction in the destination currency
CreditCardProcessor::FraudCheckResult * CreditCardProcessor::cvvCodeLookup ( QChar  pcode)
protectedvirtual
int CreditCardProcessor::defaultPort ( bool  ptestmode = false)
virtual

Return the default port expected by the subclass.

This can differ depending on whether running in live or test mode. It is the subclass' responsibility to set both default ports.

QString CreditCardProcessor::defaultServer ( )
virtual

Return the default server expected by the subclass.

This can differ depending on whether running in live or test mode. It is the subclass' responsibility to set both default servers.

int CreditCardProcessor::doAuthorize ( const int  pccardid,
const QString &  pcvv,
double &  pamount,
const double  ptax,
const bool  ptaxexempt,
const double  pfreight,
const double  pduty,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
ParameterList &  pParams 
)
protectedvirtual

Placeholder for subclasses to override.

See also
authorize

Reimplemented in CyberSourceProcessor, AuthorizeDotNetProcessor, YourPayProcessor, PaymentechProcessor, and ExternalCCProcessor.

int CreditCardProcessor::doCharge ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
const double  ptax,
const bool  ptaxexempt,
const double  pfreight,
const double  pduty,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
ParameterList &  pParams 
)
protectedvirtual

Placeholder for subclasses to override.

See also
charge

Reimplemented in CyberSourceProcessor, AuthorizeDotNetProcessor, YourPayProcessor, PaymentechProcessor, and ExternalCCProcessor.

int CreditCardProcessor::doChargePreauthorized ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
ParameterList &  pParams 
)
protectedvirtual

Placeholder for subclasses to override.

See also
chargePreauthorized

Reimplemented in CyberSourceProcessor, AuthorizeDotNetProcessor, YourPayProcessor, PaymentechProcessor, and ExternalCCProcessor.

int CreditCardProcessor::doCredit ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
const double  ptax,
const bool  ptaxexempt,
const double  pfreight,
const double  pduty,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
ParameterList &  pParams 
)
protectedvirtual

Placeholder for subclasses to override.

See also
credit

Reimplemented in CyberSourceProcessor, AuthorizeDotNetProcessor, YourPayProcessor, PaymentechProcessor, and ExternalCCProcessor.

int CreditCardProcessor::doReversePreauthorized ( const double  pamount,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int  pccpayid,
ParameterList &  pparams 
)
protectedvirtual

Placeholder for subclasses to override.

See also
reversePreauthorized
int CreditCardProcessor::doTestConfiguration ( )
protectedvirtual

Placeholder for subclasses to override.

See also
testConfiguration

Reimplemented in CyberSourceProcessor, AuthorizeDotNetProcessor, YourPayProcessor, PaymentechProcessor, and VerisignProcessor.

int CreditCardProcessor::doVoidPrevious ( const int  pccardid,
const QString &  pcvv,
const double  pamount,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
QString &  papproval,
int &  pccpayid,
ParameterList &  pParams 
)
protectedvirtual

Placeholder for subclasses to override.

See also
voidPrevious

Reimplemented in CyberSourceProcessor, AuthorizeDotNetProcessor, YourPayProcessor, PaymentechProcessor, and ExternalCCProcessor.

QString CreditCardProcessor::errorMsg ( )
static

Returns the most recent error message set by CreditCardProcessor or one of its subclasses.

QString CreditCardProcessor::errorMsg ( const int  pcode)
static

Returns the error message associated with the given pcode.

int CreditCardProcessor::fraudChecks ( )
protectedvirtual

Handle fraud checking as determined by the system configuration.

Reimplemented in YourPayProcessor.

CreditCardProcessor * CreditCardProcessor::getProcessor ( const QString  pcompany = QString())
static

Get a new instance of a specific CreditCardProcessor subclass.

This method is used to retrieve a CreditCardProcessor for actual use by the application, rather than calling CreditCardProcessor::CreditCardProcessor.

getProcessor retrieves the right subclass for the current configuration.

Parameters
pcompanyThis causes the method to instantiate the subclass for the named service, rather than the configured service. pcompany should be an empty string except when checking for errors in configCC
Returns
An instance of a CreditCardProcessor subclass
See also
configCC
bool CreditCardProcessor::handlesChecks ( )
virtual

Returns whether the subclass handles checks.

bool CreditCardProcessor::handlesCreditCards ( )
virtual

Returns whether the subclass handles credit cards.

Reimplemented in CyberSourceProcessor, YourPayProcessor, AuthorizeDotNetProcessor, PaymentechProcessor, and ExternalCCProcessor.

bool CreditCardProcessor::isLive ( )
virtual

Returns whether credit card processing is configured in live mode.

bool CreditCardProcessor::isTest ( )
virtual

Returns whether credit card processing is configured in test mode.

int CreditCardProcessor::printReceipt ( const int  pccpayid)
static

Print the CCReceipt report for a credit card transaction.

Parameters
pccpayidThe internal id of the transaction for which to print the receipt
void CreditCardProcessor::reset ( )
virtual

Reset error handling internal settings so previous transactions don't interfere with new transactions.

Reimplemented in YourPayProcessor.

int CreditCardProcessor::reversePreauthorized ( const double  pamount,
const int  pcurrid,
QString &  pneworder,
QString &  preforder,
int &  pccpayid,
QString  preftype,
int  prefid 
)
virtual

Reverse a preauthorization.

This method performs application-level error checking and all of the database work required to reverse a prior preauthorization. This makes available to the card holder the funds that have been reserved by that preauthorization.

Warning
This method should never be overridden. Service-specific functionality should be implemented in the doReversePreauthorized method of the service' subclass.
Parameters
pamountThe amount to be reversed, not necessarily the same as the amount originally authorized.
pcurridThe currency of the amount.
pneworderThe order number associated with the preauthorization
preforderThe reference number (preforder) generated by the preauthorization transaction
pccpayidThe internal id of the preauthorization transaction
preftypeEither cohead or cashrcpt or blank
prefidThe cashrcpt_id or cohead_id associated with the preauthorization transaction
Returns
An index into _errMsg; 0 indicates success
int CreditCardProcessor::sendViaHTTP ( const QString &  prequest,
QString &  presponse 
)
protectedvirtual

Send an HTTP request to the configured credit card service and wait for its response.

This method is intended to be called by subclasses of CreditCardProcessor. It sends a message to the service using HTTP or HTTPS, as set by the configuration, and waits for a response. If necessary it applies a local certificate for bidirectional encryption.

It is the caller's responsibility to format an appropriate message and decode the response.

Parameters
[in]prequestThe string to send via HTTP
[out]presponseThe string returned by the service
void CreditCardProcessor::sslErrors ( const QList< QSslError > &  errors)
protectedslot
int CreditCardProcessor::testConfiguration ( )
virtual

Test whether common credit card processing configuration options are consistent.

Calls toTestConfiguration to check if service-specific options are set.

Reimplemented in ExternalCCProcessor.

QString CreditCardProcessor::typeToCode ( CCTransaction  ptranstype)
static
int CreditCardProcessor::updateCCPay ( int &  pccpayid,
ParameterList &  pparams 
)
protectedvirtual

Insert into or update the ccpay table based on parameters extracted from the credit card processing service' response to a transaction request.

Todo:
document the parameter names and expected values to help subclassers
int CreditCardProcessor::voidPrevious ( int &  pccpayid)
virtual

Processes void transactions.

This method performs application-level error checking and all of the database work required to void a prior transaction. It calls doVoid to handle the direct communication with the service.

Warning
This method should never be overridden. Service-specific functionality should be implemented in the doVoid method of the service' subclass.
Parameters
pccpayidThis should be the ccpay_id of the original transaction record.
Returns
An index into _errMsg; 0 indicates success
ParameterList CreditCardProcessor::voidPrevious ( const ParameterList &  pinput)
static

Processes void transactions.

This version of voidPrevious is intended for use by scripts. Instead of passing all of the arguments in order, this method allows creating a QtScript object and setting properties on this object by name. Then the script can pass this object to voidPrevious.

Parameters
pinputThe parameter list to unpack and use to call voidPrevious
Returns
A parameter list containing the output parameters, plus one called returnVal holding the return value of voidPrevious
See also
authorize(const ParameterList &pinput)

Member Data Documentation

QList<FraudCheckResult*> CreditCardProcessor::_avsCodes
protected
QString CreditCardProcessor::_company
protected
QList<FraudCheckResult*> CreditCardProcessor::_cvvCodes
protected
int CreditCardProcessor::_defaultLivePort
protected
QString CreditCardProcessor::_defaultLiveServer
protected
int CreditCardProcessor::_defaultTestPort
protected
QString CreditCardProcessor::_defaultTestServer
protected
QString CreditCardProcessor::_errorMsg = ""
staticprotected
QList<QPair<QString, QString> > CreditCardProcessor::_extraHeaders
protected
QHttp* CreditCardProcessor::_http
protected
bool CreditCardProcessor::_ignoreSslErrors
protected
QHash< int, QString > CreditCardProcessor::_msgHash
staticprotected
bool CreditCardProcessor::_passedAvs
protected
bool CreditCardProcessor::_passedCvv
protected
QString CreditCardProcessor::_plogin
protected
QString CreditCardProcessor::_ppassword
protected
QString CreditCardProcessor::_pport
protected
QString CreditCardProcessor::_pserver
protected

The documentation for this class was generated from the following files:

Generated on Fri Oct 7 2016 16:24:47 xTuple ERP Programmer Reference, Version 4.7.0 doxygen 1.8.10