TSYSReversal Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSReversal class is used to reverse transactions that were previously authorized using the TSYSRETAIL , TSYSECOMMERCE , or TSYSHEALTHCARE classes.

Syntax

TSYSReversal

Remarks

Credit card authorizations put a hold on funds on a credit card, until the time at which the transaction is settled or the hold expires. Reversals are similar to voids, but they're online transactions. Voids are off-line. This means that a void will not release the hold on funds at the next batch settlement (usually). Authorization reversals are online transactions, meaning that the hold on funds is immediately removed, and the cardholder may use the funds on the card for other purchases.

This class works for all IndustryTypes and supports Credit, EBT, and Debit card transactions. Both partial and full reversals are supported. When a transaction has been fully reversed (SettlementAmount is "0") the original transaction must not be included in the batch settlement. However, if the transaction has been only partially reversed, the original detail record must be updated with the new settlement amount. The SettlementAmount property in the detail record should be set to the SettlementAmount sent in the reversal transaction. The AuthorizedAmount in the detail record should contain the transaction amount authorized from the original authorization request message. This value is retrieved from the detail aggregate, however you may set it using the TSYSDetailRecord's AuthorizedAmount property. You must also set the PartiallyReversed configuration setting to True. For instance:

TSYSRetail.TransactionAmount = "10000"; // $100.00 TSYSRetail.Authorize(); TSYSReversal.ParseAggregate(TSYSRetail.GetDetailAggregate()); TSYSReversal.ReversalCode = rcCustomerDirected; TSYSReversal.ReversalType = rtPreSettlement; TSYSReversal.SettlementAmount = "5000"; // $50.00 TSYSReversal.Reverse(); TSYSDetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()); TSYSDetailRecord.AuthorizedAmount = "10000"; // Original authorized amount TSYSDetailRecord.SettlementAmount = "5000"; // Amount you wish to settle (need not be equal to AuthorizedAmount) TSYSDetailRecord.Config("PartiallyReversed=True"); TSYSSettle.DetailRecords.Add(new TSYSRecordType(TSYSDetailRecord.GetDetailAggregate()));

So long as you pass aggregates around, the TSYSDetailRecord's TotalAuthorizedAmount will still reflect the originally authorized amount. You may change this using the TSYSDetailRecord's TotalAuthorizedAmount property.

When the class receives a response from the Vital/TSYS servers, the result of the reversal will be displayed in several Response properties. The ResponseCode indicates whether the reversal was approved, and the remaining response properties should exactly match the response from the original authorization.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AgentBankNumber Property (TSYSReversal Class)

Identifies a specific agent entity of the member bank or processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAgentBankNumber();
int SetAgentBankNumber(const char* lpszAgentBankNumber);

Unicode (Windows)
LPWSTR GetAgentBankNumber();
INT SetAgentBankNumber(LPCWSTR lpszAgentBankNumber);

char* dpaymentssdk_tsysreversal_getagentbanknumber(void* lpObj);
int dpaymentssdk_tsysreversal_setagentbanknumber(void* lpObj, const char* lpszAgentBankNumber);

QString GetAgentBankNumber();
int SetAgentBankNumber(QString qsAgentBankNumber);

Default Value

""

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.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

AgentChainNumber Property (TSYSReversal Class)

Identifies a specific chain of an agent organization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAgentChainNumber();
int SetAgentChainNumber(const char* lpszAgentChainNumber);

Unicode (Windows)
LPWSTR GetAgentChainNumber();
INT SetAgentChainNumber(LPCWSTR lpszAgentChainNumber);

char* dpaymentssdk_tsysreversal_getagentchainnumber(void* lpObj);
int dpaymentssdk_tsysreversal_setagentchainnumber(void* lpObj, const char* lpszAgentChainNumber);

QString GetAgentChainNumber();
int SetAgentChainNumber(QString qsAgentChainNumber);

Default Value

""

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.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

ApprovalCode Property (TSYSReversal Class)

The Response ApprovalCode of the transaction being reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovalCode();
int SetApprovalCode(const char* lpszApprovalCode);

Unicode (Windows)
LPWSTR GetApprovalCode();
INT SetApprovalCode(LPCWSTR lpszApprovalCode);

char* dpaymentssdk_tsysreversal_getapprovalcode(void* lpObj);
int dpaymentssdk_tsysreversal_setapprovalcode(void* lpObj, const char* lpszApprovalCode);

QString GetApprovalCode();
int SetApprovalCode(QString qsApprovalCode);

Default Value

""

Remarks

This must exactly match the ResponseApprovalCode from the original authorization.

Data Type

String

BatchNumber Property (TSYSReversal Class)

The batch number that this transaction will be included in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Unicode (Windows)
INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);

int dpaymentssdk_tsysreversal_getbatchnumber(void* lpObj);
int dpaymentssdk_tsysreversal_setbatchnumber(void* lpObj, int iBatchNumber);

int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Default Value

1

Remarks

Unlike regular credit card transactions, Debit transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSDebit or TSYSBenefit class's BatchNumber property during the authorization.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

Integer

CardType Property (TSYSReversal Class)

Type of credit card being used in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardType();
int SetCardType(int iCardType);

Unicode (Windows)
INT GetCardType();
INT SetCardType(INT iCardType);

CT_UNKNOWN(0), 
CT_VISA(1), 
CT_MASTER_CARD(2), 
CT_AMEX(3), 
CT_DISCOVER(4), 
CT_DINERS(5), 
CT_JCB(6), 
CT_VISA_ELECTRON(7), 
CT_MAESTRO(8), 
CT_LASER(10)

int dpaymentssdk_tsysreversal_getcardtype(void* lpObj);
int dpaymentssdk_tsysreversal_setcardtype(void* lpObj, int iCardType);

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

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardCVVData();
int SetCardCVVData(const char* lpszCardCVVData);

