TSYSReversal Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibcTSYSReversal

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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

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

AgentBankNumber Property (TSYSReversal Component)

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

Syntax

__property String AgentBankNumber = { read=FAgentBankNumber, write=FSetAgentBankNumber };

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

Identifies a specific chain of an agent organization.

Syntax

__property String AgentChainNumber = { read=FAgentChainNumber, write=FSetAgentChainNumber };

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

The Response ApprovalCode of the transaction being reversed.

Syntax

__property String ApprovalCode = { read=FApprovalCode, write=FSetApprovalCode };

Default Value

""

Remarks

This must exactly match the ResponseApprovalCode from the original authorization.

Data Type

String

BatchNumber Property (TSYSReversal Component)

The batch number that this transaction will be included in.

Syntax

__property int BatchNumber = { read=FBatchNumber, write=FSetBatchNumber };

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 component's BatchNumber property during the authorization.

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

Data Type

Integer

CardType Property (TSYSReversal Component)

Type of credit card being used in this transaction.

Syntax

__property TibcTSYSReversalCardTypes CardType = { read=FCardType, write=FSetCardType };

enum TibcTSYSReversalCardTypes {
  ctUnknown=0,
  ctVisa=1,
  ctMasterCard=2,
  ctAMEX=3,
  ctDiscover=4,
  ctDiners=5,
  ctJCB=6,
  ctVisaElectron=7,
  ctMaestro=8,
  ctLaser=10
};

Default Value

ctUnknown

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

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

Syntax

__property String CardCVVData = { read=FCardCVVData, write=FSetCardCVVData };

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

Indicates the presence of the card verification value.

Syntax

__property TibcTSYSReversalCardCVVPresences CardCVVPresence = { read=FCardCVVPresence, write=FSetCardCVVPresence };

enum TibcTSYSReversalCardCVVPresences {
  cvpNotProvided=0,
  cvpProvided=1,
  cvpIllegible=2,
  cvpNotOnCard=3
};

Default Value

cvpNotProvided

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The component 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 Component)

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

Syntax

__property TibcTSYSReversalCardEntryDataSources CardEntryDataSource = { read=FCardEntryDataSource, write=FSetCardEntryDataSource };

enum TibcTSYSReversalCardEntryDataSources {
  edsTrack1=0,
  edsTrack2=1,
  edsManualEntryTrack1Capable=2,
  edsManualEntryTrack2Capable=3,
  edsManualEntryNoCardReader=4,
  edsTrack1Contactless=5,
  edsTrack2Contactless=6,
  edsManualEntryContactlessCapable=7,
  edsIVR=8,
  edsKiosk=9
};

Default Value

edsTrack1

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

Expiration month of the credit card specified in Number .

Syntax

__property int CardExpMonth = { read=FCardExpMonth, write=FSetCardExpMonth };

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

Expiration year of the credit card specified in Number .

Syntax

__property int CardExpYear = { read=FCardExpYear, write=FSetCardExpYear };

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

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

Syntax

__property bool CardIsEncrypted = { read=FCardIsEncrypted, write=FSetCardIsEncrypted };

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

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

Syntax

__property String CardMagneticStripe = { read=FCardMagneticStripe, write=FSetCardMagneticStripe };

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?"

component.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" component.CardEntryDataSource = edsTrack1 or component.CardMagneticStripe = "4788250000028291=05121015432112345678" component.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 Component)

Customer's credit card number for the transaction.

Syntax

__property String CardNumber = { read=FCardNumber, write=FSetCardNumber };

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

The CardholderId code for this reversal.

Syntax

__property String CardholderId = { read=FCardholderId, write=FSetCardholderId };

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

Amount returned to the customer in cash.

Syntax

__property String CashBackAmount = { read=FCashBackAmount, write=FSetCashBackAmount };

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 component's CashBackAmount property during the authorization.

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

Data Type

String

IndustryType Property (TSYSReversal Component)

Code which indicates the industry the merchant is engaged in.

Syntax

__property TibcTSYSReversalIndustryTypes IndustryType = { read=FIndustryType, write=FSetIndustryType };

enum TibcTSYSReversalIndustryTypes {
  sitUnknown=0,
  sitRetail=1,
  sitRestaurant=2,
  sitGroceryStore=3,
  sitDirectMarketing=4,
  sitHotel=5,
  sitAutoRental=6,
  sitPassengerTransport=7
};

Default Value

sitRetail

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

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

Data Type

Integer

MerchantBankId Property (TSYSReversal Component)

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

Syntax

__property String MerchantBankId = { read=FMerchantBankId, write=FSetMerchantBankId };

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

Classifies a merchant by the type of store.

Syntax

__property String MerchantCategoryCode = { read=FMerchantCategoryCode, write=FSetMerchantCategoryCode };

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

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

Syntax

__property String MerchantCity = { read=FMerchantCity, write=FSetMerchantCity };

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

Identifies the country where the merchant is located.

Syntax

__property String MerchantCountryCode = { read=FMerchantCountryCode, write=FSetMerchantCountryCode };

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

Identifies the type of currency used by the merchant.

Syntax

__property String MerchantCurrencyCode = { read=FMerchantCurrencyCode, write=FSetMerchantCurrencyCode };

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

Designates the language that response messages will be returned in.

Syntax

__property String MerchantLanguage = { read=FMerchantLanguage, write=FSetMerchantLanguage };

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

Name of the merchant.

Syntax

__property String MerchantName = { read=FMerchantName, write=FSetMerchantName };

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

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

Syntax

__property String MerchantNumber = { read=FMerchantNumber, write=FSetMerchantNumber };

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

Merchant's phone number.

Syntax

__property String MerchantPhone = { read=FMerchantPhone, write=FSetMerchantPhone };

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

Merchant's customer service number.

Syntax

__property String MerchantServicePhone = { read=FMerchantServicePhone, write=FSetMerchantServicePhone };

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

State or province that the merchant is located in.

Syntax

__property String MerchantState = { read=FMerchantState, write=FSetMerchantState };

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

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

Syntax

__property String MerchantStoreNumber = { read=FMerchantStoreNumber, write=FSetMerchantStoreNumber };

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

Merchant's street address.

Syntax

__property String MerchantStreetAddress = { read=FMerchantStreetAddress, write=FSetMerchantStreetAddress };

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

Used to identify a unique terminal within a merchant location.

Syntax

__property String MerchantTerminalNumber = { read=FMerchantTerminalNumber, write=FSetMerchantTerminalNumber };

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

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

Syntax

__property String MerchantTimeZone = { read=FMerchantTimeZone, write=FSetMerchantTimeZone };

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

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

Syntax

__property String MerchantZip = { read=FMerchantZip, write=FSetMerchantZip };

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

Merchant's routing number.

Syntax

__property String MerchantABANumber = { read=FMerchantABANumber, write=FSetMerchantABANumber };

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

Merchant's settling agent.

Syntax

__property String MerchantSettlementAgent = { read=FMerchantSettlementAgent, write=FSetMerchantSettlementAgent };

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

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

Syntax

__property String NetworkId = { read=FNetworkId, write=FSetNetworkId };

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

Indicates the type of fee applicable to this transaction.

Syntax

__property TibcTSYSReversalReimbursementAttributes ReimbursementAttribute = { read=FReimbursementAttribute, write=FSetReimbursementAttribute };

enum TibcTSYSReversalReimbursementAttributes {
  raStandardRetail=0,
  raQualifiedGrocery=1,
  raPreExistingRetail=2,
  raPreExistingGrocery=3,
  raNonDebit=4,
  raTaxExempt=5
};

Default Value

raStandardRetail

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

Contains an authorization code when a transaction has been approved.

Syntax

__property String ResponseApprovalCode = { read=FResponseApprovalCode };

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

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

Syntax

__property String ResponseAuthorizedAmount = { read=FResponseAuthorizedAmount };

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

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

__property String ResponseAuthSource = { read=FResponseAuthSource };

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

Contains the Address Verification System result code.

Syntax

__property String ResponseAVSResult = { read=FResponseAVSResult };

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

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

