SPIDEF.h

Go to the documentation of this file.

#pragma once

#include <iostream>
#include <string>
#include <cstring>
#include "types.def"

#ifdef WIN32
#ifdef SPI_EXPORTS
#define SPILIBRARY_API __declspec(dllexport)
#elif SPI_NOEXPORTS
#define SPILIBRARY_API
#else
#define SPILIBRARY_API __declspec(dllimport)
#endif
#elif __GNUC__
#ifdef SPI_EXPORTS
#define SPILIBRARY_API __attribute__((visibility("default")))
#else
#define SPILIBRARY_API
#endif
#endif



using std::string;

typedef void*       APIHandle;

typedef usint       PortType;

typedef uint64_t    AmountType;

typedef int32_t     PaymentType;

typedef sint        PPIDType;

typedef sint        ResultType;

typedef uint64_t    RateType;

typedef int32_t     PercentType;

typedef int32_t     MonthType;

typedef ulint       TimeOutType;

typedef byte        FrequencyType;

typedef int32_t     CurrencyISOType;

typedef usint       CounterType;

typedef uint32_t    UnsignedNumericType;

typedef int32_t SignedNumericType;




namespace Modularity {

    namespace SPI {
        enum SPI_RET_VAL
        {
            SPI_SUCCESS = 0,                
            SPI_ALREADY_EXIST = -1,         
            SPI_FAIL = -2,                  
            SPI_INVALID = -3,               
            SPI_MISSING_EVENT_HANDLER = -4, 
            SPI_NOT_SUPPORTED = -5,         
            SPI_ABORTED = -6,               
            SPI_CONNECTION_ERR = -7,        
            SPI_TIME_OUT = -8,              
            SPI_NO_INIT = -999              
        };

        enum SPI_STATUS
        {
            SPI_READY = 0,              
            SPI_READY_ONLINE = 1,       
            SPI_NOT_ESTABLISHED = -1,   
            SPI_NOT_READY = -2,         
            SPI_ERROR = -3              
        };

        enum TransactionStatus
        {
            Tran_NotCompleted,              
            Tran_Phase1Now,                 
            Tran_AuthoriztionNumber,        
            Tran_CVV,                       
            Tran_CardHolderId,              
            Tran_Completed                  
        };

        enum EndOfDayStatus
        {
            EndOfDay_NotCompleted,          
            EndOfDay_Completed              
        };

        enum ExcUnitLocation
        {
            SPIEXCUNIT_THISINT = 0,     
            SPIEXCUNIT_IPINT = 1,       
            SPIEXCUNIT_SERIALINT = 2,   
            SPIEXCUNIT_NONE = 99        
        };

        enum ServiceID
        {
            AshraitService = 0,             
            DebitService = 1,               
            TransportationService = 2,      
            NayaxVendService = 3,           
            NayaxEngineService = 4,         
            CibusService = 5,               
            MultipassService = 6            
        };

        enum DeviceId
        {
            ModularityDevice = 0,               
            VPOSTouch = 1,                      
        };


        enum PP_Protocol
        {
            MP3 = 0,                        
            MPOS = 1,                       
            XPI = 2                         
        };

        enum ReportType
        {
            X_REPORT = 0,                   
            Z_REPORT = 1,                   
            ACCM_REPORT = 2,                
            PARAM_REPORT = 3,               
            QUERY_TRANSACTIONS_REPORT = 4,  
            QUERY_REPORTS_REPORT = 5,       
            MINI_SETTLEMENT_REPORT = 6,     
            QUERY_PRE_AUTH_TRANSACTIONS_REPORT = 7, 
            QUERY_PENDING_DEFERRED_AUTH = 8,         
            AUTHORIZE_PENDING_TRANSACTIONS = 9,  
            BASE = 99                       
        };

        enum ZReportFormat
        {
            ZReport_Narrow = 0,             
            ZReport_Medium = 1,             
            ZReport_Wide = 2,               
            ZReport_XML = 3,                
        };

