![]() |
SPI
1.2111.4
Secured Payment Interface
|
This namespace contains avilible classes and enumerators for SPI library. More...
Namespaces | |
| Ashrait | |
| This namespace contains requiered enumerators for AshraitEMV service. | |
| NayaxVend | |
| This namespace contains requiered enumerators for NayaxVend service. | |
Classes | |
| struct | AcquiredBrandInfo |
| A struct that reprensts information about an acquire for a brand. More... | |
| class | AshraitEMVTransaction |
| 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... | |
| class | Config |
| This class contains all the methods to Config a Service or a device when attached to a Service. More... | |
| class | Device |
| This class contains all the operations that Avilible for a Service. Since this class is abstract, Servuce object is invlaid and can't be constructed. A Service handle is created by SPI class interface. All data in this class is reachable through various methods which define the behaivor of the operation. More... | |
| struct | EndOfDayReportInfo |
| A struct that reprensts information end of day report. More... | |
| class | NayaxEngineTransaction |
| 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... | |
| class | NayaxVendTransaction |
| 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... | |
| struct | ReceiptLine |
| A struct which reprensts a line in receipt. More... | |
| class | Report |
| This class contains all the requiered operations for Reports. More... | |
| class | Service |
| This class contains all the operations that Avilible for a Service. Since this class is abstract, Servuce object is invlaid and can't be constructed. A Service handle is created by SPI class interface. All data in this class is reachable through various methods which define the behaivor of the operation. More... | |
| class | SPI |
| This class contains all the operations of the Payment Interface, Creation and Services management. More... | |
| struct | SubRetailer |
| A struct that reprensts information about sub retailer in RavSapak mode. More... | |
| class | Transaction |
| 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... | |
This namespace contains avilible classes and enumerators for SPI library.
The type of currency used to perform the transaction
| Enumerator | |
|---|---|
| Curr_Shekel | New Israeli Shekel |
| Curr_Dollar | United States Dollar |
| Curr_Foreign | Foreign Currency - Must set Foreign currency |
Nayax DCS Properties used in GetDCSProperty
Definition at line 354 of file SPIDEF.h.
Nayax DCS activation status used in GetDCSStatus
| Enumerator | |
|---|---|
| DcsStatus_NotActivated | Machine is not activaited |
| DcsStatus_Activated | Machine is activaited |
| DcsStatus_TokenOnly | Machine is not activaited Token exist |
Definition at line 339 of file SPIDEF.h.
The device type supported in SPI
| Enumerator | |
|---|---|
| ModularityDevice | Device powered by Modularity |
Status of a nonblocking end of day batching
| Enumerator | |
|---|---|
| EndOfDay_NotCompleted | Batching not completed |
| EndOfDay_Completed | Batching completed |
Definition at line 124 of file SPIDEF.h.
Execution unit Location. Can be defined either to Service or to Pinpad while is added.
| Enumerator | |
|---|---|
| SPIEXCUNIT_THISINT | Local |
| SPIEXCUNIT_IPINT | Remoted Service/Device over TCP/IP |
| SPIEXCUNIT_SERIALINT | Remoted Service/Device over Serial port |
| SPIEXCUNIT_NONE | None |
Extended status about ongoing EMV transaction
| Enumerator | |
|---|---|
| EMVStatus_Idle | Transaction in idle mode |
| EMVStatus_Processing | Processing |
| EMVStatus_WaitForCard | Transaction waiting for card |
| EMVStatus_ReadingCard | Reading the card |
| EMVStatus_ApplicationSelection | Application selection |
| EMVStatus_Loyalty | Card detected - In loyalty (Phase 1) |
| EMVStatus_PinCode | Waiting for PIN code (Not supported yet) |
| EMVStatus_FirstCardDecision | Doing first card decision |
| EMVStatus_WaitProcessorApproval | Waiting for online approval from the processor |
| EMVStatus_FinalCardDecision | Doing first card decision |
| EMVStatus_Completed | Transaction completed |
Extended status about ongoing periodic process (EndOfDay or DoEstablishment)
Definition at line 248 of file SPIDEF.h.
The Pinpad Protocol used when Adding a Pinpad
| Enumerator | |
|---|---|
| MP3 | MP3 |
| MPOS | mPos (Not Supported this verison) |
| XPI | XPI (Not Supported this verison) |
The type of report produced by a Service
| Enumerator | |
|---|---|
| X_REPORT | X Report - Current status of the service |
| Z_REPORT | Z Report - Produced when batching all transactions in Service at end of day |
| ACCM_REPORT | Accumlated Report - Resetable report |
| PARAM_REPORT | Parameters Report |
| QUERY_TRANSACTIONS_REPORT | Query transaction Report |
| QUERY_REPORTS_REPORT | Query end of day reports Report |
| MINI_SETTLEMENT_REPORT | When performing mini settlement only |
The payment Services which are supported in SPI
| Enumerator | |
|---|---|
| AshraitService | Ashrait EMV |
| DebitService | Debit (Not Supported this verison) |
| TransportationService | Transportation (Not Supported this verison) |
| NayaxVendService | Nayax veding service |
| NayaxEngineService | Nayax Engine Methods service |
Service Properties used in GetProperty
| Enumerator | |
|---|---|
| ServiceProperty_TransmitTime | Automated transmit time to the processor |
| ServiceProperty_SystemTrace | System Trace number when service in Master mode |
| ServiceProperty_DeviceSerial | Connected device serial number |
| ServiceProperty_CountryCode | NayaxVend terminal country code |
| ServiceProperty_Currency | NayaxVend terminal currency |
| ServiceProperty_DecimalPlace | NayaxVend terminal currenct decimal place in unsigned int |
| ServiceProperty_AcquirerTermianlId | NayaxVend ??? |
| ServiceProperty_RavSapak | Ashrait Rav sapak |
Definition at line 318 of file SPIDEF.h.
Return value from SPI API functions
Definition at line 88 of file SPIDEF.h.
SPI status
| Enumerator | |
|---|---|
| SPI_READY | Service is ready to use |
| SPI_READY_ONLINE | Service is ready to use. All transactions verified against processor |
| SPI_NOT_ESTABLISHED | Service isn't established |
| SPI_NOT_READY | Service isn't ready to use |
| SPI_ERROR | A general error occured |
Definition at line 103 of file SPIDEF.h.
Languages supprted in SPI in various parameters
| Enumerator | |
|---|---|
| SPILanguage_Hebrew | Hebrew |
| SPILanguage_English | English |
Definition at line 311 of file SPIDEF.h.
Return value from SPI API functions
| Enumerator | |
|---|---|
| SPILog_Emergency | Emergency/off |
| SPILog_Alert | Alert |
| SPILog_Critical | Critical |
| SPILog_Error | Error |
| SPILog_Warning | Warning |
| SPILog_Notice | Notice |
| SPILog_Info | Info |
| SPILog_Debug | Debug |
Definition at line 298 of file SPIDEF.h.
Status of a nonblocking transaction
| Enumerator | |
|---|---|
| Tran_NotCompleted | Transaction not completed |
| Tran_Phase1Now | Transaction not completed, in loyalty state |
| Tran_AuthoriztionNumber | Transaction not completed, in auth num state |
| Tran_CVV | Transaction not completed, in cvv state |
| Tran_CardHolderId | Transaction not completed, in card holder Id state |
| Tran_Completed | Transaction completed |
Definition at line 113 of file SPIDEF.h.
Z Reprt format
1.8.14