Main Page

Please see the most important fr.marketpay.driver.IDriver and fr.marketpay.driver.ITransactionHandler interfaces.

Library structure

The ECR driver consists of 3 library files. The marketpay_pos_api.dll (API definitions) and marketpay-pos-driver.dll (.NET wrapper on core library) are .NET libraries so they both have to be included into project as DLL library reference in VisualStudio. There is also 3rd necessary library marketpay-driver-cpp.dll file which is written in C++. This file is not needed at build time because it's dynamically linked in runtime. But it has to be reached by executable program. The simplest way is to copy this file into directory where an exe app is located. There are also 2 other ways like modifying PATH environmental variable or putting library into system directory like C:/Windows/System32. The last 2 ways are more difficult because of access permission or need of OS restart)

Diagrams

Diagrams 1

The diagram below shows processing transation in direct mode.

Diagrams 2

The diagram below shows processing transation in dual mode which allows to modify an amount during processing a transaction depending on loyaltyId or PAN.

Diagrams 3

The diagram below shows processing transation which is successfully aborted. An early state of transaction is usually possible to aborted a transaction.

Diagrams 4

The diagram below shows processing transation which is unsuccessfully aborted. Usually transaction can not be aborted when fr.marketpay.driver.ITransactionHandler.onTransactionStatus(TransactionStatus) with BankAutorised status is called

Diagrams 5

The diagram below shows processing transaction interrupted by broken TCP/IP connection.

Diagrams 6

The diagram below shows processing transaction interrupted by broken TCP/IP connection

Diagrams 7

The diagram below shows gettign card data which can be interrupted using fr.marketpay.driver.IDriver.abortGettingCardData()

Example code

There is below example console application source in Visual Basic language showing how to perform transation in direct mode.

Imports System.Windows
Imports fr.marketpay.driver
 
Module Module1
 
    Dim driver As fr.marketpay.driver.IDriver
 
    Public Class Logger
        Implements ILogger
 
        Public Sub log(logLevel As LogLevel, message As String) Implements ILogger.log
            Console.WriteLine("DRIVER LOG: " + message)
        End Sub
    End Class
 
    Public Class TransactionHandler
        Implements ITransactionHandler
 
        Dim transactionRuntime As ITransactionRuntime
 
        Private Sub ITransactionHandler_onTransactionStarted(runtime As ITransactionRuntime) Implements ITransactionHandler.onTransactionStarted
            Console.WriteLine("ITransactionHandler_onTransactionStarted")
            transactionRuntime = runtime
        End Sub
 
        Private Sub ITransactionHandler_onTransactionStatus(status As TransactionStatus) Implements ITransactionHandler.onTransactionStatus
            Console.WriteLine("ITransactionHandler_onTransactionStatus: " + status.ToString)
 
        End Sub
 
        Private Sub ITransactionHandler_onDualProcessing(intermediateTransactionResult As IntermediateTransactionResult, mutableDualTransactionParams As MutableDualTransactionParams) Implements ITransactionHandler.onDualProcessing
            Console.WriteLine("ITransactionHandler_onDualProcessing")
 
            If True Then
                Console.WriteLine("Modifying amount...")
                mutableDualTransactionParams.amount = 4567
                mutableDualTransactionParams.merchantOption = "modified merchant option"
            Else
                Console.WriteLine("Aborting")
                transactionRuntime.abort()
            End If
        End Sub
    End Class
 
    Sub Main()
        Dim loggerHandler As fr.marketpay.driver.ILogger
        loggerHandler = New Logger()
 
        Dim transactionHandler As fr.marketpay.driver.ITransactionHandler
        transactionHandler = New TransactionHandler()
 
        Dim ecrConfiguration As fr.marketpay.driver.EcrConfiguration
        ecrConfiguration = New fr.marketpay.driver.EcrConfiguration()
 
        Dim poiConfiguration As fr.marketpay.driver.PoiConfiguration
        poiConfiguration = New fr.marketpay.driver.PoiConfiguration()
 
        Dim transactionParams As fr.marketpay.driver.TransactionParams
        transactionParams = New fr.marketpay.driver.TransactionParams()
 
        driver = New fr.marketpay.driver.Driver(loggerHandler)
 
        ecrConfiguration.ecrId = "123"
        ecrConfiguration.cashierId = "456"
        ecrConfiguration.providerId = "Novelpay"
        ecrConfiguration.appName = "ECR Simulator"
        ecrConfiguration.version = "0.0.5"
        ecrConfiguration.componentDescription = ""
        ecrConfiguration.operatorLanguage = "PL"
        ecrConfiguration.printerAvailable = True
 
        poiConfiguration.address = "192.168.42.129:7778"
        poiConfiguration.maxMessageSize = 32768
        poiConfiguration.tc1 = 1000
        poiConfiguration.tc1 = 2000
 
        transactionParams.type = TransactionType.Purchase
        transactionParams.mode = TransactionMode.Dual
        transactionParams.amount = 1234
        transactionParams.amountTip = 0
        transactionParams.amountCashback = 0
        transactionParams.transactionId = "123"
        transactionParams.currency = 978 'euro
        transactionParams.cashierId = "666"
        transactionParams.merchantId = "777"
        transactionParams.terminalId = "888"
        transactionParams.merchantOption = ""
 
        Console.WriteLine("API version: " + driver.getApiVersion().ToString)
        Console.WriteLine("driver version: " + driver.getVersion())
 
        Console.WriteLine("Openign...")
        driver.open(ecrConfiguration, poiConfiguration)
        Console.WriteLine("Open...")
 
        Console.WriteLine("Performing transaction...")
        driver.processTransaction(transactionParams, transactionHandler)
        Console.WriteLine("Performed transaction")
 
        Console.WriteLine("Closing...")
        driver.close()
        Console.WriteLine("closed")
 
        Console.WriteLine("the end")
    End Sub
