13 #ifndef __ASHRAITEMVTRANSACTION_H__ 14 #define __ASHRAITEMVTRANSACTION_H__ 108 SPILIBRARY_API
void SetCVV(std::string CVV);
452 SPILIBRARY_API
void SetCustomData(std::string Key, std::string Value);
472 SPILIBRARY_API
void SetMutav(std::string Mutav);
638 SPILIBRARY_API
void GetSolekInformation(std::string &Name, std::string &BusinessNumber, std::string &PhoneNumber)
const;
645 SPILIBRARY_API
bool IsClub()
const;
759 SPILIBRARY_API
string GetUID ()
const;
837 SPILIBRARY_API std::string
GetRRN ()
const;
927 SPILIBRARY_API
void GetBalanceInformation (std::string & OutputBalance,
boolean & MustPrint,
boolean & MustShow)
const;
948 SPILIBRARY_API std::string
GetToken()
const;
974 SPILIBRARY_API std::string
GetMutav()
const;
SPILIBRARY_API SPI_RET_VAL SetAsSpecialCredit()
Set transaction with special credit-terms.
SPILIBRARY_API SPI_RET_VAL SetSettelmentRecord(string Record, string UID)
Setelment transaction in Mastermode.
SPILIBRARY_API SPI_RET_VAL SetAsCreditTransaction(PaymentType NoOfPayments)
Set transaction with Credit credit-terms. Division is mady by SHVA.
SPILIBRARY_API std::string GetSettelmentRecord() const
Get the transaction record when using master/slave mode.
SPILIBRARY_API void SetMutav(std::string Mutav)
Set mutav number for Rav-Mutav. Can be called either before DoTransactionPhase1 or DoTransactionPhase...
SPILIBRARY_API SPI_RET_VAL SetMSRData(std::string Data)
Use unsupprted pinpad interface to do MSR transactions.
SPILIBRARY_API SPI_RET_VAL SetBalaceData(Ashrait::IPayType Type)
Set requiered information for balance transaction.
SPILIBRARY_API void SetSubRetailer(std::string SubRetailer)
Set SubRetailer when working in RavSapak Mode.
SPILIBRARY_API SPI_RET_VAL SetAsCardless()
Don't ask for a card for CancelRegisteredTransaction/ CancelPreAuth / CompletePreAuth By deafult a ca...
SPILIBRARY_API SPI_RET_VAL SetAsChargePrepaid(Ashrait::IPayType Type, AmountType UnitsAmount=0)
Set transaction as a charge prepaid transaction עסקת טעינה לכרטיסים נטענים
SPILIBRARY_API SPI_RET_VAL SetAsCashback(AmountType CashbackAmount)
Set transaction as a cashback transaction עסקה עם מזומן
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 bool IsCombinedCard() const
A method that tells weather detected card is combined card. This method can be called during loyalty ...
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 std::string GetSystemTraceNum() const
System trace number is SHVA field-11. XXYYYZZZ - XX - File Number, YYY - Terminal Number/ECR Id ...
This namespace contains avilible API from Modularity Inc.
SPILIBRARY_API SPI_RET_VAL SetLoyaltyAmount(AmountType Amount)
Change the transaction amount post transaction phase1.
SPILIBRARY_API Ashrait::AuthCodeIssuer GetAuthCodeIssuer() const
Manpik (issuer) authorization number if transaction went online. This value is already printd on reci...
SPILIBRARY_API SPI_RET_VAL SetToForceOfflineApproval()
Set transaction to be approved offline. This option is on the merchent responsibility.
SPILIBRARY_API AmountType GetTip() const
Get tip setted with SetTip() This value is already printd on recipt.
SPILIBRARY_API string GetIsracardGroup() const
Get the Isracard group number קבוצת שיוך
SPILIBRARY_API SPI_RET_VAL SetToForceOnlineAuthorization()
Set transaction to go online to SHVA.
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 std::string GetCompanyBussinessNumber() const
Get company bussiness number. This value is already printd on recipt.
SPILIBRARY_API void SetDisplayLanguage(SPILanguage Language)
Set the display language on a pinpad during the transaction. Supported only in remoted Ashrait...
SPILIBRARY_API SPI_RET_VAL SetOfferCode(std::string OfferCode)
Use an agreed offer.
SPILIBRARY_API bool IsPrepaid() const
A method that tells weather detected card is preapaid card. This method can be called during loyalty ...
SPILIBRARY_API SPI_RET_VAL SetFullAddress(std::string Address, std::string City, std::string ZipCode)
Set credit card holder address detailes.
SPILIBRARY_API Ashrait::MissingEventType GetMissingEvent() const
Get the type of information were missing in the transaction. Each event has it's Setter.
SPILIBRARY_API SPI_RET_VAL SetAsGenerateStandingOrder(AmountType TotalAmount, FrequencyType Freq)
Generate a standing order הוראת קבע . If generation succeeded user should use data of this transactio...
SPILIBRARY_API void SetAsPetrol()
Use this method to set transaction as petrol transaction.
SPILIBRARY_API std::vector< std::string > GetMiniSettelemntTransactions() const
Get the transactions UIDS that was settelmented to gateway during mini settelemnt.
SPILIBRARY_API std::string GetCardExpiryDate() const
Get card expiry date in format YYMM.
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 std::string GetToken() const
Get the transaction token generated in gateway.
SPILIBRARY_API SPI_RET_VAL SetZipCode(std::string ZipCode)
Set credit card holder ZIP code address.
SPILIBRARY_API AshraitEMVTransaction(AmountType Amount, string VendorUID, CurrencyType Currency)
Class constructor. When this constructor is called the transaction can be decrotated as: ...
SPILIBRARY_API PaymentType GetMinimumCreditPaymentsAvilible() const
Get minimum of credit payments allowed in transaction after the card identified in the transaction ph...
SPILIBRARY_API std::string GetIssuerAuthNum() const
Manpik (issuer) authorization number if transaction went online. This value is already printd on reci...
SPILIBRARY_API SPI_RET_VAL SetAsIPayTransaction(AmountType MoneyAmount)
Set transaction with IPay is עסקה עם הטבה
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.
SPILIBRARY_API void SetServiceAmount(AmountType ServiceAmount)
Use this method to set the service fee as part of the total amount in petrol transaction.
A struct that reprensts information about sub retailer in RavSapak mode.
SPILIBRARY_API string GetIsracardClubNumber() const
Get Isracard club number מספר מועדון This value is for and card issued by Isracard and the brand is I...
SPILIBRARY_API AmountType GetNotFirstPayment() const
Get the amount of the rest of the payments if transaction was setted as Payments. ...
SPILIBRARY_API SPI_RET_VAL SetTip(AmountType TipAmount)
Tip as part of the Transaction Amount.
SPILIBRARY_API SPI_RET_VAL SetAsRefund()
Set transaction as a refund transaction עסקת זיכוי
SPILIBRARY_API ExtendedEMVStatus GetExtendedEMVStatus() const
Get the status of the transaction.
SPILIBRARY_API SPI_RET_VAL SetAsSelfService()
Set transaction a self service. This function should called when the customer is making the transacti...
SPILIBRARY_API void SetCVV(std::string CVV)
Set cvv when Tran_CVV.
SPILIBRARY_API SPI_RET_VAL SetAsPreAuthorization()
Set transaction as obligo. to complete ot cancel this transaction user should keep the UID...
SPILIBRARY_API void SetOfflineMode()
Offline mode to prevent online authorization in case needed.
SPILIBRARY_API AmountType GetFirstPayment() const
Get the amount of the first payment if transaction was setted as Payments. This value may be chang du...
SPILIBRARY_API std::string GetPaymentAggregatorValue(std::string Key) const
Get payment aggreagtor value be name.
SPILIBRARY_API PaymentType GetMaximumCreditPaymentsAvilible() const
Get maximum of credit payments allowed in transaction after the card identified in the transaction ph...
SPILIBRARY_API void SetAdditionalInformation(std::string Information)
Set stream to be sent over addendum1-settl.
SPILIBRARY_API string GetUID() const
Get transaction Uniqie IDentification number. UID is 23 len string that generated by Ashrait for ever...
SPILIBRARY_API std::string GetMiniSettelmentCommStat() const
Get statistics times regarding mini settlement comm times. Data is retunrd in json object with the fo...
SPILIBRARY_API bool WasSuccessful() const
A method that tells post transaction weather transaction succeded or not.
SPILIBRARY_API SPI_RET_VAL SetDueDate(std::string DueDateYYMMDD)
Set defer months to transaction in months.
SPILIBRARY_API std::string GetCardName() const
Get card name (VISA, MasterCard, etc..) Name can be also in Hebrew (UTF-8)
SPILIBRARY_API PaymentType GetNoOfPayments() const
Get number of payments if transaction was setted as payments or credit.
SPILIBRARY_API Ashrait::Mutag GetMutag() const
Get credit card Mutag (brand) enumerator.
SPILIBRARY_API std::string GetMiniSettelemntAckNumber() const
Get the ack number from gateway when performing mini settelment.
SPILIBRARY_API void SetZData(UnsignedNumericType ZData)
Set ZData. This is AshraitEMV n8 field that passed as is to Shva.
SPILIBRARY_API Ashrait::Solek GetSolek() const
Get credit card Solek enumerator.
SPILIBRARY_API SPI_RET_VAL CompletePreAuthorization(std::string UID)
Complete an obligo transaction created with SetAsPreAuthorization(). The Amount in the constructor sh...
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 bool IsCvvRequiered() const
A method that tells if CVV is requiered for completeing the transaction This method can be called dur...
SPILIBRARY_API SPI_RET_VAL SetSystemTrace(std::string SystemTrace)
Set System Trace Number when working as Slave.
SPILIBRARY_API SPI_RET_VAL SetAsCancelTransaction(std::string OriginalUID)
Cancel a transaction that succeded. Aka GetResultCode was 0.
SPILIBRARY_API bool IsPendingAuthorization() const
Is transaction waiting to authorization.
SPILIBRARY_API void GetSolekInformation(std::string &Name, std::string &BusinessNumber, std::string &PhoneNumber) const
Get all the requiered information.
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 bu...
SPILIBRARY_API void SetCardHolderId(std::string CardHolderId)
Set cardholder Id's when Tran_CardHolderId.
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 a...
SPILIBRARY_API std::string GetAuthorizationCommStat() const
Get statistics times regarding authorization comm times. Data is retunrd in json object with the foll...
SPILIBRARY_API SPI_RET_VAL SetAsCash()
Set transaction as a cash transaction עסקת מזומן
SPILIBRARY_API SPI_RET_VAL SetAsUnChargePrepaid(Ashrait::IPayType Type)
Set transaction as a uncharge prepaid transaction עסקת פריקה לכרטיסים נטענים
SPILIBRARY_API AmountType GetMinimumAmountForCreditPayment() const
Get minimum amount of single payment allowed in credit transaction after the card identified in the t...
SPILIBRARY_API void SetCustomData(std::string Key, std::string Value)
Set custom data to payment gateway.
SPILIBRARY_API SPI_RET_VAL SetAsImmediateCredit()
Set transaction with immediate credit-terms.
SPILIBRARY_API SPI_RET_VAL SetAsPaymentsTransaction(PaymentType NoOfPayments, AmountType First, Ashrait::PaymentLinked Link)
Set transaction with payments credit-terms.
SPILIBRARY_API std::string GetSolekAuthNum() const
Solek authorization number if transaction went online. This value is already printd on recipt...
SPILIBRARY_API SPI_RET_VAL SetDeferMonths(MonthType Months)
Set defer months to transaction in months.
SPILIBRARY_API bool IsCardHoderIdRequiered() const
A method that tells if Card holder Id is requiered for completeing the transaction This method can be...
SPILIBRARY_API PaymentType GetMaximumPaymentsAvilible() const
Get maximum of payments allowed in transaction after the card identified in the transaction phase 1...
SPILIBRARY_API bool IsClub() const
A method that tells weather detected card is club card. This method can be called during loyalty phas...
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 t...
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 "חתימת הלקוח", "טלפון הלקוח".
This file conatins all defenitions which are used in SPI API.
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 std::string GetRRN() const
RRN is unique identifier number generated by transaction approver when transaction goes online...
SPILIBRARY_API AmountType GetAuthorizedAmount() const
Get the authorized amount for petrol transaction.
SPILIBRARY_API std::string GetSubRetailer() const
A method that returns the sub retailer in case of RAV SAPAK. This can be either automated split subre...
This class contains all the input data and output data of Transactions. Those methods are common to a...
SPILIBRARY_API void SetPaymentAggregatorValue(std::string Key, std::string Value)
set payment aggreagtor value be name
APIHandle GetAshEMVHandle() const
Handle get - reserved for internal useage.
SPILIBRARY_API SPI_RET_VAL SetForeignCurrency(CurrencyISOType ISOCode, AmountType ConversionAmount, RateType ChangeRate)
Set transaction with foreign currency.
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...
uint32_t UnsignedNumericType
SPILIBRARY_API ~AshraitEMVTransaction()
Class desrstructor
SPILIBRARY_API string GetClubNumber() const
Get the club number מספר מועדון
This class contains all the operations of the Payment Interface, Creation and Services management...
SPILIBRARY_API SPI_RET_VAL SetAuthorizationNumber(std::string AuthNumber)
Use this method if the merchent has quthorization number from credit card company.
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 std::string GetTokenizedPAN() const
Get credit card PAN tokenized by MD5 rfc1321.
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. תשלום תור"ן להוראת קבע
This file conatins all requiered methods for abstract SPI Transaction.
SPILIBRARY_API SPI_RET_VAL SetAsInternetTransaction(Ashrait::ECIType ECI, string CAVVUCAF, string XID, string CAP_DPA)
Set internet transaction data.
SPILIBRARY_API std::string GetMutav() const
Get the transaction mutav number used if RavMutav was used.
SPILIBRARY_API bool WasPhase1() const
A method that tells post transaction weather there was already phase 1 of the transaction.
SPILIBRARY_API UnsignedNumericType GetTranKinds() const
The kinds of transaction records exist when getting transaction with RetrieveTransaction by UID or em...
SPILIBRARY_API Ashrait::Manpik GetManpik() const
Get credit card Manpik (issuer) enumerator.
SPILIBRARY_API SPI_RET_VAL SetIsracardGift(std::string OfferCode, std::string GiftNumber)
Set a gift from Isracard.
SPILIBRARY_API Ashrait::TransactionType GetTranType() const
Get transaction type as enumerator. Transaction type can be changed by Ashrait during transaction...