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

#include <AshraitEMVTransaction.h>

Inheritance diagram for Modularity::SPI::AshraitEMVTransaction:

Public Member Functions
SPILIBRARY_API	~AshraitEMVTransaction ()
	Class desrstructor.

APIHandle	GetAshEMVHandle () const
	Handle get - reserved for internal useage.

Pre Transaction Information
Those methods can be called before transaction is executed.
SPILIBRARY_API	AshraitEMVTransaction (AmountType Amount, string VendorUID, CurrencyType Currency)
	Class constructor. When this constructor is called the transaction can be decrotated as:

SPILIBRARY_API SPI_RET_VAL	SetAsCNPTransaction (Ashrait::CardNotPresentType Type, string CardNumber, string Exp, string CVV, string ID, std::string Address, std::string City, std::string ZipCode)
	Set transaction credit card deatils when no device is used.

SPILIBRARY_API SPI_RET_VAL	SetAsInternetTransaction (Ashrait::ECIType ECI, string CAVVUCAF, string XID, string CAP_DPA)
	Set internet transaction data.

SPILIBRARY_API void	SetCVV (std::string CVV)
	Set cvv when Tran_CVV.

SPILIBRARY_API void	SetCardHolderId (std::string CardHolderId)
	Set cardholder Id's when Tran_CardHolderId.

SPILIBRARY_API SPI_RET_VAL	SetMSRData (std::string Data)
	Use unsupprted pinpad interface to do MSR transactions.

SPILIBRARY_API SPI_RET_VAL	SetAsRefund ()
	Set transaction as a refund transaction עסקת זיכוי

SPILIBRARY_API SPI_RET_VAL	SetAsCashback (AmountType CashbackAmount)
	Set transaction as a cashback transaction עסקה עם מזומן

SPILIBRARY_API SPI_RET_VAL	SetAsCash ()
	Set transaction as a cash transaction עסקת מזומן

SPILIBRARY_API SPI_RET_VAL	SetAsChargePrepaid (Ashrait::IPayType Type, AmountType UnitsAmount=0)
	Set transaction as a charge prepaid transaction עסקת טעינה לכרטיסים נטענים

SPILIBRARY_API SPI_RET_VAL	SetAsUnChargePrepaid (Ashrait::IPayType Type)
	Set transaction as a uncharge prepaid transaction עסקת פריקה לכרטיסים נטענים

SPILIBRARY_API SPI_RET_VAL	SetAsSingleStandingPayment (std::string OriginUID, PaymentType PaymentIndex, std::string SolekAuthNum, std::string IssuerAuthNum, AmountType Commision=0)
	Set transaction as a single payment for standing order. תשלום תור"ן להוראת קבע

SPILIBRARY_API SPI_RET_VAL	SetAsSingleStandingPayment (std::string OriginUID, AmountType TotalAmount, PaymentType PaymentIndex, std::string SolekAuthNum, std::string IssuerAuthNum, AmountType Commision=0)
	Set transaction as a single payment for standing order. תשלום תור"ן להוראת קבע

SPILIBRARY_API SPI_RET_VAL	SetAsSingleStandingPayment (std::string OriginUID, PaymentType TotalNumberOfPayments, PaymentType PaymentIndex, std::string SolekAuthNum, std::string IssuerAuthNum, AmountType Commision=0)
	Set transaction as a single payment for standing order. תשלום תור"ן להוראת קבע

SPILIBRARY_API SPI_RET_VAL	SetAsCreditTransaction (PaymentType NoOfPayments)
	Set transaction with Credit credit-terms. Division is mady by SHVA.

SPILIBRARY_API SPI_RET_VAL	SetAsPaymentsTransaction (PaymentType NoOfPayments, AmountType First, Ashrait::PaymentLinked Link)
	Set transaction with payments credit-terms.

SPILIBRARY_API SPI_RET_VAL	SetAsSpecialCredit ()
	Set transaction with special credit-terms.

SPILIBRARY_API SPI_RET_VAL	SetAsImmediateCredit ()
	Set transaction with immediate credit-terms.

SPILIBRARY_API SPI_RET_VAL	SetAsIPayTransaction (AmountType MoneyAmount)
	Set transaction with IPay is עסקה עם הטבה

SPILIBRARY_API SPI_RET_VAL	SetAsIPayTransaction (PercentType Percents)
	Set transaction with IPay is עסקה עם הטבה

SPILIBRARY_API SPI_RET_VAL	SetAsIPayTransaction (Ashrait::IPayType Type, AmountType MoneyAmount, AmountType UnitsAmount)
	Set transaction with IPay is עסקה עם הטבה

SPILIBRARY_API SPI_RET_VAL	SetForeignCurrency (CurrencyISOType ISOCode, AmountType ConversionAmount, RateType ChangeRate)
	Set transaction with foreign currency.

SPILIBRARY_API SPI_RET_VAL	SetIsracardGift (std::string OfferCode, std::string GiftNumber)
	Set a gift from Isracard.

SPILIBRARY_API SPI_RET_VAL	SetOfferCode (std::string OfferCode)
	Use an agreed offer.

SPILIBRARY_API SPI_RET_VAL	SetTip (AmountType TipAmount)
	Tip as part of the Transaction Amount.

SPILIBRARY_API SPI_RET_VAL	SetDeferMonths (MonthType Months)
	Set defer months to transaction in months.

SPILIBRARY_API SPI_RET_VAL	SetDueDate (std::string DueDateYYMMDD)
	Set defer months to transaction in months.

SPILIBRARY_API SPI_RET_VAL	SetToForceOfflineApproval ()
	Set transaction to be approved offline. This option is on the merchent responsibility.

SPILIBRARY_API SPI_RET_VAL	SetToForceOnlineAuthorization ()
	Set transaction to go online to SHVA.

SPILIBRARY_API SPI_RET_VAL	SetAsSelfService ()
	Set transaction a self service. This function should called when the customer is making the transaction all alone.

SPILIBRARY_API SPI_RET_VAL	SetFullAddress (std::string Address, std::string City, std::string ZipCode)
	Set credit card holder address detailes.

SPILIBRARY_API SPI_RET_VAL	SetZipCode (std::string ZipCode)
	Set credit card holder ZIP code address.

SPILIBRARY_API SPI_RET_VAL	SetAsPreAuthorization ()
	Set transaction as obligo. to complete ot cancel this transaction user should keep the UID,.

SPILIBRARY_API SPI_RET_VAL	CompletePreAuthorization (std::string UID)
	Complete an obligo transaction created with SetAsPreAuthorization(). The Amount in the constructor should be less or equal to the amount from the original transaction.

SPILIBRARY_API SPI_RET_VAL	SetAuthorizationNumber (std::string AuthNumber)
	Use this method if the merchent has quthorization number from credit card company.

SPILIBRARY_API SPI_RET_VAL	SetAsPetrol (Ashrait::GasolineType GasolineType, AmountType GasolineLiter, AmountType OilLiter, AmountType OilAmount, AmountType Speedometer, std::string CarNumber, AmountType Service)
	Use this method if the merchent has quthorization number from credit card company.

SPILIBRARY_API void	SetDisplayLanguage (SPILanguage Language)
	Set the display language on a pinpad during the transaction. Supported only in remoted Ashrait.

SPILIBRARY_API void	SetAdditionalInformation (std::string Information)
	Set stream to be sent over addendum1-settl.

SPILIBRARY_API SPI_RET_VAL	SetSystemTrace (std::string SystemTrace)
	Set System Trace Number when working as Slave.

SPILIBRARY_API void	SetPaymentAggregatorValue (std::string Key, std::string Value)
	set payment aggreagtor value be name

SPILIBRARY_API void	SetCustomData (std::string Key, std::string Value)
	Set custom data to payment gateway.

SPILIBRARY_API void	SetSubRetailer (std::string SubRetailer)
	Set SubRetailer when working in RavSapak Mode.

SPILIBRARY_API void	SetZData (UnsignedNumericType ZData)
	Set ZData. This is AshraitEMV n8 field that passed as is to Shva.

SPILIBRARY_API void	SetMutav (std::string Mutav)
	Set mutav number for Rav-Mutav. Can be called either before DoTransactionPhase1 or DoTransactionPhase2.

Virtual transactions
Special operations using AshraitEMVTransaction handle
SPILIBRARY_API	AshraitEMVTransaction (std::string VendorUID, Ashrait::VirtualReason Virtual)
	Class constructor. When this constructor is called the transaction handle is used for speical kinds of operations. USer must proveide a reason (Virtual) for creating this kind of transaction. Each reason got a method to complete the information needed to perform the operation.

SPILIBRARY_API SPI_RET_VAL	SetAsSwipeData (PPIDType DeviceId, std::vector< std::string > DisplayMessages, TimeOutType TimeOutSeconds)
	Set all the requiered data when performing track2 request.

SPILIBRARY_API SPI_RET_VAL	SetAsCancelTransaction (std::string OriginalUID)
	Cancel a transaction that succeded. Aka GetResultCode was 0.

SPILIBRARY_API SPI_RET_VAL	SetAsCancelPreAuthorization (std::string OriginalUID)
	Cancel a transaction that generated via SetAsPreAuthorization() and never completed. The original transaction must be succeded. Aka GetResultCode was 0.

SPILIBRARY_API SPI_RET_VAL	SetBalaceData (Ashrait::IPayType Type)
	Set requiered information for balance transaction.

SPILIBRARY_API SPI_RET_VAL	SetAsGenerateStandingOrder (AmountType TotalAmount, FrequencyType Freq)
	Generate a standing order הוראת קבע . If generation succeeded user should use data of this transaction according to SetAsSingleStandingPayment() parameters. There're 3 different API's for generating standing order. In this configuration.

SPILIBRARY_API SPI_RET_VAL	SetAsGenerateStandingOrder (PaymentType TotalNumberOfPayments, FrequencyType Freq)
	Generate a standing order.

SPILIBRARY_API SPI_RET_VAL	SetAsGenerateStandingOrder (FrequencyType Freq)
	Generate a standing order.

SPILIBRARY_API SPI_RET_VAL	SetSettelmentRecord (string Record, string UID)
	Setelment transaction in Mastermode.

SPILIBRARY_API SPI_RET_VAL	SetAsCardless ()
	Don't ask for a card for CancelRegisteredTransaction/ CancelPreAuth / CompletePreAuth By deafult a card will be needed unless CNP method used.

Post Phase1 Information
Those methods can be called after phase 1 is completed, weather using DoTransactionPhase1() or when TransactionStatus is Tran_Phase1Now when using PollTransaction().
SPILIBRARY_API SPI_RET_VAL	SetLoyaltyAmount (AmountType Amount)
	Change the transaction amount post transaction phase1.

SPILIBRARY_API std::vector < Ashrait::CreditTerms >	GetAvilibleCreditTerms () const
	Check which credit terms are allowed with the card identified in the transaction phase 1.

SPILIBRARY_API PaymentType	GetMinimumCreditPaymentsAvilible () const
	Get minimum of credit payments allowed in transaction after the card identified in the transaction phase 1.

SPILIBRARY_API PaymentType	GetMaximumCreditPaymentsAvilible () const
	Get maximum of credit payments allowed in transaction after the card identified in the transaction phase 1.

SPILIBRARY_API AmountType	GetMinimumAmountForCreditPayment () const
	Get minimum amount of single payment allowed in credit transaction after the card identified in the transaction phase 1.

SPILIBRARY_API PaymentType	GetMaximumPaymentsAvilible () const
	Get maximum of payments allowed in transaction after the card identified in the transaction phase 1.

SPILIBRARY_API void	GetSolekInformation (std::string &Name, std::string &BusinessNumber, std::string &PhoneNumber) const
	Get all the requiered information.

SPILIBRARY_API bool	IsClub () const
	A method that tells weather detected card is club card. This method can be called during loyalty phase and after transaction was executed.

SPILIBRARY_API bool	IsPrepaid () const
	A method that tells weather detected card is preapaid card. This method can be called during loyalty phase and after transaction was executed.

SPILIBRARY_API bool	IsCombinedCard () const
	A method that tells weather detected card is combined card. This method can be called during loyalty phase and after transaction was executed.

SPILIBRARY_API string	GetClubNumber () const
	Get the club number מספר מועדון

SPILIBRARY_API string	GetIsracardClubNumber () const
	Get Isracard club number מספר מועדון This value is for and card issued by Isracard and the brand is Isracard or PL. The value is 4 digits length club number from track2 discretionary data field position 29.

SPILIBRARY_API string	GetIsracardGroup () const
	Get the Isracard group number קבוצת שיוך

SPILIBRARY_API bool	IsCvvRequiered () const
	A method that tells if CVV is requiered for completeing the transaction This method can be called during loyalty phase and after transaction was executed.

SPILIBRARY_API bool	IsCardHoderIdRequiered () const
	A method that tells if Card holder Id is requiered for completeing the transaction This method can be called during loyalty phase and after transaction was executed.

Post Transaction Information
Those methods can be called after transaction is executed.
SPILIBRARY_API bool	WasSuccessful () const
	A method that tells post transaction weather transaction succeded or not.

SPILIBRARY_API std::vector < ReceiptLine >	GetMerchentRecipt () const
	Get a list of (key,value) AshraitEMV receipt. According to SHVA AshraitEMV documentation, receipt must be printed in pre defined order. ECR prints the list provided from this function by it's order. Each member of the vector is a line. The key member is the field name and value is the field value. e.g. key=סוג עסקה and value=חובה e.g. key=זיהוי יישום בשבב and value=A00000003010 - some EMV unformation about the transaction. Receipt exists only if WasSuccessful() is true or GetResultCode() is 0. This function returns all the lines that belongs to the merchant copy. According to SHVA not all transactions will require the customer signature and phone number, thus, if transaction requieres customer phone and signtaure last two lines will include the keys "חתימת הלקוח", "טלפון הלקוח".

SPILIBRARY_API std::vector < ReceiptLine >	GetCustomerRecipt () const
	Get a list of (key,value) AshraitEMV receipt. According to SHVA AshraitEMV documentation, receipt must be printed in pre defined order. ECR prints the list provided from this function by it's order. Each member of the vector is a line. The key member is the field name and value is the field value. e.g. key=סוג עסקה and value=חובה e.g. key=זיהוי יישום בשבב and value=A00000003010 - some EMV unformation about the transaction. Receipt exists only if WasSuccessful() is true or GetResultCode() is 0. This function returns all the lines that belongs to the customer copy.

SPILIBRARY_API bool	WasPhase1 () const
	A method that tells post transaction weather there was already phase 1 of the transaction.

SPILIBRARY_API string	GetUID () const
	Get transaction Uniqie IDentification number. UID is 23 len string that generated by Ashrait for every transaction wheather succeded or not. This value is already printd on recipt.

SPILIBRARY_API std::string	GetSolekAuthNum () const
	Solek authorization number if transaction went online. This value is already printd on recipt.

SPILIBRARY_API std::string	GetIssuerAuthNum () const
	Manpik (issuer) authorization number if transaction went online. This value is already printd on recipt.

SPILIBRARY_API Ashrait::AuthCodeIssuer	GetAuthCodeIssuer () const
	Manpik (issuer) authorization number if transaction went online. This value is already printd on recipt.

SPILIBRARY_API std::string	GetSystemTraceNum () const
	System trace number is SHVA field-11. XXYYYZZZ - XX - File Number, YYY - Terminal Number/ECR Id , ZZZ - Terminal sequence number This value is already printd on recipt.

SPILIBRARY_API std::string	GetSwipeData () const
	Get data on card magnetic stripe track2 info. From version 1.2008 track2 of card is avililble in this method in case ResultCode eq 44 or 47.

SPILIBRARY_API std::string	GetMaskedPan () const
	Get credit card PAN masked with 3 *'s. This value is already printd on recipt according to the copy type.

SPILIBRARY_API std::string	GetMaskedPanOriginalLength () const
	Get credit card PAN masked with *'s in it's original length. This value is already printd on recipt according to the copy type.

SPILIBRARY_API std::string	GetCardExpiryDate () const
	Get card expiry date in format YYMM.

SPILIBRARY_API std::string	GetCardName () const
	Get card name (VISA, MasterCard, etc..) Name can be also in Hebrew (UTF-8)

SPILIBRARY_API std::string	GetTokenizedPAN () const
	Get credit card PAN tokenized by MD5 rfc1321.

SPILIBRARY_API std::string	GetRRN () const
	RRN is unique identifier number generated by transaction approver when transaction goes online. This value is already printd on recipt.

SPILIBRARY_API Ashrait::Solek	GetSolek () const
	Get credit card Solek enumerator.

SPILIBRARY_API Ashrait::Mutag	GetMutag () const
	Get credit card Mutag (brand) enumerator.

SPILIBRARY_API Ashrait::Manpik	GetManpik () const
	Get credit card Manpik (issuer) enumerator.

SPILIBRARY_API Ashrait::PanEntryMode	GetPanEntryMode () const
	PAN entry mode is the way AshraitEMV got the credit card PAN. This value is already printd on recipt.

SPILIBRARY_API Ashrait::CreditTerms	GetCreditTerms () const
	Get credit terms as enumerator. Credit type can be changed by Ashrait during transaction. This value is already printd on recipt.

SPILIBRARY_API Ashrait::TransactionType	GetTranType () const
	Get transaction type as enumerator. Transaction type can be changed by Ashrait during transaction. This value is already printd on recipt.

SPILIBRARY_API std::string	GetCompanyBussinessNumber () const
	Get company bussiness number. This value is already printd on recipt.

SPILIBRARY_API PaymentType	GetNoOfPayments () const
	Get number of payments if transaction was setted as payments or credit.

SPILIBRARY_API AmountType	GetFirstPayment () const
	Get the amount of the first payment if transaction was setted as Payments. This value may be chang during transaction in order to create an equal division for the rest of the payments.

SPILIBRARY_API AmountType	GetNotFirstPayment () const
	Get the amount of the rest of the payments if transaction was setted as Payments.

SPILIBRARY_API AmountType	GetTip () const
	Get tip setted with SetTip() This value is already printd on recipt.

SPILIBRARY_API void	GetBalanceInformation (std::string &OutputBalance, boolean &MustPrint, boolean &MustShow) const
	Get balance of a pre paid card in balance transaction. The balance will be printed into a provided buffer as std::string. The other flags mean wheather merchent has to print a copy with the balance output to the customer and wheather must show on the Pinpad, both are possible.

SPILIBRARY_API ExtendedEMVStatus	GetExtendedEMVStatus () const
	Get the status of the transaction.

SPILIBRARY_API Ashrait::MissingEventType	GetMissingEvent () const
	Get the type of information were missing in the transaction. Each event has it's Setter.

