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

TSYSHealthCareResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the TSYSHealthCare 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.

AuthorizedAmount
String

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

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

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

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

AuthSource
String

Indicates the source of the authorization code stored in ApprovalCode.

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

CodeDescription
1STIP (Stand-In Processing): time-out response.
2STIP: amount below issuer limit.
3STIP: issuer in Suppress Inquiry mode.
4STIP: issuer unavailable.
5Issuer generated response.
6Off-line approval: POS device generated.
7Acquirer approval: Base I unavailable.
8Acquirer approval of a referral.
9Use for non-authorized transactions; such as credit card credits.
DReferral: authorization code manually keyed.
EOff-line approval: authorization code manually keyed.
FCAFIS Interface Off-Line Post-Auth.*
GIssuer Approval: Post-Auth.*

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

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

Balance
String

Available balance remaining on card.

This field contains the Available Balance remaining on the card following the transaction that was just authorized. It represents the balance on the card prior to the transaction, minus the TransactionAmount from this transaction. For example, if an FSA card has a $20.00 balance prior to a $15.00 authorization, then the Balance will reflect an available balance of "500" ($20.00 - $15.00 = $5.00).

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.

Code
String

Indicates the status of the authorization request.

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

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

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

RetrievalNumber
String

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

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

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

Text
String

Text information that describes each response code.

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

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.

TransactionId
String

Contains the Transaction Identifier or MasterCard Reference Number.

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

NOTE: If "MAV" is in positions 5-7 of this field, the transaction should not be submitted for capture.

TransactionNumber
String

Check this field against the original Transaction Number.

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

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

ValidationCode
String

This optional field contains information generated by the card issuer.

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

Constructors

[VB.NET]
Public TSYSHealthCareResponse()

[C#]
public TSYSHealthCareResponse();



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