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


AVSResult	Description
A	Address matches, Zip does not.
E	AVS error.
G	Non-U.S. issuing bank does not support AVS.
N	No match on Address or CustomerZip.
P	AVS not applicable for this transaction.
R	Retry - Issuer system unavailable.
S	Service not supported by issuer.
U	Address information is unavailable.
W	Nine digit Zip matches, Address does not.
X	Exact AVS match, nine digit Zip.
Y	Exact AVS match, five digit Zip.
Z	Five digit Zip matches, Address does not.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

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


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

American Payment Solutions

For American Payment Solutions, this field will contain the following possible values:


X	Exact match, 9-character numeric ZIP
Y, D, or M	Exact match, 5-character numeric ZIP
2 or 6	Exact match, 5-character numeric ZIP, customer name
A or B	Address match only
3 or 7	Address, customer name match only
W	9-character numeric ZIP match only
Z, P, or L	5-character ZIP match only
1 or 5	5-character ZIP, customer name match only
N or C	No address or ZIP match only
4 or 8	No address or ZIP or customer name match only
U	Address unavailable
G or I	Non-U.S. issuer does not participate
R	Issuer system unavailable
E	Not a mail/phone order
S	Service not supported
0, O, or B	AVS not available

Barclay

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


YY	Address and zip code or postal code match
YN	Address matches only
NY	Zip code or postal code matches
NN	Neither address nor zip code or postal code matches; address is not parsable
UU	Address information is unavailable, service is unavailable, or Error; Unknown
Blank	No AVS performed

BlueSnap

For BlueSnap, the field will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following fields:


1st Character	Name AVS check
2nd Character	Address AVS check
3rd Character	Postal/Zip Code AVS check

The possible values for each result character are:


M	Matches
N	Does not match
U	Could not be verified

HSBC

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


YY	Address and zip code or postal code match
YN	Address matches only
NY	Zip code or postal code matches
NN	Neither address nor zip code or postal code matches; address is not parsable
UU	Address information is unavailable, service is unavailable, or Error; Unknown
FF	Issuer does not participate in AVS
Blank	No AVS performed

PayTrace

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

QBMS

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.

DataCash

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

Stripe

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


Pass	The first address line or zip code provided is correct.
Fail	The first address line or zip code provided is incorrect.
Unavailable	The customer's bank did not check the first address line or zip code provided.
Unchecked	The first address line or zip code was provided but has not yet been checked.

Worldpay

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


1st Character	Card Verification Value (CVV) check
2nd Character	Postal/Zip Code AVS check
3rd Character	Address AVS check
4th Character	Country Comparison check

The possible values for each result character are:


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

Worldpay Online

For Worldpay Online, the field will contain one of the following:


Value	Description
APPROVED	The supplied street and postal code details fully matched the payment provider's records
PARTIAL APPROVED	One of the supplied street or postal code details did not match the payment provider's records
NOT SENT TO ACQUIRER	Problem with acquirer - possibly no AVS support
NO RESPONSE FROM ACQUIRER	Problem with acquirer - possibly no AVS support
NOT CHECKED BY ACQUIRER	The acquirer did not check the address details
NOT SUPPLIED BY SHOPPER	Missing, incomplete or invalid address details in the order prevented the address from being checked
FAILED	Both street and postal code details did not match the payment provider's records

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:


M	CVV2 Match.
N	CVV2 No Match.
P	Not Processed.
S	Merchant has indicated that CVV2 is not present on card.
U	Issuer 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: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the field will contain:


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

Adyen

For Adyen, the field will contain:


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

Barclay

For Barclay, the field will contain:


0,1	CVM was not processed
2	CVM match
4	CVM does not match issuer value
Unknown	CVM invalid or missing
Blank	No response from server

BlueSnap

For BlueSnap, the field will contain:


MA	Match
NC	Issuer is not certified for CVV2/CVC2/CID
ND	Check was not done
NM	No match
NP	CVV2/CVC2/CID should be on the card but is not present
NR	CVV check not requested

(Note: There are some scenarios in which the field will be empty instead, refer to BlueSnap's documentation for more details.)

DataCash

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

Stripe

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


Pass	The CVC provided is correct.
Fail	The CVC provided is incorrect.
Unavailable	The customer's bank did not check the CVC provided.
Unchecked	The CVC was provided but has not yet been checked.

Worldpay Online

For Worldpay Online, the field will contain one of the following:


Value	Description
APPROVED	The supplied CVC details matched the payment provider's records
NOT SENT TO ACQUIRER	Problem with acquirer - possibly no CVC support
NO RESPONSE FROM ACQUIRER	Problem with acquirer - possibly no CVC support
NOT CHECKED BY ACQUIRER	The acquirer did not check the CVC details
NOT SUPPLIED BY SHOPPER	Missing, or invalid CVC in the payment details prevented the CVC from being checked
FAILED	The supplied CVC did not match the payment provider's records

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();