ResponseMACKey Property

MAC Encryption key to be loaded into the PIN pad device.

Syntax

 ptechcanadiandebit.getResponseMACKey([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 getResponseMACKey([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 setResponseMACKey([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

MAC Encryption key to be loaded into the PIN pad device. MAC encryption key encrypted under the PIN pad master key. This key changes as required by Interac regulations, and should be loaded into the PIN pad device upon receipt. The developer should validate the MACValue returned in the host response using this key. Future transactions must contain a MACValue that was computed by the PIN pad using this key.

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

When the host changes the key, a new key index is assigned and returned in the EncryptedKeyIndex property. The class needs to update the PIN pad with the ResponsePINKey and ResponseMACKey after each transaction in order to stay in sync with the host. If the keys and/or the EncryptedKeyIndex become out of sync, you must use the RequestCurrentKeys method to retrieve a valid set of keys and restore the synchronization.

If the ResponseForceKeyRequest property is True after any transaction, you must immediately perform a RequestCurrentKeys transaction before sending any more authorizations.

This property is read-only.

Data Type

String