EncryptedKeyIndex Property
Specifies the current keys that are in use in the PIN pad and by Paymentech.
Syntax
ptechcanadiandebit.getEncryptedKeyIndex([callback]) ptechcanadiandebit.setEncryptedKeyIndex( encryptedKeyIndex, [callback])
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 getEncryptedKeyIndex([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 setEncryptedKeyIndex([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 EncryptedKeyIndex specifies the current keys that are in use on the host (Paymentech) and in the PIN pad. This EncryptedKeyIndex is updated after every transaction, and is required to be sent in all transactions except a RequestCurrentKeys transaction. The normal range is from 1 through 9. The default is zero (0), and indicates that no encryption keys have been established. Transaction requests should never be sent with a value of zero (0). Note that MACReversals must be sent with the EncryptedKeyIndex from the original transaction to insure that the EncryptedPIN can be properly translated by the host.
Keys are required to be renewed every:
- 200 Transactions
- 24 Hours
- Each time a Batch is released for settlement
- Whenever the PIN pad loses sync with the server
If the ResponseForceKeyRequest property is True after any transaction, you must immediately perform a RequestCurrentKeys transaction before sending any more authorizations.
Data Type
Integer