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:

  Copy
  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 MagneticStripe data for Prepaid cards can be either track1 or track2, but Gift cards support only the dsTrack2 EntryDataSource. Both types support manual entry via the Number, ExpMonth, and ExpYear 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:

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

  Copy
  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 Code 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.
Card	Contains the customer's credit card information.
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.
Merchant	Contains the merchant's setup information.
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.
Response	Contains the response to a debit authorization request.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
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.
MaskSensitiveData	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

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

Card Property (TSYSGiftCard Class)

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard* GetCard();
int SetCard(DPaymentsSDKCCCard* val);

int dpaymentssdk_tsysgiftcard_getcardtype(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardtype(void* lpObj, int iCardType);

char* dpaymentssdk_tsysgiftcard_getcardcvvdata(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

int dpaymentssdk_tsysgiftcard_getcardcvvpresence(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int dpaymentssdk_tsysgiftcard_getcardentrydatasource(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int dpaymentssdk_tsysgiftcard_getcardexpmonth(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardexpmonth(void* lpObj, int iCardExpMonth);

int dpaymentssdk_tsysgiftcard_getcardexpyear(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardexpyear(void* lpObj, int iCardExpYear);

int dpaymentssdk_tsysgiftcard_getcardisencrypted(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

char* dpaymentssdk_tsysgiftcard_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

char* dpaymentssdk_tsysgiftcard_getcardnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setcardnumber(void* lpObj, const char* lpszCardNumber);

int GetCardType();
int SetCardType(int iCardType);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

Note that Track1 data is only applicable for Prepaid cards. For all other gift cards you must use Track2 data, or manual entry.

This property is not available at design time.

Data Type

DPaymentsSDKCCCard

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.

In order to maximize the address information included in the request, it is suggested that you strip out the spaces (when possible) and punctuations before setting the property.

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

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

Merchant Property (TSYSGiftCard Class)

Contains the merchant's setup information.

Syntax

DPaymentsSDKTSYSMerchant* GetMerchant();
int SetMerchant(DPaymentsSDKTSYSMerchant* val);

char* dpaymentssdk_tsysgiftcard_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);

char* dpaymentssdk_tsysgiftcard_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);

char* dpaymentssdk_tsysgiftcard_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcity(void* lpObj, const char* lpszMerchantCity);

char* dpaymentssdk_tsysgiftcard_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);

char* dpaymentssdk_tsysgiftcard_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);

char* dpaymentssdk_tsysgiftcard_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);

char* dpaymentssdk_tsysgiftcard_getmerchantname(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantname(void* lpObj, const char* lpszMerchantName);

char* dpaymentssdk_tsysgiftcard_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

char* dpaymentssdk_tsysgiftcard_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);

char* dpaymentssdk_tsysgiftcard_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);

char* dpaymentssdk_tsysgiftcard_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantstate(void* lpObj, const char* lpszMerchantState);

char* dpaymentssdk_tsysgiftcard_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);

char* dpaymentssdk_tsysgiftcard_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);

char* dpaymentssdk_tsysgiftcard_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

char* dpaymentssdk_tsysgiftcard_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);

char* dpaymentssdk_tsysgiftcard_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysgiftcard_setmerchantzip(void* lpObj, const char* lpszMerchantZip);

QString GetMerchantBankId();
int SetMerchantBankId(QString qsMerchantBankId);

QString GetMerchantCategoryCode();
int SetMerchantCategoryCode(QString qsMerchantCategoryCode);

QString GetMerchantCity();
int SetMerchantCity(QString qsMerchantCity);

QString GetMerchantCountryCode();
int SetMerchantCountryCode(QString qsMerchantCountryCode);

QString GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(QString qsMerchantCurrencyCode);

QString GetMerchantLanguage();
int SetMerchantLanguage(QString qsMerchantLanguage);

QString GetMerchantName();
int SetMerchantName(QString qsMerchantName);

QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

QString GetMerchantPhone();
int SetMerchantPhone(QString qsMerchantPhone);