SPILIBRARY_API std::string	GetToken () const
	Get the transaction token generated in gateway.

SPILIBRARY_API std::string	GetSettelmentRecord () const
	Get the transaction record when using master/slave mode.

SPILIBRARY_API AmountType	GetAuthorizedAmount () const
	Get the authorized amount for petrol transaction.

SPILIBRARY_API std::string	GetPaymentAggregatorValue (std::string Key) const
	Get payment aggreagtor value be name.

SPILIBRARY_API std::string	GetMutav () const
	Get the transaction mutav number used if RavMutav was used.

SPILIBRARY_API std::string	GetMiniSettelemntAckNumber () const
	Get the ack number from gateway when performing mini settelment.

SPILIBRARY_API std::vector < std::string >	GetMiniSettelemntTransactions () const
	Get the transactions UIDS that was settelmented to gateway during mini settelemnt.

Public Member Functions inherited from Modularity::SPI::Transaction
APIHandle	GetTransactionHandle () const
	Reserved for internal useage.

SPILIBRARY_API	Transaction (AmountType Amount, CurrencyType Currency, string VendorUID)
	Transaction constructor. Can't be used explicitly as Transaction is pure virtual.

virtual SPILIBRARY_API	~Transaction ()=0
	Class destructor.

SPILIBRARY_API PPIDType	GetPinPadId () const
	Get device identification number used to make the transaction.

SPILIBRARY_API void	SetPinPadId (PPIDType PinPadID)
	Set device identification number used to make the transaction.

SPILIBRARY_API string	GetVendorUID () const
	Get vendor unique ID as initialized at derived class constructor.

SPILIBRARY_API AmountType	GetAmount () const
	Get Transaction original amount as initialized at derived class constructor.

SPILIBRARY_API CurrencyType	GetCurrency () const
	Get currency enumerator as initialized at derived class constructor.

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.

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

Detailed Description

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.

Examples:: CPP_Examples.cpp.

Definition at line 33 of file AshraitEMVTransaction.h.

Constructor & Destructor Documentation

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

Class constructor. When this constructor is called the transaction can be decrotated as:

        - Regular (Deafult) - חיוב
        - Refund - זיכוי
        - Cash - מזומן
        - Cashback - עסקה עם מזומן
        - Charge Prepaid - פריקה
        - Uncharge Prepaid - טעינה
        - Single payment for Standing Order - תשלום תור"ן להוראת קבע

    Each transaction can be decorted with speical credit terms:
        - Regular (Default) - רגיל
        - Credit - עסקת קרדיט
        - Payments  - עסקת תשלומים
        - Speical - מיוחד
        - Immediate - חיוב מיידי

    Transactions can be also decorated with Ipay, Foreign Currency, 
    Tip amount and a given future time. 
This kind Transaction can be forced to go online or to approved offline,
    to be setted as Self Service, and set Full address of the Card Holder.

    This kind of transaction can be also be Pre-Authorized by providing 7 digits Authoriztion number.
    This kind of transaction can be an obloigo request (Pre authorization) בקשה לאישור ללא עסקה
    and to complete obligo transaction with a less ot equal amount from the request.
    This kind of transaction can be used with a card non present.

Parameters

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

SPILIBRARY_API Modularity::SPI::AshraitEMVTransaction::AshraitEMVTransaction	(	std::string	VendorUID,
		Ashrait::VirtualReason	Virtual
	)

Class constructor. When this constructor is called the transaction handle is used for speical kinds of operations. USer must proveide a reason (Virtual) for creating this kind of transaction. Each reason got a method to complete the information needed to perform the operation.

    - Swipe - to get track2 from different kinds of cards. note: credit cards are not returnrd back. 
    - Cancel Transaction - Cancel a transaction that succeded (with ResultCode=0) 
    - Cancel Pre Authoriztion Transaction - Cancel an obligo created with SetAsPreAuthorization()
    - Balance - Check the balance of a pre paid card.
    - Generate standing order - create a standing order הוראת קבע , this kind of transaction has 3 different interfaces.

See Also: SetAsSwipeData(); SetAsCancelTransaction(); SetAsCancelPreAuthorization(); SetBalaceData(); SetAsGenerateStandingOrder()

Parameters

[in]	VendorUID	is an identifier string generated by the ECR. Can't be empty string.
[in]	Virtual	is enumerator specifing the reason for creating virtual transaction.

Member Function Documentation

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::CompletePreAuthorization ( std::string UID )

Complete an obligo transaction created with SetAsPreAuthorization(). The Amount in the constructor should be less or equal to the amount from the original transaction.

See Also: SetAsPreAuthorization()

Parameters

[in] UID is std::string specifing UID form original transaction created with SetAsPreAuthorization().

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API Ashrait::AuthCodeIssuer Modularity::SPI::AshraitEMVTransaction::GetAuthCodeIssuer ( ) const

Manpik (issuer) authorization number if transaction went online. This value is already printd on recipt.

Returns: Issuer company authorization number as std::string

SPILIBRARY_API AmountType Modularity::SPI::AshraitEMVTransaction::GetAuthorizedAmount ( ) const

Get the authorized amount for petrol transaction.

Returns: amount

SPILIBRARY_API std::vector<Ashrait::CreditTerms> Modularity::SPI::AshraitEMVTransaction::GetAvilibleCreditTerms ( ) const

Check which credit terms are allowed with the card identified in the transaction phase 1.

Returns: vector with Ashrait::CreditTerms that allowed for the transaction.

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::GetBalanceInformation	(	std::string &	OutputBalance,
		boolean &	MustPrint,
		boolean &	MustShow
	)		const

Get balance of a pre paid card in balance transaction. The balance will be printed into a provided buffer as std::string. The other flags mean wheather merchent has to print a copy with the balance output to the customer and wheather must show on the Pinpad, both are possible.

Parameters

[out]	OutputBalance	is the result of the balance query
[out]	MustPrint	wheather must print a paper with the output of OutputBalance
[out]	MustShow	wheather must show to the customer the OutputBalance

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetCardExpiryDate ( ) const

Get card expiry date in format YYMM.

Returns: expiry date as string

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetCardName ( ) const

Get card name (VISA, MasterCard, etc..) Name can be also in Hebrew (UTF-8)

Returns: card name as string

