LockType Property
Indicates the type of lock requested by the LockCard method.
Syntax
fdmsgiftcard.getLockType([callback]) fdmsgiftcard.setLockType( lockType, [callback])
Possible Values
0 (ltFullLock), 1 (ltPartialLock)
Default Value
0
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 getLockType([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 setLockType([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
This property is only used when locking funds on a card. If set to ltFullLock (default), the full balance on the gift card will be locked, and the customer will be unable to use funds on the card until the card is unlocked by setting RedemptionType to rtRedemptionWithUnlock and calling RedeemCard.
If set to ltPartialLock, only the amount indicated by the TransactionAmount property is locked. Any remaining funds on the card may be used for other purchases.
Data Type
Integer