Modularity::SPI::NayaxEngineTransaction Class Reference

This class contains all the input data and output data of NayaxEngineTransaction transactions, including the methods inherited from class Transaction. All data in this class is reachable through various methods which define the behaivor of the operation. More...

#include <NayaxEngineTransaction.h>

Inheritance diagram for Modularity::SPI::NayaxEngineTransaction:

Public Member Functions
SPILIBRARY_API	~NayaxEngineTransaction ()
	Class desrstructor.
APIHandle	GetNayaxEngineHandle () const
	Handle get - reserved for internal useage.
Pre Transaction Information
Those methods can be called before transaction is executed.
SPILIBRARY_API	NayaxEngineTransaction (string VendorUID, AmountType Amount, UnsignedNumericType APMCode)
	Class constructor. When this an item must be added using AddItem()
SPILIBRARY_API void	SetItemsQuantity (CounterType Quantity)
	Set number of items in the sale.
State data
Those methods can be called at the appropiate state of the transaction.
SPILIBRARY_API string	GetQRCodeData () const
	Get QR that represent the transaction on the device. QR should be displayed to the customer. Support only Asynchro API. To be used after Service.StartTransaction was called.
SPILIBRARY_API bool	TokenReceived () const
	Get indication if token received from broker for QR transaction.
Post Transaction Information
Those methods can be called after transaction is executed.
SPILIBRARY_API bool	WasSuccessful () const
	A method that tells post transaction weather transaction succeded or not.
SPILIBRARY_API string	GetTransasctionId () const
	Get transaction identifier on Nayax DCS.
SPILIBRARY_API std::vector < ReceiptLine >	GetMerchentRecipt () const
	Get a list of (key,value). Vending application prints the list provided from this function by it's order. Each member of the vector is a line. The key member is the field name and value is the field value. e.g. key=Type , value=SALE e.g. key=AID , value=A00000003010 Receipt exists only if WasSuccessful() is true or GetResultCode() is 0. This function returns all the lines that belongs to the merchant copy.
SPILIBRARY_API string	GetFullName () const
	Get Monyx user full name.
SPILIBRARY_API string	GetCurrencyCode () const
	Get Currency code used for for transaction.
Public Member Functions inherited from Modularity::SPI::Transaction
APIHandle	GetTransactionHandle () const
	Reserved for internal useage.
SPILIBRARY_API	Transaction (AmountType Amount, CurrencyType Currency, string VendorUID)
	Transaction constructor. Can't be used explicitly as Transaction is pure virtual.
virtual SPILIBRARY_API	~Transaction ()=0
	Class destructor.
SPILIBRARY_API PPIDType	GetPinPadId () const
	Get device identification number used to make the transaction.
SPILIBRARY_API void	SetPinPadId (PPIDType PinPadID)
	Set device identification number used to make the transaction.
SPILIBRARY_API string	GetVendorUID () const
	Get vendor unique ID as initialized at derived class constructor.
SPILIBRARY_API AmountType	GetAmount () const
	Get Transaction original amount as initialized at derived class constructor.
SPILIBRARY_API CurrencyType	GetCurrency () const
	Get currency enumerator as initialized at derived class constructor.
SPILIBRARY_API ResultType	GetTransactionResultCode () const
	Get transaction result code. If called before transaction was ended, a speical code -999 (Transaction in progress) is returned. Each code has a message. You may see Result Codes Messages for reference.
SPILIBRARY_API std::string	GetTransactionResultMessage () const
	Get transaction result message. All messages are in Hebrew and encoded in UTF-8 If called before transaction was ended a speical message is returned - "Transaction in progress" (In Hebrew).

Detailed Description

This class contains all the input data and output data of NayaxEngineTransaction transactions, including the methods inherited from class Transaction. All data in this class is reachable through various methods which define the behaivor of the operation.

Definition at line 32 of file NayaxEngineTransaction.h.

Constructor & Destructor Documentation

SPILIBRARY_API Modularity::SPI::NayaxEngineTransaction::NayaxEngineTransaction	(	string	VendorUID,
		AmountType	Amount,
		UnsignedNumericType	APMCode
	)

Class constructor. When this an item must be added using AddItem()

Parameters

[in]

VendorUID

is an identifier string generated by the ECR. Can't be empty string.

Member Function Documentation

SPILIBRARY_API string Modularity::SPI::NayaxEngineTransaction::GetCurrencyCode

(

)

const

Get Currency code used for for transaction.

Returns

Currrency code as std::string ("USD" . "ILS" . etc.. )

SPILIBRARY_API string Modularity::SPI::NayaxEngineTransaction::GetFullName

(

)

const

Get Monyx user full name.

Returns

Full Name as std::string

SPILIBRARY_API std::vector<ReceiptLine> Modularity::SPI::NayaxEngineTransaction::GetMerchentRecipt

(

)

const

Get a list of (key,value). Vending application prints the list provided from this function by it's order. Each member of the vector is a line. The key member is the field name and value is the field value. e.g. key=Type , value=SALE e.g. key=AID , value=A00000003010 Receipt exists only if WasSuccessful() is true or GetResultCode() is 0. This function returns all the lines that belongs to the merchant copy.

Returns

list of key,value in ReceiptLine struct

SPILIBRARY_API string Modularity::SPI::NayaxEngineTransaction::GetQRCodeData

(

)

const

Get QR that represent the transaction on the device. QR should be displayed to the customer. Support only Asynchro API. To be used after Service.StartTransaction was called.

Returns

QR code as std::string

SPILIBRARY_API string Modularity::SPI::NayaxEngineTransaction::GetTransasctionId

(

)

const

Get transaction identifier on Nayax DCS.

Returns

TransasctionId as std::string

SPILIBRARY_API void Modularity::SPI::NayaxEngineTransaction::SetItemsQuantity

(

CounterType

Quantity

)

Set number of items in the sale.

    - Mandatory for Monyx transactions

Parameters

[in]

Quantity

is the item quntity in the vend

SPILIBRARY_API bool Modularity::SPI::NayaxEngineTransaction::TokenReceived

(

)

const

Get indication if token received from broker for QR transaction.

Returns

bool

SPILIBRARY_API bool Modularity::SPI::NayaxEngineTransaction::WasSuccessful

(

)

const

A method that tells post transaction weather transaction succeded or not.

Returns

weather transaction succeded or not

---

The documentation for this class was generated from the following file:

• NayaxEngineTransaction.h