Unicode (Windows)
LPWSTR GetCardCVVData();
INT SetCardCVVData(LPCWSTR lpszCardCVVData);

char* dpaymentssdk_tsysreversal_getcardcvvdata(void* lpObj);
int dpaymentssdk_tsysreversal_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

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

Default Value

""

Remarks

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

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

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

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

This property is not available at design time.

Data Type

String

CardCVVPresence Property (TSYSReversal Class)

Indicates the presence of the card verification value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Unicode (Windows)
INT GetCardCVVPresence();
INT SetCardCVVPresence(INT iCardCVVPresence);

CVP_NOT_PROVIDED(0), 
CVP_PROVIDED(1), 
CVP_ILLEGIBLE(2), 
CVP_NOT_ON_CARD(3)

int dpaymentssdk_tsysreversal_getcardcvvpresence(void* lpObj);
int dpaymentssdk_tsysreversal_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

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

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (TSYSReversal Class)

This property contains a 1-character code identifying the source of the customer data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

Unicode (Windows)
INT GetCardEntryDataSource();
INT SetCardEntryDataSource(INT iCardEntryDataSource);

EDS_TRACK_1(0), 
EDS_TRACK_2(1), 
EDS_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
EDS_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
EDS_MANUAL_ENTRY_NO_CARD_READER(4), 
EDS_TRACK_1CONTACTLESS(5), 
EDS_TRACK_2CONTACTLESS(6), 
EDS_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
EDS_IVR(8), 
EDS_KIOSK(9)

int dpaymentssdk_tsysreversal_getcardentrydatasource(void* lpObj);
int dpaymentssdk_tsysreversal_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

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

Default Value

0

Remarks

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

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.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (TSYSReversal Class)

Expiration month of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Unicode (Windows)
INT GetCardExpMonth();
INT SetCardExpMonth(INT iCardExpMonth);

int dpaymentssdk_tsysreversal_getcardexpmonth(void* lpObj);
int dpaymentssdk_tsysreversal_setcardexpmonth(void* lpObj, int iCardExpMonth);

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

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (TSYSReversal Class)

Expiration year of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Unicode (Windows)
INT GetCardExpYear();
INT SetCardExpYear(INT iCardExpYear);

int dpaymentssdk_tsysreversal_getcardexpyear(void* lpObj);
int dpaymentssdk_tsysreversal_setcardexpyear(void* lpObj, int iCardExpYear);

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

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardIsEncrypted();
int SetCardIsEncrypted(int bCardIsEncrypted);

Unicode (Windows)
BOOL GetCardIsEncrypted();
INT SetCardIsEncrypted(BOOL bCardIsEncrypted);

int dpaymentssdk_tsysreversal_getcardisencrypted(void* lpObj);
int dpaymentssdk_tsysreversal_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

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

Default Value

FALSE

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardMagneticStripe();
int SetCardMagneticStripe(const char* lpszCardMagneticStripe);

Unicode (Windows)
LPWSTR GetCardMagneticStripe();
INT SetCardMagneticStripe(LPCWSTR lpszCardMagneticStripe);

char* dpaymentssdk_tsysreversal_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_tsysreversal_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

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

Default Value

""

Remarks

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

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

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

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (TSYSReversal Class)

Customer's credit card number for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardNumber();
int SetCardNumber(const char* lpszCardNumber);

Unicode (Windows)
LPWSTR GetCardNumber();
INT SetCardNumber(LPCWSTR lpszCardNumber);

char* dpaymentssdk_tsysreversal_getcardnumber(void* lpObj);
int dpaymentssdk_tsysreversal_setcardnumber(void* lpObj, const char* lpszCardNumber);

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

Default Value

""

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

CardholderId Property (TSYSReversal Class)

The CardholderId code for this reversal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardholderId();
int SetCardholderId(const char* lpszCardholderId);

Unicode (Windows)
LPWSTR GetCardholderId();
INT SetCardholderId(LPCWSTR lpszCardholderId);

char* dpaymentssdk_tsysreversal_getcardholderid(void* lpObj);
int dpaymentssdk_tsysreversal_setcardholderid(void* lpObj, const char* lpszCardholderId);

QString GetCardholderId();
int SetCardholderId(QString qsCardholderId);

Default Value

"@"

Remarks

This 1-character property contains a code that specifies the method used to verify the identity of the cardholder. The value may be used in conjunction with AVS and ACI indicators. The following table lists all of the supported cardholder identification codes, but please note that some codes are Direct Marketing-specific and some are Retail-specific.

NOTE: The CardholderId for reversals is applicable to the reversal transaction itself, NOT to the transaction being reversed. Generally the card will be present and the cardholder will sign the receipt, so for most cases this should be "@".

Data Type

String

CashBackAmount Property (TSYSReversal Class)

Amount returned to the customer in cash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBackAmount();
int SetCashBackAmount(const char* lpszCashBackAmount);

Unicode (Windows)
LPWSTR GetCashBackAmount();
INT SetCashBackAmount(LPCWSTR lpszCashBackAmount);

char* dpaymentssdk_tsysreversal_getcashbackamount(void* lpObj);
int dpaymentssdk_tsysreversal_setcashbackamount(void* lpObj, const char* lpszCashBackAmount);

QString GetCashBackAmount();
int SetCashBackAmount(QString qsCashBackAmount);

Default Value

""

Remarks

The amount of CashBack specified in the authorization request. This property should be the same number you set to the TSYSDebit or TSYSBenefit class's CashBackAmount property during the authorization.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

IndustryType Property (TSYSReversal Class)

Code which indicates the industry the merchant is engaged in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIndustryType();
int SetIndustryType(int iIndustryType);