        enum CurrencyType
        {
            Curr_Shekel = 376,          
            Curr_Dollar = 840,          
            Curr_Foreign = 0            
        };

        struct ReceiptLine
        {
            string key;                 
            string value;               
        };

        struct AcquiredBrandInfo
        {
            string brandName;                   
            string acquireName;                 
            string businessNumber;              
            string phoneNumber;                 
        };

        struct SubRetailer
        {
            string RetailerId;                  
            string RetailerName;                
            bool   IsActivated;                 
            bool   StartWork;                   
        };



        struct EndOfDayReportInfo
        {
            string AckNumber;               
            string Date;                    
        };

        enum ExtendedEMVStatus
        {
            EMVStatus_Idle = 0,                     
            EMVStatus_Processing = 1,               
            EMVStatus_WaitForCard = 2,              
            EMVStatus_ReadingCard = 3,              
            EMVStatus_ApplicationSelection = 4,     
            EMVStatus_Loyalty = 5,                  
            EMVStatus_PinCode = 6,                  
            EMVStatus_FirstCardDecision = 7,        
            EMVStatus_WaitProcessorApproval = 8,    
            EMVStatus_FinalCardDecision = 9,        
            EMVStatus_Completed = 10,               
        };

        enum ExtendedPeriodicStatus
        {
            PeriodicStatus_Idle = 0,                                        
            PeriodicStatus_SendDynamicParameterRequest = 1001,              
            PeriodicStatus_RecvDynamicParameterResponse = 1002,             
            PeriodicStatus_RecvDynamicParameterIsraelResponse = 1003,       
            PeriodicStatus_RecvDynamicParameterTouristResponse = 1004,      
            PeriodicStatus_RecvDynamicParameterGeneralResponse = 1005,      
            PeriodicStatus_RecvTkefimIsracard = 1056,                       
            PeriodicStatus_RecvTikrutPL = 1201,                             
            PeriodicStatus_RecvTikrutLocal = 1202,                          
            PeriodicStatus_RecvTikrutTourist = 1204,                        
            PeriodicStatus_RecvIsracardPermission = 1301,                   
            PeriodicStatus_RecvIsracardNames = 1304,                        
            PeriodicStatus_RecvNonPLServiceCodeChecks = 1306,               
            PeriodicStatus_RecvCalImmediateChargeIdentification = 1311,     
            PeriodicStatus_RecvPLServiceCodeChecks = 1312,                  
            PeriodicStatus_RecvCalPermissions = 1315,                       
            PeriodicStatus_RecvCalNames = 1318,                             
            PeriodicStatus_RecvLeumiPermissions = 1331,                     
            PeriodicStatus_RecvLeumiNames = 1334,                           
            PeriodicStatus_RecvFutureManpikPermissions = 1341,              
            PeriodicStatus_RecvFutureNames = 1344,                          
            PeriodicStatus_RecvTouristNames = 1364,                         
            PeriodicStatus_RecvUnauthorizedIsraeliCards = 1380,             
            PeriodicStatus_RecvBenefitsDefinitions = 1381,                  
            PeriodicStatus_RecvPrivateFieldsInChipLocation = 1382,          
            PeriodicStatus_RecvCardMaskingDefinitions = 1383,               
            PeriodicStatus_RecvIssuerPrefixAssociation = 1390,              
            PeriodicStatus_RecvSolekDefinitions = 1391,                     
            PeriodicStatus_RecvBrandDefinitions = 1392,                     
            PeriodicStatus_RecvManpikDefinitions = 1393,                    
            PeriodicStatus_RecvSystemMessage = 1400,                        
            PeriodicStatus_SendBatchRequest = 1401,                         
            PeriodicStatus_SendBatchBlock = 1402,                           
            PeriodicStatus_SendBatchAmounts = 1403,                         
            PeriodicStatus_RecvBatchResponse = 1404,                        
            PeriodicStatus_RecvCommReportResponse = 1502,                   
            PeriodicStatus_SendBlockedCardsRequest = 1601,                  
            PeriodicStatus_RecvBlockedCardsResponseFull = 1604,             
            PeriodicStatus_RecvBlockedCardsResponseSmall = 1605,            
            PeriodicStatus_SendPinPadParametersRequest = 1701,              
            PeriodicStatus_RecvPinPadParametersResponseParameters = 1702,   
            PeriodicStatus_RecvPinPadParametersResponseCAKey = 1703,        
            PeriodicStatus_RecvPinPadParametersResponseBins = 1704,         
            PeriodicStatus_UpdatingPinpadParameters = 1,                    
            PeriodicStatus_AuthorizingPendingTransaction = 2,               
            PeriodicStatus_Completed = 10,                                  
        };

        enum SPILogLevel
        {
            SPILog_Emergency = 0,           
            SPILog_Alert = 1,               
            SPILog_Critical = 2,            
            SPILog_Error = 3,               
            SPILog_Warning = 4,             
            SPILog_Notice = 5,              
            SPILog_Info = 6,                
            SPILog_Debug = 7,               
        };

        enum SPILanguage
        {
            SPILanguage_Hebrew = 1,         
            SPILanguage_English = 2,        
            SPILanguage_Generic = 3,        
        };


        enum SPIMode 
        {
            SPIMode_IdleAlways = 0,         
            SPIMode_SessionStart = 1,       
        };

        enum ServiceProperty
        {
            ServiceProperty_TransmitTime = 1,           
            ServiceProperty_SystemTrace = 2,            
            ServiceProperty_DeviceSerial = 3,           
            ServiceProperty_CountryCode = 4,            
            ServiceProperty_Currency = 5,               
            ServiceProperty_DecimalPlace = 6,           
            ServiceProperty_AcquirerTermianlId = 7,     
            ServiceProperty_RavSapak = 8,               
        };

        enum DeviceProperty
        {
            DeviceProperty_SN = 1,          
            DeviceProperty_NayaxSN = 2,     
            DeviceProperty_AppVersion = 3,  
        };       

        enum DcsStatus
        {
            DcsStatus_NotActivated = 0,         
            DcsStatus_Activated = 1,            
            DcsStatus_TokenOnly = 2,            
        };

        enum DcsActivationMode
        {
            DcsActivationMode_FullActivation = 1,   
            DcsActivationMode_TokenOnly = 2,                
        };

        enum DcsProperty
        {
            DcsProperty_RetailerNumber = 1,         
            DcsProperty_Token = 2,                  
            DcsProperty_NayaxSN = 3,                
            DcsProperty_ActivationError = 4,        
            DcsProperty_Parameters = 5,             
            DcsProperty_PaymentMethods = 6,         
            DcsProperty_EMVProvider = 7,            
            DcsProperty_CibusEnabled = 8,           
            DcsProperty_CibusRestaurantId = 9,      
            DcsProperty_CibusPosId = 10,            
            DcsProperty_MultipassEnabled = 11,      
            DcsProperty_MultipassPosId = 12,        
        };

        enum MasterSlaveMode
        {
            MasterSlaveMode_None = 0,           
            MasterSlaveMode_Master = 1,         
            MasterSlaveMode_Slave = 2,          
        };

        enum ReadCardEntry
        {
            MSR = 0,                    
            MIFARE = 1                  
        };

        namespace Ashrait {
            
            enum VirtualReason 
            {
                SwipeData = 1,                      
                Balance = 2,                        
                CancelRegisteredTransaction = 3,    
                CancelPreAuthorization = 4,         
                GenerateStandingOrder = 5,          
                RetreiveTransaction = 6,            
                Settelment = 7,                     
                RetreiveTransactionByVuid = 8,      
            };
            
            enum CreditTerms 
            {
                CT_Regular = 1,                     
                CT_IsracreditVisaMaofVisa30 = 2,    
                CT_Immidiate = 3,                   
                CT_CreditFixed = 6,                 
                CT_Payments = 8,                    
            };

            enum PaymentLinked 
            {
                ToNone = 0,                 
                ToCPI = 1,                  
                ToDollar = 2,               
            };            
            
            enum Status 
            {
                Ready = 0,                  
                NotEstablished = -1,        
                BatchNeeded = -2,           
                DBError = -3,               
                PinpadError = -4,           
                VersionError = -5,          
                Unknown = -6,               
                BatchRequiered = -7,        
                NotConnected = -8,          
            };

            enum CardNotPresentType 
            {
                CNP_Signature = 1,          
                CNP_Phone = 2,              
                CNP_Internet = 3,           
            };

            enum TransactionType 
            {
                TT_Informative = 0,         
                TT_Regular = 1,             
                TT_Unload = 2,              
                TT_Forced = 3,              
                TT_CashBack = 6,            
                TT_Cash = 7,                
                TT_StandingOrder = 11,      
                TT_BalanceCheck = 30,       
                TT_Refund = 53,             
                TT_Charge = 55,             
            };

            enum IPayType 
            {
                IPay_Money = 0,             
                IPay_Starts = 1,            
                IPay_Points = 2,            
                IPay_Club = 3,              
                IPay_NoIpay = 99,           
            };

            enum ECIType 
            {
                ECI_InternetNoSign = 1,                 
                ECI_InternetManpikNotRegistered = 2,    
                ECI_InternetWithSign = 3,               
            };
            
            enum MissingEventType 
            {
                MissingNone = 0,                        
                MissingAuthorizationNumber = 1,         
                MissingAVSDeatils = 2,                  
                MissingUnknown = 3,                     
            };
            
            enum Manpik 
            {
                Manpik_Tourist = 0,     
                Manpik_Isracard = 1,    
                Manpik_CAL = 2,         
                Manpik_3 = 3,           
                Manpik_4 = 4,           
                Manpik_5 = 5,           
                Manpik_LeumiCard = 6,   
                Manpik_7 = 7,           
                Manpik_8 = 8,           
                Manpik_9 = 9,           
                Manpik_10 = 10,         
                Manpik_11 = 11,         
                Manpik_12 = 12,         
            };
            
            enum Solek 
            {
                Solek_Isracard = 1,     
                Solek_Cal = 2,          
                Solek_3 = 3,            
                Solek_4 = 4,            
                Solek_Tranzila = 5,     
                Solek_LeumiCard = 6,    
                Solek_Cardcom = 7,      
                Solek_8 = 8,            
                Solek_9 = 9,            
                Solek_10 = 10,          
                Solek_11 = 11,          
                Solek_12 = 12,          
            };
            
            enum Mutag 
            {
                Mutag_PL = 0,           
                Mutag_Mastercard = 1,   
                Mutag_Visa = 2,         
                Mutag_Diners = 3,       
                Mutag_Amex = 4,         
                Mutag_Isracard = 5,     
                Mutag_JCB = 6,          
                Mutag_Discover = 7,     
                Mutag_Maestro = 8       
            };
            
            enum PanEntryMode 
            {
                PEM_Magnetic = 0,                       
                PEM_Magnetic_Contactless = 4,           
                PEM_EMV_Contactless = 5,                
                PEM_Mobile_Magnetic_Contactless = 6,    
                PEM_EMV_Mobile_Contactless = 7,         
                PEM_PhoneNumber = 10,                   
                PEM_RFU = 11,                           
                PEM_EMV_Contact = 40,                   
                PEM_Phone = 50,                         
                PEM_Signeture_Only = 51,                
                PEM_Internet = 52,                      
                PEM_Fallback = 80,                      
                PEM_Empty_Candidate_List = 81,          
                PEM_Empty = 99,                         
            };