Syntax

__property String ResponseCardLevel = { read=FResponseCardLevel };

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

Indicates the status of the authorization request.

Syntax

__property String ResponseCode = { read=FResponseCode };

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

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

Syntax

__property TibcTSYSReversalResponseCommercialCardTypes ResponseCommercialCardType = { read=FResponseCommercialCardType };

enum TibcTSYSReversalResponseCommercialCardTypes {
  tccNotCommercial=0,
  tccBusinessCard=1,
  tccVisaCommerce=2,
  tccCorporateCard=3,
  tccPurchaseCard=4
};

Default Value

tccNotCommercial

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 components 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 Component)

Contains the returned CVV result code if it was requested.

Syntax

__property String ResponseCVVResult = { read=FResponseCVVResult };

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

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

Syntax

__property String ResponseRetrievalNumber = { read=FResponseRetrievalNumber };

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

Returned Authorization Characteristics Indicator contains CPS qualification status.

Syntax

__property String ResponseReturnedACI = { read=FResponseReturnedACI };

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

Text information that describes each response code.

Syntax

__property String ResponseText = { read=FResponseText };

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

Local transaction date returned from the server in MMddyy format.

Syntax

__property String ResponseTransactionDate = { read=FResponseTransactionDate };

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

Contains the Transaction Identifier or MasterCard Reference Number.

Syntax

__property String ResponseTransactionId = { read=FResponseTransactionId };

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

Check this property against the original Transaction Number.

Syntax

__property String ResponseTransactionNumber = { read=FResponseTransactionNumber };

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

Local transaction time returned from the server in HHmmss format.

Syntax

__property String ResponseTransactionTime = { read=FResponseTransactionTime };

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

This optional property contains information generated by the card issuer.

Syntax

__property String ResponseValidationCode = { read=FResponseValidationCode };

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

The Response RetrievalNumber of the transaction being reversed.

Syntax

__property String RetrievalNumber = { read=FRetrievalNumber, write=FSetRetrievalNumber };

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

The Response ReturnedACI of the transaction being reversed.

Syntax

__property String ReturnedACI = { read=FReturnedACI, write=FSetReturnedACI };

Default Value

""

Remarks

The length of this property is one character.

Data Type

String

ReversalCode Property (TSYSReversal Component)

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

Syntax

__property TibcTSYSReversalReversalCodes ReversalCode = { read=FReversalCode, write=FSetReversalCode };

enum TibcTSYSReversalReversalCodes {
  rcNotSpecified=0,
  rcCustomerDirected=1,
  rcPartialReversal=2,
  rcCNPSuspectFraud=3
};

Default Value

rcNotSpecified

Remarks

Data Type

Integer

ReversalType Property (TSYSReversal Component)

Specifies the type of reversal to process.

Syntax

__property TibcTSYSReversalReversalTypes ReversalType = { read=FReversalType, write=FSetReversalType };

enum TibcTSYSReversalReversalTypes {
  rtPreSettlement=0,
  rtDebitPurchase=1,
  rtDebitCredit=2,
  rtDebitTimeout=3,
  rtTimeout=4,
  rtCreditAuthorization=5
};

Default Value

rtPreSettlement

Remarks

Data Type

Integer

SettlementAmount Property (TSYSReversal Component)

The new Settlement Amount for this transaction.

Syntax

__property String SettlementAmount = { read=FSettlementAmount, write=FSetSettlementAmount };

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

List of Debit and EBT networks that the merchant supports.

Syntax

