TSYSGiftCard Class
Properties Methods Events Config Settings Errors
The TSYSGiftCard class is used to manipulate funds on Gift and Prepaid Cards using the Vital/TSYS payment system. This class supports card-present gift card transactions, and allows for simple, direct, secure communication to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand- alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
Syntax
TSYSGiftCard
Remarks
This class supports two different kinds of Stored Value cards. Gift Cards and Prepaid Cards. Gift Cards support only the Fifth/Third and Stored Value Systems (SVS) ReceivingInstitutions, and a merchant must have software (such as this class) to authorize gift card Purchase (redemption) transactions. On the other hand, Prepaid cards (once activated) authorize exactly like credit cards, and can be used at any store. Examples of gift and cards include a retailer's gift card, a prepaid telephone card, and a reloadable subway pass. Examples of prepaid cards would be the prepaid cards purchased at shopping malls, or sometimes given away as promotional gimmicks. Not included in either of these are government income-support cards, otherwise known as EBT cards or electronic food stamps. (Use the TSYSBenefit class for EBT cards).
The TSYSGiftCard class makes these transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:
First, set the merchant properties with setup information acquired from your member bank or processor. For instance:
TSYSGiftCard1.MerchantBankId = "999995"
TSYSGiftCard1.MerchantNumber = "888000002447"
TSYSGiftCard1.MerchantName = "TEST_MERCHANT"
TSYSGiftCard1.MerchantTerminalNumber = "1515"
TSYSGiftCard1.MerchantStoreNumber = "5999"
TSYSGiftCard1.MerchantCategoryCode = "5999"
TSYSGiftCard1.MerchantCity = "Durham"
TSYSGiftCard1.MerchantState = "NC"
TSYSGiftCard1.MerchantZip = "27713"
TSYSGiftCard1.MerchantTimeZone = "705"
TSYSGiftCard1.MerchantABANumber = "123456789"
TSYSGiftCard1.MerchantSettlementAgent = "V123"
TSYSGiftCard1.AgentBankNumber = "000000"
TSYSGiftCard1.AgentChainNumber = "111111"
TSYSGiftCard1.IndustryType = itRetail
TSYSGiftCard1.ReceivingInstitution = riFifthThird
Next, set properties that contain details about the transaction. The TransactionNumber is a sequence number, and should be incremented for each transaction you send. TransactionAmount is the amount of sale, plus any CashBackAmount returned to the customer, formatted with an implicit decimal place (CashBackAmount is only applicable to the ttGiftCardPurchase TransactionType). The CardMagneticStripe data for Prepaid cards can be either track1 or track2, but Gift cards support only the dsTrack2 CardEntryDataSource. Both types support manual entry via the CardNumber, CardExpMonth, and CardExpYear properties.
In addition, you are also be required to set an EmployeeId and BatchNumber for Gift Card transactions. (These are ignored for Prepaid transactions). Even though Gift Card transactions are not submitted for settlement, the BatchNumber should reflect the batch sequence number of the current batch. The EmployeeId is a unique number used to identify the employee operating the terminal being used to issue gift cards. For example:
TSYSGiftCard1.TransactionNumber = 1
TSYSGiftCard1.BatchNumber = 123
TSYSGiftCard1.EmployeeId = "12345678"
TSYSGiftCard1.TransactionAmount = "1000"
TSYSGiftCard1.CashBackAmount = "300"
TSYSGiftCard1.CardTrack2Data = "9999999800002773=09121015432112345678"
The TSYSGiftCard class supports both Gift Card and Prepaid Cards, so you should make sure to choose the correct TransactionType for the type of card you are using. Then call the Authorize method to submit the transaction.
TSYSGiftCard1.TransactionType = ttGiftCardPurchase
TSYSGiftCard1.Authorize()
When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved, and the remaining properties provide additional information about the transaction.
Note that Gift Card and Prepaid Card transactions, with the exception of the ttPrepaidCardPurchase TransactionType are real-time transactions, and cannot be settled with the TSYSSettle class. ttPrepaidCardPurchase is identical to a credit card purchase made with the TSYSRetail class, so it must be settled with the TSYSSettle class. However, using this class to authorize Prepaid card transactions allows you to retrieve balance information and allow partial authorizations.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AgentBankNumber | Identifies a specific agent entity of the member bank or processor. |
AgentChainNumber | Identifies a specific chain of an agent organization. |
BatchNumber | The batch number that this transaction will be included in. |
CardType | Type of credit card being used in this transaction. |
CardCVVData | Three digit security code on back of card (optional). |
CardCVVPresence | Indicates the presence of the card verification value. |
CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in Number . |
CardExpYear | Expiration year of the credit card specified in Number . |
CardIsEncrypted | Determines whether data set to the Number or MagneticStripe properties is validated. |
CardMagneticStripe | Track data read off of the card's magnetic stripe. |
CardNumber | Customer's credit card number for the transaction. |
CashBackAmount | Amount returned to the customer in cash. |
CustomerAddress | The customer's billing address. |
CustomerZip | Customer's zip code (or postal code if outside of the USA). |
EmployeeId | Identification number of the Employee making this transaction. |
IndustryType | Code which indicates the industry the merchant is engaged in. |
MerchantBankId | The number which identifies the merchant's bank or processor. |
MerchantCategoryCode | Classifies a merchant by the type of store. |
MerchantCity | Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. |
MerchantCountryCode | Identifies the country where the merchant is located. |
MerchantCurrencyCode | Identifies the type of currency used by the merchant. |
MerchantLanguage | Designates the language that response messages will be returned in. |
MerchantName | Name of the merchant. |
MerchantNumber | A unique number used to identify the merchant within the VisaNet system. |
MerchantPhone | Merchant's phone number. |
MerchantServicePhone | Merchant's customer service number. |
MerchantState | State or province that the merchant is located in. |
MerchantStoreNumber | Used to identify a specific merchant's store within the VisaNet system. |
MerchantStreetAddress | Merchant's street address. |
MerchantTerminalNumber | Used to identify a unique terminal within a merchant location. |
MerchantTimeZone | Specifies the GMT offset used to calculate the local time within the VisaNet system. |
MerchantZip | Zip code where the merchant that initiated this transaction is located. |
MerchantABANumber | Merchant's routing number. |
MerchantSettlementAgent | Merchant's settling agent. |
OriginalPurchaseDate | Date and time of original purchase, used for returns. |
PartialRedemption | Partial Redemption indicator. |
ReceivingInstitution | Indicates which gift card network to use. |
ResponseApprovalCode | Contains an authorization code when a transaction has been approved. |
ResponseAuthorizedAmount | Amount actually used from the card (used when supporting partial redemptions). |
ResponseAuthSource | Indicates the source of the authorization code stored in ApprovalCode . |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseBalance | Available balance remaining on card. |
ResponseCode | Indicates the status of the authorization request. |
ResponseCVVResult | Contains the returned CVV result code if it was requested. |
ResponseHostMessageId | Unique host message identifier (Reserved for future use). |
ResponseNetworkId | Identification code of the network on which the transaction was authorized. |
ResponseRetrievalNumber | This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement. |
ResponseReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
ResponseSettleDate | Date at which the Debit, EBT, or Gift Card transaction will settle. |
ResponseText | Text information that describes each response code. |
ResponseTrace | System Trace Audit Number returned for Debit transactions. |
ResponseTransactionDate | Local transaction date returned from the server in MMddyy format. |
ResponseTransactionId | Contains the Transaction Identifier or MasterCard Reference Number. |
ResponseTransactionNumber | Check this property against the original Transaction Number. |
ResponseTransactionTime | Local transaction time returned from the server in HHmmss format. |
ResponseValidationCode | This optional property contains information generated by the card issuer. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | A timeout for the class. |
TransactionAmount | Purchase amount to be authorized. |
TransactionNumber | Sequence number of this transaction. |
TransactionType | Specifies the type of Gift Card transaction to process. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Authorize | Sends a Gift Card transaction. |
Config | Sets or retrieves a configuration setting. |
GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
Interrupt | Interrupts the current action. |
Reset | Clears all properties to their default values. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Disconnected | Fired when a connection is closed. |
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ActivateTerminal | Authenticates a POS device with TSYS. |
AuthenticationCode | An alphanumeric code provided to the POS user for input when authenticating a POS device. |
AuthorizationIndicator | The type of authorization request. |
CardholderId | Specifies the method used to verify the identity of the cardholder. |
DeactivateTerminal | Deactivates a POS device with TSYS. |
GatewayID | A unique value to identify a Gateway or Aggregator. |
GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
Port | The port to which transactions are posted. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
ResponseCardholderVerification | Verification results for cardholder identification data (extended AVS). |
ResponseStoreNumber | Check this field against the original Merchant StoreNumber. |
ResponseTerminalNumber | Check this field against the original Merchant TerminalNumber. |
Retry | Set this to retry a failed transaction. |
SendExtendedAVS | Specifies whether to send extended AVS data. |
Server | The server to which transactions are posted. |
TsysETB | The Encryption Transmission Block TSYS uses to decrypt encrypted data. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AgentBankNumber Property (TSYSGiftCard Class)
Identifies a specific agent entity of the member bank or processor.
Syntax
ANSI (Cross Platform) char* GetAgentBankNumber();
int SetAgentBankNumber(const char* lpszAgentBankNumber); Unicode (Windows) LPWSTR GetAgentBankNumber();
INT SetAgentBankNumber(LPCWSTR lpszAgentBankNumber);
char* dpaymentssdk_tsysgiftcard_getagentbanknumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setagentbanknumber(void* lpObj, const char* lpszAgentBankNumber);
QString GetAgentBankNumber();
int SetAgentBankNumber(QString qsAgentBankNumber);
Default Value
"000000"
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.
Data Type
String
AgentChainNumber Property (TSYSGiftCard Class)
Identifies a specific chain of an agent organization.
Syntax
ANSI (Cross Platform) char* GetAgentChainNumber();
int SetAgentChainNumber(const char* lpszAgentChainNumber); Unicode (Windows) LPWSTR GetAgentChainNumber();
INT SetAgentChainNumber(LPCWSTR lpszAgentChainNumber);
char* dpaymentssdk_tsysgiftcard_getagentchainnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setagentchainnumber(void* lpObj, const char* lpszAgentChainNumber);
QString GetAgentChainNumber();
int SetAgentChainNumber(QString qsAgentChainNumber);
Default Value
"000000"
Remarks
This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.
Data Type
String
BatchNumber Property (TSYSGiftCard Class)
The batch number that this transaction will be included in.
Syntax
ANSI (Cross Platform) int GetBatchNumber();
int SetBatchNumber(int iBatchNumber); Unicode (Windows) INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);
int dpaymentssdk_tsysgiftcard_getbatchnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setbatchnumber(void* lpObj, int iBatchNumber);
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);
Default Value
1
Remarks
Unlike regular credit card transactions, Debit, EBT, and GiftCard transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSSettle class's BatchNumber property. The range is from 1 to 999.
Note, this property is ignored for Prepaid Card transactions.
Data Type
Integer
CardType Property (TSYSGiftCard Class)
Type of credit card being used in this transaction.
Syntax
ANSI (Cross Platform) int GetCardType();
int SetCardType(int iCardType); Unicode (Windows) INT GetCardType();
INT SetCardType(INT iCardType);
Possible Values
CT_UNKNOWN(0),
CT_VISA(1),
CT_MASTER_CARD(2),
CT_AMEX(3),
CT_DISCOVER(4),
CT_DINERS(5),
CT_JCB(6),
CT_VISA_ELECTRON(7),
CT_MAESTRO(8),
CT_LASER(10)
int dpaymentssdk_tsysgiftcard_getcardtype(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardtype(void* lpObj, int iCardType);
int GetCardType();
int SetCardType(int iCardType);
Default Value
0
Remarks
Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.
ctUnknown (0) | Invalid or unknown prefix, card type not known. |
ctVisa (1) | Visa or Delta Card. |
ctMasterCard (2) | MasterCard. |
ctAMEX (3) | American Express Card. |
ctDiscover (4) | Discover Card. |
ctDiners (5) | Diners Club or Carte Blanche Card. |
ctJCB (6) | JCB Card. |
ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
ctMaestro (8) | Maestro Card |
ctLaser (10) | Laser Card (Ireland) |
This property is not available at design time.
Data Type
Integer
CardCVVData Property (TSYSGiftCard Class)
Three digit security code on back of card (optional).
Syntax
ANSI (Cross Platform) char* GetCardCVVData();
int SetCardCVVData(const char* lpszCardCVVData); Unicode (Windows) LPWSTR GetCardCVVData();
INT SetCardCVVData(LPCWSTR lpszCardCVVData);
char* dpaymentssdk_tsysgiftcard_getcardcvvdata(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);
QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);
Default Value
""
Remarks
Three digit security code on back of card (optional).
This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.
Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.
Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.
This property is not available at design time.
Data Type
String
CardCVVPresence Property (TSYSGiftCard Class)
Indicates the presence of the card verification value.
Syntax
ANSI (Cross Platform) int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence); Unicode (Windows) INT GetCardCVVPresence();
INT SetCardCVVPresence(INT iCardCVVPresence);
Possible Values
CVP_NOT_PROVIDED(0),
CVP_PROVIDED(1),
CVP_ILLEGIBLE(2),
CVP_NOT_ON_CARD(3)
int dpaymentssdk_tsysgiftcard_getcardcvvpresence(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardcvvpresence(void* lpObj, int iCardCVVPresence);
int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);
Default Value
0
Remarks
Indicates the presence of the card verification value.
This property is used to indicate the presence of CardCVVData.
The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
This property is not available at design time.
Data Type
Integer
CardEntryDataSource Property (TSYSGiftCard Class)
This property contains a 1-character code identifying the source of the customer data.
Syntax
ANSI (Cross Platform) int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource); Unicode (Windows) INT GetCardEntryDataSource();
INT SetCardEntryDataSource(INT iCardEntryDataSource);
Possible Values
EDS_TRACK_1(0),
EDS_TRACK_2(1),
EDS_MANUAL_ENTRY_TRACK_1CAPABLE(2),
EDS_MANUAL_ENTRY_TRACK_2CAPABLE(3),
EDS_MANUAL_ENTRY_NO_CARD_READER(4),
EDS_TRACK_1CONTACTLESS(5),
EDS_TRACK_2CONTACTLESS(6),
EDS_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7),
EDS_IVR(8),
EDS_KIOSK(9)
int dpaymentssdk_tsysgiftcard_getcardentrydatasource(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);
int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);
Default Value
0
Remarks
This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.
edsTrack1 (0) | Full Magnetic stripe read and transmit, Track 1. |
edsTrack2 (1) | Full magnetic stripe read and transmit, Track 2. |
edsManualEntryTrack1Capable (2) | Manually keyed, Track 1 capable. |
edsManualEntryTrack2Capable (3) | Manually keyed, Track 2 capable. |
edsManualEntryNoCardReader (4) | Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions). |
edsTrack1Contactless (5) | Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsTrack2Contactless (6) | Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsManualEntryContactlessCapable (7) | Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only). |
edsIVR (8) | Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (CardNumber, CardExpMonth, and CardExpYear are sent). |
edsKiosk (9) | Automated kiosk transaction. Track1 or Track2 data must be sent in CardMagneticStripe, the transaction cannot be manually entered. |
Below is a list of processors and their support EntryDataSource values:
FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk
FDMSOmaha - All EntryDataSources applicable
FDMS Rapid Connect - All EntryDataSources applicable
Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk
PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable
TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable
TSYSHC - Values are based on Industry type.
TSYSHCBenefit | edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable |
TSYSHCECommerce | edsManualEntryNoCardReader |
TSYSHCRetail | edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable |
This property is not available at design time.
Data Type
Integer
CardExpMonth Property (TSYSGiftCard Class)
Expiration month of the credit card specified in Number .
Syntax
ANSI (Cross Platform) int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth); Unicode (Windows) INT GetCardExpMonth();
INT SetCardExpMonth(INT iCardExpMonth);
int dpaymentssdk_tsysgiftcard_getcardexpmonth(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardexpmonth(void* lpObj, int iCardExpMonth);
int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);
Default Value
1
Remarks
Expiration month of the credit card specified in CardNumber.
This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
This property is not available at design time.
Data Type
Integer
CardExpYear Property (TSYSGiftCard Class)
Expiration year of the credit card specified in Number .
Syntax
ANSI (Cross Platform) int GetCardExpYear();
int SetCardExpYear(int iCardExpYear); Unicode (Windows) INT GetCardExpYear();
INT SetCardExpYear(INT iCardExpYear);
int dpaymentssdk_tsysgiftcard_getcardexpyear(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardexpyear(void* lpObj, int iCardExpYear);
int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);
Default Value
2000
Remarks
Expiration year of the credit card specified in CardNumber.
This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
This property is not available at design time.
Data Type
Integer
CardIsEncrypted Property (TSYSGiftCard Class)
Determines whether data set to the Number or MagneticStripe properties is validated.
Syntax
ANSI (Cross Platform) int GetCardIsEncrypted();
int SetCardIsEncrypted(int bCardIsEncrypted); Unicode (Windows) BOOL GetCardIsEncrypted();
INT SetCardIsEncrypted(BOOL bCardIsEncrypted);
int dpaymentssdk_tsysgiftcard_getcardisencrypted(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardisencrypted(void* lpObj, int bCardIsEncrypted);
bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);
Default Value
FALSE
Remarks
Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.
By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.
This property is not available at design time.
Data Type
Boolean
CardMagneticStripe Property (TSYSGiftCard Class)
Track data read off of the card's magnetic stripe.
Syntax
ANSI (Cross Platform) char* GetCardMagneticStripe();
int SetCardMagneticStripe(const char* lpszCardMagneticStripe); Unicode (Windows) LPWSTR GetCardMagneticStripe();
INT SetCardMagneticStripe(LPCWSTR lpszCardMagneticStripe);
char* dpaymentssdk_tsysgiftcard_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);
QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);
Default Value
""
Remarks
Track data read off of the card's magnetic stripe.
If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.
The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1
or
class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2
Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.
This property is not available at design time.
Data Type
String
CardNumber Property (TSYSGiftCard Class)
Customer's credit card number for the transaction.
Syntax
ANSI (Cross Platform) char* GetCardNumber();
int SetCardNumber(const char* lpszCardNumber); Unicode (Windows) LPWSTR GetCardNumber();
INT SetCardNumber(LPCWSTR lpszCardNumber);
char* dpaymentssdk_tsysgiftcard_getcardnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardnumber(void* lpObj, const char* lpszCardNumber);
QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);
Default Value
""
Remarks
Customer's credit card number for the transaction.
If you're sending the transaction with CardMagneticStripe data, this property should be left empty.
This property is not available at design time.
Data Type
String
CashBackAmount Property (TSYSGiftCard Class)
Amount returned to the customer in cash.
Syntax
ANSI (Cross Platform) char* GetCashBackAmount();
int SetCashBackAmount(const char* lpszCashBackAmount); Unicode (Windows) LPWSTR GetCashBackAmount();
INT SetCashBackAmount(LPCWSTR lpszCashBackAmount);
char* dpaymentssdk_tsysgiftcard_getcashbackamount(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcashbackamount(void* lpObj, const char* lpszCashBackAmount);
QString GetCashBackAmount();
int SetCashBackAmount(QString qsCashBackAmount);
Default Value
""
Remarks
This property may contain an optional cash back amount when authorizing a Debit Purchase transaction, EBT Cash Benefit Purchase, or a Gift Card Purchase transaction. The value of TransactionAmount must reflect the cost of the goods or service purchased plus this CashBackAmount.
Note: CashBackAmount must be empty for Restaurant IndustryType as this is not supported by TSYS.
Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
Note: For EBT Withdrawal transactions, CashBackAmount must be empty. However, when creating detail records for the settlement of the transaction, the DebitCashBack in the detail record must match the TransactionAmount for the authorization.
Note, this property is only valid for the ttGiftCardPurchase TransactionType. Trying to send any other TransactionType with cash back will cause the class to fail with an error.
Data Type
String
CustomerAddress Property (TSYSGiftCard Class)
The customer's billing address.
Syntax
ANSI (Cross Platform) char* GetCustomerAddress();
int SetCustomerAddress(const char* lpszCustomerAddress); Unicode (Windows) LPWSTR GetCustomerAddress();
INT SetCustomerAddress(LPCWSTR lpszCustomerAddress);
char* dpaymentssdk_tsysgiftcard_getcustomeraddress(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcustomeraddress(void* lpObj, const char* lpszCustomerAddress);
QString GetCustomerAddress();
int SetCustomerAddress(QString qsCustomerAddress);
Default Value
""
Remarks
This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.
This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.
Per TSYS specs, the following rules apply:
- In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
- There must be a (space) between two consecutive data elements that are only numeric.
Note the following examples:
- "1234 56th Street" is equivalent to: "1234 56Street"
- "1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
- "1391 ELM STREET" is equivalent to: "1391ELMSTREET"
- "P.O. BOX 24356" is equivalent to: "POBOX24356"
The length of this property is 19 characters, and any string longer than this fails with an error. If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.
Data Type
String
CustomerZip Property (TSYSGiftCard Class)
Customer's zip code (or postal code if outside of the USA).
Syntax
ANSI (Cross Platform) char* GetCustomerZip();
int SetCustomerZip(const char* lpszCustomerZip); Unicode (Windows) LPWSTR GetCustomerZip();
INT SetCustomerZip(LPCWSTR lpszCustomerZip);
char* dpaymentssdk_tsysgiftcard_getcustomerzip(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcustomerzip(void* lpObj, const char* lpszCustomerZip);
QString GetCustomerZip();
int SetCustomerZip(QString qsCustomerZip);
Default Value
""
Remarks
This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.
This field is an alphanumeric field with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.
Data Type
String
EmployeeId Property (TSYSGiftCard Class)
Identification number of the Employee making this transaction.
Syntax
ANSI (Cross Platform) char* GetEmployeeId();
int SetEmployeeId(const char* lpszEmployeeId); Unicode (Windows) LPWSTR GetEmployeeId();
INT SetEmployeeId(LPCWSTR lpszEmployeeId);
char* dpaymentssdk_tsysgiftcard_getemployeeid(void* lpObj);
int dpaymentssdk_tsysgiftcard_setemployeeid(void* lpObj, const char* lpszEmployeeId);
QString GetEmployeeId();
int SetEmployeeId(QString qsEmployeeId);
Default Value
""
Remarks
This property identifies the operator initiating this transaction, and should be a unique value defined for each employee within the merchant. This field is only required if the merchant participates in a program where operator level reporting is performed.
Note, this property is ignored for Prepaid Card transactions.
Data Type
String
IndustryType Property (TSYSGiftCard Class)
Code which indicates the industry the merchant is engaged in.
Syntax
ANSI (Cross Platform) int GetIndustryType();
int SetIndustryType(int iIndustryType); Unicode (Windows) INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);
Possible Values
SIT_UNKNOWN(0),
SIT_RETAIL(1),
SIT_RESTAURANT(2),
SIT_GROCERY_STORE(3),
SIT_DIRECT_MARKETING(4),
SIT_HOTEL(5),
SIT_AUTO_RENTAL(6),
SIT_PASSENGER_TRANSPORT(7)
int dpaymentssdk_tsysgiftcard_getindustrytype(void* lpObj);
int dpaymentssdk_tsysgiftcard_setindustrytype(void* lpObj, int iIndustryType);
int GetIndustryType();
int SetIndustryType(int iIndustryType);
Default Value
1
Remarks
This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.
sitUnknown (0) | Unknown or unsure. |
sitRetail (1) | Retail store. |
sitRestaurant (2) | Food / Restaurant. |
sitGroceryStore (3) | Grocery store or supermarket. |
sitDirectMarketing (4) | eCommerce or Direct Marketing |
sitHotel (5) | Hotel / Lodging |
sitAutoRental (6) | Auto Rental |
sitPassengerTransport (7) | Passenger Transport |
Note: American Express cards are NOT currently supported in the sitAutoRental industry.
Note: itDirectMarketing, itHotel, and itAutoRental are NOT supported for this class All Debit, EBT, and Gift Card transactions must be face-to-face card present transactions.
Data Type
Integer
MerchantBankId Property (TSYSGiftCard Class)
The number which identifies the merchant's bank or processor.
Syntax
ANSI (Cross Platform) char* GetMerchantBankId();
int SetMerchantBankId(const char* lpszMerchantBankId); Unicode (Windows) LPWSTR GetMerchantBankId();
INT SetMerchantBankId(LPCWSTR lpszMerchantBankId);
char* dpaymentssdk_tsysgiftcard_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);
QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId);
Default Value
""
Remarks
The number which identifies the merchant's bank or processor.
This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.
Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
Data Type
String
MerchantCategoryCode Property (TSYSGiftCard Class)
Classifies a merchant by the type of store.
Syntax
ANSI (Cross Platform) char* GetMerchantCategoryCode();
int SetMerchantCategoryCode(const char* lpszMerchantCategoryCode); Unicode (Windows) LPWSTR GetMerchantCategoryCode();
INT SetMerchantCategoryCode(LPCWSTR lpszMerchantCategoryCode);
char* dpaymentssdk_tsysgiftcard_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);
QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode);
Default Value
""
Remarks
Classifies a merchant by the type of store.
This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
Data Type
String
MerchantCity Property (TSYSGiftCard Class)
Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
Syntax
ANSI (Cross Platform) char* GetMerchantCity();
int SetMerchantCity(const char* lpszMerchantCity); Unicode (Windows) LPWSTR GetMerchantCity();
INT SetMerchantCity(LPCWSTR lpszMerchantCity);
char* dpaymentssdk_tsysgiftcard_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcity(void* lpObj, const char* lpszMerchantCity);
QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity);
Default Value
""
Remarks
Merchant's City
For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the MerchantName and MerchantState must also be specified.
The first character of this property may not be a space and must contain the same data used in the batch settlement.
Note that this property is ignored for Direct Marketing and E-Commerce transactions. MerchantServicePhone is used for those industries instead of MerchantCity.
This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.
Data Type
String
MerchantCountryCode Property (TSYSGiftCard Class)
Identifies the country where the merchant is located.
Syntax
ANSI (Cross Platform) char* GetMerchantCountryCode();
int SetMerchantCountryCode(const char* lpszMerchantCountryCode); Unicode (Windows) LPWSTR GetMerchantCountryCode();
INT SetMerchantCountryCode(LPCWSTR lpszMerchantCountryCode);
char* dpaymentssdk_tsysgiftcard_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);
QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode);
Default Value
"840"
Remarks
Identifies the country where the merchant is located.
This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".
Data Type
String
MerchantCurrencyCode Property (TSYSGiftCard Class)
Identifies the type of currency used by the merchant.
Syntax
ANSI (Cross Platform) char* GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(const char* lpszMerchantCurrencyCode); Unicode (Windows) LPWSTR GetMerchantCurrencyCode();
INT SetMerchantCurrencyCode(LPCWSTR lpszMerchantCurrencyCode);
char* dpaymentssdk_tsysgiftcard_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);
QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode);
Default Value
"840"
Remarks
Identifies the type of currency used by the merchant.
This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".
Data Type
String
MerchantLanguage Property (TSYSGiftCard Class)
Designates the language that response messages will be returned in.
Syntax
ANSI (Cross Platform) char* GetMerchantLanguage();
int SetMerchantLanguage(const char* lpszMerchantLanguage); Unicode (Windows) LPWSTR GetMerchantLanguage();
INT SetMerchantLanguage(LPCWSTR lpszMerchantLanguage);
char* dpaymentssdk_tsysgiftcard_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);
QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage);
Default Value
"00"
Remarks
Designates the language that response messages will be returned in.
This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.
Indicator | Language |
00 | English. |
01 | Spanish. |
02 | Portuguese. |
03 | Reserved for Irish. |
04 | Reserved for French. |
05 | Reserved for German. |
06 | Reserved for Italian. |
07 | Reserved for Dutch. |
Data Type
String
MerchantName Property (TSYSGiftCard Class)
Name of the merchant.
Syntax
ANSI (Cross Platform) char* GetMerchantName();
int SetMerchantName(const char* lpszMerchantName); Unicode (Windows) LPWSTR GetMerchantName();
INT SetMerchantName(LPCWSTR lpszMerchantName);
char* dpaymentssdk_tsysgiftcard_getmerchantname(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantname(void* lpObj, const char* lpszMerchantName);
QString GetMerchantName();
int SetMerchantName(QString qsMerchantName);
Default Value
""
Remarks
Name of the merchant.
This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.
This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.
This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.
Data Type
String
MerchantNumber Property (TSYSGiftCard Class)
A unique number used to identify the merchant within the VisaNet system.
Syntax
ANSI (Cross Platform) char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber); Unicode (Windows) LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);
char* dpaymentssdk_tsysgiftcard_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);
QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);
Default Value
""
Remarks
A unique number used to identify the merchant within the VisaNet system.
This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.
Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.
Data Type
String
MerchantPhone Property (TSYSGiftCard Class)
Merchant's phone number.
Syntax
ANSI (Cross Platform) char* GetMerchantPhone();
int SetMerchantPhone(const char* lpszMerchantPhone); Unicode (Windows) LPWSTR GetMerchantPhone();
INT SetMerchantPhone(LPCWSTR lpszMerchantPhone);
char* dpaymentssdk_tsysgiftcard_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);
QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone);
Default Value
""
Remarks
Merchant's phone number.
This property contains the Merchant's business phone number. This can be the same as the customer service phone number.
Data Type
String
MerchantServicePhone Property (TSYSGiftCard Class)
Merchant's customer service number.
Syntax
ANSI (Cross Platform) char* GetMerchantServicePhone();
int SetMerchantServicePhone(const char* lpszMerchantServicePhone); Unicode (Windows) LPWSTR GetMerchantServicePhone();
INT SetMerchantServicePhone(LPCWSTR lpszMerchantServicePhone);
char* dpaymentssdk_tsysgiftcard_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);
QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);
Default Value
""
Remarks
Merchant's customer service number.
This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.
This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.
Data Type
String
MerchantState Property (TSYSGiftCard Class)
State or province that the merchant is located in.
Syntax
ANSI (Cross Platform) char* GetMerchantState();
int SetMerchantState(const char* lpszMerchantState); Unicode (Windows) LPWSTR GetMerchantState();
INT SetMerchantState(LPCWSTR lpszMerchantState);
char* dpaymentssdk_tsysgiftcard_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantstate(void* lpObj, const char* lpszMerchantState);
QString GetMerchantState();
int SetMerchantState(QString qsMerchantState);
Default Value
""
Remarks
State or province that the merchant is located in.
This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.
This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.
Data Type
String
MerchantStoreNumber Property (TSYSGiftCard Class)
Used to identify a specific merchant's store within the VisaNet system.
Syntax
ANSI (Cross Platform) char* GetMerchantStoreNumber();
int SetMerchantStoreNumber(const char* lpszMerchantStoreNumber); Unicode (Windows) LPWSTR GetMerchantStoreNumber();
INT SetMerchantStoreNumber(LPCWSTR lpszMerchantStoreNumber);
char* dpaymentssdk_tsysgiftcard_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);
QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber);
Default Value
""
Remarks
Used to identify a specific merchant's store within the VisaNet system.
This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.
Data Type
String
MerchantStreetAddress Property (TSYSGiftCard Class)
Merchant's street address.
Syntax
ANSI (Cross Platform) char* GetMerchantStreetAddress();
int SetMerchantStreetAddress(const char* lpszMerchantStreetAddress); Unicode (Windows) LPWSTR GetMerchantStreetAddress();
INT SetMerchantStreetAddress(LPCWSTR lpszMerchantStreetAddress);
char* dpaymentssdk_tsysgiftcard_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);
QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress);
Default Value
""
Remarks
Merchant's street address.
This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.
Data Type
String
MerchantTerminalNumber Property (TSYSGiftCard Class)
Used to identify a unique terminal within a merchant location.
Syntax
ANSI (Cross Platform) char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber); Unicode (Windows) LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);
char* dpaymentssdk_tsysgiftcard_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);
QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);
Default Value
""
Remarks
Used to identify a unique terminal within a merchant location.
This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.
Data Type
String
MerchantTimeZone Property (TSYSGiftCard Class)
Specifies the GMT offset used to calculate the local time within the VisaNet system.
Syntax
ANSI (Cross Platform) char* GetMerchantTimeZone();
int SetMerchantTimeZone(const char* lpszMerchantTimeZone); Unicode (Windows) LPWSTR GetMerchantTimeZone();
INT SetMerchantTimeZone(LPCWSTR lpszMerchantTimeZone);
char* dpaymentssdk_tsysgiftcard_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);
QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone);
Default Value
"705"
Remarks
Specifies the GMT offset used to calculate the local time within the VisaNet system.
This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.
Byte #1:
Value | Meaning |
0 | Positive offset, in hours, ahead of GMT. |
1 | Negative offset, in hours, behind GMT. |
2 | Positive offset, in 15 minute increments, ahead of GMT. |
3 | Negative offset, in 15 minute increments, behind GMT. |
4 | Positive offset, in 15 minute increments, ahead of GMT, in cities participating in daylight savings. |
5 | Negative offset, in 15 minute increments, behind GMT, in cities participating in daylight savings. |
6 | Positive offset, in hours, ahead of GMT, in cities participating in daylight savings. |
7 | Negative offset, in hours, behind GMT, in cities participating in daylight savings. |
8-9 | RESERVED. |
If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.
Data Type
String
MerchantZip Property (TSYSGiftCard Class)
Zip code where the merchant that initiated this transaction is located.
Syntax
ANSI (Cross Platform) char* GetMerchantZip();
int SetMerchantZip(const char* lpszMerchantZip); Unicode (Windows) LPWSTR GetMerchantZip();
INT SetMerchantZip(LPCWSTR lpszMerchantZip);
char* dpaymentssdk_tsysgiftcard_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantzip(void* lpObj, const char* lpszMerchantZip);
QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);
Default Value
""
Remarks
Zip code where the merchant that initiated this transaction is located.
This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.
This property is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.
Data Type
String
MerchantABANumber Property (TSYSGiftCard Class)
Merchant's routing number.
Syntax
ANSI (Cross Platform) char* GetMerchantABANumber();
int SetMerchantABANumber(const char* lpszMerchantABANumber); Unicode (Windows) LPWSTR GetMerchantABANumber();
INT SetMerchantABANumber(LPCWSTR lpszMerchantABANumber);
char* dpaymentssdk_tsysgiftcard_getmerchantabanumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantabanumber(void* lpObj, const char* lpszMerchantABANumber);
QString GetMerchantABANumber();
int SetMerchantABANumber(QString qsMerchantABANumber);
Default Value
""
Remarks
This property identifies the merchant to a direct debit switch, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 9 digits in length.
Data Type
String
MerchantSettlementAgent Property (TSYSGiftCard Class)
Merchant's settling agent.
Syntax
ANSI (Cross Platform) char* GetMerchantSettlementAgent();
int SetMerchantSettlementAgent(const char* lpszMerchantSettlementAgent); Unicode (Windows) LPWSTR GetMerchantSettlementAgent();
INT SetMerchantSettlementAgent(LPCWSTR lpszMerchantSettlementAgent);
char* dpaymentssdk_tsysgiftcard_getmerchantsettlementagent(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantsettlementagent(void* lpObj, const char* lpszMerchantSettlementAgent);
QString GetMerchantSettlementAgent();
int SetMerchantSettlementAgent(QString qsMerchantSettlementAgent);
Default Value
""
Remarks
This property identifies the merchant settling agent, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 4 digits in length.
Data Type
String
OriginalPurchaseDate Property (TSYSGiftCard Class)
Date and time of original purchase, used for returns.
Syntax
ANSI (Cross Platform) char* GetOriginalPurchaseDate();
int SetOriginalPurchaseDate(const char* lpszOriginalPurchaseDate); Unicode (Windows) LPWSTR GetOriginalPurchaseDate();
INT SetOriginalPurchaseDate(LPCWSTR lpszOriginalPurchaseDate);
char* dpaymentssdk_tsysgiftcard_getoriginalpurchasedate(void* lpObj);
int dpaymentssdk_tsysgiftcard_setoriginalpurchasedate(void* lpObj, const char* lpszOriginalPurchaseDate);
QString GetOriginalPurchaseDate();
int SetOriginalPurchaseDate(QString qsOriginalPurchaseDate);
Default Value
""
Remarks
This property is only applicable for Debit Credit transactions and Gift Card Refund transactions. If supplied, this property must be 8 characters long and formatted as "MMDDhhmm" (month, day, hour, minute).
Note that this property is only valid for the ttGiftCardRefund TransactionType, and will be ignored for all other transactions.
Data Type
String
PartialRedemption Property (TSYSGiftCard Class)
Partial Redemption indicator.
Syntax
ANSI (Cross Platform) int GetPartialRedemption();
int SetPartialRedemption(int bPartialRedemption); Unicode (Windows) BOOL GetPartialRedemption();
INT SetPartialRedemption(BOOL bPartialRedemption);
int dpaymentssdk_tsysgiftcard_getpartialredemption(void* lpObj);
int dpaymentssdk_tsysgiftcard_setpartialredemption(void* lpObj, int bPartialRedemption);
bool GetPartialRedemption();
int SetPartialRedemption(bool bPartialRedemption);
Default Value
FALSE
Remarks
If the customer does not have enough on his stored value card to cover the complete cost of the purchase, the merchant may request that the host perform a partial redemption. The stored value card will be used to fund as much of the transaction as possible, and the remainder may be funded by some other form of payment. When PartialRedemption is set to True, the host will supply the actual amount authorized from the stored value card in the ResponseAuthorizedAmount property.
Note that the ResponseAuthorizedAmount will only contain a value if PartialRedemption is set to True, and will remain blank otherwise. If the Stored Value card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialRedemption.
Data Type
Boolean
ReceivingInstitution Property (TSYSGiftCard Class)
Indicates which gift card network to use.
Syntax
ANSI (Cross Platform) int GetReceivingInstitution();
int SetReceivingInstitution(int iReceivingInstitution); Unicode (Windows) INT GetReceivingInstitution();
INT SetReceivingInstitution(INT iReceivingInstitution);
Possible Values
RI_STORED_VALUE_SYSTEMS(0),
RI_FIFTH_THIRD(1)
int dpaymentssdk_tsysgiftcard_getreceivinginstitution(void* lpObj);
int dpaymentssdk_tsysgiftcard_setreceivinginstitution(void* lpObj, int iReceivingInstitution);
int GetReceivingInstitution();
int SetReceivingInstitution(int iReceivingInstitution);
Default Value
0
Remarks
This field contains a secondary network routing identifier, which indicates the gift card network to be used to process transactions. This is necessary because private issue gift card number ranges may conflict with ranges assigned to major credit card issuers. The supported receiving institutions include:
riStoredValueSystems (0) | Stored Value Systems Gift Card |
riFifthThird (1) | Fifth Third Gift Card |
Note, this property is ignored for Prepaid Card transactions.
Data Type
Integer
ResponseApprovalCode Property (TSYSGiftCard Class)
Contains an authorization code when a transaction has been approved.
Syntax
ANSI (Cross Platform) char* GetResponseApprovalCode(); Unicode (Windows) LPWSTR GetResponseApprovalCode();
char* dpaymentssdk_tsysgiftcard_getresponseapprovalcode(void* lpObj);
QString GetResponseApprovalCode();
Default Value
""
Remarks
Contains an authorization code when a transaction has been approved.
This six character property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction has not been approved, then the contents of the property should be ignored. The ResponseApprovalCode must be stored and submitted in the settlement data capture record.
This property is read-only and not available at design time.
Data Type
String
ResponseAuthorizedAmount Property (TSYSGiftCard Class)
Amount actually used from the card (used when supporting partial redemptions).
Syntax
ANSI (Cross Platform) char* GetResponseAuthorizedAmount(); Unicode (Windows) LPWSTR GetResponseAuthorizedAmount();
char* dpaymentssdk_tsysgiftcard_getresponseauthorizedamount(void* lpObj);
QString GetResponseAuthorizedAmount();
Default Value
""
Remarks
Amount actually used from the card (used when supporting partial redemptions).
The ResponseAuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then ResponseAuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.
For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the ResponseAuthorizedAmount will represent the approved amount of $7.50.In this case, the ResponseCode will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the ResponseAuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this property will be "0" or "".
If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.
This property is read-only.
Data Type
String
ResponseAuthSource Property (TSYSGiftCard Class)
Indicates the source of the authorization code stored in ApprovalCode .
Syntax
ANSI (Cross Platform) char* GetResponseAuthSource(); Unicode (Windows) LPWSTR GetResponseAuthSource();
char* dpaymentssdk_tsysgiftcard_getresponseauthsource(void* lpObj);
QString GetResponseAuthSource();
Default Value
""
Remarks
Indicates the source of the authorization code stored in ResponseApprovalCode.
This property contains a one character code indicating the source of the ResponseApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:
Code | Description |
6 | Off-line approval: POS device generated. |
7 | Acquirer approval. |
9 | Use for non-authorized transactions; such as credit card credits |
B | Response provided by Visa Transaction Advisor Service. |
E | Off-line approval: authorization code manually keyed. |
F | CAFIS-generated response: Post-Auth.* |
G | Issuer Approval: Post-Auth.* |
H | Exceeds acquirer settlement risk exposure cap. |
N | No authorization required: Below floor limit |
L | Late clearing - authorization previously obtained (clearing beyond 30 days) |
V | Authorization obtained via VisaNet (Issuer or STIP response) |
Space | Default value, if acquirer cannot define it (MC, D, AX) |
This property is read-only and not available at design time.
Data Type
String
ResponseAVSResult Property (TSYSGiftCard Class)
Contains the Address Verification System result code.
Syntax
ANSI (Cross Platform) char* GetResponseAVSResult(); Unicode (Windows) LPWSTR GetResponseAVSResult();
char* dpaymentssdk_tsysgiftcard_getresponseavsresult(void* lpObj);
QString GetResponseAVSResult();
Default Value
""
Remarks
Contains the Address Verification System result code.
This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:
Code | Description |
0 | Approved/Declined - Address verification was not requested or it was requested but the transaction was declined (Visa, MC, Amex, Discover). |
A | Address Match - CustomerAddress matches, CustomerZip does not, or the request does not include the CustomerZip (Visa, Amex, Discover). |
I* | Ver Unavailable - Address information not verified (Discover). |
N | No match - Transaction contained postal/ZIP code only, or street address only, or postal code and street address. Also used when transaction requests AVS but sends no AVS data (Visa, MC, Amex, Discover). |
R | Retry - System unable to process (Visa, MC, Amex, Discover). |
S | Serv Unavailable - Service not supported (MC, Amex, Discover). |
U | Ver Unavailable - No data from Issuer/Authorization platform (Visa, MC, Amex, Discover). |
W | Zip Match - Nine character CustomerZip matches, CustomerAddress does not (MC, Discover). |
X | Exact Match - Nine character CustomerZip and CustomerAddress match (MC, Discover). |
Y | Exact Match - CustomerZip and CustomerAddress match (Visa, MC, Amex, Discover). |
Z | Zip Match - CustomerZip matches; CustomerAddress does not match or street address not included in the request (Visa, MC, Amex, Discover). |
1 | APPROVAL - Cardholder name and ZIP match (Amex only). |
2 | APPROVAL - Cardholder name, address, and ZIP match (Amex only). |
3 | APPROVAL - Cardholder name, address match (Amex only). |
4 | APPROVAL - Cardholder name matches (Amex only). |
5 | APPROVAL - Cardholder name incorrect, ZIP matches (Amex only). |
6 | APPROVAL - Cardholder name incorrect, address and ZIP match (Amex only). |
7 | APPROVAL - Cardholder name incorrect, address matches (Amex only). |
8 | NO MATCH - Cardholder name, address, and ZIP do not match (Amex only). |
*AVS Result Code for International addresses only
This property is read-only and not available at design time.
Data Type
String
ResponseBalance Property (TSYSGiftCard Class)
Available balance remaining on card.
Syntax
ANSI (Cross Platform) char* GetResponseBalance(); Unicode (Windows) LPWSTR GetResponseBalance();
char* dpaymentssdk_tsysgiftcard_getresponsebalance(void* lpObj);
QString GetResponseBalance();
Default Value
""
Remarks
Available balance remaining on card.
This property contains the Available Balance remaining on the card following the transaction that was just authorized. It represents the balance on the card prior to the transaction, minus the TransactionAmount from this transaction. For example, if a card has a $20.00 balance prior to a $15.00 ttGiftCardPurchase authorization, then the ResponseBalance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).
Note that this balance will be returned for all TransactionTypes, not just Balance Inquiries.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
This property is read-only.
Data Type
String
ResponseCode Property (TSYSGiftCard Class)
Indicates the status of the authorization request.
Syntax
ANSI (Cross Platform) char* GetResponseCode(); Unicode (Windows) LPWSTR GetResponseCode();
char* dpaymentssdk_tsysgiftcard_getresponsecode(void* lpObj);
QString GetResponseCode();
Default Value
""
Remarks
Indicates the status of the authorization request.
This property contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".
A list of valid result ResponseCodes are listed in the table of contents.
This property is read-only and not available at design time.
Data Type
String
ResponseCVVResult Property (TSYSGiftCard Class)
Contains the returned CVV result code if it was requested.
Syntax
ANSI (Cross Platform) char* GetResponseCVVResult(); Unicode (Windows) LPWSTR GetResponseCVVResult();
char* dpaymentssdk_tsysgiftcard_getresponsecvvresult(void* lpObj);
QString GetResponseCVVResult();
Default Value
""
Remarks
Contains the returned CVV result code if it was requested.
If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an ResponseText indicating such. The following is a list of current result codes:
M | CVV2 match. |
N | CVV2 no match. |
P | Not processed. |
S | Merchant has indicated that CVV2 is not present on card. |
U | Issuer not certified and/or has not provided Visa encryption keys. |
This property is read-only and not available at design time.
Data Type
String
ResponseHostMessageId Property (TSYSGiftCard Class)
Unique host message identifier (Reserved for future use).
Syntax
ANSI (Cross Platform) char* GetResponseHostMessageId(); Unicode (Windows) LPWSTR GetResponseHostMessageId();
char* dpaymentssdk_tsysgiftcard_getresponsehostmessageid(void* lpObj);
QString GetResponseHostMessageId();
Default Value
""
Remarks
Unique host message identifier (Reserved for future use).
This property will contain a unique host message identifier assigned by the authorizing system and returned in Debit, EBT, and Gift card response messages. This property is reserved for future use and will most likely contain spaces.
This property is read-only.
Data Type
String
ResponseNetworkId Property (TSYSGiftCard Class)
Identification code of the network on which the transaction was authorized.
Syntax
ANSI (Cross Platform) char* GetResponseNetworkId(); Unicode (Windows) LPWSTR GetResponseNetworkId();
char* dpaymentssdk_tsysgiftcard_getresponsenetworkid(void* lpObj);
QString GetResponseNetworkId();
Default Value
""
Remarks
Identification code of the network on which the transaction was authorized.
This property indicates the network through which the transaction was authorized. If this property contains a "V" or a "5", this indicates the transaction was processed as a credit card purchase transaction even though it was originally submitted as a debit transaction. When these values ("V" or "5") are returned, the transaction must be settled as a credit card (non-debit) transaction.
The ResponseNetworkId must be printed on the customer's receipt.
The following values may be returned by the TSYS host:
1 | AFFN ATM |
5 | Visa Check Card II |
7 | ITS Shazam |
8 | Maestro |
! | ATH/Evertec |
A | Amex ATM |
B | Plus ATM |
C | CU24 |
D | Discover ATM |
E | Accel |
F | NYCE |
G | Interlink |
H | PULSE |
J | MasterCard ATM |
K | EBT |
L | Pulse |
M | STAR |
N | STAR |
O | Cirrus ATM |
Q | STAR W |
S | PULSE |
T | EBT ATM |
U | AFFN |
W | STAR SE |
Y | NYCE |
Z | STAR NE |
This property is read-only.
Data Type
String
ResponseRetrievalNumber Property (TSYSGiftCard Class)
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
Syntax
ANSI (Cross Platform) char* GetResponseRetrievalNumber(); Unicode (Windows) LPWSTR GetResponseRetrievalNumber();
char* dpaymentssdk_tsysgiftcard_getresponseretrievalnumber(void* lpObj);
QString GetResponseRetrievalNumber();
Default Value
""
Remarks
This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.
This property is read-only and not available at design time.
Data Type
String
ResponseReturnedACI Property (TSYSGiftCard Class)
Returned Authorization Characteristics Indicator contains CPS qualification status.
Syntax
ANSI (Cross Platform) char* GetResponseReturnedACI(); Unicode (Windows) LPWSTR GetResponseReturnedACI();
char* dpaymentssdk_tsysgiftcard_getresponsereturnedaci(void* lpObj);
QString GetResponseReturnedACI();
Default Value
""
Remarks
Returned Authorization Characteristics Indicator contains CPS qualification status.
This one character property contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the ResponseTransactionId or ResponseValidationCode properties.
This property is read-only and not available at design time.
Data Type
String
ResponseSettleDate Property (TSYSGiftCard Class)
Date at which the Debit, EBT, or Gift Card transaction will settle.
Syntax
ANSI (Cross Platform) char* GetResponseSettleDate(); Unicode (Windows) LPWSTR GetResponseSettleDate();
char* dpaymentssdk_tsysgiftcard_getresponsesettledate(void* lpObj);
QString GetResponseSettleDate();
Default Value
""
Remarks
Date at which the Debit, EBT, or Gift Card transaction will settle.
This property contains a four-character transaction settlement date as returned by the TSYS Acquiring Solutions authorization system. This date is in "MMDD" format, and indicates the date at which this transaction will settle. This date does not have to match the date you actually submit this transaction in a batch settlement.
This property is read-only.
Data Type
String
ResponseText Property (TSYSGiftCard Class)
Text information that describes each response code.
Syntax
ANSI (Cross Platform) char* GetResponseText(); Unicode (Windows) LPWSTR GetResponseText();
char* dpaymentssdk_tsysgiftcard_getresponsetext(void* lpObj);
QString GetResponseText();
Default Value
""
Remarks
Text information that describes each response code.
This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.
The English-language response text messages are listed in the table of contents.
This property is read-only and not available at design time.
Data Type
String
ResponseTrace Property (TSYSGiftCard Class)
System Trace Audit Number returned for Debit transactions.
Syntax
ANSI (Cross Platform) char* GetResponseTrace(); Unicode (Windows) LPWSTR GetResponseTrace();
char* dpaymentssdk_tsysgiftcard_getresponsetrace(void* lpObj);
QString GetResponseTrace();
Default Value
""
Remarks
System Trace Audit Number returned for Debit transactions.
This property contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages.
This property is read-only.
Data Type
String
ResponseTransactionDate Property (TSYSGiftCard Class)
Local transaction date returned from the server in MMddyy format.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionDate(); Unicode (Windows) LPWSTR GetResponseTransactionDate();
char* dpaymentssdk_tsysgiftcard_getresponsetransactiondate(void* lpObj);
QString GetResponseTransactionDate();
Default Value
""
Remarks
Local transaction date returned from the server in MMddyy format.
This six digit property contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionId Property (TSYSGiftCard Class)
Contains the Transaction Identifier or MasterCard Reference Number.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionId(); Unicode (Windows) LPWSTR GetResponseTransactionId();
char* dpaymentssdk_tsysgiftcard_getresponsetransactionid(void* lpObj);
QString GetResponseTransactionId();
Default Value
""
Remarks
Contains the Transaction Identifier or MasterCard Reference Number.
This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionNumber Property (TSYSGiftCard Class)
Check this property against the original Transaction Number.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionNumber(); Unicode (Windows) LPWSTR GetResponseTransactionNumber();
char* dpaymentssdk_tsysgiftcard_getresponsetransactionnumber(void* lpObj);
QString GetResponseTransactionNumber();
Default Value
""
Remarks
Check this property against the original Transaction Number.
This property should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionTime Property (TSYSGiftCard Class)
Local transaction time returned from the server in HHmmss format.
Syntax
ANSI (Cross Platform) char* GetResponseTransactionTime(); Unicode (Windows) LPWSTR GetResponseTransactionTime();
char* dpaymentssdk_tsysgiftcard_getresponsetransactiontime(void* lpObj);
QString GetResponseTransactionTime();
Default Value
""
Remarks
Local transaction time returned from the server in HHmmss format.
This six digit property contains the Local Transaction Time returned by the authorizing system. This property should be recorded and submitted in the Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
ResponseValidationCode Property (TSYSGiftCard Class)
This optional property contains information generated by the card issuer.
Syntax
ANSI (Cross Platform) char* GetResponseValidationCode(); Unicode (Windows) LPWSTR GetResponseValidationCode();
char* dpaymentssdk_tsysgiftcard_getresponsevalidationcode(void* lpObj);
QString GetResponseValidationCode();
Default Value
""
Remarks
This optional property contains information generated by the card issuer.
This optional four character property contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.
This property is read-only and not available at design time.
Data Type
String
SSLAcceptServerCertEncoded Property (TSYSGiftCard Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysgiftcard_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysgiftcard_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (TSYSGiftCard Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int dpaymentssdk_tsysgiftcard_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysgiftcard_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (TSYSGiftCard Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int dpaymentssdk_tsysgiftcard_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysgiftcard_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (TSYSGiftCard Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* dpaymentssdk_tsysgiftcard_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (TSYSGiftCard Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int dpaymentssdk_tsysgiftcard_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (TSYSGiftCard Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* dpaymentssdk_tsysgiftcard_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLProvider Property (TSYSGiftCard Class)
This specifies the SSL/TLS implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int dpaymentssdk_tsysgiftcard_getsslprovider(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEncoded Property (TSYSGiftCard Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int dpaymentssdk_tsysgiftcard_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (TSYSGiftCard Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int dpaymentssdk_tsysgiftcard_gettimeout(void* lpObj);
int dpaymentssdk_tsysgiftcard_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
30
Remarks
If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.
The default value for Timeout is 30 (seconds).
Data Type
Integer
TransactionAmount Property (TSYSGiftCard Class)
Purchase amount to be authorized.
Syntax
ANSI (Cross Platform) char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount); Unicode (Windows) LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);
char* dpaymentssdk_tsysgiftcard_gettransactionamount(void* lpObj);
int dpaymentssdk_tsysgiftcard_settransactionamount(void* lpObj, const char* lpszTransactionAmount);
QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);
Default Value
""
Remarks
This field contains the transaction amount to be authorized.
This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.
Data Type
String
TransactionNumber Property (TSYSGiftCard Class)
Sequence number of this transaction.
Syntax
ANSI (Cross Platform) int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber); Unicode (Windows) INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);
int dpaymentssdk_tsysgiftcard_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_settransactionnumber(void* lpObj, int iTransactionNumber);
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);
Default Value
0
Remarks
This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.
Data Type
Integer
TransactionType Property (TSYSGiftCard Class)
Specifies the type of Gift Card transaction to process.
Syntax
ANSI (Cross Platform) int GetTransactionType();
int SetTransactionType(int iTransactionType); Unicode (Windows) INT GetTransactionType();
INT SetTransactionType(INT iTransactionType);
Possible Values
TT_GIFT_CARD_PURCHASE(15),
TT_GIFT_CARD_REFUND(16),
TT_GIFT_CARD_ADD_VALUE(17),
TT_GIFT_CARD_DECREASE_VALUE(18),
TT_GIFT_CARD_CLOSE_CARD(19),
TT_GIFT_CARD_BALANCE_INQUIRY(20),
TT_PREPAID_CARD_ACTIVATION(21),
TT_PREPAID_CARD_LOAD(22),
TT_PREPAID_CARD_PURCHASE(23),
TT_PREPAID_CARD_BALANCE_INQUIRY(24)
int dpaymentssdk_tsysgiftcard_gettransactiontype(void* lpObj);
int dpaymentssdk_tsysgiftcard_settransactiontype(void* lpObj, int iTransactionType);
int GetTransactionType();
int SetTransactionType(int iTransactionType);
Default Value
15
Remarks
This property indicates the type of Gift Card transaction to send. The following table explains the transaction types in detail:
ttGiftCardPurchase (15) | This transaction redeems funds on the cards towards the purchase of goods or services. |
ttGiftCardRefund (16) | This transaction refunds a previous ttGiftCardPurchase transaction. |
ttGiftCardAddValue (17) | This transaction adds funds to the gift card. |
ttGiftCardDecreaseValue (18) | This transaction removes funds from the gift card (do not use this for purchases. Use ttGiftCardPurchase instead). |
ttGiftCardCloseCard (19) | This transaction closes a gift card and removes it from circulation. Any remaining balance on the card will be returned in the ResponseAuthorizedAmount property. |
ttGiftCardBalanceInquiry (20) | This transaction retrieves the current available balance for the gift card. The balance is returned in the ResponseBalance property. |
ttPrepaidCardActivation (21) | This transaction activates a card and loads it with funds. The TransactionAmount must match the value indicated on the face of the card. |
ttPrepaidCardLoad (22) | This transaction loads a prepaid card with funds. Total funds on the card (current balance of the card plus the TransactionAmount) cannot exceed the value printed on the face of the card. |
ttPrepaidCardPurchase (23) | This transaction is identical to a regular credit card authorization. |
ttPrepaidCardBalanceInquiry (24) | This transaction retrieves the current available balance for the prepaid card. The balance is returned in the ResponseBalance property. |
Data Type
Integer
Authorize Method (TSYSGiftCard Class)
Sends a Gift Card transaction.
Syntax
ANSI (Cross Platform) int Authorize(); Unicode (Windows) INT Authorize();
int dpaymentssdk_tsysgiftcard_authorize(void* lpObj);
int Authorize();
Remarks
This method sends a Gift Card authorization request to the Vital/TSYS host. The type of transaction sent is based upon the value of the TransactionType property. If the request was successful, the ResponseCode property will contain "00".
Note that only ttPrepaidCardPurchase transactions are settled with the TSYSSettle class. All other transactions (including ttGiftCardPurchase) take place in real time. Instead of using this class to authorize Prepaid Card purchases, you may opt to use the TSYSRetail class instead. However, this class allows you to support PartialRedemption, and will also return the prepaid card's available balance in the ResponseBalance property.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (TSYSGiftCard Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* dpaymentssdk_tsysgiftcard_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetDetailAggregate Method (TSYSGiftCard Class)
Returns an aggregate containing details of this transaction, which is then used for settlement.
Syntax
ANSI (Cross Platform) char* GetDetailAggregate(); Unicode (Windows) LPWSTR GetDetailAggregate();
char* dpaymentssdk_tsysgiftcard_getdetailaggregate(void* lpObj);
QString GetDetailAggregate();
Remarks
This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.
Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.
An example of how this method is used is shown below:
TSYSRetail.Authorize()
TSYSSettle.DetailRecordCount = 1
TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()
Note that ttPrepaidCardPurchase transactions are identical to regular credit card authorizations, and thus must be settled like credit card transactions. Attempting to call this method for any other TransactionType will cause the class to fail with an error.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Interrupt Method (TSYSGiftCard Class)
Interrupts the current action.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int dpaymentssdk_tsysgiftcard_interrupt(void* lpObj);
int Interrupt();
Remarks
This method interrupts any processing that the class is currently executing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (TSYSGiftCard Class)
Clears all properties to their default values.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int dpaymentssdk_tsysgiftcard_reset(void* lpObj);
int Reset();
Remarks
This method clears all properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Connected Event (TSYSGiftCard Class)
Fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(TSYSGiftCardConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } TSYSGiftCardConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(TSYSGiftCardConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } TSYSGiftCardConnectedEventParams;
#define EID_TSYSGIFTCARD_CONNECTED 1 virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class TSYSGiftCardConnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(TSYSGiftCardConnectedEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireConnected(TSYSGiftCardConnectedEventParams *e) {...}
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
DataPacketIn Event (TSYSGiftCard Class)
Fired when receiving a data packet from the transaction server.
Syntax
ANSI (Cross Platform) virtual int FireDataPacketIn(TSYSGiftCardDataPacketInEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } TSYSGiftCardDataPacketInEventParams;
Unicode (Windows) virtual INT FireDataPacketIn(TSYSGiftCardDataPacketInEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } TSYSGiftCardDataPacketInEventParams;
#define EID_TSYSGIFTCARD_DATAPACKETIN 2 virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);
class TSYSGiftCardDataPacketInEventParams { public: const QByteArray &DataPacket(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DataPacketIn(TSYSGiftCardDataPacketInEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireDataPacketIn(TSYSGiftCardDataPacketInEventParams *e) {...}
Remarks
This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.
DataPacketOut Event (TSYSGiftCard Class)
Fired when sending a data packet to the transaction server.
Syntax
ANSI (Cross Platform) virtual int FireDataPacketOut(TSYSGiftCardDataPacketOutEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } TSYSGiftCardDataPacketOutEventParams;
Unicode (Windows) virtual INT FireDataPacketOut(TSYSGiftCardDataPacketOutEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } TSYSGiftCardDataPacketOutEventParams;
#define EID_TSYSGIFTCARD_DATAPACKETOUT 3 virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);
class TSYSGiftCardDataPacketOutEventParams { public: const QByteArray &DataPacket(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DataPacketOut(TSYSGiftCardDataPacketOutEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireDataPacketOut(TSYSGiftCardDataPacketOutEventParams *e) {...}
Remarks
This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.
Disconnected Event (TSYSGiftCard Class)
Fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(TSYSGiftCardDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } TSYSGiftCardDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(TSYSGiftCardDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } TSYSGiftCardDisconnectedEventParams;
#define EID_TSYSGIFTCARD_DISCONNECTED 4 virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class TSYSGiftCardDisconnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(TSYSGiftCardDisconnectedEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireDisconnected(TSYSGiftCardDisconnectedEventParams *e) {...}
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.
Please refer to the Error Codes section for more information.
Error Event (TSYSGiftCard Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(TSYSGiftCardErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } TSYSGiftCardErrorEventParams;
Unicode (Windows) virtual INT FireError(TSYSGiftCardErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } TSYSGiftCardErrorEventParams;
#define EID_TSYSGIFTCARD_ERROR 5 virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class TSYSGiftCardErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(TSYSGiftCardErrorEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireError(TSYSGiftCardErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
SSLServerAuthentication Event (TSYSGiftCard Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(TSYSGiftCardSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } TSYSGiftCardSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(TSYSGiftCardSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } TSYSGiftCardSSLServerAuthenticationEventParams;
#define EID_TSYSGIFTCARD_SSLSERVERAUTHENTICATION 6 virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class TSYSGiftCardSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(TSYSGiftCardSSLServerAuthenticationEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireSSLServerAuthentication(TSYSGiftCardSSLServerAuthenticationEventParams *e) {...}
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (TSYSGiftCard Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(TSYSGiftCardSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } TSYSGiftCardSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(TSYSGiftCardSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } TSYSGiftCardSSLStatusEventParams;
#define EID_TSYSGIFTCARD_SSLSTATUS 7 virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);
class TSYSGiftCardSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(TSYSGiftCardSSLStatusEventParams *e);
// Or, subclass TSYSGiftCard and override this emitter function. virtual int FireSSLStatus(TSYSGiftCardSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (TSYSGiftCard Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.TSYSGiftCard Config Settings
Valid values are:
Code | Description |
P | Pre Authorization |
F | Final Authorization |
U | Undefined Authorization |
Code Example:
TSYSRetail.Config("POSDataCode=CardholderAuthCap=1;CardInputMode=2;CardInputCap=2");
CardInputCap (Terminal card data input capability)
0 (default) | Unspecified, data not available |
1 | Manual; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader capability |
3 | Bar code/ Payment code |
4 | Optical character reader (OCR) capability, [MC, AX] |
5 | Integrated circuit card (ICC) capability and magnetic stripe reader |
6 | Key entry only capability; Mastercard recurring and installment transactions |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader and key entry capability |
C | Magnetic stripe reader, ICC, and key entry capability |
D | Magnetic stripe reader and ICC capability |
E | ICC entry capability |
H | ICC Reader and Contactless Capability; Magnetic stripe & manual entry implied |
M | PAN auto-entry via contactless chip |
V | Other capability, [MC] |
X | Reserved for private use |
CardholderAuthCap (Terminal cardholder authentication capability)
0 | No electronic authentication capability |
1 | PIN entry capability |
2 | Electronic signature analysis capability |
3 | mPOS software-based PIN entry capability |
5 | Electronic authentication capability is inoperative |
6 | Other |
9 (default) | Unspecified, data not available |
CardCaptureCap (Terminal card-capture capability)
0 | No capture capability |
1 | Card capture capability |
9 (default) | Unspecified, data not available |
TerminalOpEnv (Terminal operating environment)
0 | No terminal used; Voice auth/ARU; Mastercard recurring/installment transactions |
1 | On card acceptor premises; attended terminal |
2 | On card acceptor premises; unattended terminal |
3 | Off card acceptor premises; attended |
4 | Off card acceptor premises; unattended |
5 | On cardholder premises; unattended |
6 | Off cardholder premises; unattended |
9 (default) | Unspecified, data not available |
M | Off card acceptor premises; merchant mobile POS environment, including mPOS |
P | On card acceptor premises; merchant mobile POS environment, including mPOS |
Q | Off card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
R | On card acceptor premises; cardholder mobile environment, including home PC, mobile phone, PDA |
S | Electronic delivery of product, [AX] |
T | Physical delivery of product, [AX] |
CardholderPresent (Cardholder present data)
0 | Cardholder present |
1 | Cardholder not present; unspecified reason |
2 | Cardholder not present; mail transaction |
3 | Cardholder not present; phone transaction |
4 | Cardholder not present; standing (recurring) transaction |
5 | Cardholder not present; electronic commerce |
8 | Cardholder not present; recurrent billing such as a loan or installment payment |
R | Recurring purchase transaction (original transaction was token-based with valid cryptogram) |
T | PayButton (Discover only) |
CardPresent (Card present data)
0 | Card not present |
1 | Card present |
W | Transponder, [AX] |
X | Contactless Chip Transactions, including AMEX Expresspay |
Z | Digital Wallet [AX] |
CardInputMode (Card data input mode)
0 (default) | Unspecified, data not available |
1 | Manual input; no terminal; Voice auth/ARU |
2 | Magnetic stripe reader input |
3 | Bar code/Payment code |
6 | Key entered input |
7 | Payment Credential stored on file. NOTE: This value is required for all Mastercard recurring transactions. |
A | PAN auto-entry via contactless magnetic stripe |
B | Magnetic stripe reader input; track data captured and passed unaltered |
C | Online Chip |
F | Offline Chip |
M | PAN auto-entry via contactless Chip Card (EMV Mode) |
N | Track data read and sent unaltered, chip capable terminal, chip data could not be read |
P | Empty candidate list fallback |
R | PAN Entry via electronic commerce, including remote chip |
S | Electronic commerce, no security, channel encrypted, or SET without cardholder certificate |
V | Manually entered with keyed CID, [AX, JCB Canada] |
W | Swiped transaction with keyed CID, [AX, JCB Canada] |
X | Reserved for private use |
Y | Reserved for private use |
Z | Contactless Interface Change Identifies when a Chip Card Transaction with a dualinterface card switches from a contactless to a contact chip card transaction [Discover] |
NOTE: AMEX defines ApplePay with value C - Online Chip
CardholderAuthMethod (Cardholder authentication method)
0 | Not authenticated |
1 | PIN |
2 | Electronic signature analysis |
5 | Manual signature verification |
6 | Other manual verification (such as a driver's license number) |
9 (default) | Unspecified, data not available |
S | Other systematic verification |
T | Electronic ticket environment, [AX] |
CardholderAuthEntity (Cardholder authentication entity)
0 | Not authenticated |
1 | ICC - Offline PIN |
2 | Card acceptance device (CAD) |
3 | Authorizing agent - Online PIN |
4 | Merchant/card acceptor - signature |
5 | Other |
9 (default) | Unspecified, data not available |
CardOutputCap (Card data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Magnetic stripe write |
3 | ICC |
S | Other |
TerminalOutputCap (Terminal data output capability)
0 (default) | Unspecified, data not available |
1 | None |
2 | Printing capability only |
3 | Display capability only |
4 | Printing and display capability |
PINCaptureCap (PIN capture capability)
0 | No PIN capture capability |
1 (default) | Unspecified, data not available |
2 | Reserved |
3 | Reserved |
4 | PIN capture capability four characters maximum |
5 | PIN capture capability five characters maximum |
6 | PIN capture capability six characters maximum |
7 | PIN capture capability seven characters maximum |
8 | PIN capture capability eight characters maximum |
9 | PIN capture capability nine characters maximum |
A | PIN capture capability 10 characters maximum |
B | PIN capture capability 11 characters maximum |
C | PIN capture capability 12 characters maximum |
Note: Setting this configuration setting in TSYSDetailRecord class will not update the POSDataCode tag in the detail aggregate of the original transaction.
Byte Number | Description |
Byte 1 | Billing ZIP Code |
Byte 2 | Billing Street Match Code |
Byte 3 | Billing Name Match Code |
Byte 4 | Telephone Number Match Code |
Byte 5 | E-mail Address Match Code |
The possible values for each byte are:
Value | Description |
Y | Data Matches |
U | Data Unchecked |
N | No Match |
S | Service not allowed |
R | Retry |
' ' (Space) | Data not sent |
For Discover transactions, byte 3 will be populated with the following values:
Value | Description |
B | No response due to blank input |
K | Unknown |
P | Not processed |
M | First Name and Last Name match |
F | First Name Matches, Last Name does not match |
L | First Name does not match, Last Name matches |
N | Nothing matches |
W | No data from Issuer/Authorization system |
U | Retry, system unable to process |
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (TSYSGiftCard Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
TSYSGiftCard Errors
501 Data field invalid length. | |
502 Data field invalid format. | |
503 Data field out of range. | |
504 Luhn digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
507 Card type unknown. | |
509 No gateway specified. | |
511 Invalid data entered. | |
512 Truncated response. | |
513 Invalid response. | |
517 Response length mismatch. | |
518 LRC check failed. | |
519 Corrupt response. | |
520 Response packet empty. | |
521 Response truncated. | |
522 Host disconnected. | |
523 No response from host. | |
524 Server error response. | |
526 Invalid timeout value. | |
527 Vital/TSYS returned an error response. | |
535 Signature verification failed. | |
544 Error building packet. | |
593 Missing or erroneous property value. Cannot send transaction. | |
594 Response received before transmission completed. | |
595 Prematurely disconnected (check MerchantNumber and MerchantBankId). | |
596 Pending responses max number exceeded (Interleaved). | |
597 Pending response timeout (Interleaved). |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |