Transaction Response

The transaction response from the payment gateway is returned as a delimited string and provides information about the status of a transaction—whether it was accepted or declined—as well as information included in the transaction request.

Fields in the response are delimited by a character that is specified in the transaction request string (x_delim_char) or configured in the Merchant Interface. The merchant server can parse this data to customize receipt messages to display or email to the customer. Transaction results are also provided in the payment gateway merchant confirmation email, and on the Transaction Detail page for the transaction in the Merchant Interface.

You can use the following fields to customize the format of the payment gateway transaction response. You can also configure these settings in the NaviGate Merchant Interface.

Fields are name/value pairs with the syntax: x_name_of_field=value of the field&.

Field Name

Description

x_delim_data

Value: The request to receive a delimited transaction response

format: TRUE

Notes: In order to receive a delimited response from the payment gateway,submit this field with a value of TRUE, or the merchant has to configure a delimited response through the Merchant Interface. Submit this field for each transaction basis to be sure that transaction responses are returned in the correct format.

x_delim_char

Value: The delimiting character

Format: A single symbol. For example: , (comma), | (pipe), “ (double quotes), ‘ (single quote), : (colon), ; (semicolon), / (forward slash), \ (back slash), - (dash), * (star)

Notes: The character used to separate fields in the transaction response. The payment gateway uses the character passed in this field or, if no value is passed, the value stored in the Merchant Interface. If this field is passed, and the value is null, it overrides the value stored in the Merchant Interface and there is no delimiting character in the transaction response. Submit this field for each transaction to be sure that transaction responses are returned in the correct format.

x_encap_char

Value: The encapsulating character

Format: A single symbol. For example: | (pipe), “ (double quotes), ‘ (single quote), : (colon), ; (semicolon), / (forward slash), \ (back slash), - (dash), * (star).

Notes: The character used to encapsulate the fields in the transaction response. This is necessary only if your delimiting character could possibly be included in any field values. The payment gateway uses the character passed in this field or, If no value is passed, the value stored in the Merchant Interface.

Fields in the Payment Gateway Response

The following table lists the fields returned in the response from the merchant payment gateway.

