fr.marketpay.driver Namespace Reference

Namespaces
namespace	exception

Data Structures
class	BalanceInquiryResult
class	CancellationParams
	Parameters required to cancel payment transaction. More...
class	CancellationResult
	Result of transaction cancellation. More...
class	CardData
	Contains card identification data obtained during card reading operation. More...
class	CheckParams
	Data describing the check (cheque). More...
class	DccDetails
class	EcrCapabilities
class	EcrConfiguration
interface	IDriver
interface	ILogger
class	IntermediateTransactionResult
interface	ITransactionHandler
interface	ITransactionRuntime
class	LastTransactionResult
class	MutableDualTransactionParams
class	PinChangeResult
	Describes the result of PIN change operation. More...
class	PoiConfiguration
class	TerminalActivationResult
class	TerminalStatus
class	TerminalUpdateResult
	Describes update result of payment terminal. More...
class	TransactionParams
class	TransactionResult

Enumerations
enum class	CardCapture {   Chip , Contactless , MagneticStripe , TapPhone ,   Other }
enum class	LastTransactionState { NotFound , InProgress , Finished }
enum class	LogLevel {   Verbose , Debug , Info , Warning ,   Error }
enum class	Status { OK , NOK , Partial }
enum class	TransactionMode { Direct , Dual }
enum class	TransactionStatus { WaitingForCard , PinRequired , BankAuthorization }
enum class	TransactionType {   Purchase , Refund , CashAdvance , PreAuthorisation ,   PreAuthorisationCompletion }

Enumeration Type Documentation

CardCapture

enum fr.marketpay.driver.CardCapture

strong

Enumerator
Chip
Contactless
MagneticStripe
TapPhone
Other

Definition at line 3 of file CardCapture.cs.

    {
        Chip, Contactless, MagneticStripe, TapPhone, Other
    }

LastTransactionState

enum fr.marketpay.driver.LastTransactionState

strong

Describes a state of last transaction.

Since

0.0.7

Enumerator
NotFound	Last transaction not found. It is not possible to get last transaction result because there is no any previus transaction.
InProgress	Last transaction is still being processed. The result cannot be returned yet.
Finished	Last transaction is finished. The TransactionResult contains last transaction data. User is obligated to compare transactionId to be sure that returned transaction result describes proper transaction.

Definition at line 8 of file LastTransactionState.cs.

    {
        NotFound,
 
        InProgress,
 
        Finished,
    }

LogLevel

enum fr.marketpay.driver.LogLevel

strong

Log levels

Since

0.0.7

Enumerator
Verbose
Debug
Info
Warning
Error

Definition at line 8 of file LogLevel.cs.

    {
        Verbose,
        Debug,
        Info,
        Warning,
        Error,
    }

Status

enum fr.marketpay.driver.Status

strong

Generic status values. It may be a transaction or payment terminal status.

See also

TerminalStatus::generalStatus

TransactionResult::status

Since

0.0.1

Enumerator
OK	It expresses any success or correct state.
NOK	It expresses any failure or bad state.
Partial	When transaction passed with success but not all amounts has been accepted. Since v17

Definition at line 10 of file Status.cs.

    {
 
        OK,
 
        NOK,
 
        Partial
    }

TransactionMode

enum fr.marketpay.driver.TransactionMode

strong

Determines the transaction scenario. Tells whether should it be short, direct transaction or long dual-exchange transaction.

See also

TransactionParams

IDriver::processTransaction(TransactionParams, ITransactionHandler)

Since

0.0.1

Enumerator
Direct	The ECR will not modify the transaction amount during the transaction.
Dual	The ECR may modify the transaction amount during the transaction. See also ITransactionHandler::onDualProcessing(IntermediateTransactionResult, MutableDualTransactionParams) IntermediateTransactionResult MutableDualTransactionParams

Definition at line 10 of file TransactionMode.cs.

    {
        Direct,
 
        Dual
    }

TransactionStatus

enum fr.marketpay.driver.TransactionStatus

strong

Used to notify the ECR about the current transaction status.

During the transaction process, the terminal reports on the status of the transaction to the Merchant Application.

See also

ITransactionHandler::onTransactionStatus(TransactionStatus)

Since

0.0.1

Enumerator
WaitingForCard
PinRequired
BankAuthorization

Definition at line 11 of file TransactionStatus.cs.

    {
        WaitingForCard, PinRequired, BankAuthorization
    }

TransactionType

enum fr.marketpay.driver.TransactionType

strong

This type corresponds to the Nexo Retailer / PaymentType.

Since

0.0.1

Enumerator
Purchase	Normal Payment.
Refund	Payment refund. Note Refers to main TransactionParams.amount. The cashback and tip amounts must not be used. Refund transaction must be TransactionMode.Direct;
CashAdvance	A service allowing cash withdrawal. Note Refers to main TransactionParams.amount. The cashback and tip amounts must not be used. CashAdvance transaction must be TransactionMode.Direct;
PreAuthorisation	First reservation for an amount and period of time. This service is sometimes called "Pre-Authorisation". Note Refers to main TransactionParams.amount. The cashback and tip amounts must not be used. PreAuthorisation transaction must be TransactionMode.Direct; See also TransactionParams.transactionReference
PreAuthorisationCompletion	End of the reservation transaction. Note Refers to main TransactionParams.amount. The cashback and tip amounts must not be used. PreAuthorisationCompletion transaction must be TransactionMode.Direct; See also TransactionParams.transactionReference

Definition at line 8 of file TransactionType.cs.

    {
 
        Purchase,
 
        Refund,
 
        CashAdvance,
 
        PreAuthorisation,
 
        PreAuthorisationCompletion
    }