Modularity::SPI::Config Class Reference

This class contains all the methods to Config a Service or a device when attached to a Service. More...

#include <Config.h>

Public Member Functions
SPILIBRARY_API	Config ()
	This constructor is used when service is running on the machine as dynamic library.
SPILIBRARY_API	Config (string IP, PortType RFU)
	This constructor is used when service is running on remoted TCP service.
SPILIBRARY_API	Config (string COMPort)
	This constructor is used when service is running on remote serial service. Win32/Win64 users can use auto detection for com port by providing PID/VID. the format is fixed. example "USB\\VID_067B&PID_2303".
SPILIBRARY_API	Config (const Config &TmpConfig)
	Copy constructor.
SPILIBRARY_API Config &	operator= (const Config &NewConfig)
	Copy constructor.
SPILIBRARY_API SPI_RET_VAL	SetCertificateFilesDirectory (string Path)
	Set certificate directory.
SPILIBRARY_API SPI_RET_VAL	SetProcessorIPAddress (string IPAddress)
	Set Proccessor IP address directory.
SPILIBRARY_API void	SetProcessorHostname (string Hostname)
	Set Proccessor host name.
SPILIBRARY_API SPI_RET_VAL	SetProcessorPortNumber (PortType Port)
	Set Proccessor Port number. For SHVA test envitment calling this method is not necessary.
SPILIBRARY_API SPI_RET_VAL	SetManufactureID (string ID)
	Manufacture Id in Process.
SPILIBRARY_API SPI_RET_VAL	SetECRIdentifier (string ID)
	ECR Identifier number In AshraitEMV , ID must be a number in range of 1:999.
SPILIBRARY_API void	EnableMiniSettelment ()
	Enable mini settelment transmission post sucessful transaction. Mini-settlment is done as part of thr transaction and transmitted to the IP set in SetProcessorIP()
SPILIBRARY_API void	DisableFullPanOnMerchentReceipt ()
	Disable get the PAN unmasked in merchent receipt.
SPILIBRARY_API void	SetProcessorID (Modularity::SPI::Ashrait::ProcessorId Id)
	Set your service processor. Using this will load deafult certificate and settings for choosen processor. AshraitEMV service Note: SetProcessorIPAddress() and SetProcessorPortNumber() are still mandatory. Default value is ABS.
SPILIBRARY_API void	SetMutavByMutag (Modularity::SPI::Ashrait::Mutag mutag, std::string mutav)
	Set Rav mutav by Mutag.
SPILIBRARY_API void	SetProcessorEndpoint (std::string endpoint)
	Set processor endpoint.
SPILIBRARY_API void	SetProcessorKeystoreId (std::string KeystoreId)
	Set keystore id to use with processor.
SPILIBRARY_API void	SetDepositServerKeystoreId (std::string KeystoreId)
	Set keystore id to use with depsit server.
SPILIBRARY_API string	GetIP ()
	Get IP provided in TCP based in TCP constructor.
SPILIBRARY_API string	GetCOM ()
	Get Serial port provided in Seri based in TCP constructor.
SPILIBRARY_API ExcUnitLocation	GetEUL ()
	Get the execute location of the service.
SPILIBRARY_API SPI_STATUS	GetStatus ()
	Get status of Config (Not supported in this version)
SPILIBRARY_API void	EnableNayaxXCR ()
	Enavble Nayax External cashless report.
SPILIBRARY_API void	SetMasterSlaveMode (MasterSlaveMode mode)
	Set Master/Slave Mode, none is default.
SPILIBRARY_API void	UseTestCertificate ()
	Use test enviorment certificate for the gateway if needed.
SPILIBRARY_API void	EnableBalanceQueryLoyalty ()
	Query Balance for a prepaid card before loyalty phase.
SPILIBRARY_API void	ConfigPaymentAggregator (std::string Key, std::string Value)
	Set Payment Aggregator configuration. Key "name" must be set according to the payment aggreagtor.
SPILIBRARY_API void	SetCustomAttribute (const std::string &Key, std::string Value)
	Set custom attribute to pass to Device using SetConfig.
SPILIBRARY_API string	GetCustomAttribute (const std::string &Key)
	Get custom attribute.
SPILIBRARY_API void	SetLanguage (SPILanguage Language)
	Set the display language on a PINPad Periodic operations.
SPILIBRARY_API void	EnableCardEjectionEnforcement ()
	Enforce card ejection from slot before transaction is over.
SPILIBRARY_API void	AddRetailerForSplit (std::string Retailer, Modularity::SPI::Ashrait::Manpik Issuer, std::string SplitRetailer)
	Set Retailer for Split transaction, only for Ashrait Service.
SPILIBRARY_API	~Config ()
	default destructor
APIHandle	GetConfigHandle ()
	Reserved for internal useage.
SPILIBRARY_API void	SetMode (SPIMode Mode)
	Set the mode of the device. may be idle always or by sessio request.
SPILIBRARY_API SPIMode	GetMode ()
	Get the mode of the device. may be idle always or by sessio request.

Detailed Description

This class contains all the methods to Config a Service or a device when attached to a Service.

Examples:

CPP_Examples.cpp.

Definition at line 33 of file Config.h.

Constructor & Destructor Documentation

SPILIBRARY_API Modularity::SPI::Config::Config	(	string	IP,
		PortType	RFU
	)

This constructor is used when service is running on remoted TCP service.

Parameters

[in]	IP	is the Service IP address
[in]	RFU	is unsued for this version

SPILIBRARY_API Modularity::SPI::Config::Config

(

string

COMPort

)

This constructor is used when service is running on remote serial service. Win32/Win64 users can use auto detection for com port by providing PID/VID. the format is fixed. example "USB\\VID_067B&PID_2303".

