E-Payment Integrator V6 - Online Help
E-Payment Integrator V6
Questions / Feedback?

EPResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the ICharge, Retail, and ECheck components. The fields contained by this type are listed below.

Fields

ApprovalCode
String

Contains an authorization code when a transaction has been approved. This field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction is not approved, then the contents of this field should be ignored.

Approved
Boolean

Indicates the status of the last transaction. This field will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the Code should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

ApprovedAmount
String

The amount approved for the transaction, this is the amount actually charged to the credit card.

This field is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this field is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this field is not populated).

AVSResult
String

Contains the Address Verification System result code. This one character field contains the Address Verification Service (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 for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

AVSResultDescription
AAddress matches, Zip does not.
EAVS error.
GNon-U.S. issuing bank does not support AVS.
NNo match on Address or CustomerZip.
PAVS not applicable for this transaction.
RRetry - Issuer system unavailable.
SService not supported by issuer.
UAddress information is unavailable.
WNine digit Zip matches, Address does not.
XExact AVS match, nine digit Zip.
YExact AVS match, five digit Zip.
ZFive digit Zip matches, Address does not.

Note: The above table does not apply to the WorldPay gateway, HSBC gateway, Adyen gateway, Barclay gateway, or PayTrace.

For Worldpay, the field will contain a 4-character string, which contains the AVS checks for the following fields:

1st CharacterCard Verification Value (CVV) check
2nd CharacterPostal/Zip Code AVS check
3rd CharacterAddress AVS check
4th CharacterCountry Comparison check

The possible values for each result character are:

0Not Supported.
1Not Checked.
2Matched.
4No Match.
8Partial Match.

For HSBC, the field will contain the following possible values:

YYAddress and zip code or postal code match
YNAddress matches only
NYZip code or postal code matches
NNNeither address nor zip code or postal code matches; address is not parsable
UUAddress information is unavailable, service is unavailable, or Error; Unknown
FFIssuer does not participate in AVS
BlankNo AVS performed

For Adyen, this field will contain the following possible values:

0Unknown
1Address matches, postal code doesn't
2Neither postal code nor address match
3AVS unavailable
4AVS not supported for this card type
5No AVS data provided
6Postal code matches, address doesn't match
7Both postal code and address match
8Address not checked, postal code unknown
9Address matches, postal code unknown
10Address doesn't match, postal code unknown
11Postal code not checked, address unknown
12Address matches, postal code not checked
13Address doesn't match, postal code not checked
14Postal code matches, address unknown
15Postal code matches, address not checked
16Postal code doesn't match, address unknown
17Postal code doesn't match, address not checked
18Neither postal code nor address were checked

For Barclay, the field will contain the following possible values:

YYAddress and zip code or postal code match
YNAddress matches only
NYZip code or postal code matches
NNNeither address nor zip code or postal code matches; address is not parsable
UUAddress information is unavailable, service is unavailable, or Error; Unknown
BlankNo AVS performed

For PayTrace, the field will contain the following possible values:

Full Exact Match
Address Match Only
Zip Match Only
No Match
Address Unavailable
Non-US Issuer does not participate
Issuer System Unavailable
Not a Mail/Phone Order
Service Not Supported

For the QBMS gateway, the AVSResult field will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an AVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

For DataCash, the field will contain the following possible values (of which correspond to both AVS and CVV checks):

NO DATA MATCHES
ADDRESS MATCH ONLY
SECURITY CODE MATCH ONLY
ALL MATCH
DATA NOT CHECKED

Code
String

Indicates the status of the authorization request. This field contains the actual response code as returned by the Gateway. Unlike the Approved field, this Code field may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the Code as well as the Approved field. The Point of Sale system should evaluate this response code and NOT the Text to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

CVVResult
String

Contains the returned CVV2 result code if it was requested. This field contains the host returned CVV2 result code (if CVV data was sent in the request). 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.

A gateway may also support custom codes or human-readable response messages in this field. Please consult your gateway documentation to determine if CVV2 codes are supported.

Note: The above table does not apply to the HSBC, Adyen or Barclay gateways.

For HSBC, the field will contain:

0Card type does not support CVM
1CVM match
2CVM did not match issuer value
3CVM was not processed
4CVM should be on the card but cardholder indicated otherwise
5CVM not supported by issuer
6Not valid
7No response from server

For Adyen, the field will contain:

0Unknown
1Matches
2Does not match
3Not checked
4No CVC/CVV provided, but was required
5Issuer not certified for CVC/CVV
6No CVC/CVV provided

For Barclay, the field will contain:

0,1CVM was not processed
2CVM match
4CVM does not match issuer value
UnknownCVM invalid or missing
BlankNo response from server

For DataCash, the field will contain the following possible values (of which correspond to both AVS and CVV checks):

NO DATA MATCHES
ADDRESS MATCH ONLY
SECURITY CODE MATCH ONLY
ALL MATCH
DATA NOT CHECKED

Data
String

The entire response returned from the gateway processor. This field contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response fields.

ErrorCode
String

Additional error code returned by some gateways. If a gateway returns it, this field will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ErrorText for a human-readable description of this ErrorCode.

ErrorText
String

Additional error description returned by some gateways. If a gateway returns it, this field will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ErrorCode for an accompanying code which may be parsed and used by your application.

InvoiceNumber
String

Invoice number submitted in authorization request (if applicable). This field contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

ProcessorCode
String

Response code from the underlying processor. Often times a Gateway will return a Code that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this field will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

Text
String

Text information that describes each response code. This field contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

TransactionId
String

Contains the Visa Transaction Identifier or MasterCard Reference Number. This field contains a transaction identifier or reference number. 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 used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

Constructors

[VB.NET]
Public EPResponse()

[C#]
public EPResponse();



 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0