SPILIBRARY_API string Modularity::SPI::AshraitEMVTransaction::GetClubNumber ( ) const

Get the club number מספר מועדון

Returns: club number as string or empty string if card not detected

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetCompanyBussinessNumber ( ) const

Get company bussiness number. This value is already printd on recipt.

Returns: Company bussiness number as enumerator

SPILIBRARY_API Ashrait::CreditTerms Modularity::SPI::AshraitEMVTransaction::GetCreditTerms ( ) const

Get credit terms as enumerator. Credit type can be changed by Ashrait during transaction. This value is already printd on recipt.

Returns: Credit type as enumerator

SPILIBRARY_API std::vector<ReceiptLine> Modularity::SPI::AshraitEMVTransaction::GetCustomerRecipt ( ) const

Get a list of (key,value) AshraitEMV receipt. According to SHVA AshraitEMV documentation, receipt must be printed in pre defined order. ECR prints the list provided from this function by it's order. Each member of the vector is a line. The key member is the field name and value is the field value. e.g. key=סוג עסקה and value=חובה e.g. key=זיהוי יישום בשבב and value=A00000003010 - some EMV unformation about the transaction. Receipt exists only if WasSuccessful() is true or GetResultCode() is 0. This function returns all the lines that belongs to the customer copy.

Returns: list of key,value in ReceiptLine struct

SPILIBRARY_API ExtendedEMVStatus Modularity::SPI::AshraitEMVTransaction::GetExtendedEMVStatus ( ) const

Get the status of the transaction.

Returns: Status as enumerator.

SPILIBRARY_API AmountType Modularity::SPI::AshraitEMVTransaction::GetFirstPayment ( ) const

Get the amount of the first payment if transaction was setted as Payments. This value may be chang during transaction in order to create an equal division for the rest of the payments.

See Also: SetAsPaymentsTransaction() This value is already printd on recipt.

Returns: First payment amount

SPILIBRARY_API string Modularity::SPI::AshraitEMVTransaction::GetIsracardClubNumber ( ) const

Get Isracard club number מספר מועדון This value is for and card issued by Isracard and the brand is Isracard or PL. The value is 4 digits length club number from track2 discretionary data field position 29.

Returns: club number as string or empty string if card not detected

SPILIBRARY_API string Modularity::SPI::AshraitEMVTransaction::GetIsracardGroup ( ) const

Get the Isracard group number קבוצת שיוך

Returns: group number as string or empty string if card not detected or not belongs to Isracard group

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetIssuerAuthNum ( ) const

Manpik (issuer) authorization number if transaction went online. This value is already printd on recipt.

Returns: Issuer company authorization number as std::string

SPILIBRARY_API Ashrait::Manpik Modularity::SPI::AshraitEMVTransaction::GetManpik ( ) const

Get credit card Manpik (issuer) enumerator.

Returns: Manpik as enumerator

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetMaskedPan ( ) const

Get credit card PAN masked with 3 *'s. This value is already printd on recipt according to the copy type.

Returns: Masked credit card PAN numberas std::string

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetMaskedPanOriginalLength ( ) const

Get credit card PAN masked with *'s in it's original length. This value is already printd on recipt according to the copy type.

Returns: Masked credit card PAN numberas std::string

SPILIBRARY_API PaymentType Modularity::SPI::AshraitEMVTransaction::GetMaximumCreditPaymentsAvilible ( ) const

Get maximum of credit payments allowed in transaction after the card identified in the transaction phase 1.

Returns: the number as PaymentType

SPILIBRARY_API PaymentType Modularity::SPI::AshraitEMVTransaction::GetMaximumPaymentsAvilible ( ) const

Get maximum of payments allowed in transaction after the card identified in the transaction phase 1.

Returns: the number as PaymentType

SPILIBRARY_API std::vector<ReceiptLine> Modularity::SPI::AshraitEMVTransaction::GetMerchentRecipt ( ) const

Get a list of (key,value) AshraitEMV receipt. According to SHVA AshraitEMV documentation, receipt must be printed in pre defined order. ECR prints the list provided from this function by it's order. Each member of the vector is a line. The key member is the field name and value is the field value. e.g. key=סוג עסקה and value=חובה e.g. key=זיהוי יישום בשבב and value=A00000003010 - some EMV unformation about the transaction. Receipt exists only if WasSuccessful() is true or GetResultCode() is 0. This function returns all the lines that belongs to the merchant copy. According to SHVA not all transactions will require the customer signature and phone number, thus, if transaction requieres customer phone and signtaure last two lines will include the keys "חתימת הלקוח", "טלפון הלקוח".

Returns: list of key,value in ReceiptLine struct

Examples:: CPP_Examples.cpp.

SPILIBRARY_API AmountType Modularity::SPI::AshraitEMVTransaction::GetMinimumAmountForCreditPayment ( ) const

Get minimum amount of single payment allowed in credit transaction after the card identified in the transaction phase 1.

Returns: the number as AmountType

SPILIBRARY_API PaymentType Modularity::SPI::AshraitEMVTransaction::GetMinimumCreditPaymentsAvilible ( ) const

Get minimum of credit payments allowed in transaction after the card identified in the transaction phase 1.

Returns: the number as PaymentType

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetMiniSettelemntAckNumber ( ) const

Get the ack number from gateway when performing mini settelment.

Returns: Ack as string

SPILIBRARY_API std::vector<std::string> Modularity::SPI::AshraitEMVTransaction::GetMiniSettelemntTransactions ( ) const

Get the transactions UIDS that was settelmented to gateway during mini settelemnt.

Returns: Vector of UID's as string

SPILIBRARY_API Ashrait::MissingEventType Modularity::SPI::AshraitEMVTransaction::GetMissingEvent ( ) const

Get the type of information were missing in the transaction. Each event has it's Setter.

See Also: SetAuthorizationNumber() SetFullAddress()

Returns: Missing event as enumerator

SPILIBRARY_API Ashrait::Mutag Modularity::SPI::AshraitEMVTransaction::GetMutag ( ) const

Get credit card Mutag (brand) enumerator.

Returns: Mutag as enumerator

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetMutav ( ) const

Get the transaction mutav number used if RavMutav was used.

Returns: mutav number as string

SPILIBRARY_API PaymentType Modularity::SPI::AshraitEMVTransaction::GetNoOfPayments ( ) const

Get number of payments if transaction was setted as payments or credit.

See Also: SetAsCreditTransaction(); SetAsPaymentsTransaction() This value is already printd on recipt.

Returns: number of payments

SPILIBRARY_API AmountType Modularity::SPI::AshraitEMVTransaction::GetNotFirstPayment ( ) const

Get the amount of the rest of the payments if transaction was setted as Payments.

See Also: SetAsPaymentsTransaction() This value is already printd on recipt.

Returns: Rest of the payments amunt for each payment

SPILIBRARY_API Ashrait::PanEntryMode Modularity::SPI::AshraitEMVTransaction::GetPanEntryMode ( ) const

PAN entry mode is the way AshraitEMV got the credit card PAN. This value is already printd on recipt.

Returns: PAN entry mode as enumerator

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetPaymentAggregatorValue ( std::string Key ) const

Get payment aggreagtor value be name.

Parameters

[in] Key is the name of the values to return

Returns: value as string

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetRRN ( ) const

RRN is unique identifier number generated by transaction approver when transaction goes online. This value is already printd on recipt.

Returns: RRN as std::string

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetSettelmentRecord ( ) const

Get the transaction record when using master/slave mode.

Returns: record

SPILIBRARY_API Ashrait::Solek Modularity::SPI::AshraitEMVTransaction::GetSolek ( ) const

Get credit card Solek enumerator.

Returns: Solek as enumerator

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetSolekAuthNum ( ) const

Solek authorization number if transaction went online. This value is already printd on recipt.

Returns: Solek company authorization number as std::string

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::GetSolekInformation	(	std::string &	Name,
		std::string &	BusinessNumber,
		std::string &	PhoneNumber
	)		const

Get all the requiered information.

Parameters

[out]	Name	is Solek Name in UTF-8 Hebrew
[out]	BusinessNumber	- Company Business number
[out]	PhoneNumber	- Phone number

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetSwipeData ( ) const

Get data on card magnetic stripe track2 info. From version 1.2008 track2 of card is avililble in this method in case ResultCode eq 44 or 47.

See Also: SetAsSwipeData()

Returns: track2 as std::string

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetSystemTraceNum ( ) const

System trace number is SHVA field-11. XXYYYZZZ - XX - File Number, YYY - Terminal Number/ECR Id , ZZZ - Terminal sequence number This value is already printd on recipt.

Returns: System Trace Number

SPILIBRARY_API AmountType Modularity::SPI::AshraitEMVTransaction::GetTip ( ) const

Get tip setted with SetTip() This value is already printd on recipt.

Returns: Transaction tip

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetToken ( ) const

Get the transaction token generated in gateway.

Returns: token

SPILIBRARY_API std::string Modularity::SPI::AshraitEMVTransaction::GetTokenizedPAN ( ) const

Get credit card PAN tokenized by MD5 rfc1321.

Returns: Tokenized credit card PAN numberas std::string

SPILIBRARY_API Ashrait::TransactionType Modularity::SPI::AshraitEMVTransaction::GetTranType ( ) const

Get transaction type as enumerator. Transaction type can be changed by Ashrait during transaction. This value is already printd on recipt.

Returns: Transaction type as enumerator

SPILIBRARY_API string Modularity::SPI::AshraitEMVTransaction::GetUID ( ) const

Get transaction Uniqie IDentification number. UID is 23 len string that generated by Ashrait for every transaction wheather succeded or not. This value is already printd on recipt.

Returns: UID as std::string

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::IsCardHoderIdRequiered ( ) const

A method that tells if Card holder Id is requiered for completeing the transaction This method can be called during loyalty phase and after transaction was executed.

Returns: weather Card holder Id is requiered for transaction

See Also: SetCardHolderId()

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::IsClub ( ) const

A method that tells weather detected card is club card. This method can be called during loyalty phase and after transaction was executed.

Returns: weather detected card is club or false when card not detected

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::IsCombinedCard ( ) const

A method that tells weather detected card is combined card. This method can be called during loyalty phase and after transaction was executed.

Returns: weather detected card is combined or false when card not detected

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::IsCvvRequiered ( ) const

A method that tells if CVV is requiered for completeing the transaction This method can be called during loyalty phase and after transaction was executed.

Returns: weather CVV is requiered for transaction

See Also: SetCVV()

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::IsPrepaid ( ) const

A method that tells weather detected card is preapaid card. This method can be called during loyalty phase and after transaction was executed.

Returns: weather detected card is prepaid or false when card not detected

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetAdditionalInformation ( std::string Information )

Set stream to be sent over addendum1-settl.

Parameters

[in] Information is the stream.

Returns: None

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCancelPreAuthorization ( std::string OriginalUID )

Cancel a transaction that generated via SetAsPreAuthorization() and never completed. The original transaction must be succeded. Aka GetResultCode was 0.

Parameters

[in] OriginalUID is the Original UID of the original canceled transaction. Note: This transaction will create another UID of it's own.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCancelTransaction ( std::string OriginalUID )

Cancel a transaction that succeded. Aka GetResultCode was 0.

Parameters

[in] OriginalUID is the Original UID of the original canceled transaction. Note: This transaction will create another UID of it's own.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCardless ( )

Don't ask for a card for CancelRegisteredTransaction/ CancelPreAuth / CompletePreAuth By deafult a card will be needed unless CNP method used.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCash ( )

Set transaction as a cash transaction עסקת מזומן

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCashback ( AmountType CashbackAmount )

Set transaction as a cashback transaction עסקה עם מזומן

Parameters

[in] CashbackAmount is cashback amount. can't be bigger than constructor Amount

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsChargePrepaid	(	Ashrait::IPayType	Type,
		AmountType	UnitsAmount = `0`
	)

Set transaction as a charge prepaid transaction עסקת טעינה לכרטיסים נטענים

Parameters

[in]	Type	is Ashrait::IPayType units type for amount.
[in]	UnitsAmount	is the amount of the units to charge when Type is not money.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCNPTransaction	(	Ashrait::CardNotPresentType	Type,
		string	CardNumber,
		string	Exp,
		string	CVV,
		string	ID,
		std::string	Address,
		std::string	City,
		std::string	ZipCode
	)

Set transaction credit card deatils when no device is used.

Parameters