End Module

Release notes

v17.0.0

• fr.marketpay.driver.Status.Partial has been added. Transaction may finish with Partial status. User is obligated to handle such transaction result.
• fr.marketpay.driver.IDriver.processCheckTransaction() has been added.

v16.1.0

• Versioning change: <API-version>.<C++-core-implementation-version>.<net-wrapper-version>.
• Logging the warning about using wrong ecrdrv-core library version.
• fr.marketpay.driver.CardData.panSequenceNumber has been added.
• fr.marketpay.driver.CardData.applicationId has been added.
• fr.marketpay.driver.PinChangeResult.customerReceipt has been added.

0.0.13

• fr.marketpay.driver.CancellationParams and fr.marketpay.driver.CancellationResult classes and fr.marketpay.driver.IDriver.transactionCancellation() method have been added
• fr.marketpay.driver.IDriver.pinChange() and fr.marketpay.driver.IDriver.abortPinChange() methods have been added
• fr.marketpay.driver.TransactionResult.terminalTransactionId has been added
• fr.marketpay.driver.TransactionParams.transactionId field has been renamed to fr.marketpay.driver.TransactionParams.ecrTransactionId to avoid confusing with fr.marketpay.driver.TransactionResult.terminalTransactionId

0.0.12

• a fr.marketpay.driver.TransactionType.CashAdvance has been added

0.0.11

• a fr.marketpay.driver.CardData.loyaltyErrorFlag has been added

0.0.10

• a fr.marketpay.driver.IDriver.updateTerminal() function and fr.marketpay.driver.TerminalUpdateResult class have been added
• a fr.marketpay.driver.exception.InvalidCallException class has been added

0.0.9

• a fr.marketpay.driver.EcrConfiguration.poiId has been added
• a merchantId and terminalId fields have been removed from fr.marketpay.driver.TransactionParams (they are replaced with fr.marketpay.driver.EcrConfiguration.poiId)
• a fr.marketpay.driver.TransactionResult.cardData has been added
• a loyaltyId, extractedPan and, cardCapture fields from fr.marketpay.driver.TransactionResult have been removed (replaced with fr.marketpay.driver.TransactionResult.cardData which contains the same data)

0.0.8

• the fr.marketpay.driver.IDriver.getCardData() and fr.marketpay.driver.IDriver.abortGettingCardData() have been added.
• the fr.marketpay.driver.IDriver.abortProcessingTransaction() has been added for convinence
• the fr.marketpay.driver.ITransactionRuntime.abort() is marked as deprecated because fr.marketpay.driver.IDriver.abortProcessingTransaction() has been added.
• from fr.marketpay.driver.IntermediateTransactionResult class the following fields has been exported into fr.marketpay.driver.CardData class: cardCapture, extractedPan, loyaltyId and schema;
• updated desciption of Exceptions which requires reopen driver
• diagrams have been added

0.0.7

• parameterless constructor fr.marketpay.driver.Driver() has been changed to fr.marketpay.driver.Driver(fr.marketpay.driver.ILogger).
• fr.marketpay.driver.ILogger interface and fr.marketpay.driver.LogLevel class have been added.
• fr.marketpay.driver.IDriver.getLastTransaction() function and fr.marketpay.driver.LastTransactionResult class added.
• fr.marketpay.driver.IDriver.activateTerminal() function and fr.marketpay.driver.TerminalActivationResult class have been added.
• fr.marketpay.driver.exception.DriverNotOpenException and fr.marketpay.driver.exception.MessageFormatException classes added

0.0.6

• Exceptions have been added in fr.marketpay.driver.exception namespace.