QString GetMerchantServicePhone();
int SetMerchantServicePhone(QString qsMerchantServicePhone);

QString GetMerchantState();
int SetMerchantState(QString qsMerchantState);

QString GetMerchantStoreNumber();
int SetMerchantStoreNumber(QString qsMerchantStoreNumber);

QString GetMerchantStreetAddress();
int SetMerchantStreetAddress(QString qsMerchantStreetAddress);

QString GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(QString qsMerchantTerminalNumber);

QString GetMerchantTimeZone();
int SetMerchantTimeZone(QString qsMerchantTimeZone);

QString GetMerchantZip();
int SetMerchantZip(QString qsMerchantZip);

Remarks

This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available fields.

Data Type

DPaymentsSDKTSYSMerchant

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

Note that the AuthorizedAmount 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

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

Response Property (TSYSGiftCard Class)

Contains the response to a debit authorization request.

Syntax

DPaymentsSDKTSYSDebitResponse* GetResponse();

char* dpaymentssdk_tsysgiftcard_getresponseapprovalcode(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponseauthorizedamount(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponseauthsource(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponseavsresult(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsebalance(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsecode(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsecvvresult(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsehostmessageid(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsenetworkid(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponseretrievalnumber(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsereturnedaci(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsesettledate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsetext(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsetrace(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsetransactiondate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsetransactionid(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsetransactionnumber(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsetransactiontime(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getresponsevalidationcode(void* lpObj);

QString GetResponseApprovalCode();

QString GetResponseAuthorizedAmount();

QString GetResponseAuthSource();

QString GetResponseAVSResult();

QString GetResponseBalance();

QString GetResponseCode();

QString GetResponseCVVResult();

QString GetResponseHostMessageId();

QString GetResponseNetworkId();

QString GetResponseRetrievalNumber();

QString GetResponseReturnedACI();

QString GetResponseSettleDate();

QString GetResponseText();

QString GetResponseTrace();

QString GetResponseTransactionDate();

QString GetResponseTransactionId();

QString GetResponseTransactionNumber();

QString GetResponseTransactionTime();

QString GetResponseValidationCode();

Remarks

This property will contain the response returned from the TSYS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The TSYSResponse type contains the following fields:


ApprovalCode	Contains an authorization code for approved transactions, or a description of the error for declines.
AuthorizedAmount	Amount actually used from the card (used when supporting partial redemptions).
AuthSource	Indicates the source of the authorization code stored in ApprovalCode.
AVSResult	Contains the Address Verification System result code.
CardLevel	This field contains a two-character code created by Visa during the authorization process.
Code	Indicates the status of the authorization request.
CommercialCardType	Indicates whether the credit card charged is a corporate commercial card (and if so the type of commercial card).
CVVResult	Contains the returned CVV result code (if CVV data was sent in the request).
RetrievalNumber	This number is to be submitted for reversals or at settlement.
ReturnedACI	Returned Authorization Characteristics Indicator contains CPS qualification status.
Text	Text information that describes each response code.
TransactionDate	Local transaction date returned from the server in MMDDYY format.
TransactionId	Contains the Transaction Identifier or MasterCard Reference Number.
TransactionNumber	Check this field against the TransactionNumber sent in the authorization.
TransactionTime	Local transaction time returned from the server in HHMMSS format.
ValidationCode	Additional information generated by the card issuer.
Balance	Available balance remaining on card.
HostMessageId	Unique host message identifier (Reserved for future use).
NetworkId	Identification code of the network on which the transaction was authorized.
SettleDate	Date at which the Debit, EBT, or Gift Card transaction will settle.
Trace	System Trace Audit Number returned for Debit transactions.

This property is read-only.

Data Type

DPaymentsSDKTSYSDebitResponse

SSLAcceptServerCert Property (TSYSGiftCard Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_tsysgiftcard_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_tsysgiftcard_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_tsysgiftcard_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysgiftcard_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DPaymentsSDKCertificate

SSLCert Property (TSYSGiftCard Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_tsysgiftcard_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertissuer(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysgiftcard_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_tsysgiftcard_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_tsysgiftcard_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_tsysgiftcard_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertusage(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertversion(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysgiftcard_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_tsysgiftcard_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysgiftcard_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DPaymentsSDKCertificate

SSLProvider Property (TSYSGiftCard Class)

The Secure Sockets Layer/Transport Layer Security (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

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 as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

SSLServerCert Property (TSYSGiftCard Class)

The server certificate for the last established connection.

Syntax

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_tsysgiftcard_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_tsysgiftcard_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertusage(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertversion(void* lpObj);

char* dpaymentssdk_tsysgiftcard_getsslservercertsubject(void* lpObj);

int dpaymentssdk_tsysgiftcard_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

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

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.

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

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

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 AuthorizedAmount property.
ttGiftCardBalanceInquiry (20)	This transaction retrieves the current available balance for the gift card. The balance is returned in the Balance 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 Balance 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 Code 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 Balance 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:

  Copy
	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++)

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

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

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.

CCCard Type

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard (declared in dpaymentssdk.h)

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields

  Copy
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A";
card.EntryDataSource = edsTrack1;

Example: Using a Constructor

  Copy
CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields

  Copy
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;

Example: Using a Constructor

  Copy
CCCard card = new CCCard("4012000033330026", 04, 2009);

Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will fails with an error because none is present.

The following fields are available:

CardType
CVVData
CVVPresence
EntryDataSource
ExpMonth
ExpYear
IsEncrypted
MagneticStripe
Number

Fields

CardType
int
Default Value: 0

Type of credit card being used in this transaction. This field contains the customer's credit card type. This is automatically computed after the Number 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)

CVVData
char*
Default Value: ""

Three digit security code on back of card (optional).

This alphanumeric field 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 field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult field and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.

CVVPresence
int
Default Value: 0

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

The class will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.

Available values are:

cvpNotProvided (0)
cvpProvided (1)
cvpIllegible (2)
cvpNotOnCard (3)

EntryDataSource
int
Default Value: 0

This field contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this field.


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. (Number, ExpMonth, and ExpYear are sent).
edsKiosk (9)	Automated kiosk transaction. Track1 or Track2 data must be sent in MagneticStripe, 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

ExpMonth
int
Default Value: 1

Expiration month of the credit card specified in Number.

This field contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

ExpYear
int
Default Value: 2000

Expiration year of the credit card specified in Number.

This field contains the expiration date of the customer's credit card. This field must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

IsEncrypted
int
Default Value: FALSE

Determines whether data set to the Number or MagneticStripe fields is validated.

By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. 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 Number or MagneticStripe 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.

MagneticStripe
char*
Default Value: ""

Track data read off of the card's magnetic stripe.

If EntryDataSource is not one of the manually entered enumerations, then this field 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 field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.

The following example shows how to set the MagneticStripe and EntryDataSource fields if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

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

Number
char*
Default Value: ""

Customer's credit card number for the transaction.

If you're sending the transaction with MagneticStripe data, this field should be left empty.

Constructors

CCCard()

CCCard(const char* lpszNumber, int iExpMonth, int iExpYear)

CCCard(const char* lpszMagneticStripe, int iEntryDataSource)

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

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 field 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 Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: C# Copy `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

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 field 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=example@email.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.

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

TSYSDebitResponse Type

Contains the response to the authorization.

Syntax

DPaymentsSDKTSYSDebitResponse (declared in dpaymentssdk.h)

Remarks

This type contains the results of a transaction made with the TSYSDebit, TSYSGiftCard, or TSYSBenefit class. The fields contained by this type are listed below.

The following fields are available:

ApprovalCode
AuthorizedAmount
AuthSource
AVSResult
Balance
Code
CVVResult
HostMessageId
NetworkId
RetrievalNumber
ReturnedACI
SettleDate
Text
Trace
TransactionDate
TransactionId
TransactionNumber
TransactionTime
ValidationCode

Fields

ApprovalCode
char* (read-only)
Default Value: ""

Contains an authorization code when a transaction has been approved.

This six character field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction has not been approved, then the contents of the field should be ignored. The ApprovalCode must be stored and submitted in the settlement data capture record.

AuthorizedAmount
char* (read-only)
Default Value: ""

Amount actually used from the card (used when supporting partial redemptions).

The AuthorizedAmount 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 AuthorizedAmount 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 AuthorizedAmount will represent the approved amount of $7.50.In this case, the Code will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the AuthorizedAmount 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 field 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.

AuthSource
char* (read-only)
Default Value: ""

Indicates the source of the authorization code stored in ApprovalCode.

This field contains a one character code indicating the source of the ApprovalCode. 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)

* Currently in use by Japan Acquirer Services (JAS).

AVSResult
char* (read-only)
Default Value: ""

Contains the Address Verification System result code.

This one character field 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

Balance
char* (read-only)
Default Value: ""

Available balance remaining on card.

This field 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 Balance 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.

Code
char* (read-only)
Default Value: ""

Indicates the status of the authorization request.

This field 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 Text 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 Codes are listed in the table of contents.

CVVResult
char* (read-only)
Default Value: ""

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character field 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 Text 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.

HostMessageId
char* (read-only)
Default Value: ""

Unique host message identifier (Reserved for future use).

This field will contain a unique host message identifier assigned by the authorizing system and returned in Debit, EBT, and Gift card response messages. This field is reserved for future use and will most likely contain spaces.

NetworkId
char* (read-only)
Default Value: ""

Identification code of the network on which the transaction was authorized.

This field indicates the network through which the transaction was authorized. If this field 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 NetworkId 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 field is valid for Debit card and EBT card transactions only. It will be ignored for all other TransactionTypes.

RetrievalNumber
char* (read-only)
Default Value: ""

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

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

ReturnedACI
char* (read-only)
Default Value: ""

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field 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 field and submit it in the batch settlement. The POS system should not interpret any relationship between this field and the presence of data in either the TransactionId or ValidationCode fields.

SettleDate
char* (read-only)
Default Value: ""

Date at which the Debit, EBT, or Gift Card transaction will settle.

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

Text
char* (read-only)
Default Value: ""

Text information that describes each response code.

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

Trace
char* (read-only)
Default Value: ""

System Trace Audit Number returned for Debit transactions.

This field contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages.

TransactionDate
char* (read-only)
Default Value: ""

Local transaction date returned from the server in MMddyy format.

This six digit field contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This field should be recorded and submitted in the Batch Settlement.

TransactionId
char* (read-only)
Default Value: ""

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character field 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 field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

TransactionNumber
char* (read-only)
Default Value: ""

Check this field against the original Transaction Number.

This field 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 field should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

TransactionTime
char* (read-only)
Default Value: ""

Local transaction time returned from the server in HHmmss format.

This six digit field contains the Local Transaction Time returned by the authorizing system. This field should be recorded and submitted in the Batch Settlement.

ValidationCode
char* (read-only)
Default Value: ""

This optional field contains information generated by the card issuer.

This optional four character field 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 field. Data returned in this field should be recorded and submitted as part of a Batch Settlement.

Constructors

TSYSDebitResponse()

TSYSMerchant Type

Contains the merchant's setup information.

Syntax

DPaymentsSDKTSYSMerchant (declared in dpaymentssdk.h)

Remarks

This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other fields that identify the merchant to the TSYS server. Some of the information in these fields will be included on the customer's credit card statement, such as the merchant's Name, State, ServicePhone, etc.

The following fields are available:

BankId
CategoryCode
City
CountryCode
CurrencyCode
Language
Name
Number
Phone
ServicePhone
State
StoreNumber
StreetAddress
TerminalNumber
TimeZone
Zip

Fields

BankId
char*
Default Value: ""

The number which identifies the merchant's bank or processor.

This field 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 field may not remain zero-filled.

Note, the TSYS Server uses the Merchant's BankId and Number 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.

CategoryCode
char*
Default Value: ""

Classifies a merchant by the type of store.

This four digit field 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).

City
char*
Default Value: ""

Merchant's City

For Retail (Card Present) transactions, this field should contain the city in which the merchant is located. This is an optional field. However if it is specified, the Name and State must also be specified.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this field is ignored. ServicePhone is used for those industries instead of City (this does not apply to MasterCard).

Note: This field must contain the same data used in the batch settlement. The first character of this field may not be a space. This field may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this field is 13 characters.

CountryCode
char*
Default Value: "840"

Identifies the country where the merchant is located.

This field 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".

CurrencyCode
char*
Default Value: "840"

Identifies the type of currency used by the merchant.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

Language
char*
Default Value: "00"

Designates the language that response messages will be returned in.

This field contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This field 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.

Name
char*
Default Value: ""

Name of the merchant.

This 25 character field 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 field may not be a space. This field must contain the same value in both authorization and batch settlement.

This is an optional field. However if this field is specified, the State and City (Retail) or State and ServicePhone (E-Commerce) must also be specified.

This field may contain alphanumeric and punctuation characters. The maximum length of this field is 25 characters.

Number
char*
Default Value: ""

A unique number used to identify the merchant within the VisaNet system.

This 12 digit field contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.

Phone
char*
Default Value: ""

Merchant's phone number.

This field contains the Merchant's business phone number. This can be the same as the customer service phone number.

ServicePhone
char*
Default Value: ""

Merchant's customer service number.

This field 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 field is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

State
char*
Default Value: ""

State or province that the merchant is located in.

This two character field contains the merchant state or province provided by the signing member or processor. This field must contain the same data used in the batch settlement.

This is an optional field. However if it is specified the Merchant Name and City (Retail) or Name and ServicePhone (E-Commerce) must also be specified.

StoreNumber
char*
Default Value: ""

Used to identify a specific merchant's store within the VisaNet system.

This four digit field contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This field must be right-justified and zero-filled.

StreetAddress
char*
Default Value: ""

Merchant's street address.

This 25 character field 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.

TerminalNumber
char*
Default Value: ""

Used to identify a unique terminal within a merchant location.

This four digit field 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 field 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 field must be right-justified and zero-filled.

TimeZone
char*
Default Value: "705"

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.

Bytes #2-3:

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.

Zip
char*
Default Value: ""

Zip code where the merchant that initiated this transaction is located.

This field 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 field will be assigned by the signing member or processor.

This field is alphanumeric, with a maximum length of nine characters. Spaces and dashes are automatically stripped when the field is set.

Constructors

TSYSMerchant()

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

ActivateTerminal: Authenticates a POS device with TSYS.

This is an action config which when called will authenticate a POS device with TSYS. Authentication is required when processing transactions using Voltage Encryption or Tokenization. An AuthenticationCode is required to be specified, as is Zip and/or ServicePhone, to perform authentication. After a POS device is successfully authenticated, GenKey will be populated.

AuthenticationCode: An alphanumeric code provided to the POS user for input when authenticating a POS device.

This field is used to specify the AuthenticationCode, assigned by TSYS, to authenticate a POS device (made via a call to ActivateTerminal).

AuthorizationIndicator: The type of authorization request.

This field defines the type of authorization request and must be included on all MasterCard authorization request transactions.

Valid values are:


Code	Description
P	Pre Authorization
F	Final Authorization
U	Undefined Authorization

CardholderId: Specifies the method used to verify the identity of the cardholder.

By default the class automatically computes the CardholderId based on several factors. Changing this config setting will override this automatic calculation. Clear this setting to "" (empty string) to restore automatic calculation. Please see the TSYSDetailRecord class's CardholderId property for more information.

DeactivateTerminal: Deactivates a POS device with TSYS.

This is an action config which when called will deactivate the POS device specified via GenKey with TSYS.

GatewayID: A unique value to identify a Gateway or Aggregator.

This 10 character field provides a unique value to identify a Gateway or Aggregator. This number is provided by TSYS Acquiring Solutions during the certification process.

GenKey: A randomly generated string of alphanumeric characters identifying the terminal.

This field is used to specify retrieve or specify a GenKey value for a terminal. This field will be populated after a successful call to ActivateTerminal is made. The Genkey must be stored in the POS device, must be sent with every request to the TSYS Acquiring Solutions host after authentication (by setting this field), and will be checked against the terminal hierarchy. A GenKey value is required when processing transactions using Voltage Encryption or Tokenization.

Port: The port to which transactions are posted.

This is port that this class connects to on the server. The default value for TSYS is 5003 for the live server, and 5004 for the test server. The default live server values for Heartland is 22341 for Authorization and 22342 for Settlement. The Heartland test server values are 12341 for Authorization and 12342 for Settlement.

POSDataCode: Specifies the condition of the POS device used at the time of the transaction.

This configuration setting takes a semi-colon separated list of name-value pairs. The available field names and their applicable values can be found below. The fields can be set in any order and not all fields are required to be set (unless you wish to change their default values).

Code Example:

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

ResponseCardholderVerification: Verification results for cardholder identification data (extended AVS).

This response data is returned when SendExtendedAVS is set to 'True' and is only available for American Express and Discover cards. This data is arranged in order of 5 bytes, one for each result of a cardholder identification data element:


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

ResponseStoreNumber: Check this field against the original Merchant StoreNumber.

The value of this field is used to correctly match responses with transactions by comparing its value to that of the StoreNumber. This is particularly useful when making a multi-merchant or multi-store routing system. If the system that originally made the transaction receives a response where the ResponseStoreNumber is not identical to the StoreNumber the transaction should not be stored for batch settlement. This field is read-only.

ResponseTerminalNumber: Check this field against the original Merchant TerminalNumber.

The value of this field is used to correctly match responses with transactions by comparing its value to that of TerminalNumber. This is particularly useful when making a multi-terminal routing system within a merchant location. If the terminal that originally made the transaction receives a response where the ResponseTerminalNumber is not identical to the TerminalNumber, the transaction should not be stored for batch settlement. This field is read-only.

Retry: Set this to retry a failed transaction.

If an authorization returns ambiguously or times out without receiving a response, you may send the same transaction over again with this Retry flag set to True. This will prevent you from double-charging your customers in the case of a communications error (only available for credit card transactions. Does not apply to Debit, Gift Card, or EBT transactions).

SendExtendedAVS: Specifies whether to send extended AVS data.

When set to 'True', AVS data will be sent in the extended AVS field for the transaction. ResponseCardholderVerification will contain the extended AVS verification results. When set to 'False' (default value), the CustomerAddress and CustomerZip values will be sent using the simple AVS data fields.

Server: The server to which transactions are posted.

This is name of the server to which all transactions are posted. Do not use an IP address, use the actual name, as a server's IP address may change. The default (Live) TSYS server is "ssl2.vitalps.net", but you may use "ssltest.tsysacquiring.net" for testing. The default (Live) Heartland server is "txns.secureexchange.net", but you may use "test.txns.secureexchange.net" for testing. Note that there are several BankIds and Numbers that will always run in test mode regardless of whether you are using the live server. See the included demos for examples.

TsysETB: The Encryption Transmission Block TSYS uses to decrypt encrypted data.

This field is used to specify the Base-64 encoded ETB (Encryption Transmission Block) used by TSYS to decrypt Voltage encrypted data. The value is retrieved from the POS device containing the Voltage encryption software. When specified, the transaction will be sent as a Voltage encrypted transaction. The encrypted card data will be specified as normal via the MagneticStripe or Number fields.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

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

The following is a list of valid code page identifiers for Mac OS only:


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

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

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.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

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.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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 Number and BankId).
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 nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot 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] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is 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 is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).