Order	Field Name	Description
1	Response Code	Value: The overall status of the transaction Format: 1 = Approved 2 = Declined 3 = Error
2	Response Sub code	Value: A code used by the payment gateway for internal transaction tracking
3	Response Reason Code	Value: A code that represents more details about the result of the transaction Format: Numeric Notes: See the "Response Code Details," section of this document for a listing of response reason codes.
4	Response Reason Text	Value: A brief description of the result, which corresponds with the response reason code Format: Text Notes: You can generally use this text to display a transaction result or error to the customer. However, review the"Response Code Details," section of this document to identify any specific texts you do not want to pass to the customer.
5	Approval Code	Value: The authorization or approval code Format: 6 characters
6	AVS Response	Value: The Address Verification Service (AVS) response code Format: A = Address (Street) matches, ZIP does not B = Address information not provided for AVS check E = AVS error G = Non-U.S. Card Issuing Bank N = No Match on Address (Street) or ZIP P = AVS not applicable for this transaction R = Retry—System unavailable or timed out S = Service not supported by issuer U = Address information is unavailable W = Nine digit ZIP matches, Address (Street) does not X = Address (Street) and nine digit ZIP match Y = Address (Street) and five digit ZIP match Z = Five digit ZIP matches, Address (Street) does not Notes: Indicates the result of the AVS filter.
7	Transaction ID	Value: The payment gateway-assigned identification number for the transaction Notes: This value must be used for any follow on transactions such as a CREDIT, PRIOR_AUTH_CAPTURE or VOID.
8	Invoice Number	Value: The merchant-assigned invoice number for the transaction Format: Up to 20 characters (no symbols)
9	Description	Value: The transaction description Format: Up to 255 characters (no symbols)
10	Amount	Value: The amount of the transaction Format: Up to 15 digits
11	Method	Value: The payment method CC or SVP
12	Transaction Type	Value: The type of credit card transaction Format: AUTH_CAPTURE, AUTH_ONLY, CREDIT, PRIOR_AUTH_CAPTURE, VOID
13	Customer ID	Value: The merchant-assigned customer ID Format: Up to 20 characters (no symbols)
14	First Name	Value: The first name associated with the customer’s billing address Format: Up to 50 characters (no symbols)
15	Last Name	Value: The last name associated with the customer’s billing address Format: Up to 50 characters (no symbols)
16	Company	Value: The company associated with the customer’s billing address Format: Up to 50 characters (no symbols)
17	Address	Value: The customer’s billing address Format: Up to 60 characters (no symbols)
18	City	Value: The city of the customer’s billing address Format: Up to 40 characters (no symbols)
19	State	Value: The state of the customer’s billing address Format: Up to 40 characters (no symbols) or a valid two-character state code
20	ZIP Code	Value: The ZIP code of the customer’s billing address Format: Up to 20 characters (no symbols)
21	Country	Value: The country of the customer’s billing address Format: Up to 60 characters (no symbols)
22	Phone	Value: The phone number associated with the customer’s billing address Format: Up to 25 digits (no letters). For example, (123)123-1234
23	Fax	Value: The fax number associated with the customer’s billing address Format: Up to 25 digits (no letters). For example, (123)123-1234
24	Email Address	Value: The customer’s valid email address Format: Up to 255 characters
25	Ship To First Name	Value: The first name associated with the customer’s shipping address Format: Up to 50 characters (no symbols)
26	Ship To Last Name	Value: The last name associated with the customer’s shipping address Format: Up to 50 characters (no symbols)
27	Ship To Company	Value: The company associated with the customer’s shipping address Format: Up to 50 characters (no symbols)
28	Ship To Address	Value: The customer’s shipping address Format: Up to 60 characters (no symbols)
29	Ship To City	Value: The city of the customer’s shipping address Format: Up to 40 characters (no symbols)
30	Ship To State	Value: The state of the customer’s shipping address Format: Up to 40 characters (no symbols) or a valid two character state code
31	Ship To ZIP Code	Value: The ZIP code of the customer’s shipping address Format: Up to 20 characters (no symbols)
32	Ship To Country	Value: The country of the customer’s shipping address Format: Up to 60 characters (no symbols)
33	Tax	Value: The tax amount charged Format: Numeric Notes: Delimited tax information is not included in the transaction response.
34	Duty	Value: The duty amount charged Format: Numeric Notes: Delimited duty information is not included in the transaction response.
35	Freight	Value: The freight amount charged Format: Numeric Notes: Delimited freight information is not included in the transaction response.
36	Tax Exempt	Value: The tax exempt status Format: T, F
37	Purchase Order Number	Value: The merchant assigned purchase order number Format: Up to 25 characters (no symbols)
38	MD5 Hash	Value: The payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
39	Card Code Response	Value: The card code verification (CCV) response code Format: M = Match N = No Match P = Not Processed S = Should have been present U = Issuer unable to process request Notes: Indicates the result of the CCV filter. For more information about CCV, see the Merchant Integration Guide at http://www.merchantplus.com/support/merchant/.

API Transaction Response

The following is a sample SALE Transaction query string:

https://gateway.merchantplus.com/cgi-bin/PAWebClient.cgi?x_Login=APIUSER&x_Tran_Key=TRANSKEY&x_First_Name=Joe&x_Last_Name=Doe&x_Company=XYZ+Company&x_Address=29+Broadway&x_City=New+York&x_State=NY&x_Zip=10006&x_Country=US&x_Phone=8005461997&x_Fax=&x_Cust_Id=23232323&x_Customer_Tax_ID=123456789&x_Email=TEST@EMAIL.COM&x_Invoice_Num=1232132132&x_Ship_To_First_Name=John&x_Ship_To_Last_Name=Doe&x_Ship_To_Company=XYZ+Company&x_Ship_To_Address=29+Broadway&x_Ship_To_City=New+York&x_Ship_To_State=NY&x_Ship_To_Zip=10006&x_Amount=102&x_Method=CC&x_Type=AUTH_CAPTURE&x_Card_Num=4111111111111111&x_Exp_Date=1218&x_Card_Code=123&x_delim_data=TRUE&x_delim_char=

The response would be:

1,,1,This transaction has been approved,001331,N,5786,1232132132,,10200,,AUTH_CAPTURE,23232323,John,Doe,XY Company,29 Broadway,New York,NY,10006,x_Phone=8005461997,,,test@email.com,John,Doe,XYZ Company,29 Broadway,New York,NY,10006,,0,0,0,0,,,,M,

Response Code Details

The following tables list the response codes and response reason texts that are returned for each transaction.

Response Code indicates the overall status of the transaction with possible values of approved, declined, error-ed, or held for review.
Response Reason Code is a numeric representation of a more specific reason for the transaction status.
Response Reason Text details the specific reason for the transaction status. This information can be returned to the merchant and/or customer to provide more information about the status of the transaction.

Response Codes

RESPONSE CODE	DESCRIPTION
1	This transaction has been approved.
2	This transaction has been declined.
3	There has been an error processing this transaction

Response Reason Codes and Response Reason Text

RESPONSE CODE	RESPONSE REASON CODE	RESPONSE REASON TEXT
1	1	This transaction has been approved.
2	2	This transaction has been declined.
3	6	The credit card number is invalid.
3	7	The credit card expiration date is invalid.
3	8	The credit card expiration date is invalid.
3	13	The merchant Login ID or Password or TransactionKey is invalid or the account is inactive.
3	15	The transaction ID is invalid.
3	16	The transaction was not found
3	17	The merchant does not accept this type of credit card.
3	19	An error occurred during processing. Please try again in 5 minutes.
3	33	A required field is missing.
3	42	There is missing or invalid information in a parameter field.
3	47	The amount requested for settlement may not be greater than the original amount authorized.
3	49	A transaction amount equal or greater than $100000 will not be accepted.
3	50	This transaction is awaiting settlement and cannot be refunded.
3	51	The sum of all credits against this transaction is greater than the original transaction amount.
3	57	A transaction amount less than $1 will not be accepted.
3	64	The referenced transaction was not approved.
3	69	The transaction type is invalid.
3	70	The transaction method is invalid.
3	72	The authorization code is invalid.
3	73	The driver's license date of birth is invalid.
3	84	The referenced transaction was already voided.
3	85	The referenced transaction has already been settled and cannot be voided.
3	86	Your settlements will occur in less than 5 minutes. It is too late to void any existing transactions.
3	87	The transaction submitted for settlement was not originally an AUTH_ONLY.
3	88	Your account does not have access to perform that action.
3	89	The referenced transaction was already refunded.
3	90	Data Base Error.
3	91	The merchant ID or eWiseNetwork ID is invalid. (SVP )
3	92	eWiseNetwork Communication or SOAP Error. (SVP )
3	101	eWiseFinancialNetwork table Empty No FILIST .(SVP )

Email Receipt

Merchants can choose to send a payment gateway-generated email receipt to customers who provide an email address with their transaction. The email receipt includes a summary and results of the transaction. To the customer, this email appears to be sent from the merchant contact that is configured as the Email Sender in the Merchant Interface.

To send the payment gateway-generated customer email receipt, submit the API fields in the following table, with the transaction request string. These settings can also be configured in the Merchant Interface.

Fields are name/value pairs with the syntax of: x_name_of_field=value of the field&.

Field Name	Description
x_email	Value: The customer’s valid email address Format: Up to 255 characters. For example, user@merchantplus.com Notes: The email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
x_email_customer	Value: The customer email receipt status Format: TRUE, FALSE Notes: Indicates whether an email receipt should be sent to the customer. If set to TRUE, the payment gateway will send an email to the customer after the transaction is processed using the customer email address submitted with the transaction. If FALSE, no email is sent to the customer. If no value is submitted, the payment gateway will look up the configuration in the Merchant Interface and send an email only if the merchant has enabled the setting. If this field is not submitted and the setting is disabled in the Merchant Interface, no email is sent.
x_email_merchant	Value: The merchant email receipt status Format: TRUE, FALSE Notes: Indicates whether an email receipt should be sent to the merchant. If set to TRUE, the payment gateway will send an email to the merchant after the transaction is processed using the merchant email address submitted with the transaction. If FALSE, no email is sent to the merchant. If no value is submitted, the payment gateway will look up the configuration in the Merchant Interface and send an email only if the merchant has enabled the setting. If this field is not submitted and the setting is disabled in the Merchant Interface, no email is sent.
x_merchant_email	Value: Any merchant valid email address Format: Up to 255 characters Only one email address per variable is allowed Notes: Email address to which the merchant’s copy of the customer confirmation email should be sent. If a value is submitted, an email will be sent to this address as well as the address(es) configured in the Merchant Interface. Warning If it is included, it can subject the merchant to spam on their business email address, because it announces where the receipt gets returned to, and gives a hint where relay response or silent post information may be sent.