For the complete documentation index, see llms.txt. This page is also available as Markdown.
Page cover

MTSCRA Class Methods - 61 - 69

requestCardSwipe

Request the device to display a message for swiping a card.

public int requestSwipeCard( 
        byte waitTime, 
        byte messageID, 
        byte beepCount)

Parameters:

Parameter

Description

waitTime

Wait Time in seconds, (0x01 – 0xFF; 0x00 = Infinite Wait Time)

messageID

Card Message ID to display:

0x00 = Swipe Card / Idle (alternating) 0x01 = Swipe Card

0x02 = Please Swipe Card

0x03 = Please Swipe Card Again 0x04 = Chip Error, Use Mag Stripe 0x07 = Please Swipe, Insert or Tap 0x08 = Insert Card

0x09 = Please Swipe or Insert Card 0x0C = Tap Card

0x0D = Please Insert or Tap Card

beepCount

0x00 = None

0x01 = Single Beep 0x02 = Double Beep

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

getMSRData

This function requests the device to send MSR data after calling requestCardSwipe().

public int getMSRData()

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

requestPINEntry

Request PIN entry by the cardholder.

Parameters:

Parameter

Description

waitTie

Wait Time in seconds, (0x01 – 0xFF; 0x00 = 256 seconds)

pinMode

Message mode to display on the device. 0x00 = Enter PIN

0x01 = Enter PIN Amount 0x02 = Reenter PIN Amount 0x03 = Reenter PIN

0x04 = Verify PIN

pinLength

Range for the PIN entered.

High nibble = Max PIN length (<=12) Low nibble = Min PIN length (>=4)

Example: 0x64 is for PIN length of 4 to 6 Example: 0xC4 is for PIN length of 4 to 12 Example: 0xC8 is for PIN length of 8 to 12

beepCount

0x00 = None

0x01 = Single Beep 0x02 = Double Beep

pinOption

Bit(7,6,5)

PIN Block Format 0b000 = ISO Format 0

0b001 = ISO Format 1 (No PAN Required) 0b011 = ISO Format 3

0b100 = ISO Format 4

Bit(4,3)

(PIN Language Select Only) Language Select:

0b00 = Disabled

0b01 = English or French Only

0b10 = All Languages as defined by DFDF2D

Bit 2

Wait Message

Bit 1

Verify PIN

Bit 0

Reserved

amount

Numeric: n12

pan

Min.: 9 bytes; Max.: 21 bytes

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

requestManualCardEntry

Request the card holder to enter card data manually.

Parameters:

Parameter

Description

waitTime

Wait Time in seconds, (0x01 – 0xFF; 0x00 = 256 seconds)

options

Message and mode to display on the device. Bit (7,6,5)

Reserved

Bit 4

0=Use PAN min 9, max 19

1=Use PAN min 14, max 21

Bit 3

1=Use PAN in PIN block creation

Bit 2

1=Use QwickCodes entry Bit (1,0)

0 = Acct, Date, CVC

1 = Acct, Date

2 = Acct, CVC

3 = Acct

beepCount

0x00 = None

0x01 = Single Beep 0x02 = Double Beep

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

requestSignature

Request the card holder to sign on the screen.

Parameters:

Parameter

Description

waitTime

Wait Time in seconds, (0x01 – 0xFF; 0x00 = 256 seconds)

options

0x00 = Timeout clears any signature data

0x01 = Timeout returns timeout status plus length collected. Sig Data can be requested.

beepCount

0x00 = None

0x01 = Single Beep 0x02 = Double Beep

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

getSignature

Request the card holder signature from the device. To be used after calling requestSignature().

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

requestEncryptedInputData

Request the card holder to enter text for encryption.

Parameters:

Parameter

Description

waitTime

Wait Time in seconds, (0x01 – 0xFF; 0x00 = 256 seconds)

beepCount

0x00 = None

0x01 = Single Beep 0x02 = Double Beep

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

getEncryptedInputData

Request the encrypted input data from the device. To be used after calling requestEncryptedInputData().

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

cancelRequest

Request to cancel a command or request while the device is waiting for the card holder.

Return Value:

  • 0 = Success

  • 9 = Error

  • 15 = Busy

Last updated