[in]	Type	is the CardNotPresentType of the transaction. if Internet is used, SetAsInternetTransaction must be called.
[in]	CardNumber	is a string contins card PAN.
[in]	Exp	is string for card experation date. format is YYMM e.g. card expiered in December 2018 Exp="1812"
[in]	CVV	is astring for the card CVV
[in]	ID	is cardholder ID string alphanumeric digits only
[in]	Address	is string describing cardholder address
[in]	City	is is string describing cardholder city
[in]	ZipCode	is string describing cardholder Zip code

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsCreditTransaction ( PaymentType NoOfPayments )

Set transaction with Credit credit-terms. Division is mady by SHVA.

Parameters

[in] NoOfPayments is total number of payments.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsGenerateStandingOrder	(	AmountType	TotalAmount,
		FrequencyType	Freq
	)

Generate a standing order הוראת קבע . If generation succeeded user should use data of this transaction according to SetAsSingleStandingPayment() parameters. There're 3 different API's for generating standing order. In this configuration.

Parameters

[in] Type is Ashrait::IPayType units type of the balance amount.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsGenerateStandingOrder	(	PaymentType	TotalNumberOfPayments,
		FrequencyType	Freq
	)

Generate a standing order.

Parameters

[in] Type is Ashrait::IPayType units type of the balance amount.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsGenerateStandingOrder ( FrequencyType Freq )

Generate a standing order.

Parameters

[in] Type is Ashrait::IPayType units type of the balance amount.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsImmediateCredit ( )

Set transaction with immediate credit-terms.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsInternetTransaction	(	Ashrait::ECIType	ECI,
		string	CAVVUCAF,
		string	XID,
		string	CAP_DPA
	)

Set internet transaction data.

Parameters

[in]	ECI	is ????? Ashrait::ECIType
[in]	CAVVUCAF	is string ?????
[in]	XID	is string ?????
[in]	CAP_DPA	is string ?????

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsIPayTransaction ( AmountType MoneyAmount )

Set transaction with IPay is עסקה עם הטבה

Parameters

[in] MoneyAmount is Amount of money reduced from the transaction amount.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsIPayTransaction ( PercentType Percents )

Set transaction with IPay is עסקה עם הטבה

Parameters

[in] Percents is partial amount in percents of money reduced from the transaction amount.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsIPayTransaction	(	Ashrait::IPayType	Type,
		AmountType	MoneyAmount,
		AmountType	UnitsAmount
	)

Set transaction with IPay is עסקה עם הטבה

Parameters

[in]	Type	is Ashrait::IPayType of units. יחידות הטבה
[in]	MoneyAmount	is Amount of money reduced from the transaction amount.
[in]	UnitsAmount	is Amount of units which equlas to the MoneyAmount.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsPaymentsTransaction	(	PaymentType	NoOfPayments,
		AmountType	First,
		Ashrait::PaymentLinked	Link
	)

Set transaction with payments credit-terms.

Parameters

[in]	NoOfPayments	is total number of payments.
[in]	First	is the amount of the first payment.
[in]	Link	is wheather transaction is linked to Madad or dollar or not linked. צמוד למדד או צמוד לדולר

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsPetrol	(	Ashrait::GasolineType	GasolineType,
		AmountType	GasolineLiter,
		AmountType	OilLiter,
		AmountType	OilAmount,
		AmountType	Speedometer,
		std::string	CarNumber,
		AmountType	Service
	)

Use this method if the merchent has quthorization number from credit card company.

Parameters

[in]	GasolineType	is an Enum describes type of gaseline. Can be Ashrait::GasolineType_None.
[in]	GasolineLiter	is the amount of gasoline in liter cents.
[in]	OilLiter	is the amount of oil in refueling in liter cents
[in]	OilAmount	is the price in cents of the oil.
[in]	Speedometer	is the car speedometer counter
[in]	CarNumber	as string without speical charechters
[in]	Service	fee in cents,

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsPreAuthorization ( )

Set transaction as obligo. to complete ot cancel this transaction user should keep the UID,.

See Also: CompletePreAuthorization(); SetAsCancelPreAuthorization(); GetUID()

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsRefund ( )

Set transaction as a refund transaction עסקת זיכוי

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsSelfService ( )

Set transaction a self service. This function should called when the customer is making the transaction all alone.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsSingleStandingPayment	(	std::string	OriginUID,
		PaymentType	PaymentIndex,
		std::string	SolekAuthNum,
		std::string	IssuerAuthNum,
		AmountType	Commision = `0`
	)

Set transaction as a single payment for standing order. תשלום תור"ן להוראת קבע

Parameters

[in]	OriginUID	is the Original UID of the generated standing order request from SetAsGenerateStandingOrder
[in]	PaymentIndex	is the following index number of the payment
[in]	SolekAuthNum	is the authorization number from the card's SOLEK company.
[in]	IssuerAuthNum	is the authorization number from the card's MANPIK company.
[in]	Commision	is the commision collected by the merchant, deafult value is 0 if not passed.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsSingleStandingPayment	(	std::string	OriginUID,
		AmountType	TotalAmount,
		PaymentType	PaymentIndex,
		std::string	SolekAuthNum,
		std::string	IssuerAuthNum,
		AmountType	Commision = `0`
	)

Set transaction as a single payment for standing order. תשלום תור"ן להוראת קבע

Parameters

[in]	OriginUID	is the Original UID of the generated standing order request from SetAsGenerateStandingOrder
[in]	TotalAmount	is the ???????????????
[in]	PaymentIndex	is the following index number of the payment
[in]	SolekAuthNum	is the authorization number from the card's SOLEK company.
[in]	IssuerAuthNum	is the authorization number from the card's MANPIK company.
[in]	Commision	is the commision collected by the merchant, deafult value is 0 if not passed.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsSingleStandingPayment	(	std::string	OriginUID,
		PaymentType	TotalNumberOfPayments,
		PaymentType	PaymentIndex,
		std::string	SolekAuthNum,
		std::string	IssuerAuthNum,
		AmountType	Commision = `0`
	)

Set transaction as a single payment for standing order. תשלום תור"ן להוראת קבע

Parameters

[in]	OriginUID	is the Original UID of the generated standing order request from SetAsGenerateStandingOrder
[in]	TotalNumberOfPayments	is the ???????????????????????????
[in]	PaymentIndex	is the following index number of the payment
[in]	SolekAuthNum	is the authorization number from the card's SOLEK company.
[in]	IssuerAuthNum	is the authorization number from the card's MANPIK company.
[in]	Commision	is the commision collected by the merchant, deafult value is 0 if not passed.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsSpecialCredit ( )

