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

MTSCRA Callback Messages 1 - 10

OnDeviceConnectionStateChanged

This message occurs when the state of the device is changed.

Parameter

Description

Obj

MTConnectionState value indicating the state of the device:

Disconnected Connecting Connected Disconneting

OnCardDataStateChanged

This message occurs when the state of the card information is changed.

Parameter

Description

obj

MTCardDataState value indicating the state of the card data:

DataNotReady DataReady DataError

OnDataReceived

This message occurs when card information is received from the device.

Parameter

Description

obj

IMTCardData value containing the card data received.

OnDeviceResponse

This message occurs when a response is received from the device.

Parameter

Description

obj

String containing the response data received from the device.

OnTransactionStatus (EMV Device Only)

This message occurs when transaction status update is received from the EMV device.

Parameter

Description

obj

Byte array containing the data received from the device. See table below for descriptions of the data.

Offset

Field Name

Value

0

Event

Indicates the event that triggered this notification: 0x00 = No events since start of transaction

0x01 = Card Inserted 0x02 = Card Error

0x03 = Transaction Progress Change 0x04 = Waiting for User Response 0x05 = Timed Out

0x06 = Transaction Terminated 0x07 = Host Cancelled Transaction 0x08 = Card Removed

1

Current Transaction Time remaining

Indicates the remaining time available, in seconds, for the transaction to complete. If the transaction does not complete within this time it will be aborted.

2

Current Transaction Progress Indicator

This one byte field indicates the current processing stage for the transaction: 0x00 = No transaction in progress

0x01 = waiting for user to insert card 0x02 = powering up the card

0x03 = selecting the application

0x04 = waiting user language selection 0x05 = waiting user application selection 0x06 = initiating application

0x07 = reading application data 0x08 = offline data authentication 0x09 = process restrictions

0x0A = card holder verification 0x0B = terminal risk management 0x0C = terminal action analysis

0x0D = generating first application cryptogram 0x0E = card action analysis

0x0F = online processing

0x10 = waiting online processing response 0x11 = transaction completion

0x12 = transaction error 0x13 = transaction approved 0x14 = transaction declined

3-4

Final Status

TBD

OnDisplayMessageRequest (EMV Device Only)

This message occurs when the EMV device has display message to present to the user.

Parameter

Description

obj

Byte array containing the display message. If the length is zero, the request to clear the display.

OnUserSelectionRequest (EMV Device Only)

This message occurs when the EMV device has user selection message to present to the user.

Parameter

Description

obj

Byte array containing the data received from the device. See table below for descriptions of the data.

Offset

Field Name

Value

0

Selection Type

This field specifies what kind of selection request this is: 0x00 = Application Selection

0x01 = Language Selection

1

Timeout

Specifies the maximum time, in seconds, allowed to complete the selection process. If this time is exceeded, the host should send the User Selection Result command with transaction will be aborted and an appropriate Transaction Status will be available. Value 0 is not allowed.

2

Menu Items

This field is variable length and is a collection of “C” style zero terminated strings (maximum 17 strings). The maximum length of each string is 20 characters, not including a Line Feed (0x0A) character that may be in the string. The last string may not have the Line Feed character.

The first string is a title and should not be considered for selection.

It is expected that the receiver of the notification will display the menu items and return (in the User Selection Result request) the number of the item the user selects. The minimum value of the Selection Result should be 1 (the first item, #0, was a title line only). The maximum value of the Selection Result is based on the number of items displayed.

OnARQCReceived (EMV Device Only)

This message occurs when ARQC is received from the EMV device.

Parameter

Description

Obj

Byte array containing the data received from the device. See table below for descriptions of the data.

Offset

Field Name

Value

0

Message Length

Two byte binary, most significant byte first. This gives the total length of the ARQC message that follows.

2

ARQC

Message

Byte array containing the ARQC Message. For details about the ARQC format, see the Programmer's Manual (COMMANDS) for the specific device you are communicating with.

OnTransactionResult (EMV Device Only)

This message occurs when transaction result is received from the EMV device.

Parameter

Description

Obj

Byte array containing the data received from the device. See table below for descriptions of the data.

Offset

Field Name

Value

0

Signature Required

This field indicates whether a card holder signature is required to complete the transaction:

0x00 = No signature required 0x01 = Signature required

If a signature is required, it is expected that the host will acquire the signature from the card holder as part of the transaction data.

1

Batch Data Length

Two byte binary, most significant byte first. This gives the total length of the Batch Data that follows.

3

Batch Data

Byte array containing the Batch Data. For details about the batch data format, see the Programmer's Manual (COMMANDS) for the specific device you are communicating with..

OnEMVCommandResult (EMV Device Only)

This message occurs when an EMV command result is received from the EMV device.

Result Code Description

  • 0x0000 = Success 0x0001 = Failure

  • 0x0381 = Failure, DUKPT scheme is not loaded

  • 0x0382 = Failure, DUKPT scheme is loaded but all of its keys have been used

  • 0x0383 = Failure, DUKPT scheme is not loaded (Security Level not 3 or 4)

  • 0x0384 = Invalid Total Transaction Time field

  • 0x0385 = Invalid Card Type field 0x0386 = Invalid Options field

  • 0x0387 = Invalid Amount Authorized field

  • 0x0388 = Invalid Transaction Type field

  • 0x0389 = Invalid Cash Back field

  • 0x038A = Invalid Transaction Currency Code field

  • 0x038B = Invalid Selection Status

  • 0x038C = Invalid Selection Result

  • 0x038D = Failure, no transaction currently in progress

  • 0x038E = Invalid Reporting Option

  • 0x038F = Failure, transaction already in progress 0x0390 = Device Has No Keys

  • 0x0391 = Invalid Device Serial Number

  • 0x0392 = Invalid Type of MAC field

  • 0x0393 = Invalid Slot Number field

  • 0x0394 = Invalid Operation field

  • 0x0395 = Invalid Database Selector field

  • 0x0396 = Invalid System Date and Time

  • 0x0396 = Invalid Objects to Write field

  • 0x0396 = Invalid Tags to Read field

  • 0x0396 = Invalid Date / Time data (Date / Time has not been set yet)

  • 0x0397 = Invalid MAC

  • 0x0398 = No Slots Available

  • 0x0399 = Object Write Protected

  • 0x039B = Invalid CAPK Checksum

  • 0x039C = Invalid Configuration Identifier

Last updated