A simple interface for entering credit card transaction information manually. More...

#include <externalccprocessor.h>

Inheritance diagram for ExternalCCProcessor:

Public Types
enum	CCTransaction { Authorize, Reverse, Capture, Charge, Credit, Void }

enum	FraudCheck { Match, NoMatch, NotAvail, Address, PostalCode, Name, NotProcessed, Invalid, ServiceUnavailable, IssuerNotCertified, Suspicious, Unsupported }

Public Member Functions
	ExternalCCProcessor ()

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 Q_INVOKABLE int	canProcessCCTrans (int pCardId, int pCurrId)
	Checks if all accounting related setup and mapping is valid for a Credit Card and Currency. 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	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 ()
	Simplify CreditCardProcessor's implementation - we really don't care about much with the external credit card processor. 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 bool	certificateIsValid (const QSslCertificate *cert)

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 CreditCardProcessor *	getProcessor (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 Slots
void	sslErrors (const QList< QSslError > &errors)

Protected Member Functions
virtual FraudCheckResult *	avsCodeLookup (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 FraudCheckResult *	cvvCodeLookup (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 &pnweorder, 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 &pnweorder, 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 &pnweorder, 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 &pnweorder, 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 &pnweorder, 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 bool	handlesCreditCards ()
	Returns whether the subclass handles credit cards. More...

virtual int	handleTrans (const int pccardid, const QString &ptype, const QString &pcvv, const double pamount, const int pcurrid, QString &pneworder, QString &preforder, int &pccpayid, ParameterList &pparams)

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...

virtual bool	waitForHTTP ()
	Wait for the HTTP request sent by _manager to finish. Added for Qt5. More...

Static Protected Member Functions
static double	currToCurr (const int, const int, const double, int *=0)
	Convert between two currencies. 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	_pemfile

QString	_plogin

QString	_ppassword

QString	_pport

QString	_pserver

Static Protected Attributes
static QString	_errorMsg

static QHash< int, QString >	_msgHash

Detailed Description

A simple interface for entering credit card transaction information manually.

Member Enumeration Documentation

◆ CCTransaction

enum CreditCardProcessor::CCTransaction

inherited

Enumerator
Authorize
Reverse
Capture
Charge
Credit
Void

◆ FraudCheck

enum CreditCardProcessor::FraudCheck

inherited

Enumerator
Match
NoMatch
NotAvail
Address
PostalCode
Name
NotProcessed
Invalid
ServiceUnavailable
IssuerNotCertified
Suspicious
Unsupported

Constructor & Destructor Documentation

◆ ExternalCCProcessor()

ExternalCCProcessor::ExternalCCProcessor ( )

Member Function Documentation

◆ authorize() [1/2]

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
	)

virtualinherited

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]	pccardid	The internal id of the credit card to preauthorize
[in]	pcvv	The CVV/CCV code of the credit card to preauthorize
[in]	pamount	The 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]	ptax	The subportion of the total which is tax
[in]	ptaxexempt	Whether or not this transaction is tax exempt
[in]	pfreight	The subportion of the total which is freight
[in]	pduty	The subportion of the total which is customs duty
[in]	pcurrid	The currency of the amount to preauthorize
[in,out]	pneworder	The order number associated with this preauthorization
[out]	preforder	The reference number associated with this preauthorization (may be required to 'capture' the preauthorization)
[out]	pccpayid	The ccpay_id of the record created by this transaction
[in]	preftype	Either `cohead` or `cashrcpt` or blank
[in,out]	prefid	The cashrcpt_id or cohead_id associated with this transaction

Returns: An index into _errMsg; 0 indicates success

◆ authorize() [2/2]

ParameterList CreditCardProcessor::authorize ( const ParameterList & pinput )

staticinherited

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

pinput The 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

◆ avsCodeLookup()

CreditCardProcessor::FraudCheckResult * CreditCardProcessor::avsCodeLookup ( QChar pcode )

protectedvirtualinherited

◆ buildURL()

QString CreditCardProcessor::buildURL	(	const QString	pserver,
		const QString	pport,
		const bool	pinclport
	)

protectedvirtualinherited

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

pserver	Use this server, or the defaultServer if blank
pport	Use this port, or the defaultPort if blank
pinclport	Flag whether the port should be part of the constructed URL or not

See also: defaultServer; defaultPort

◆ canProcessCCTrans()

int CreditCardProcessor::canProcessCCTrans	(	int	pCardId,
		int	pCurrId
	)

virtualinherited