Unicode (Windows)
INT GetIndustryType();
INT SetIndustryType(INT iIndustryType);

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_tsysreversal_getindustrytype(void* lpObj);
int dpaymentssdk_tsysreversal_setindustrytype(void* lpObj, int iIndustryType);

int GetIndustryType();
int SetIndustryType(int iIndustryType);

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Data Type

Integer

MerchantBankId Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantBankId();
int SetMerchantBankId(const char* lpszMerchantBankId);

Unicode (Windows)
LPWSTR GetMerchantBankId();
INT SetMerchantBankId(LPCWSTR lpszMerchantBankId);

char* dpaymentssdk_tsysreversal_getmerchantbankid(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantbankid(void* lpObj, const char* lpszMerchantBankId);

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

Default Value

""

Remarks

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

This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantCategoryCode Property (TSYSReversal Class)

Classifies a merchant by the type of store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCategoryCode();
int SetMerchantCategoryCode(const char* lpszMerchantCategoryCode);

Unicode (Windows)
LPWSTR GetMerchantCategoryCode();
INT SetMerchantCategoryCode(LPCWSTR lpszMerchantCategoryCode);

char* dpaymentssdk_tsysreversal_getmerchantcategorycode(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantcategorycode(void* lpObj, const char* lpszMerchantCategoryCode);

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

Default Value

""

Remarks

Classifies a merchant by the type of store.

This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).

Data Type

String

MerchantCity Property (TSYSReversal Class)

Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCity();
int SetMerchantCity(const char* lpszMerchantCity);

Unicode (Windows)
LPWSTR GetMerchantCity();
INT SetMerchantCity(LPCWSTR lpszMerchantCity);

char* dpaymentssdk_tsysreversal_getmerchantcity(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantcity(void* lpObj, const char* lpszMerchantCity);

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

Default Value

""

Remarks

Merchant's City

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

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

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

Data Type

String

MerchantCountryCode Property (TSYSReversal Class)

Identifies the country where the merchant is located.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCountryCode();
int SetMerchantCountryCode(const char* lpszMerchantCountryCode);

Unicode (Windows)
LPWSTR GetMerchantCountryCode();
INT SetMerchantCountryCode(LPCWSTR lpszMerchantCountryCode);

char* dpaymentssdk_tsysreversal_getmerchantcountrycode(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantcountrycode(void* lpObj, const char* lpszMerchantCountryCode);

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

Default Value

"840"

Remarks

Identifies the country where the merchant is located.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".

Data Type

String

MerchantCurrencyCode Property (TSYSReversal Class)

Identifies the type of currency used by the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantCurrencyCode();
int SetMerchantCurrencyCode(const char* lpszMerchantCurrencyCode);

Unicode (Windows)
LPWSTR GetMerchantCurrencyCode();
INT SetMerchantCurrencyCode(LPCWSTR lpszMerchantCurrencyCode);

char* dpaymentssdk_tsysreversal_getmerchantcurrencycode(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantcurrencycode(void* lpObj, const char* lpszMerchantCurrencyCode);

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

Default Value

"840"

Remarks

Identifies the type of currency used by the merchant.

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

Data Type

String

MerchantLanguage Property (TSYSReversal Class)

Designates the language that response messages will be returned in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantLanguage();
int SetMerchantLanguage(const char* lpszMerchantLanguage);

Unicode (Windows)
LPWSTR GetMerchantLanguage();
INT SetMerchantLanguage(LPCWSTR lpszMerchantLanguage);

char* dpaymentssdk_tsysreversal_getmerchantlanguage(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantlanguage(void* lpObj, const char* lpszMerchantLanguage);

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

Default Value

"00"

Remarks

Designates the language that response messages will be returned in.

This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.

Data Type

String

MerchantName Property (TSYSReversal Class)

Name of the merchant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantName();
int SetMerchantName(const char* lpszMerchantName);

Unicode (Windows)
LPWSTR GetMerchantName();
INT SetMerchantName(LPCWSTR lpszMerchantName);

char* dpaymentssdk_tsysreversal_getmerchantname(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantname(void* lpObj, const char* lpszMerchantName);

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

Default Value

""

Remarks

Name of the merchant.

This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.

This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.

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

Data Type

String

MerchantNumber Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber);

Unicode (Windows)
LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);

char* dpaymentssdk_tsysreversal_getmerchantnumber(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);

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

Default Value

""

Remarks

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

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

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantPhone Property (TSYSReversal Class)

Merchant's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantPhone();
int SetMerchantPhone(const char* lpszMerchantPhone);

Unicode (Windows)
LPWSTR GetMerchantPhone();
INT SetMerchantPhone(LPCWSTR lpszMerchantPhone);

char* dpaymentssdk_tsysreversal_getmerchantphone(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantphone(void* lpObj, const char* lpszMerchantPhone);

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

Default Value

""

Remarks

Merchant's phone number.

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

Data Type

String

MerchantServicePhone Property (TSYSReversal Class)

Merchant's customer service number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantServicePhone();
int SetMerchantServicePhone(const char* lpszMerchantServicePhone);

Unicode (Windows)
LPWSTR GetMerchantServicePhone();
INT SetMerchantServicePhone(LPCWSTR lpszMerchantServicePhone);

char* dpaymentssdk_tsysreversal_getmerchantservicephone(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantservicephone(void* lpObj, const char* lpszMerchantServicePhone);

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

Default Value

""

Remarks

Merchant's customer service number.

This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

Data Type

String

MerchantState Property (TSYSReversal Class)

State or province that the merchant is located in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantState();
int SetMerchantState(const char* lpszMerchantState);

Unicode (Windows)
LPWSTR GetMerchantState();
INT SetMerchantState(LPCWSTR lpszMerchantState);

char* dpaymentssdk_tsysreversal_getmerchantstate(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantstate(void* lpObj, const char* lpszMerchantState);

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

Default Value

""

Remarks

State or province that the merchant is located in.

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

This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.

Data Type

String

MerchantStoreNumber Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantStoreNumber();
int SetMerchantStoreNumber(const char* lpszMerchantStoreNumber);

Unicode (Windows)
LPWSTR GetMerchantStoreNumber();
INT SetMerchantStoreNumber(LPCWSTR lpszMerchantStoreNumber);

char* dpaymentssdk_tsysreversal_getmerchantstorenumber(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantstorenumber(void* lpObj, const char* lpszMerchantStoreNumber);

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

Default Value

""

Remarks

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

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

Data Type

String

MerchantStreetAddress Property (TSYSReversal Class)

Merchant's street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantStreetAddress();
int SetMerchantStreetAddress(const char* lpszMerchantStreetAddress);

Unicode (Windows)
LPWSTR GetMerchantStreetAddress();
INT SetMerchantStreetAddress(LPCWSTR lpszMerchantStreetAddress);

char* dpaymentssdk_tsysreversal_getmerchantstreetaddress(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantstreetaddress(void* lpObj, const char* lpszMerchantStreetAddress);

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

Default Value

""

Remarks

Merchant's street address.

This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.

Data Type

String

MerchantTerminalNumber Property (TSYSReversal Class)

Used to identify a unique terminal within a merchant location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTerminalNumber();
int SetMerchantTerminalNumber(const char* lpszMerchantTerminalNumber);

Unicode (Windows)
LPWSTR GetMerchantTerminalNumber();
INT SetMerchantTerminalNumber(LPCWSTR lpszMerchantTerminalNumber);

char* dpaymentssdk_tsysreversal_getmerchantterminalnumber(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantterminalnumber(void* lpObj, const char* lpszMerchantTerminalNumber);

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

Default Value

""

Remarks

Used to identify a unique terminal within a merchant location.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.

Data Type

String

MerchantTimeZone Property (TSYSReversal Class)

Specifies the GMT offset used to calculate the local time within the VisaNet system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantTimeZone();
int SetMerchantTimeZone(const char* lpszMerchantTimeZone);

Unicode (Windows)
LPWSTR GetMerchantTimeZone();
INT SetMerchantTimeZone(LPCWSTR lpszMerchantTimeZone);

char* dpaymentssdk_tsysreversal_getmerchanttimezone(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchanttimezone(void* lpObj, const char* lpszMerchantTimeZone);

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

Default Value

"705"

Remarks

Specifies the GMT offset used to calculate the local time within the VisaNet system.

This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.

Byte #1:

If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.

Data Type

String

MerchantZip Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantZip();
int SetMerchantZip(const char* lpszMerchantZip);

Unicode (Windows)
LPWSTR GetMerchantZip();
INT SetMerchantZip(LPCWSTR lpszMerchantZip);

char* dpaymentssdk_tsysreversal_getmerchantzip(void* lpObj);
int dpaymentssdk_tsysreversal_setmerchantzip(void* lpObj, const char* lpszMerchantZip);

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

Default Value

""

Remarks

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

This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.

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

Data Type

String

MerchantABANumber Property (TSYSReversal Class)

Merchant's routing number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantABANumber();
int SetMerchantABANumber(const char* lpszMerchantABANumber);

Unicode (Windows)
LPWSTR GetMerchantABANumber();
INT SetMerchantABANumber(LPCWSTR lpszMerchantABANumber);

char* dpaymentssdk_tsysreversal_getmerchantabanumber(void* lpObj);
int dpaymentssdk_tsysreversal_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.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

MerchantSettlementAgent Property (TSYSReversal Class)

Merchant's settling agent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantSettlementAgent();
int SetMerchantSettlementAgent(const char* lpszMerchantSettlementAgent);

Unicode (Windows)
LPWSTR GetMerchantSettlementAgent();
INT SetMerchantSettlementAgent(LPCWSTR lpszMerchantSettlementAgent);

char* dpaymentssdk_tsysreversal_getmerchantsettlementagent(void* lpObj);
int dpaymentssdk_tsysreversal_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.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

NetworkId Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNetworkId();
int SetNetworkId(const char* lpszNetworkId);

Unicode (Windows)
LPWSTR GetNetworkId();
INT SetNetworkId(LPCWSTR lpszNetworkId);

char* dpaymentssdk_tsysreversal_getnetworkid(void* lpObj);
int dpaymentssdk_tsysreversal_setnetworkid(void* lpObj, const char* lpszNetworkId);

QString GetNetworkId();
int SetNetworkId(QString qsNetworkId);

Default Value

""

Remarks

This property indicates the network through which the transaction was authorized. This value should be set to the NetworkId returned in the response of the original TSYSDebit or TSYSBenefit authorization.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

ReimbursementAttribute Property (TSYSReversal Class)

Indicates the type of fee applicable to this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReimbursementAttribute();
int SetReimbursementAttribute(int iReimbursementAttribute);

Unicode (Windows)
INT GetReimbursementAttribute();
INT SetReimbursementAttribute(INT iReimbursementAttribute);

RA_STANDARD_RETAIL(0), 
RA_QUALIFIED_GROCERY(1), 
RA_PRE_EXISTING_RETAIL(2), 
RA_PRE_EXISTING_GROCERY(3), 
RA_NON_DEBIT(4), 
RA_TAX_EXEMPT(5)

int dpaymentssdk_tsysreversal_getreimbursementattribute(void* lpObj);
int dpaymentssdk_tsysreversal_setreimbursementattribute(void* lpObj, int iReimbursementAttribute);

int GetReimbursementAttribute();
int SetReimbursementAttribute(int iReimbursementAttribute);

Default Value

0

Remarks

This property contains the reimbursement attribute assigned by the signing member or processor. This property designates the Reimbursement Fee applicable to a transaction. This value should be set to the value of the ReimbursementAttribute of the original TSYSDebit authorization. The following values are valid:

This field is only used for Debit and Benefit/EBT reversals.

Data Type

Integer

ResponseApprovalCode Property (TSYSReversal Class)

Contains an authorization code when a transaction has been approved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* dpaymentssdk_tsysreversal_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved.

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

This property is read-only and not available at design time.

Data Type

String

ResponseAuthorizedAmount Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthorizedAmount();

Unicode (Windows)
LPWSTR GetResponseAuthorizedAmount();

char* dpaymentssdk_tsysreversal_getresponseauthorizedamount(void* lpObj);

QString GetResponseAuthorizedAmount();

Default Value

""

Remarks

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

The ResponseAuthorizedAmount represents the actual approved transaction amount when a transaction request is received from a client using the PartialRedemption option. If PartialAuthorization is set to True, then ResponseAuthorizedAmount will be the amount of the TransactionAmount that was actually covered by the remaining balance on the card when the requested authorization amount exceeds the available card balance.

For example, a card may have an available balance of $7.50, but the cardholder does not know this. Rather than submit a Balance Inquiry transaction followed by a Purchase transaction, the merchant can use the PartialAuthorization option. If a purchase for $10.00 is attempted on the card with a $7.50 balance, the system will respond with an approval, and the ResponseAuthorizedAmount will represent the approved amount of $7.50.In this case, the ResponseCode will also be "00" (Approval). The merchant must tender the difference between the requested TransactionAmount and the ResponseAuthorizedAmount using another form of payment. If the transaction is fully covered by the balance remaining on the FSA card (ie, the current available balance is greater than the TransactionAmount) then this property will be "0" or "".

If the card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialAuthorization.

This property is read-only.

Data Type

String

ResponseAuthSource Property (TSYSReversal Class)

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAuthSource();

Unicode (Windows)
LPWSTR GetResponseAuthSource();

char* dpaymentssdk_tsysreversal_getresponseauthsource(void* lpObj);

QString GetResponseAuthSource();

Default Value

""

Remarks

Indicates the source of the authorization code stored in ResponseApprovalCode.

This property contains a one character code indicating the source of the ResponseApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes are:

This property is read-only and not available at design time.

Data Type

String

ResponseAVSResult Property (TSYSReversal Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* dpaymentssdk_tsysreversal_getresponseavsresult(void* lpObj);

QString GetResponseAVSResult();

Default Value

""

Remarks

Contains the Address Verification System result code.

This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. Valid AVS codes are:

*AVS Result Code for International addresses only

This property is read-only and not available at design time.

Data Type

String

ResponseCardLevel Property (TSYSReversal Class)

This property contains a two-character code created by Visa during the authorization process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCardLevel();

Unicode (Windows)
LPWSTR GetResponseCardLevel();

char* dpaymentssdk_tsysreversal_getresponsecardlevel(void* lpObj);

QString GetResponseCardLevel();

Default Value

""

Remarks

This property contains a two-character code created by Visa during the authorization process.

The current list of possible return values can be found in the table of contents.

This property is read-only and not available at design time.

Data Type

String

ResponseCode Property (TSYSReversal Class)

Indicates the status of the authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* dpaymentssdk_tsysreversal_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

""

Remarks

Indicates the status of the authorization request.

This property contains a two character response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents an approval. A response code of "85" represents a successful card verification (when the TransactionType set to dcCardAuthentication). A response code of "10" indicates that the transaction was partially approved for a lesser amount. In such cases, the partially authorized amount can be retrieved via ResponseAuthorizedAmount config. All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

A list of valid result ResponseCodes are listed in the table of contents.

This property is read-only and not available at design time.

Data Type

String

ResponseCommercialCardType Property (TSYSReversal Class)

Response property that indicates whether the card is a commercial card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseCommercialCardType();

Unicode (Windows)
INT GetResponseCommercialCardType();

TCC_NOT_COMMERCIAL(0), 
TCC_BUSINESS_CARD(1), 
TCC_VISA_COMMERCE(2), 
TCC_CORPORATE_CARD(3), 
TCC_PURCHASE_CARD(4)

int dpaymentssdk_tsysreversal_getresponsecommercialcardtype(void* lpObj);

int GetResponseCommercialCardType();

Default Value

0

Remarks

Response property that indicates whether the card is a commercial card.

If you wish to support Corporate Purchasing Cards with Level II or Level III data, you should inspect the value of this property after a successful authorization. If the Vital/TSYS host indicates that the authorized card is a commercial card, you may use the TSYSLevel2 or TSYSLevel3 classs to add the extra data required during settlement.

Possible values for this property include:

This property is only valid after a successful authorization request and response.

This property is read-only and not available at design time.

Data Type

Integer

ResponseCVVResult Property (TSYSReversal Class)

Contains the returned CVV result code if it was requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVVResult();

Unicode (Windows)
LPWSTR GetResponseCVVResult();

char* dpaymentssdk_tsysreversal_getresponsecvvresult(void* lpObj);

QString GetResponseCVVResult();

Default Value

""

Remarks

Contains the returned CVV result code if it was requested.

If a CVV value was sent in the authorization request, then this one character property will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CVV data is included in the authorization. Instead, an AMEX transaction will be declined if the CVV value does not match, with an ResponseText indicating such. The following is a list of current result codes:

This property is read-only and not available at design time.

Data Type

String

ResponseRetrievalNumber Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseRetrievalNumber();

Unicode (Windows)
LPWSTR GetResponseRetrievalNumber();

char* dpaymentssdk_tsysreversal_getresponseretrievalnumber(void* lpObj);

QString GetResponseRetrievalNumber();

Default Value

""

Remarks

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

This property contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.

This property is read-only and not available at design time.

Data Type

String

ResponseReturnedACI Property (TSYSReversal Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseReturnedACI();

Unicode (Windows)
LPWSTR GetResponseReturnedACI();

char* dpaymentssdk_tsysreversal_getresponsereturnedaci(void* lpObj);

QString GetResponseReturnedACI();

Default Value

""

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character property contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this property and submit it in the batch settlement. The POS system should not interpret any relationship between this property and the presence of data in either the ResponseTransactionId or ResponseValidationCode properties.

This property is read-only and not available at design time.

Data Type

String

ResponseText Property (TSYSReversal Class)

Text information that describes each response code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* dpaymentssdk_tsysreversal_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

Text information that describes each response code.

This property contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.

The English-language response text messages are listed in the table of contents.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionDate Property (TSYSReversal Class)

Local transaction date returned from the server in MMddyy format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionDate();

Unicode (Windows)
LPWSTR GetResponseTransactionDate();

char* dpaymentssdk_tsysreversal_getresponsetransactiondate(void* lpObj);

QString GetResponseTransactionDate();

Default Value

""

Remarks

Local transaction date returned from the server in MMddyy format.

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

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionId Property (TSYSReversal Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* dpaymentssdk_tsysreversal_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and submitted in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionNumber Property (TSYSReversal Class)

Check this property against the original Transaction Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionNumber();

Unicode (Windows)
LPWSTR GetResponseTransactionNumber();

char* dpaymentssdk_tsysreversal_getresponsetransactionnumber(void* lpObj);

QString GetResponseTransactionNumber();

Default Value

""

Remarks

Check this property against the original Transaction Number.

This property should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this property should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransactionTime Property (TSYSReversal Class)

Local transaction time returned from the server in HHmmss format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionTime();

Unicode (Windows)
LPWSTR GetResponseTransactionTime();

char* dpaymentssdk_tsysreversal_getresponsetransactiontime(void* lpObj);

QString GetResponseTransactionTime();

Default Value

""

Remarks

Local transaction time returned from the server in HHmmss format.

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

This property is read-only and not available at design time.

Data Type

String

ResponseValidationCode Property (TSYSReversal Class)

This optional property contains information generated by the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseValidationCode();

Unicode (Windows)
LPWSTR GetResponseValidationCode();

char* dpaymentssdk_tsysreversal_getresponsevalidationcode(void* lpObj);

QString GetResponseValidationCode();

Default Value

""

Remarks

This optional property contains information generated by the card issuer.

This optional four character property contains specific information generated by the card issuer. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property should be recorded and submitted as part of a Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

RetrievalNumber Property (TSYSReversal Class)

The Response RetrievalNumber of the transaction being reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRetrievalNumber();
int SetRetrievalNumber(const char* lpszRetrievalNumber);

Unicode (Windows)
LPWSTR GetRetrievalNumber();
INT SetRetrievalNumber(LPCWSTR lpszRetrievalNumber);

char* dpaymentssdk_tsysreversal_getretrievalnumber(void* lpObj);
int dpaymentssdk_tsysreversal_setretrievalnumber(void* lpObj, const char* lpszRetrievalNumber);

QString GetRetrievalNumber();
int SetRetrievalNumber(QString qsRetrievalNumber);

Default Value

""

Remarks

This property contains a 12-character value reflecting the transaction Retrieval Reference Number of the transaction being reversed.

Data Type

String

ReturnedACI Property (TSYSReversal Class)

The Response ReturnedACI of the transaction being reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnedACI();
int SetReturnedACI(const char* lpszReturnedACI);

Unicode (Windows)
LPWSTR GetReturnedACI();
INT SetReturnedACI(LPCWSTR lpszReturnedACI);

char* dpaymentssdk_tsysreversal_getreturnedaci(void* lpObj);
int dpaymentssdk_tsysreversal_setreturnedaci(void* lpObj, const char* lpszReturnedACI);

QString GetReturnedACI();
int SetReturnedACI(QString qsReturnedACI);

Default Value

""

Remarks

The length of this property is one character.

Data Type

String

ReversalCode Property (TSYSReversal Class)

This code can be present in the reversal request for MasterCard transactions to signify the reason for the reversal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReversalCode();
int SetReversalCode(int iReversalCode);

Unicode (Windows)
INT GetReversalCode();
INT SetReversalCode(INT iReversalCode);

RC_NOT_SPECIFIED(0), 
RC_CUSTOMER_DIRECTED(1), 
RC_PARTIAL_REVERSAL(2), 
RC_CNPSUSPECT_FRAUD(3)

int dpaymentssdk_tsysreversal_getreversalcode(void* lpObj);
int dpaymentssdk_tsysreversal_setreversalcode(void* lpObj, int iReversalCode);

int GetReversalCode();
int SetReversalCode(int iReversalCode);

Default Value

0

Remarks

Data Type

Integer

ReversalType Property (TSYSReversal Class)

Specifies the type of reversal to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReversalType();
int SetReversalType(int iReversalType);

Unicode (Windows)
INT GetReversalType();
INT SetReversalType(INT iReversalType);

RT_PRE_SETTLEMENT(0), 
RT_DEBIT_PURCHASE(1), 
RT_DEBIT_CREDIT(2), 
RT_DEBIT_TIMEOUT(3), 
RT_TIMEOUT(4), 
RT_CREDIT_AUTHORIZATION(5)

int dpaymentssdk_tsysreversal_getreversaltype(void* lpObj);
int dpaymentssdk_tsysreversal_setreversaltype(void* lpObj, int iReversalType);

int GetReversalType();
int SetReversalType(int iReversalType);

Default Value

0

Remarks

Data Type

Integer

SettlementAmount Property (TSYSReversal Class)

The new Settlement Amount for this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSettlementAmount();
int SetSettlementAmount(const char* lpszSettlementAmount);

Unicode (Windows)
LPWSTR GetSettlementAmount();
INT SetSettlementAmount(LPCWSTR lpszSettlementAmount);

char* dpaymentssdk_tsysreversal_getsettlementamount(void* lpObj);
int dpaymentssdk_tsysreversal_setsettlementamount(void* lpObj, const char* lpszSettlementAmount);

QString GetSettlementAmount();
int SetSettlementAmount(QString qsSettlementAmount);

Default Value

""

Remarks

When performing an Authorization Reversal transaction, this field must contain a one to 12-character numeric transaction amount to be settled. The host subtracts this amount from the TotalAuthorizedAmount to derive the actual authorization amount to be reversed.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

SharingGroup Property (TSYSReversal Class)

List of Debit and EBT networks that the merchant supports.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSharingGroup();
int SetSharingGroup(const char* lpszSharingGroup);

Unicode (Windows)
LPWSTR GetSharingGroup();
INT SetSharingGroup(LPCWSTR lpszSharingGroup);

char* dpaymentssdk_tsysreversal_getsharinggroup(void* lpObj);
int dpaymentssdk_tsysreversal_setsharinggroup(void* lpObj, const char* lpszSharingGroup);

QString GetSharingGroup();
int SetSharingGroup(QString qsSharingGroup);

Default Value

""

Remarks

This one to 30-character property contains a listing of direct debit and EBT networks that a Point of Sale (POS) device can access. This property is provided by the signing member or processor, and the values must correspond to one of the Visa assigned direct debit network types. This value should be set to the value of the SharingGroup of the original TSYSDebit or TSYSBenefit authorization.

This field is only used for Debit reversals and Benefit/EBT reversals.

Data Type

String

SSLAcceptServerCertEncoded Property (TSYSReversal Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_tsysreversal_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsysreversal_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (TSYSReversal Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_tsysreversal_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsysreversal_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (TSYSReversal Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_tsysreversal_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsysreversal_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (TSYSReversal Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_tsysreversal_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsysreversal_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (TSYSReversal Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_tsysreversal_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsysreversal_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (TSYSReversal Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_tsysreversal_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsysreversal_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (TSYSReversal Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_tsysreversal_getsslprovider(void* lpObj);
int dpaymentssdk_tsysreversal_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (TSYSReversal Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (TSYSReversal Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_tsysreversal_gettimeout(void* lpObj);
int dpaymentssdk_tsysreversal_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TotalAuthorizedAmount Property (TSYSReversal Class)

The amount originally authorized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalAuthorizedAmount();
int SetTotalAuthorizedAmount(const char* lpszTotalAuthorizedAmount);

Unicode (Windows)
LPWSTR GetTotalAuthorizedAmount();
INT SetTotalAuthorizedAmount(LPCWSTR lpszTotalAuthorizedAmount);

char* dpaymentssdk_tsysreversal_gettotalauthorizedamount(void* lpObj);
int dpaymentssdk_tsysreversal_settotalauthorizedamount(void* lpObj, const char* lpszTotalAuthorizedAmount);

QString GetTotalAuthorizedAmount();
int SetTotalAuthorizedAmount(QString qsTotalAuthorizedAmount);

Default Value

""

Remarks

When performing an Authorization Reversal transaction, this field is to contain the total sum of all amounts authorized for this transaction (including any and all incremental authorizations). The TotalAuthorizedAmount minus the SettlementAmount will be the total amount reversed.

This must be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

Data Type

String

TraceAuditNumber Property (TSYSReversal Class)

System Trace Audit Number returned for Debit and EBT transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTraceAuditNumber();
int SetTraceAuditNumber(const char* lpszTraceAuditNumber);

Unicode (Windows)
LPWSTR GetTraceAuditNumber();
INT SetTraceAuditNumber(LPCWSTR lpszTraceAuditNumber);

char* dpaymentssdk_tsysreversal_gettraceauditnumber(void* lpObj);
int dpaymentssdk_tsysreversal_settraceauditnumber(void* lpObj, const char* lpszTraceAuditNumber);

QString GetTraceAuditNumber();
int SetTraceAuditNumber(QString qsTraceAuditNumber);

Default Value

""

Remarks

This setting contains a unique host message identifier assigned by the authorizing system, and is returned in Debit, EBT, and Gift Card response messages. This value should be set to the Trace returned in the response of the original TSYSDebit or TSYSBenefit authorization.

This field is only used for Debit and Benefit/EBT reversals.

Data Type

String

TransactionDate Property (TSYSReversal Class)

The Response TransactionDate of the transaction being reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionDate();
int SetTransactionDate(const char* lpszTransactionDate);

Unicode (Windows)
LPWSTR GetTransactionDate();
INT SetTransactionDate(LPCWSTR lpszTransactionDate);

char* dpaymentssdk_tsysreversal_gettransactiondate(void* lpObj);
int dpaymentssdk_tsysreversal_settransactiondate(void* lpObj, const char* lpszTransactionDate);

QString GetTransactionDate();
int SetTransactionDate(QString qsTransactionDate);

Default Value

""

Remarks

The format for this property is MMDDYY.

Data Type

String

TransactionId Property (TSYSReversal Class)

The Response TransactionId of the transaction being reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionId();
int SetTransactionId(const char* lpszTransactionId);

Unicode (Windows)
LPWSTR GetTransactionId();
INT SetTransactionId(LPCWSTR lpszTransactionId);

char* dpaymentssdk_tsysreversal_gettransactionid(void* lpObj);
int dpaymentssdk_tsysreversal_settransactionid(void* lpObj, const char* lpszTransactionId);

QString GetTransactionId();
int SetTransactionId(QString qsTransactionId);

Default Value

""

Remarks

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property, it should merely submit it in the reversal transaction.

Data Type

String

TransactionNumber Property (TSYSReversal Class)

Sequence number of this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Unicode (Windows)
INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);

int dpaymentssdk_tsysreversal_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsysreversal_settransactionnumber(void* lpObj, int iTransactionNumber);

int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

0

Remarks

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

Data Type

Integer

TransactionTime Property (TSYSReversal Class)

The Response TransactionTime of the transaction being reversed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionTime();
int SetTransactionTime(const char* lpszTransactionTime);

Unicode (Windows)
LPWSTR GetTransactionTime();
INT SetTransactionTime(LPCWSTR lpszTransactionTime);

char* dpaymentssdk_tsysreversal_gettransactiontime(void* lpObj);
int dpaymentssdk_tsysreversal_settransactiontime(void* lpObj, const char* lpszTransactionTime);

QString GetTransactionTime();
int SetTransactionTime(QString qsTransactionTime);

Default Value

""

Remarks

The format for this property is HHMMSS.

Data Type

String

Config Method (TSYSReversal Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_tsysreversal_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.

Interrupt Method (TSYSReversal Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_tsysreversal_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts any processing that the class is currently executing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ParseAggregate Method (TSYSReversal Class)

Parses the aggregate returned from another class's GetDetailAggregate method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseAggregate(const char* lpszAggregate);

Unicode (Windows)
INT ParseAggregate(LPCWSTR lpszAggregate);

int dpaymentssdk_tsysreversal_parseaggregate(void* lpObj, const char* lpszAggregate);

int ParseAggregate(const QString& qsAggregate);

Remarks

This method takes the XML aggregate returned from the TSYSRetail or TSYSHealthCare class, parses it, and then fills all the properties of this class with the information contained in the XML. Then call Reverse to reverse the transaction. You may also set these properties manually.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (TSYSReversal Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsysreversal_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reverse Method (TSYSReversal Class)

Reverses a previously authorized transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reverse();

Unicode (Windows)
INT Reverse();

int dpaymentssdk_tsysreversal_reverse(void* lpObj);

int Reverse();

Remarks

To reverse a transaction, you need the following information from the original authorization:

• ApprovalCode
• CardholderId
• IndustryType
• RetrievalNumber
• ReturnedACI
• TotalAuthorizedAmount
• TransactionId
• TransactionDate
• TransactionTime

Instead of setting these properties by hand, it is preferred that you can ParseAggregate with the XML aggregate returned from the authorizing class's GetDetailRecord method.

Then simply set the ReversalType, ReversalCode, and the new SettlementAmount, and then call Reverse. If the reversal was successful the ResponseCode property will be "00". All of the other Response properties will be identical to the values submitted in the properties above.

NOTE: Reversal transactions are not to be entered into the batch settlement. If a transaction has been partially reversed, the original detail record must be updated with the new AuthorizedAmount and SettlementAmount. If the transaction has been completely reversed the original detail record MUST NOT be included in the batch settlement.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (TSYSReversal Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(TSYSReversalConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} TSYSReversalConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(TSYSReversalConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} TSYSReversalConnectedEventParams;

#define EID_TSYSREVERSAL_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class TSYSReversalConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(TSYSReversalConnectedEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireConnected(TSYSReversalConnectedEventParams *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 (TSYSReversal Class)

Fired when receiving a data packet from the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketIn(TSYSReversalDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} TSYSReversalDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(TSYSReversalDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} TSYSReversalDataPacketInEventParams;

#define EID_TSYSREVERSAL_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class TSYSReversalDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(TSYSReversalDataPacketInEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireDataPacketIn(TSYSReversalDataPacketInEventParams *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 (TSYSReversal Class)

Fired when sending a data packet to the transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketOut(TSYSReversalDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} TSYSReversalDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(TSYSReversalDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} TSYSReversalDataPacketOutEventParams;

#define EID_TSYSREVERSAL_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class TSYSReversalDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(TSYSReversalDataPacketOutEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireDataPacketOut(TSYSReversalDataPacketOutEventParams *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 (TSYSReversal Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(TSYSReversalDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} TSYSReversalDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(TSYSReversalDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} TSYSReversalDisconnectedEventParams;

#define EID_TSYSREVERSAL_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class TSYSReversalDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(TSYSReversalDisconnectedEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireDisconnected(TSYSReversalDisconnectedEventParams *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 (TSYSReversal Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(TSYSReversalErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TSYSReversalErrorEventParams;


Unicode (Windows)
virtual INT FireError(TSYSReversalErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TSYSReversalErrorEventParams;

#define EID_TSYSREVERSAL_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TSYSReversalErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TSYSReversalErrorEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireError(TSYSReversalErrorEventParams *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 (TSYSReversal Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(TSYSReversalSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} TSYSReversalSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(TSYSReversalSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} TSYSReversalSSLServerAuthenticationEventParams;

#define EID_TSYSREVERSAL_SSLSERVERAUTHENTICATION 6

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class TSYSReversalSSLServerAuthenticationEventParams {
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(TSYSReversalSSLServerAuthenticationEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireSSLServerAuthentication(TSYSReversalSSLServerAuthenticationEventParams *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 (TSYSReversal Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(TSYSReversalSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} TSYSReversalSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(TSYSReversalSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} TSYSReversalSSLStatusEventParams;

#define EID_TSYSREVERSAL_SSLSTATUS 7

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class TSYSReversalSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(TSYSReversalSSLStatusEventParams *e);

// Or, subclass TSYSReversal and override this emitter function.
virtual int FireSSLStatus(TSYSReversalSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (TSYSReversal Class)

TSYSReversal Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings