4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

TSYSHCTransactionResult Type

Contains the response to the transaction detail request.

Remarks

This type contains the results of a transaction made with the TSYSHCTransactionDetails component. The fields contained by this type are listed below.

Fields

ApprovalCode
String

Contains an authorization code when a transaction has been approved.

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

AVSResult
String

Contains the Address Verification System result code.

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

CodeDescription
0Address verification was not requested.
ACustomerAddress matches, CustomerZip does not.
EAVS error / Ineligible (not a mail/phone order)
GVer Unavailable - Non-US Issuer does not participate.
IVer Unavailable - Address information not verified for international transaction.
MExact Match - CustomerAddress match for international transaction.
NNo match on CustomerAddress or CustomerZip.
RRetry - Issuer system unavailable.
SService not supported by issuer.
UAddress information is unavailable.
WNine digit CustomerZip matches, CustomerAddress does not.
XExact AVS match, nine digit CustomerZip.
YExact AVS match, five digit CustomerZip.
ZFive digit CustomerZip matches, CustomerAddress does not.
B*Street address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
C*Street address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code).
D*Street addresses and postal codes match for international transaction.
I*Address information not verified for international transaction.
M*Street addresses and postal codes match for international transaction.
P*Postal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code).

*International AVS Result Code

BatchNumber
Integer

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.

BatchResponseCode
String

This field contains the response code indicating the status of a batch management request. The Point of Sale (POS) system must evaluate this response code and NOT the Text to determine nature of a response message. A response code of "00" represents a successful request. All other response codes represent non-approved requests.

Response Code Response Text Definition
00 "ACCEPTED" or "DATA RETRIEVED" If CloseBatch is called response text will be "ACCEPTED", otherwise it will be "DATA RETRIEVED".
01 "EXCEEDED LIMIT" The requested batch or transaction was not in the allowable limits (current, previous, or last 5 batches).
02 "COULD NOT FIND" The host system could not find the batch or the transaction that was requested.
03 "NOT ALLOWED" An invalid request was entered.
04 "SYSTEM ERROR" The host system was not able to process the request due to some internal issue, maintenance, or other system error.
05 "ALREADY CLOSED" During a batch close request, the batch was already found to have been closed. A batch summary will be provided with the pertinent information.
06 "NOT IN BATCH" The requested Adjustment or Void was not in the current batch.

BatchResponseText
String

Text information that describes each response code.

This field contains a 32-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.

BatchStatus
String

The current status of the batch in an inquiry.

A value of "O" indicates that the batch is still open. A value of "C" indicates that the batch has been closed and sent on to the settlement system.

CardLast4
String

The last four (4) digits of the customer card number.

CardLevelResult
String

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

CardType
String

The type of card sent in the authorization request.

Possible values are:

  • CHECK
  • VISA
  • MASTERCARD
  • AMEX
  • DISCOVER
  • JCB
  • PRIVATE LABEL
  • GIFT CARD
  • DEBIT
  • EBT

Code
String

Indicates the status of the authorization request.

This field contains the response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the Text to determine nature of a response message. A response code of "00" represents an approval. A response code of "10" indicates that the transaction was partially approved for a lesser amount (AuthorizedAmount). All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

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

CVVResult
String

Contains the returned CVV result code if it was requested.

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

MCVV2 match.
NCVV2 no match.
PNot processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer not certified and/or has not provided Visa encryption keys.

ECI
String

A one-character transaction indicator identifying the type of direct marketing transaction being authorized.

IndicatorDescription
1One Time Occurrence of a Mail/Telephone Order Transaction (use for Direct Marketing).
2Recurring Mail/Telephone Order Transaction.
3Installment Payment of a Mail/Telephone Order Transaction.
4Unknown Classification.
5Secure electronic commerce transaction 3-D Secure (Visa Only) and Electronic Commerce Transaction (MasterCard Online Checkout Service).
6Non-authenticated security transaction at a 3-D Secure capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure.
7Non-authenticated Security Transaction, such as a Channel-Encrypted Transaction (default for CardNotPresent eCommerce transactions).
8Non-secure Electronic Commerce Transaction.
RFirst recurring SecureCode phone order transaction.
TSingle non-recurring SecureCode Phone Order transaction (MC only).

GoodsIndicator
ResultGoodsIndicators

The type of goods purchased over the Internet.

tgiNotUsed (0)GoodsIndicator is not used.
tgiDigitalGoods (1)Customer purchased digital goods (for instance, an application that was electronically delivered).
tgiPhysicalGoods (2)Customer purchased actual physical goods, which were then shipped to the customer.

GratuityAmount
String

The gratuity (tip) amount of the transaction being settled.

InstallmentAdvice
InstallmentAdvices

Contains the Merchant Advice Code returned by MasterCard MIP.

Possible values are:

ivNoDataPresent (0) Installment advice data was not returned.
ivNewAccountInfo (1) New account information.
ivTryAgainLater (2) Try again later.
ivDoNotTryAgain (3) Do not try again for recurring payment transaction.
ivCancelRecurring (4) Recurring payment cancellation.

InvoiceNumber
String

The invoice number assigned by the merchant for a card-not-present purchase.

IsTaxExempt
Boolean

Identifies the characteristics of the amount appearing in TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status.

When set to "True", the purchasing card will be indicated as being tax-exempt. When set to "False", the amount of TaxAmount will be indicated as being Local Sales Tax.

Note: This field cannot be set to "True" if there is a TaxAmount set.

NetworkId
String

This field contains the identification code of the network on which the transaction was authorized. The Network ID must be printed on the receipt. The table below contains a listing of Network ID codes.

ID Description
1 AFFN ATM
3 Alaska Option
7 ITS Shazam
8 Maestro
A Amex ATM
B Plus ATM
C CU24
D Discover ATM
E Accel
F NYCE
G Interlink
H PULSE
J MasterCard ATM
K EBT
L Pulse
N STAR
O Cirrus ATM
P NETS
Q STAR W
S PULSE
T EBT ATM
U AFFN
V VisaNet
W STAR SE
Y NYCE
Z STAR NE

PartialShipmentIndicator
Boolean

Indicates whether the merchant or acquirer is awaiting shipment of a portion of the goods purchased in a card transaction prior to submitting the related sales data. This field is Discover only.

PurchaseId
String

The Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder.

RequestedACI
String

A one-character field containing the Requested ACI used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs.

Possible values are:

Value Description
N Device is not CPS capable
Y Device is CPS capable
R No AVS requested (Visa) or SIIP - Recurring Payment (MC)

RetrievalNumber
String

The Retrieval Reference Number from the transaction.

ReturnedACI
String

Returned Authorization Characteristics Indicator contains CPS qualification status.

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

SettlementAmount
String

This field contains the final settlement amount of the transaction. The decimal is implied.

TaxAmount
String

Sales tax charged in addition to the original TransactionAmount

Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

TrackStatusCode
String

This field is used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions. The field is 2 characters in length.

The first character is the Track 1 data Indicator which indicates the condition of track 1 data in the request. Possible values are:

Value Description
0 No track 1 data present
1 Track 1 data present with CVV not provided
2 Track 1 data present with non-zero and non-blank CVV
3 Track 1 data present with CVV set to all zeros
4 Track 1 data present with CVV containing some or all blanks
5 Track 1 data present but CVV location not disclosed by issuer

The second character is the Track 2 data Indicator which indicates the condition of track 2 data in the request. Possible values are:

Value Description
0 No track 2 data present
1 Track 2 data present with CVV not provided
2 Track 2 data present with non-zero and non-blank CVV
3 Track 2 data present with CVV set to all zeros
4 Track 2 data present with CVV containing some or all blanks
5 Track 2data present but CVV location not disclosed by issuer

TransactionAmount
String

The Transaction Amount from the transaction.

TransactionDate
String

Local transaction date returned from the server in MMddyy format.

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

TransactionFee
String

Transaction Fee Amount is used in PIN POS transactions to carry the acquirer-assessed surcharge for informational purposes only. This field can be zero length or nine alphanumeric characters in length. The format of the nine characters is "annnnnnnn" where "a" is either "D" for debit or "C" for credit and where "nnnnnnnn" is the numeric fee amount with the decimal implied. Example: "D00000150" is a $1.50 transaction fee amount for a debit transaction.

TransactionNumber
Integer

This is the Transaction Original Number (TON) from the transaction.

TransactionTime
String

Local transaction time returned from the server in HHmmss format.

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

TransactionType
AuthTransactionTypes

The original authorization transaction type.

This field provides you with the transaction type of the original authorization request (regardless of any adjustments, voids, or reversals performed).

Possible values are:

Value Description
atUnknown (0) The original transaction type could not be determined.
atSale (1) The original transaction was a sale.
atCredit (2) The original transaction was a credit.
atForce (3) The original transaction was an offline authorization.

Constructors

[VB.NET]
Public TSYSHCTransactionResult()

[C#]
public TSYSHCTransactionResult();



 
 
Copyright (c) 2020 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 7311]