Checks if all accounting related setup and mapping is valid for a Credit Card and Currency.

Calls the database stored procedure, canProcessPaymentGatewayTransaction() to check if setup is valid.

◆ certificateIsValid()

bool CreditCardProcessor::certificateIsValid ( const QSslCertificate * cert )

staticinherited

◆ charge() [1/2]

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
	)

virtualinherited

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]	pccardid	The internal id of the credit card to charge
[in]	pcvv	The CVV/CCV code of the credit card to charge
[in]	pamount	The total amount to charge
[in]	ptax	The subportion of the total which is tax
[in]	ptaxexempt	Whether or not this transaction is tax exempt
[in]	pfreight	The subportion of the total which is freight
[in]	pduty	The subportion of the total which is customs duty
[in]	pcurrid	The currency of the amount to charge
[in,out]	pneworder	The order number associated with this charge
[out]	preforder	The reference number associated with this charge
[out]	pccpayid	The ccpay_id of the record created by this transaction
[in]	preftype	Either `cohead` or `cashrcpt` or blank
[in,out]	prefid	The cashrcpt_id or cohead_id associated with this transaction

Returns: An index into _errMsg; 0 indicates success

◆ charge() [2/2]

ParameterList CreditCardProcessor::charge ( const ParameterList & pinput )

staticinherited

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

pinput The 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)

◆ chargePreauthorized() [1/2]

ParameterList CreditCardProcessor::chargePreauthorized ( const ParameterList & pinput )

staticinherited

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

pinput The 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)

◆ chargePreauthorized() [2/2]

int CreditCardProcessor::chargePreauthorized	(	const QString &	pcvv,
		const double	pamount,
		const int	pcurrid,
		QString &	pneworder,
		QString &	preforder,
		int &	pccpayid
	)

virtualinherited

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]	pcvv	The CVV/CCV code of the credit card to charge
[in]	pamount	The total amount to charge
[in]	pcurrid	The currency of the amount to charge
[in,out]	pneworder	The order number associated with this charge
[in,out]	preforder	The reference number (preforder) generated by the preauthorization transaction
[in,out]	pccpayid	When 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

◆ checkCreditCard()

int CreditCardProcessor::checkCreditCard	(	const int	pccid,
		const QString &	pcvv,
		QString &	pccard_x
	)

protectedvirtualinherited

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

	pccid	The ccard_id of the credit card to check
	pcvv	The 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_x	The credit card number, with most of the digits replaced with `X`. Used for reporting errors.

◆ checkCreditCardProcessor()

virtual int CreditCardProcessor::checkCreditCardProcessor ( )

inlineprotectedvirtualinherited

◆ credit() [1/2]

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
	)

virtualinherited

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]	pccardid	The internal id of the credit card to credit
[in]	pcvv	The CVV/CCV code of the credit card to credit
[in]	pamount	The total amount to credit
[in]	ptax	The subportion of the total which is tax
[in]	ptaxexempt	Whether or not this transaction is tax exempt
[in]	pfreight	The subportion of the total which is freight
[in]	pduty	The subportion of the total which is customs duty
[in]	pcurrid	The currency of the amount to credit
[in,out]	pneworder	The order number associated with this credit
[in,out]	preforder	The reference number (preforder) generated by the charge transaction
[in,out]	pccpayid	When 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]	preftype	Either `cohead` or `cashrcpt` or blank
[in,out]	prefid	The cashrcpt_id or cohead_id associated with this transaction

Returns: An index into _errMsg; 0 indicates success

◆ credit() [2/2]

ParameterList CreditCardProcessor::credit ( const ParameterList & pinput )

staticinherited

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

pinput The 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)

◆ currToCurr()

double CreditCardProcessor::currToCurr	(	const int	pfrom,
		const int	pto,
		const double	pamount,
		int *	perror = `0`
	)

staticprotectedinherited

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

	pfrom	The source currency
	pto	The destination currency
	pamount	The value of the transaction in the source currency
[out]	perror	The CreditCardProcessor error code for a failed conversion

Returns: The value of the transaction in the destination currency

◆ cvvCodeLookup()

CreditCardProcessor::FraudCheckResult * CreditCardProcessor::cvvCodeLookup ( QChar pcode )

protectedvirtualinherited

◆ defaultPort()

int CreditCardProcessor::defaultPort ( bool ptestmode = false )

virtualinherited

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.

◆ defaultServer()

QString CreditCardProcessor::defaultServer ( )

virtualinherited

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.