SearchSettleMessage Property

The settlement ID or message returned from the host.

Syntax

 globaltransactionsearch.getSearchSettleMessage([callback])
 globaltransactionsearch.setSearchSettleMessage( searchSettleMessage, [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 getSearchSettleMessage([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 setSearchSettleMessage([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

The settlement ID or message returned from the host. If specified, only transactions with a matching SettleMessage value will be returned.

Data Type

String