Modularity::SPI::Transaction Class Reference

This class contains all the input data and output data of Transactions. Those methods are common to all the derived classes from Transaction. Since this class is abstract, Transaction object is invlaid and can't be constructed. All data in this class is reachable through various methods which define the behaivor of the operation. More...

#include <transaction.h>

Inheritance diagram for Modularity::SPI::Transaction:

Public Member Functions
APIHandle	GetTransactionHandle () const
	Reserved for internal useage.
Pre Transaction Information
Those methods can be called before transaction is executed.
SPILIBRARY_API	Transaction (AmountType Amount, CurrencyType Currency, string VendorUID)
	Transaction constructor. Can't be used explicitly as Transaction is pure virtual. More...
virtual SPILIBRARY_API	~Transaction ()=0
	Class destructor.
SPILIBRARY_API PPIDType	GetPinPadId () const
	Get device identification number used to make the transaction. More...
SPILIBRARY_API void	SetPinPadId (PPIDType PinPadID)
	Set device identification number used to make the transaction. More...
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. More...
SPILIBRARY_API string	GetVendorUID () const
	Get vendor unique ID as initialized at derived class constructor. More...
SPILIBRARY_API AmountType	GetAmount () const
	Get Transaction original amount as initialized at derived class constructor. More...
SPILIBRARY_API CurrencyType	GetCurrency () const
	Get currency enumerator as initialized at derived class constructor. More...
Post Transaction Information
Those methods can be called after transaction is executed.
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. More...
virtual 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). More...

Detailed Description

This class contains all the input data and output data of Transactions. Those methods are common to all the derived classes from Transaction. Since this class is abstract, Transaction object is invlaid and can't be constructed. All data in this class is reachable through various methods which define the behaivor of the operation.

Definition at line 30 of file transaction.h.

Constructor & Destructor Documentation

Transaction()

SPILIBRARY_API Modularity::SPI::Transaction::Transaction	(	AmountType	Amount,
		CurrencyType	Currency,
		string	VendorUID
	)

Transaction constructor. Can't be used explicitly as Transaction is pure virtual.

Parameters

[in]	Amount	is the transaction original amount.
[in]	Currency	the transaction CurrencyType.
[in]	VendorUID	is an identifier string generated by the ECR. Can't be empty string.

Member Function Documentation

GetAmount()

SPILIBRARY_API AmountType Modularity::SPI::Transaction::GetAmount

(

)

const

Get Transaction original amount as initialized at derived class constructor.

Returns

Result as AmountType (Number)

GetCurrency()

SPILIBRARY_API CurrencyType Modularity::SPI::Transaction::GetCurrency

(

)

const

Get currency enumerator as initialized at derived class constructor.

Returns

Result as Modularity::SPI::CurrencyType

GetPinPadId()

SPILIBRARY_API PPIDType Modularity::SPI::Transaction::GetPinPadId

(

)

const

Get device identification number used to make the transaction.

Returns

Result

GetTransactionResultCode()

SPILIBRARY_API ResultType Modularity::SPI::Transaction::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.

See also

GetTransactionResultMessage()

Returns

Result as Number

GetTransactionResultMessage()

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

virtual

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).

See also

GetTransactionResultCode()

Returns

Result as std::string Hebrew UTF-8

Reimplemented in Modularity::SPI::CibusTransaction, Modularity::SPI::EmvTransaction, and Modularity::SPI::NayaxVendTransaction.

GetVendorUID()

SPILIBRARY_API string Modularity::SPI::Transaction::GetVendorUID

(

)

const

Get vendor unique ID as initialized at derived class constructor.

Returns

Result as std:: string

SetPinPadId()

SPILIBRARY_API void Modularity::SPI::Transaction::SetPinPadId

(

PPIDType

PinPadID

)

Set device identification number used to make the transaction.

Parameters

[in]

PinPadID

is an identification number for the device.

SetVendorUID()

SPILIBRARY_API void Modularity::SPI::Transaction::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.

Parameters

[in]

Vuid

is modified Vuid

---

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

• transaction.h