Back

Transaction Response Fields

This chapter describes the fields that are returned in the response from EPX after running a transaction.

AUTH_AMOUNT

The AUTH_AMOUNT tag contains the actual dollar amount that the transaction request was approved for.

• Variable Type: Numeric
• Max Length: 13
• Format: N.NN

<FIELD KEY="AUTH_AMOUNT">379.00</FIELD>

AUTH_AMOUNT_REQUESTED

The AUTH_AMOUNT_REQUESTED field contains the dollar amount that was used during the transaction request.

• Variable Type: Numeric
• Max Length: 13
• Format: N.NN

Example:

<FIELD KEY="AUTH_AMOUNT_REQUESTED">500.00</FIELD>

AUTH_AVAILABLE_BAL

The AUTH_AVAILABLE_BAL field contains the available balance / open to buy amount for the cardholder account. EPX will include this data in the response if returned by the issuing bank.

• Variable Type: Numeric
• Max Length: 13

Example:

<FIELD KEY="AUTH_AVAILABLE_BAL">500.00</FIELD>

AUTH_AVS

The AUTH_AVS field contains the Address Verification System response for the transaction requested. The address information sent in with the transaction is validated against the information at the issuing bank. This is a bank response that is passed along by EPX. EPX supports all AVS formats supported by the card networks.

The network-specific sections that follow define the possible response values for the Address Verification System (AVS) field.

• Variable Type: Alpha
• Max Length: 1

<FIELD KEY="AUTH_AVS">M</FIELD>

Visa

• A—Address matches, ZIP code does not. Acquirer rights not implied
• B—Street addresses match. Postal code not verified due to incompatible formats. (Acquirer sent both street address and postal code.)
• C—Street address and postal code not verified due to incompatible formats. (Acquirer sent both street address and postal code.)
• D—Street addresses and postal codes match.
• F—Street address and postal code match. Applies to U.K. only.
• G—Address information not verified for international transaction. Issuer is not an AVS participant, or AVS data was present in the request but issuer did not return an AVS result, or Visa performs AVS on behalf of the issuer and there was no address record on file for this account.
• I—Address information not verified.
• M—Street address and postal code match.
• N—No match. Acquirer sent postal/ZIP code only, or street address only, or both postal code and street address. Also used when acquirer requests AVS but sends no AVS data in field 123.
• P—Postal code match. Acquirer sent both postal code and street address, but street address not verified due to incompatible formats.
• R—Retry: System unavailable or timed out. Issuer ordinarily performs AVS but was unavailable. The code R is used by V.I.P. when issuers are unavailable. Issuers should refrain from using this code.
• S—Not applicable. If present, replaced with “U” (for domestic) or “G” (for international) by V.I.P. Available for U.S. issuers only.
• U—Address not verified for domestic transaction. Issuer is not an AVS participant, or AVS data was present in the request but issuer did not return an AVS result, or Visa performs AVS on behalf of the issuer and there was no address record on file for this account.
• W—Not applicable. If present, replaced with “Z” by V.I.P. Available for U.S. issuers only.
• X—Not applicable. If present, replaced with “Y” by V.I.P. Available for U.S. issuers only.
• Y—Street address and postal code match.
• Z—Postal/ZIP matches; street address does not.

MasterCard

• A—Address matches, postal code does not
• N—Neither address nor postal code matches
• R—Retry, system unable to process
• S—AVS currently not supported
• U—No data from issuer/Authorization Platform
• W—For U.S. addresses, nine-digit postal code matches, address does not; for address outside the U.S., postal code matches, address does not
• X—For U.S. addresses, nine-digit postal code and address matches; for addresses outside the U.S., postal code and address match
• Y—For U.S. addresses, five-digit postal code and address matches
• Z—For U.S. addresses, five-digit postal code matches, address does not

Discover

• Y—Address matches, five-digit Postal Code matches
• X—Address matches, nine-digit Postal Code matches
• A—Address matches, Postal Code does not
• Z—Five-digit Postal Code matches, address does not
• W—Nine-digit Postal Code matches, address does not
• G—Address information not verified for international Transaction
• S—AVS not supported at this time
• Z—Nothing matches
• R—Approved AVS N/A
• U—Retry, system unable to process

AMEX

