Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

SearchExcludeTransType Property

If specified, any transaction matching the ExcludeTransType will be excluded from the search results.

Syntax

 globaltransactionsearch.getSearchExcludeTransType([callback])
 globaltransactionsearch.setSearchExcludeTransType( searchExcludeTransType, [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 getSearchExcludeTransType([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 setSearchExcludeTransType([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 specified, any transaction matching the ExcludeTransType will be excluded from the search results. Valid values include:

Adjustment Excludes all tip adjustment transactions.
Authorization Excludes all previously-authorized (pre-auth) transactions.
BalanceInquiry Excludes all balance inquiry transactions.
Capture Excludes all captured transactions.
Credit Excludes all return transactions.
ForceCapture Excludes all force-auth transactions.
GetStatus to make an inquiry to an EBT cards balance.
PostAuth Excludes all post-auth transactions.
RepeatSale Excludes all repeat-sale transactions.
Reversal Excludes all reversal transactions.
Sale Excludes all sale transactions.
Void Excludes all void transactions.

You may set this to a comma separated list to exclude multiple transaction types. For instance, an SearchExcludeTransType of "Credit,Sale" will ignore all transactions with either Credit or Sale transaction types.

This property is not applicable for Transaction Summaries.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0