Set transaction with special credit-terms.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsSwipeData	(	PPIDType	DeviceId,
		std::vector< std::string >	DisplayMessages,
		TimeOutType	TimeOutSeconds
	)

Set all the requiered data when performing track2 request.

Parameters

[in]	DeviceId	is the device identification number.
[in]	DisplayMessages	is a std::vector of std::string's that will be displayed on the deivce during the request. Each line is limited to 19 characters. If Hebrew is used, must be UTF-8.
[in]	TimeOutSeconds	- Set the timout to cancel the request.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAsUnChargePrepaid ( Ashrait::IPayType Type )

Set transaction as a uncharge prepaid transaction עסקת פריקה לכרטיסים נטענים

Parameters

[in] Type is Ashrait::IPayType units type for amount.

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetAuthorizationNumber ( std::string AuthNumber )

Use this method if the merchent has quthorization number from credit card company.

Parameters

[in] AuthNumber is std::string specifing authorization number the merchent got from credit card company.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetBalaceData ( Ashrait::IPayType Type )

Set requiered information for balance transaction.

Parameters

[in] Type is Ashrait::IPayType units type of the balance amount.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetCardHolderId ( std::string CardHolderId )

Set cardholder Id's when Tran_CardHolderId.

Parameters

[in] CardHolderId as string

Returns: void

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetCustomData	(	std::string	Key,
		std::string	Value
	)

Set custom data to payment gateway.

Parameters

[in]	Key	is the name of the values to add to data set
[in]	Value	to set as string

Returns: value as string

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetCVV ( std::string CVV )

Set cvv when Tran_CVV.

Parameters

[in] CVV as string

Returns: void

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetDeferMonths ( MonthType Months )

Set defer months to transaction in months.

Parameters

[in] Months is amount of months to defer the transaction

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetDisplayLanguage ( SPILanguage Language )

Set the display language on a pinpad during the transaction. Supported only in remoted Ashrait.

Parameters

[in] Language is a enum describing the language: [Hebrew,English]. If not called Hebrew is default.

Returns: None

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetDueDate ( std::string DueDateYYMMDD )

Set defer months to transaction in months.

Parameters

[in] DueDateYYMMDD is a string describing the transaction due date. e.g. DueDateYYMMDD="180131" for 31-January-2018

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetForeignCurrency	(	CurrencyISOType	ISOCode,
		AmountType	ConversionAmount,
		RateType	ChangeRate
	)

Set transaction with foreign currency.

Parameters

[in]	ISOCode	is a string describing the the currency by it's ISO code. e.g. "987"
[in]	ConversionAmount	is Amount in NIS before converting.
[in]	ChangeRate	is the change rtar in presistance of exactly 4 digits after the decimal point. e.g. 1 EUR = 4.21 NIS => ChangeRate = 42100 , 1 SEK = 0.414 ILS => ChangeRate = 4140 1 GBP = 6 NIS => CahngeRate = 60000

Returns: SPI_RET_VAL SPI_SUCESS on sucess SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetFullAddress	(	std::string	Address,
		std::string	City,
		std::string	ZipCode
	)

Set credit card holder address detailes.

Parameters

[in]	Address	is std::string specifing street name, and number.
[in]	City	is std::string specifing the city.
[in]	ZipCode	is std::string specifing ZIP code.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetIsracardGift	(	std::string	OfferCode,
		std::string	GiftNumber
	)

Set a gift from Isracard.

Parameters

[in]	OfferCode	is ???????
[in]	GiftNumber	is ??????

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetLoyaltyAmount ( AmountType Amount )

Change the transaction amount post transaction phase1.

Parameters

[in] Amount is the new amount of money.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetMSRData ( std::string Data )

Use unsupprted pinpad interface to do MSR transactions.

Parameters

[in] Data is a string describing track2 data.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetMutav ( std::string Mutav )

Set mutav number for Rav-Mutav. Can be called either before DoTransactionPhase1 or DoTransactionPhase2.

Parameters

[in] Mutav as string

Returns: void

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetOfferCode ( std::string OfferCode )

Use an agreed offer.

Parameters

[in] OfferCode is the code credit card company.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetPaymentAggregatorValue	(	std::string	Key,
		std::string	Value
	)

set payment aggreagtor value be name

Parameters

[in]	Key	is the name of the values to set
[in]	Value	to set as string

Returns: value as string

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetSettelmentRecord	(	string	Record,
		string	UID
	)

Setelment transaction in Mastermode.

Parameters

[in]	Record	is a transaction record from a slave
[in]	UID	is a transaction record from a slave

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetSubRetailer ( std::string SubRetailer )

Set SubRetailer when working in RavSapak Mode.

Parameters

[in] SubRetailer as string

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetSystemTrace ( std::string SystemTrace )

Set System Trace Number when working as Slave.

Parameters

[in] SystemTrace is the trace from SPI Master

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetTip ( AmountType TipAmount )

Tip as part of the Transaction Amount.

Parameters

[in] TipAmount is partial amount which is tip

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetToForceOfflineApproval ( )

Set transaction to be approved offline. This option is on the merchent responsibility.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetToForceOnlineAuthorization ( )

Set transaction to go online to SHVA.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API void Modularity::SPI::AshraitEMVTransaction::SetZData ( UnsignedNumericType ZData )

Set ZData. This is AshraitEMV n8 field that passed as is to Shva.

Parameters

[in] SubRetailer as string

SPILIBRARY_API SPI_RET_VAL Modularity::SPI::AshraitEMVTransaction::SetZipCode ( std::string ZipCode )

Set credit card holder ZIP code address.

Parameters

[in] ZipCode is std::string specifing ZIP code.

Returns: SPI_SUCESS on sucess, SPI_FAIL on fail

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::WasPhase1 ( ) const

A method that tells post transaction weather there was already phase 1 of the transaction.

Returns: weather transaction passed phase 1

SPILIBRARY_API bool Modularity::SPI::AshraitEMVTransaction::WasSuccessful ( ) const

A method that tells post transaction weather transaction succeded or not.

Returns: weather transaction succeded or not

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

AshraitEMVTransaction.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation