SearchExcludePaymentType Property

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

Syntax

 globaltransactionsearch.getSearchExcludePaymentType([callback])
 globaltransactionsearch.setSearchExcludePaymentType( searchExcludePaymentType, [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 getSearchExcludePaymentType([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 setSearchExcludePaymentType([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 ExcludePaymentType will be excluded from the search results. Valid values include:

You may set this to a comma separated list to exclude multiple payment types. For instance, an SearchExcludePaymentType of "DEBIT,EBT" will ignore all transactions with either DEBIT or EBT payment types.

This property is not applicable for Transaction Summaries.

Data Type

String