Parameters

[in]

COMPort

is a string describing the Service serial port location. (COM/USB)

SPILIBRARY_API Modularity::SPI::Config::Config

(

const Config &

TmpConfig

)

Copy constructor.

Parameters

[in]

TmpConfig

object

Member Function Documentation

SPILIBRARY_API void Modularity::SPI::Config::AddRetailerForSplit	(	std::string	Retailer,
		Modularity::SPI::Ashrait::Manpik	Issuer,
		std::string	SplitRetailer
	)

Set Retailer for Split transaction, only for Ashrait Service.

Parameters

[in]	Retailer	- the retailer id where transaction begins (The subretailer). For main retailer leave empty,
[in]	Issuer	to apply transaction
[in]	SplitRetailer	to direct the transaction to

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::ConfigPaymentAggregator	(	std::string	Key,
		std::string	Value
	)

Set Payment Aggregator configuration. Key "name" must be set according to the payment aggreagtor.

Parameters

[in]	Key	the property name
[in]	Value	the property value

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::DisableFullPanOnMerchentReceipt

(

)

Disable get the PAN unmasked in merchent receipt.

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::EnableMiniSettelment

(

)

Enable mini settelment transmission post sucessful transaction. Mini-settlment is done as part of thr transaction and transmitted to the IP set in SetProcessorIP()

Returns

void

SPILIBRARY_API string Modularity::SPI::Config::GetCOM

(

)

Get Serial port provided in Seri based in TCP constructor.

Returns

a string with result

SPILIBRARY_API string Modularity::SPI::Config::GetCustomAttribute

(

const std::string &

Key

)

Get custom attribute.

Parameters

[in]

Key

the property name

Returns

value of custom attribute

SPILIBRARY_API ExcUnitLocation Modularity::SPI::Config::GetEUL

(

)

Get the execute location of the service.

Returns

Matching enum result

SPILIBRARY_API string Modularity::SPI::Config::GetIP

(

)

Get IP provided in TCP based in TCP constructor.

Returns

a string with result

SPILIBRARY_API SPIMode Modularity::SPI::Config::GetMode

(

)

Get the mode of the device. may be idle always or by sessio request.

Parameters

[in]

none

Returns

Mode

SPILIBRARY_API SPI_STATUS Modularity::SPI::Config::GetStatus

(

)

Get status of Config (Not supported in this version)

Returns

Matching enum result

SPILIBRARY_API Config& Modularity::SPI::Config::operator=

(

const Config &

NewConfig

)

Copy constructor.

Parameters

[in]

NewConfig

object as left operand

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetCertificateFilesDirectory

(

string

Path

)

Set certificate directory.

Parameters

[in]

Path

is path to directory

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API void Modularity::SPI::Config::SetCustomAttribute	(	const std::string &	Key,
		std::string	Value
	)

Set custom attribute to pass to Device using SetConfig.

Parameters

[in]	Key	the property name
[in]	Value	the property value

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::SetDepositServerKeystoreId

(

std::string

KeystoreId

)

Set keystore id to use with depsit server.

Parameters

[in]

KeystoreId

as string

Returns

void

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetECRIdentifier

(

string

ID

)

ECR Identifier number In AshraitEMV , ID must be a number in range of 1:999.

Parameters

[in]

ID

is identifier.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API void Modularity::SPI::Config::SetLanguage

(

SPILanguage

Language

)

Set the display language on a PINPad Periodic operations.

Parameters

[in]

Language

is a enum describing the language. If not called Service Default is used.

Returns

None

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetManufactureID

(

string

ID

)

Manufacture Id in Process.

Parameters

[in]

ID

is a string containing the manufacture ID.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API void Modularity::SPI::Config::SetMode

(

SPIMode

Mode

)

Set the mode of the device. may be idle always or by sessio request.

Parameters

[in]

Mode

is a enum describing the mode. If not called Default is idle always.

Returns

None

SPILIBRARY_API void Modularity::SPI::Config::SetMutavByMutag	(	Modularity::SPI::Ashrait::Mutag	mutag,
		std::string	mutav
	)

Set Rav mutav by Mutag.

Parameters

[in]	mutag	- Mutag brand enum
[in]	mutav	number

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::SetProcessorEndpoint

(

std::string

endpoint

)

Set processor endpoint.

Parameters

[in]

endpoint

of the processor

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::SetProcessorHostname

(

string

Hostname

)

Set Proccessor host name.

Parameters

[in]

Hostname

is a string containing the host name of the processor.

Returns

void

SPILIBRARY_API void Modularity::SPI::Config::SetProcessorID

(

Modularity::SPI::Ashrait::ProcessorId

Id

)

Set your service processor. Using this will load deafult certificate and settings for choosen processor. AshraitEMV service Note: SetProcessorIPAddress() and SetProcessorPortNumber() are still mandatory. Default value is ABS.

Parameters

[in]

Id

is identifier

Returns

void

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetProcessorIPAddress

(

string

IPAddress

)

Set Proccessor IP address directory.

Parameters

[in]

IPAddress

is a string containing the IP address of the processor.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

SPILIBRARY_API void Modularity::SPI::Config::SetProcessorKeystoreId

(

std::string

KeystoreId

)

Set keystore id to use with processor.

Parameters

[in]

KeystoreId

as string

Returns

void

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Config::SetProcessorPortNumber

(

PortType

Port

)

Set Proccessor Port number. For SHVA test envitment calling this method is not necessary.

Parameters

[in]

SetProcessorPortNumber

is integer containing the server port number of the processor.

Returns

• SPI_SUCCESS : OK
• SPI_INVALID : An error occurred

---

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

• Config.h