• A—Billing Address only correct
• D—CM Name incorrect, Billing Postal Code matches
• E—CM Name incorrect, Billing Address and Postal Code match
• F—CM Name incorrect, Billing Address matches
• K—CM Name matches
• L—CM Name and Billing Postal Code match
• M—CM Name, Billing Address and Postal Code match
• N—No match, Billing Address and Postal Code are both incorrect
• O—CM Name and Billing Address match
• R—System unavailable; retry
• S—SE not allowed AAV function
• U—Information unavailable
• W—No, CM Name, Billing Address and Postal Code are all incorrect
• Y—Yes, Billing Address and Postal Code are both correct
• Z—Billing Postal Code only correct

AUTH_CARD_TYPE

The AUTH_CARD_TYPE field contains the card type code for the card used in the transaction request. The possible response values for the Card Type field are listed below.

• Variable Type: Alphanumeric
• Max Length: 1

<FIELD KEY="AUTH_CARD_TYPE">V</FIELD>

Card Types and Codes

• 0—Maestro
• 1—Solo Card
• 2—Switch Card
• 3—China Union
• 4—Citi Private Label
• 5—Synchrony
• 6—Stored Value / Gift Card
• 7—Voyager
• 8—WEX
• A—AliPay
• E—EBT
• J—JCB
• L—Private
• M—MasterCard
• N—Diners
• O—Other Debit
• R—Discover
• S—American Express
• V—Visa

AUTH_CODE

The AUTH_CODE field contains the approval code for the transaction requested. In the event that there is no approval, this field will be empty. Some issuers will return an authorization code on declined transactions. Use the AUTH_RESP value to determine if a transaction was approved.

• Variable Type: Alphanumeric
• Max Length: 6

Example:

<FIELD KEY="AUTH_CODE">000601</FIELD>

AUTH_CURRENCY_CODE

The AUTH_CURRENCY_CODE field contains the currency code used in the transaction request.

• Variable Type: Numeric
• Max Length: 3

Example:

<FIELD KEY="AUTH_CURRENCY_CODE">840</FIELD>

AUTH_CVV2

The AUTH_CVV2 field contains the CVV2 response for the transaction requested. The CVV value sent in with the transaction is validated against the information at the issuing bank. This is a bank response that is passed along by EPX. The table below defines the possible response values for the CVV2 field based on valid card type.

• Variable Type: Alpha
• Max Length: 1

<FIELD KEY="AUTH_CVV2">N</FIELD>

Visa

• Space—No result
• M—CVV2 match
• N—CVV2 does not match
• P—Not processed
• S—CVV2 should be on the card, but the merchant indicates that it is not
• U—Issuer is not certified or has not provided Visa with encryption keys, or both.

MasterCard

• M—CVV2 match
• N—CVV2 no match
• P—Not processed
• S—CVV2 is on the card, but the merchant has indicated that CVV2 is not present.
• U—Issuer is not Visa-certified for CVV2, has not provided Visa encryption keys, or both.

Discover

• M—CID Match
• N—CID No Match
• P—Not Processed
• S—CID should be on the Card, but the Merchant has indicated that it is not present
• U—Issuer is not certified

AMEX

• N —CID/4DBC/4CSC did not match
• U—CID/4DBC/4CSC was not checked
• Y—CID/4DBC/4CSC matched

AUTH_EBT_BAL_CASH

The AUTH_EBT_BAL_CASH field contains the available EBT Cash balance / open to buy amount for the cardholder account. EPX will include this data in the response if returned by the Networks.

• Variable Type: Numeric
• Max Length: 13

Example:

<FIELD KEY="AUTH_EBT_BAL_CASH">250.00</FIELD>

AUTH_EBT_BAL_FOOD

The AUTH_EBT_BAL_FOOD field contains the available EBT Food balance / open to buy amount for the cardholder account. EPX will include this data in the response if returned by the Networks.

• Variable Type: Numeric
• Max Length: 13

Example:

<FIELD KEY=" AUTH_EBT_BAL_FOOD">375.00</FIELD>

AUTH_EMV_DATA

The AUTH_EMV_DATA tag is provided in the response and the data must be provided back to the EMV kernel. The tag currently can contain up to 3 EMV tags from the issuer: Tags 91, 71, and 72. Data will be returned within this tag in the response nearly always.

• Tag 91 Issuer Authentication Data will be present 99.9% of the time.
• Tag 71 Issuer Script Template 1 will be present .01% of the time
• Tag 72 Issuer Script Template 1 will be present .01% of the time

Issuer scripts 0x71 and 0x72 can be very large, up to 128 bytes each, which is presented in HEX ASCII, so 256 characters each.

• Variable Type: Alphanumeric
• Max Length: variable

<FIELD KEY="AUTH_EMV_DATA">910AD1020739E23C7D443035</FIELD>

AUTH_GUID

The AUTH_GUID field contains the globally unique identifier (GUID), also commonly referred to as the EPX BRIC for the transaction requested. This value is unique throughout the EPX platform. When retained, the BRIC / GUID can be used later to reference the transaction for other transactions, such as a refund. It can also be used by the relationship manager to refer to specific transactions.

• Variable Type: Alphanumeric
• Max Length: 20

Example:

<FIELD KEY="AUTH_GUID">0V703WNY8DD00KXNQG1</FIELD>

AUTH_PAR

The AUTH_PAR response field contains the PAR (Payment Account Reference). EPX will include this field and value in the response if returned by the Networks. The PAR serves as a universal ID that can be used to tie all underlying tokens associated with a specific PAN (Primary Account Number).

• Variable Type: Alphanumeric
• Max Length: 40

<FIELD KEY="AUTH_PAR"></FIELD>

AUTH_REF_ID

The AUTH_REF_ID field contains the TeleCheck Trace ID for a TeleCheck transaction.

• Variable Type: Numeric
• Max Length: 25

Example:

<FIELD KEY="AUTH_REF_ID">8888888</FIELD>

AUTH_REF_PHONE_NBR

The AUTH_REF_PHONE_NBR field contains the Referral Phone Number for a Citi Bank Private Label Auth or Sale transaction.

• Variable Type: Numeric
• Max Length: 10

Example:

<FIELD KEY="AUTH_REF_PHONE_NBR">8005551234</FIELD>

AUTH_RESP

The AUTH_RESP field contains the response code for the transaction requested and should be used to determine the result of the transaction. This information is passed along from the issuing bank. Refer to the following tables for additional information on the ACH, CC, and PIN-less Debit response codes. In the ACH environment, the transaction receives an AUTH_CODE indication if there is anything wrong with the transaction that would cause it not to settle, including an invalid routing number.

Since ACH is not real time, EPX checks for a valid Routing Number and that all other required fields are available. Once the transaction is submitted to the Federal Reserve, merchants are notified via a return or notice of change if there is an issue or change with the account.

• Variable Type: Alphanumeric
• Max Length: 3

<FIELD KEY="AUTH_RESP">00</FIELD>

ACH Response Codes

ACH Response Codes

NACHA Account Status Declines

The following NACHA Status Declines can be returned in real time with EPX AUTH_RESP codes ‘14’ & ‘25’.

AAU Response Codes

AAU Response Codes

Credit Card / PIN Debit Response Codes

Visa Response Codes

MasterCard Response Codes

Discover Response Codes

PINless Debit Response Codes

PINless Debit Response Codes

AUTH_RESP_DETAIL

The AUTH_RESP_DETAIL field contains additional information for declined transactions. This information can change at any time and should not be used in code to validate the response of a transaction. The field is used to provide more information about the transaction when there is a decline. This field is not returned for all transaction and card types. A response version of Dynamic XML or 9 and higher is required.

• Variable Type: Alphanumeric
• Max Length: 1024

<FIELD KEY="AUTH_RESP_DETAIL">INVALID OR MISSING FLEET pageTags: 04 06</FIELD>

AUTH_RESP_TEXT

The AUTH_RESP_TEXT field contains additional information for the transaction requested. This information can change at any time and should not be used in code to validate the response of a transaction (except for a limited case with Account Updater, for MasterCard only). The field is used to provide more information about the transaction when there is a decline, or a transaction with insufficient information to process.

• Variable Type: Alphanumeric
• Max Length: 80

Example:

<FIELD KEY="AUTH_RESP_TEXT">APPROVAL</FIELD>

AUTH_RESP_TEXT_ENHANCED

The AUTH_RESP_TEXT_ENHANCED field contains additional information for declined transactions. This information can change at any time and should not be used in code to validate the response of a transaction. The field is used to provide more information about the transaction when there is a layered decline. This field is not returned for all transaction and card types. A response version of 10 and higher is required or can be set to “999” which will inherit new response versions as they are made available.

• Variable Type: Alphanumeric
• Max Length: 512

<FIELD KEY="AUTH_RESP_TEXT_ENHANCED">DECLINED - CANNOT APPROVE AT THIS TIME, TRY AGAIN LATER</FIELD>

AUTH_SPECIAL_1

The AUTH_SPECIAL_1 field contains the Purchase APR for a Citi Bank Private Label Auth or Sale transaction.

• Variable Type: Numeric
• Max Length: 25

<FIELD KEY="AUTH_SPECIAL_1">29.5</FIELD>

AUTH_SPECIAL_2

The AUTH_SPECIAL_2 field contains the APR Type for a Citi Bank Private Label Auth or Sale transaction.

• Variable Type: Alpha
• Max Length: 25

Example:

<FIELD KEY="AUTH_SPECIAL_2">V</FIELD>

AUTH_SPECIAL_3

The AUTH_SPECIAL_3 field contains the Status Flag for a Citi Bank Private Label Auth or Sale transaction.

• Variable Type: Alpha
• Max Length: 25

Example:

<FIELD KEY="AUTH_SPECIAL_3">A</FIELD>

AUTH_TRAN_DATE_GMT

The AUTH_TRAN_DATE_GMT field contains the date and time in GMT of when the transaction was processed.

• Variable Type: Alphanumeric
• Max Length: 22

Example:

<FIELD KEY="AUTH_TRAN_DATE_GMT">06/19/2009 05:31:40 PM</FIELD>

AUTH_TRAN_IDENT

The AUTH_TRAN_IDENT response tag contains the NTID (Network Transaction ID) value that is returned by the Networks only for approved transactions.

• Variable Type: Alphanumeric
• Max Length: 20
• REGEX: ^([A-Z0-9]){0,20}$

<AUTH_TRAN_IDENT>210817175754976</AUTH_TRAN_IDENT>

BATCH_ID

The BATCH_ID field contains the Batch ID sent in during the transaction request. This field is defined in the Transaction Request Fields.

• Variable Type: Numeric
• Max Length: 10

Example:

<FIELD KEY="BATCH_ID">20090315</FIELD>

LOCAL_DATE

The LOCAL_DATE field contains the local date the transaction request was sent relative to the time zone setting on the terminal that was used during the request.

• Variable Type: Numeric
• Format: MMDDYY
• Max Length: 6

The following example represents April 10, 2017:

<LOCAL_DATE>041017</LOCAL_DATE>

NETWORK_RESPONSE

The NETWORK_RESPONSE field includes additional information on the result of the transaction from the issuing bank. Refer to the response code tables for information on ACH, CC, and PIN-less Debit. The AUTH_RESP field should be used as the primary determination for the result of the transaction, and the NETWORK_RESPONSE used as a secondary source containing additional information usually for the declined reasoning.

• Variable Type: Alphanumeric
• Max Length: 3

<FIELD KEY="NETWORK_RESPONSE">05</FIELD>

LOCAL_TIME

The LOCAL_TIME field contains the local time the transaction request was sent relative to the time zone setting on the terminal that was used during the request.

• Variable Type: Numeric
• Format: HHMMSS (24hr)
• Max Length: 6

Example:

<LOCAL_TIME>100205</LOCAL_TIME>

ORIG_TRAN_TYPE

The ORIG_TRAN_TYPE field contains the TRAN_TYPE sent in the original transaction request from the client application. In some scenarios, and based on certain processing rules, the EPX platform may automatically change the TRAN_TYPE value before sending the transaction to the Card Networks for approval. The ORIG_TRAN_TYPE field will contain the original TRAN_TYPE value from the client request and can be used for matching purposes. The newly returned value in the TRAN_TYPE field will contain the transaction type that the transaction was processed as (after potentially being changed by EPX).

• Variable Type: Alphanumeric
• Max Length: 4

<ORIG_TRAN_TYPE>CCR9</ORIG_TRAN_TYPE>

TRAN_NBR

The TRAN_NBR field contains the transaction number sent in during the transaction request. This field is defined in the Transaction Request Fields.

• Variable Type: Numeric
• Max Length: 10

Example:

<FIELD KEY="TRAN_NBR">123</FIELD>

TRAN_TYPE

The TRAN_TYPE field contains the transaction type code sent in during the transaction request. This information identifies the nature, purpose, and/or reason for an individual transaction, primarily used for regulatory reporting requirements.

• Variable Type: Alphanumeric
• Max Length: 4

<FIELD KEY="TRAN_TYPE">CCE1</FIELD>

Top of Page