DebitKSN Property

Clear-text Key Sequence Number, used for Debit and EBT transactions.

Syntax

 fdmsomaharetail.getDebitKSN([callback])
 fdmsomaharetail.setDebitKSN( debitKSN, [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 getDebitKSN([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 setDebitKSN([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

A 19 or 20-byte Key Sequence Number (KSN) and associated DebitPIN are required for all Debit Sale and DebitRefund transactions. These values must be retrieved from a certified DUKPT DES pin pad device. A 20-byte Key Sequence Number consists of a 1-byte pad character ('F'), a 9-byte Base Derivation Key Id (BDK ID), a 5-byte device Id, and a 5-byte transaction counter. If this property is set with a Key Sequence Number less than 20 bytes in length, the class will pad it on the left with 'F' characters.

The DebitPIN and DebitKSN are not used for Food Stamp Voucher transactions.

Data Type

String