            enum ProcessorId
            {
                ABS = 1,                        
                Pelecard = 2,                   
                CreditGuard = 3,                
                Tranzila = 4,                   
                EZCard = 5,                     
                Arkom = 6,                      
                Nayax = 7,                      
            };

            enum AuthCodeIssuer
            {
                AuthCodeIssuer_Unauthorized = 0,                
                AuthCodeIssuer_ApprovedByIssuer = 1,            
                AuthCodeIssuer_DeclinedByIssuer = 2,            
                AuthCodeIssuer_ApprovedByAbsSTIP = 3,           
                AuthCodeIssuer_DeclinedByAbsSTIP = 4,           
                AuthCodeIssuer_ApprovedByVoice = 5,             
                AuthCodeIssuer_DeclinedByVoice = 6,             
                AuthCodeIssuer_ApprovedByIssuerPreAuth = 7,     
                AuthCodeIssuer_ApprovedByCard = 8,              
            };

        }
        
        namespace NayaxVend {
            
            enum CardEntryType 
            {
                CardEntry_MsrSwipe = 1,                     
                CardEntry_Contactless = 2,                  
                CardEntry_Contact = 3,                      
                CardEntry_Mifare = 4                        
            };                  
            
            enum UnitOfMeasurement 
            {
                Measurement_Item = 0,                       
            };

            enum CardType
            {
                CardType_Unknown = 0,       
                CardType_Proprietary = 1,   
                CardType_Visa = 2,          
                CardType_MasterCard = 3,    
                CardType_ChinaUnionPay = 4, 
                CardType_Maestro = 5,       
                CardType_Interac = 6,       
                CardType_Monyx = 7,         
            };

        }   

        namespace Cibus {

            enum CibusTranType
            {
                CibusTranType_AddOrder = 1,             
                CibusTranType_CancelOrder = 2,          
                CibusTranType_BalanceInquiry = 3,       
                CibusTranType_RetrieveByOrderId = 4,    
                CibusTranType_RetrieveByVUID = 5,   
            };

            enum CibusCardType
            {
                CibusCardType_Unkown = 1,   
                CibusCardType_Cibus = 2,    
                CibusCardType_TavZahav = 3, 
            };
            
            enum CibusCardEntryType
            {
                CibusCardEntryType_Manual = 1,  
                CibusCardEntryType_Swipe = 2,   
                CibusCardEntryType_Mifare = 3,  
            };
            
            enum CibusAcquirer
            {
                CibusAcquirer_Cibus = 1,    
                CibusAcquirer_TavZahav = 2, 
            };
            

            enum CibusReportType
            {
                CibusReportType_Companies = 1,  
            };

            struct Company
            {
                string CompanyId;               
                string CompanyName;             
            };

        }

        namespace Multipass {

            enum MultipassTransactionType
            {
                MultipassTransactionType_SumTrnsaction = 1,     
                MultipassTransactionType_ItemTransaction = 2,   
                MultipassTransactionType_RefundTransaction = 3, 
                MultipassTransactionType_DeleteTransaction = 4,     
                MultipassTransactionType_BalanceInquiry = 5,            
                MultipassTransactionType_RetrieveByTransactionId = 6,   
                MultipassTransactionType_RetrieveByVUID = 7,            
            };

            struct MultipassItem
            {
                string ItemId;              
                AmountType ItemAmount;      
                CounterType ItemQuantity;   
            };
        }

        namespace NayaxEngine {

            enum NayaxEngineTransactionType
            {
                NayaxEngineTransactionType_Sale = 1,        
                NayaxEngineTransactionType_Refund = 2,  
                NayaxEngineTransactionType_PreAuthorization = 3,    
                NayaxEngineTransactionType_DeferredAuthorization = 4, 
            };
        }





    }
}