Modularity::SPI::NayaxVendTransaction Class Reference

This class contains all the input data and output data of AshraitEMV 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 <NayaxVendTransaction.h>

Inheritance diagram for Modularity::SPI::NayaxVendTransaction:

Public Member Functions
virtual SPILIBRARY_API std::string	GetTransactionResultMessage () const
	Get transaction result message. Messages are in Hebrew. If service configured to English Messages will be in english.
SPILIBRARY_API	~NayaxVendTransaction ()
	Class desrstructor.
APIHandle	GetNayaxVendHandle () const
	Handle get - reserved for internal useage.
Pre Transaction Information
Those methods can be called before transaction is executed.
SPILIBRARY_API	NayaxVendTransaction (string VendorUID)
	Class constructor. When this an item must be added using AddItem()
SPILIBRARY_API SPI_RET_VAL	AddItem (AmountType Amount, string ItemCode, CounterType Quantity, NayaxVend::UnitOfMeasurement QuantityUnit)
	Set transaction credit card deatils when no device is used.
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 string	GetLast4Digits () const
	Get card 4 last digits that used in transaction.
SPILIBRARY_API NayaxVend::CardType	GetCardType () const
	Get card type used for transaction.
SPILIBRARY_API string	GetCardBIN () const
	Get card BIN.
SPILIBRARY_API string	GetCardBINHashed () const
	Get card BIN hashed by MD5?
SPILIBRARY_API NayaxVend::CardEntryType	GetCardEntryMode () const
	Get card entry mode.
SPILIBRARY_API AmountType	GetDiscount () const
	Get Discount made by DCS rules.
SPILIBRARY_API AmountType	GetApprovedVendAmount () const
	Get transaction final amount. Usually EQ Amount-Discount.
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 void	SetVendorUID (string Vuid)
	Set VUID during Loyalty phase. This method will override the current Vuid from the Constructor and will assert uniqueness only during Loyalty phase. The method doesn't apply the new Vuid immediately. The new value will be applied only after legal call to service method as mentioned above. It's highly recomanded to assert your new vuid with GetVendorUID() to make sure the new Vuid was applied. Supported services: Ashrait.
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.

Detailed Description

This class contains all the input data and output data of AshraitEMV 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 NayaxVendTransaction.h.

Constructor & Destructor Documentation

SPILIBRARY_API Modularity::SPI::NayaxVendTransaction::NayaxVendTransaction

(

string

VendorUID

)

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 SPI_RET_VAL Modularity::SPI::NayaxVendTransaction::AddItem	(	AmountType	Amount,
		string	ItemCode,
		CounterType	Quantity,
		NayaxVend::UnitOfMeasurement	QuantityUnit
	)

Set transaction credit card deatils when no device is used.

Parameters

[in]	Amount	is the item amount in cents
[in]	ItemCode	is the item code
[in]	Quantity	is the item quntity in the vend
[in]	QuantityUnit	is the units of the quantity

Returns

SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API AmountType Modularity::SPI::NayaxVendTransaction::GetApprovedVendAmount

(

)

const

Get transaction final amount. Usually EQ Amount-Discount.

See Also

GetAmount()

GetDiscount()

Returns

Discount as AmountType

SPILIBRARY_API string Modularity::SPI::NayaxVendTransaction::GetCardBIN

(

)

const

Get card BIN.

Returns

BIN as string

SPILIBRARY_API string Modularity::SPI::NayaxVendTransaction::GetCardBINHashed

(

)

const

Get card BIN hashed by MD5?

Returns

hashed BIN as string

SPILIBRARY_API NayaxVend::CardEntryType Modularity::SPI::NayaxVendTransaction::GetCardEntryMode

(

)

const

Get card entry mode.

Returns

card entry mode as enum

SPILIBRARY_API NayaxVend::CardType Modularity::SPI::NayaxVendTransaction::GetCardType

(

)

const

Get card type used for transaction.

Returns

card type as enum

SPILIBRARY_API AmountType Modularity::SPI::NayaxVendTransaction::GetDiscount

(

)

const

Get Discount made by DCS rules.

Returns

Discount as AmountType

SPILIBRARY_API string Modularity::SPI::NayaxVendTransaction::GetLast4Digits

(

)

const

Get card 4 last digits that used in transaction.

Returns

digits as std::string

virtual SPILIBRARY_API std::string Modularity::SPI::NayaxVendTransaction::GetTransactionResultMessage ( ) const

virtual

Get transaction result message. Messages are in Hebrew. If service configured to English Messages will be in english.

See Also

GetTransactionResultCode()

SPILanguage

Returns

Result as std::string

Reimplemented from Modularity::SPI::Transaction.

SPILIBRARY_API string Modularity::SPI::NayaxVendTransaction::GetTransasctionId

(

)

const

Get transaction identifier on Nayax DCS.

Returns

TransasctionId as std::string

SPILIBRARY_API bool Modularity::SPI::NayaxVendTransaction::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:

• NayaxVendTransaction.h