SearchTransactionType Property

If provided, only those transactions matching the TransactionType will be included.

Syntax

 globaltransactionsearch.getSearchTransactionType([callback])
 globaltransactionsearch.setSearchTransactionType( searchTransactionType, [callback])

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSearchTransactionType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSearchTransactionType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If provided, only those transactions matching the TransactionType will be included.

Valid values when SearchPaymentType is 0 (Credit) are:


1	Retrieves all Sale transactions.
2	Retrieves all Return transactions.
3	Retrieves all Reversal transactions.
4	Retrieves all Void transactions.
5	Retrieves all PreAuth transactions.
6	Retrieves all PostAuth/PreAuth transactions.
7	Retrieves all Force transactions.
9	Retrieves all Adjustment transactions.
10	Retrieves all AVSOnly transactions.
19	Retrieves all CardVerify transactions.

Valid values when SearchPaymentType is 1 (Debit) are:


1	Retrieves all Sale transactions.
2	Retrieves all Return transactions.

Valid values when SearchPaymentType is 2 (EBT) are:


11	Retrieves all CashBenefit transactions.
12	Retrieves all CashBenefitSale transactions.

You may combine set this to a comma separated list to specify multiple types. For instance, a SearchTransactionType of "1,2" will pull all transactions with either Sale or Return transaction types.

This property is not applicable for Transaction Summaries.

Data Type

String