ResponseLockAmount Property

Contains the amount that is locked and cannot be used.

Syntax

 fdmsgiftcard.getResponseLockAmount([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 getResponseLockAmount([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 setResponseLockAmount([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

Contains the amount that is locked and cannot be used.

If the gift card has previously been locked via the LockCard method, this property will reflect the balance that is locked and cannot be used for purchases.

This property is read-only.

Data Type

String