SPI  1.2404.0
Secured Payment Interface
Config.h
Go to the documentation of this file.
1 
15 #ifndef __CONFIG__H__
16 #define __CONFIG__H__
17 
18 #include <stdio.h>
19 #include <string>
20 #include <cstring>
21 
22 #include "SPIDEF.h"
23 
24 
25 using std::string;
26 
27 namespace Modularity {
28 
29  namespace SPI {
33  class Config {
34 
35  public:
39  SPILIBRARY_API Config();
40 
46  SPILIBRARY_API Config(string IP, PortType RFU);
47 
54  SPILIBRARY_API Config(string COMPort);
55 
60  SPILIBRARY_API Config (const Config& TmpConfig);
61 
66  SPILIBRARY_API Config& operator= (const Config & NewConfig);
67 
75  SPILIBRARY_API SPI_RET_VAL SetCertificateFilesDirectory(string Path);
76 
84  SPILIBRARY_API SPI_RET_VAL SetProcessorIPAddress(string IPAddress);
85 
91  SPILIBRARY_API void SetProcessorHostname(string Hostname);
92 
102  SPILIBRARY_API SPI_RET_VAL SetProcessorPortNumber(PortType Port);
103 
111  SPILIBRARY_API SPI_RET_VAL SetManufactureID(string ID);
112 
121  SPILIBRARY_API SPI_RET_VAL SetECRIdentifier(string ID);
122 
129  SPILIBRARY_API void EnableMiniSettelment();
130 
135  SPILIBRARY_API void DisableFullPanOnMerchentReceipt();
136 
137 
147 
154  SPILIBRARY_API void SetMutavByMutag(Modularity::SPI::Ashrait::Mutag mutag, std::string mutav);
155 
161  SPILIBRARY_API void SetProcessorEndpoint(std::string endpoint);
162 
168  SPILIBRARY_API void SetProcessorKeystoreId(std::string KeystoreId);
169 
175  SPILIBRARY_API void SetDepositServerKeystoreId(std::string KeystoreId);
176 
177 
178 
183  SPILIBRARY_API string GetIP();
184 
189  SPILIBRARY_API string GetCOM();
190 
195  SPILIBRARY_API ExcUnitLocation GetEUL();
196 
201  SPILIBRARY_API SPI_STATUS GetStatus();
202 
206  SPILIBRARY_API void EnableNayaxXCR();
207 
211  SPILIBRARY_API void SetMasterSlaveMode(MasterSlaveMode mode);
212 
216  SPILIBRARY_API void UseTestCertificate();
217 
221  SPILIBRARY_API void EnableBalanceQueryLoyalty();
222 
223 
230  SPILIBRARY_API void ConfigPaymentAggregator(std::string Key, std::string Value);
231 
238  SPILIBRARY_API void SetCustomAttribute(const std::string& Key, std::string Value);
239 
245  SPILIBRARY_API string GetCustomAttribute(const std::string& Key);
246 
253  SPILIBRARY_API void SetLanguage(SPILanguage Language);
254 
258  SPILIBRARY_API void EnableCardEjectionEnforcement();
259 
260 
268  SPILIBRARY_API void AddRetailerForSplit(std::string Retailer, Modularity::SPI::Ashrait::Manpik Issuer, std::string SplitRetailer);
269 
273  SPILIBRARY_API ~Config();
274 
279 
288  SPILIBRARY_API void SetMode(SPIMode Mode);
295  SPILIBRARY_API SPIMode GetMode();
296 
297  private:
298 
299  APIHandle ConfigHandle;
300  };
301 
302  }
303 
304 }
305 
306 
307 
308 
309 
310 #endif
311 
312 
SPILIBRARY_API string GetIP()
Get IP provided in TCP based in TCP constructor.
SPILIBRARY_API void SetProcessorHostname(string Hostname)
Set Proccessor host name.
SPILIBRARY_API Config & operator=(const Config &NewConfig)
Copy constructor.
This namespace contains avilible API from Modularity Inc.
APIHandle GetConfigHandle()
Reserved for internal useage.
SPILIBRARY_API void SetProcessorKeystoreId(std::string KeystoreId)
Set keystore id to use with processor.
This class contains all the methods to Config a Service or a device when attached to a Service...
Definition: Config.h:33
SPILIBRARY_API ExcUnitLocation GetEUL()
Get the execute location of the service.
SPILIBRARY_API void EnableBalanceQueryLoyalty()
Query Balance for a prepaid card before loyalty phase.
SPILIBRARY_API void SetMutavByMutag(Modularity::SPI::Ashrait::Mutag mutag, std::string mutav)
Set Rav mutav by Mutag.
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 SetLanguage(SPILanguage Language)
Set the display language on a PINPad Periodic operations.
SPILIBRARY_API SPI_RET_VAL SetProcessorPortNumber(PortType Port)
Set Proccessor Port number. For SHVA test envitment calling this method is not necessary.
SPILIBRARY_API ~Config()
default destructor
SPILIBRARY_API string GetCOM()
Get Serial port provided in Seri based in TCP constructor.
SPILIBRARY_API void SetProcessorID(Modularity::SPI::Ashrait::ProcessorId Id)
Set your service processor. Using this will load deafult certificate and settings for choosen process...
SPILIBRARY_API void SetMasterSlaveMode(MasterSlaveMode mode)
Set Master/Slave Mode, none is default.
SPILIBRARY_API void SetMode(SPIMode Mode)
Set the mode of the device. may be idle always or by sessio request.
usint PortType
Definition: SPIDEF.h:44
SPILIBRARY_API SPI_RET_VAL SetProcessorIPAddress(string IPAddress)
Set Proccessor IP address directory.
SPILIBRARY_API void SetDepositServerKeystoreId(std::string KeystoreId)
Set keystore id to use with depsit server.
SPILIBRARY_API void UseTestCertificate()
Use test enviorment certificate for the gateway if needed.
SPILIBRARY_API SPI_RET_VAL SetCertificateFilesDirectory(string Path)
Set certificate directory.
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 string GetCustomAttribute(const std::string &Key)
Get custom attribute.
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 EnableCardEjectionEnforcement()
Enforce card ejection from slot before transaction is over.
SPILIBRARY_API void EnableMiniSettelment()
Enable mini settelment transmission post sucessful transaction. Mini-settlment is done as part of thr...
SPILIBRARY_API void EnableNayaxXCR()
Enavble Nayax External cashless report.
This file conatins all defenitions which are used in SPI API.
SPILIBRARY_API void DisableFullPanOnMerchentReceipt()
Disable get the PAN unmasked in merchent receipt.
void * APIHandle
Definition: SPIDEF.h:41
SPILIBRARY_API void SetCustomAttribute(const std::string &Key, std::string Value)
Set custom attribute to pass to Device using SetConfig.
SPILIBRARY_API void SetProcessorEndpoint(std::string endpoint)
Set processor endpoint.
SPILIBRARY_API Config()
This constructor is used when service is running on the machine as dynamic library.
SPILIBRARY_API SPIMode GetMode()
Get the mode of the device. may be idle always or by sessio request.
SPILIBRARY_API SPI_STATUS GetStatus()
Get status of Config (Not supported in this version)
SPILIBRARY_API SPI_RET_VAL SetManufactureID(string ID)
Manufacture Id in Process.