__property String SharingGroup = { read=FSharingGroup, write=FSetSharingGroup };

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

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (TSYSReversal Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (TSYSReversal Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Byte Array

SSLCertStorePassword Property (TSYSReversal Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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

This is the type of certificate store for this certificate.

Syntax

__property TibcTSYSReversalSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibcTSYSReversalSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (TSYSReversal Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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

This specifies the SSL/TLS implementation to use.

Syntax

__property TibcTSYSReversalSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibcTSYSReversalSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (TSYSReversal Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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

Byte Array

Timeout Property (TSYSReversal Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

Data Type

Integer

TotalAuthorizedAmount Property (TSYSReversal Component)

The amount originally authorized.

Syntax

__property String TotalAuthorizedAmount = { read=FTotalAuthorizedAmount, write=FSetTotalAuthorizedAmount };

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

System Trace Audit Number returned for Debit and EBT transactions.

Syntax

__property String TraceAuditNumber = { read=FTraceAuditNumber, write=FSetTraceAuditNumber };

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

The Response TransactionDate of the transaction being reversed.

Syntax

__property String TransactionDate = { read=FTransactionDate, write=FSetTransactionDate };

Default Value

""

Remarks

The format for this property is MMDDYY.

Data Type

String

TransactionId Property (TSYSReversal Component)

The Response TransactionId of the transaction being reversed.

Syntax

__property String TransactionId = { read=FTransactionId, write=FSetTransactionId };

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

Sequence number of this transaction.

Syntax

__property int TransactionNumber = { read=FTransactionNumber, write=FSetTransactionNumber };

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

The Response TransactionTime of the transaction being reversed.

Syntax

__property String TransactionTime = { read=FTransactionTime, write=FSetTransactionTime };

Default Value

""

Remarks

The format for this property is HHMMSS.

Data Type

String

Config Method (TSYSReversal Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

Interrupt Method (TSYSReversal Component)

Interrupts the current action.

Syntax

void __fastcall Interrupt();

Remarks

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

ParseAggregate Method (TSYSReversal Component)

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

Syntax

void __fastcall ParseAggregate(String Aggregate);

Remarks

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

Reset Method (TSYSReversal Component)

Clears all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

This method clears all properties to their default values.

Reverse Method (TSYSReversal Component)

Reverses a previously authorized transaction.

Syntax

void __fastcall 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 component'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.

Connected Event (TSYSReversal Component)

Fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TibcTSYSReversalConnectedEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalConnectedEvent)(System::TObject* Sender, TibcTSYSReversalConnectedEventParams *e);
__property TibcTSYSReversalConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

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

Fired when receiving a data packet from the transaction server.

Syntax

typedef struct {
  String DataPacket;
  DynamicArray<Byte> DataPacketB;
} TibcTSYSReversalDataPacketInEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalDataPacketInEvent)(System::TObject* Sender, TibcTSYSReversalDataPacketInEventParams *e);
__property TibcTSYSReversalDataPacketInEvent OnDataPacketIn = { read=FOnDataPacketIn, write=FOnDataPacketIn };

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

DataPacketOut Event (TSYSReversal Component)

Fired when sending a data packet to the transaction server.

Syntax

typedef struct {
  String DataPacket;
  DynamicArray<Byte> DataPacketB;
} TibcTSYSReversalDataPacketOutEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalDataPacketOutEvent)(System::TObject* Sender, TibcTSYSReversalDataPacketOutEventParams *e);
__property TibcTSYSReversalDataPacketOutEvent OnDataPacketOut = { read=FOnDataPacketOut, write=FOnDataPacketOut };

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

Disconnected Event (TSYSReversal Component)

Fired when a connection is closed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TibcTSYSReversalDisconnectedEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalDisconnectedEvent)(System::TObject* Sender, TibcTSYSReversalDisconnectedEventParams *e);
__property TibcTSYSReversalDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

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

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibcTSYSReversalErrorEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalErrorEvent)(System::TObject* Sender, TibcTSYSReversalErrorEventParams *e);
__property TibcTSYSReversalErrorEvent OnError = { read=FOnError, write=FOnError };

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

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibcTSYSReversalSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalSSLServerAuthenticationEvent)(System::TObject* Sender, TibcTSYSReversalSSLServerAuthenticationEventParams *e);
__property TibcTSYSReversalSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibcTSYSReversalSSLStatusEventParams;
typedef void __fastcall (__closure *TibcTSYSReversalSSLStatusEvent)(System::TObject* Sender, TibcTSYSReversalSSLStatusEventParams *e);
__property TibcTSYSReversalSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (TSYSReversal Component)

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

Trappable Errors (TSYSReversal Component)

TSYSReversal Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors