Functional Reference & Result Fields

In version 3.0 of the system, there are many ways to integrate a merchant's server with the system. This section provides a convenient reference to all of the types of information than can be sent to the system, and all of the things that could be expected in return. All integration with the system is done by performing an HTML form POST to https://secure.authorize.net/gateway/transact.dll

Form Fields

The following table provides an alphabetical list of all of the possible values that will be recognized by the systems when sent in an HTML form. This table specifies which fields and which values are needed for each of the different connection types.

v3.0 Gateway Interface Form Field Names

v2.5 Equivalent Form Field Names

Possible Values (Bold = Default if not present or stored)

WebLink

ADC Direct Response

ADC Relay Response

x_ADC_Delim_Character

DELIMCHARACTER

any character ( , )

 

optional

 

x_ADC_Delim_Data

 

TRUE

 

required

 

x_ADC_Encapsulate_Character

ENCAPSULATE

any character (none)

 

optional

 

x_ADC_Relay_Response

 

TRUE

 

 

required

x_ADC_URL

 

any valid URL (or FALSE for ADC Direct Response)

 

required (it is required for x_ADC_URL to have a value of “FALSE” for ADC Direct Response)

required

x_Address

ADDRESS

any string

optional

optional

optional

x_Amount

AMOUNT

any valid amount

required

required

required

x_Auth_Code

AUTHCODE

any valid Authorization Code

optional

optional

optional

x_Background_URL

(configuration value only)

any valid URL

optional

optional

optional

x_Bank_ABA_Code

ABACODE

any valid bank ABA code

optional - only req'd for all eCheck.Net transactions

optional - only req'd for all eCheck.Net transactions

optional - only req'd for all eCheck.Net transactions

x_Bank_Acct_Num

ACCTNO

any valid bank account number

optional - only req'd for all eCheck.Net transactions

optional - only req'd for all eCheck.Net transactions

optional - only req'd for all eCheck.Net transactions

x_Bank_Acct_Type

 

CHECKING, SAVINGS

optional

optional

optional

x_Bank_Name

BANKNAME

any valid bank name

optional

optional

optional

x_Card_Num

CARDNUM

any valid credit card number

required if not using x_Show_Form

required

required if not using x_Show_Form

x_City

CITY

any string

optional

optional

optional

x_Color_Background

(configuration value only)

any valid color or color hex code (White or #FFFFFF)

optional

optional

optional

x_Color_Link

 

any valid color or color hex code (Blue or #0000FF)

optional

optional

optional

x_Color_Text

(configuration value only)

any valid color or color hex code (Black or #000000)

optional

optional

optional

x_Company

 

any string

optional

optional

optional

x_Country

COUNTRY

any string

optional

optional

optional

x_Cust_ID

CUSTID

any string

optional

optional

optional

x_Customer_IP

Must be in the format 255.255.255.255

optional

optional

optional

x_Customer_Organization_Type

"I" or "B"
"I" = Individual
"B" = Business

optional

optional

optional

x_Customer_Tax_ID

20 digits (numbers and spaces only)

optional

optional

optional

x_Description

DESCRIPTION

any string

optional

optional

optional

x_Drivers_License_Num

ECHECK only, any string

optional

optional

optional

x_Drivers_License_State

ECHECK only, 2-character state abbreviation

optional

optional

optional

x_Drivers_License_DOB

ECHECK only, YYYYMMDD

optional

optional

optional

x_Duty

 

any valid amount

optional

optional

optional

x_Email

EMAIL

any valid email address

optional

optional

optional

x_Email_Customer

EMAILCUSTOMER

TRUE, FALSE

optional

optional

optional

x_Email_Merchant

(configuration value only)

TRUE, FALSE

optional

optional

optional

x_Exp_Date

EXPDATE

mmyy, mm/yy, mm/yyyy

required if not using x_Show_Form

required

required if not using x_Show_Form

x_Fax

FAX

any string

optional

optional

optional

x_First_Name

 

any string

optional

optional

optional

x_Footer_Email_Receipt

(configuration value only)

any valid text

optional

optional

optional

x_Footer_Html_Payment_Form

(configuration value only)

any valid text or HTML

optional

optional

optional

x_Footer_Html_Receipt

(configuration value only)

any valid text or HTML

optional

optional

optional

x_Freight

 

any valid amount

optional

optional

optional

x_Header_Email_Receipt

(configuration value only)

any valid text

optional

optional

optional

x_Header_Html_Payment_Form

 

any valid text or HTML

optional

optional

optional

x_Header_Html_Receipt

(configuration value only)

any valid text or HTML

optional

optional

optional

x_Invoice_Num

INVOICE

any string

optional

optional

optional

x_Last_Name

NAME

any string

optional

optional

optional

x_Login

LOGIN

any valid merchant login ID

required

required

required

x_Logo_URL

(configuration value only)

any valid URL

optional

optional

optional

x_Merchant_Email

(configuration value only)

any valid email address

optional

optional

optional

x_Method

METHOD

CC, ECHECK

optional - should be set to ECHECK for eCheck.Net transactions

optional - should be set to ECHECK for eCheck.Net transactions

optional - should be set to ECHECK for eCheck.Net transactions

x_Password

PASSWORD

valid password for the Login ID specified in x_Login

 

optional - only required for x_Type values of CREDIT, VOID, CAPTURE_ONLY, and PRIOR_AUTH_CAPTURE

optional - only required for x_Type values of CREDIT, VOID, CAPTURE_ONLY, and PRIOR_AUTH_CAPTURE

x_Phone

PHONE

any string

optional

optional

optional

x_PO_Num

 

any string

optional

optional

optional

x_Receipt_Link_Method

(configuration value only)

LINK, POST, GET

optional

optional

optional

x_Receipt_Link_Text

(configuration value only)

any string (“Continue”)

optional

optional

optional

x_Receipt_Link_URL

(configuration value only)

any valid URL (must also exist in Merchant Configuration)

optional

optional

optional

x_Rename

 

[OldVariableName], [NewVariableName]

optional

optional

optional

x_Ship_To_Address

 

any string

optional

optional

optional

x_Ship_To_City

 

any string

optional

optional

optional

x_Ship_To_Company

 

any string

optional

optional

optional

x_Ship_To_Country

 

any string

optional

optional

optional

x_Ship_To_First_Name

 

any string

optional

optional

optional

x_Ship_To_Last_Name

 

any string

optional

optional

optional

x_Ship_To_State

 

any string

optional

optional

optional

x_Ship_To_Zip

 

any string

optional

optional

optional

x_Show_Form

 

PAYMENT_FORM (do not use this field if you do not want to show the system’s payment form)

optional

 

optional

x_State

STATE

any string

optional

optional

optional

x_Tax

 

any valid amount

optional

optional

optional

x_Tax_Exempt

 

TRUE, FALSE

optional

optional

optional

x_Test_Request

TESTREQUEST

TRUE, FALSE

optional

optional

optional

x_Trans_ID

TRANSID

any valid Transaction ID

optional

optional

optional

x_Type

TYPE

AUTH_CAPTURE, AUTH_ONLY, CAPTURE_ONLY, CREDIT, VOID, PRIOR_AUTH_CAPTURE

optional--see the table below for more information

optional--see the table below for more information

optional--see the table below for more information

x_Use_Fraudscreen

 

(Reserved for future use)

Not yet supported

 

 

x_Version

 

2.5, 3.0

Optional, but strongly recommended to be set to 3.0 to inform the system that you are passing 3.0 code.

Optional, but strongly recommended to be set to 3.0 to inform the system that you are passing 3.0 code.

Optional, but strongly recommended to be set to 3.0 to inform the system that you are passing 3.0 code.

x_Zip

ZIP

any string

optional

optional

optional

Transaction Types

The following table provides a description of the several different transaction types for use with the x_Type form field.

Type

Description

AUTH_CAPTURE

Auth-Capture is the normal transaction method; a transaction is sent to Authorize.Net for approval, the transaction is approved, the merchant is notified of the approval, and the transaction automatically settles at the end of the business day without any further action by the merchant.

AUTH_ONLY

Auth-Only stands for Authorization-Only and means obtaining an authorization for a certain amount on a customer's credit card without actually charging the card.

PRIOR_AUTH_CAPTURE

A Prior-Auth-Capture transaction is used to capture funds authorized previously using an Auth-Only transaction. Prior-Auth-Capture is really just an operation on an already existing transaction. Prior-Auth-Capture should only be used on Auth-Only transactions processed using the Authorize.Net system.

CAPTURE_ONLY

Capture-Only transactions are used when an authorization-only is obtained through any means other than the Authorize.Net system.

CREDIT

Credits are not processed in real time, but are submitted at settlement time with other transactions.

VOID

Voiding a transaction prevents a charge to a credit card/bank account from occurring. Voids are performed on existing transactions that have yet to be settled.

Result Fields

The table below provides a reference to all of the fields of information that are included in the batch download file, or are returned by one of the Automated Direct Connect (ADC) methods.

The ADC methods provide a method by which a merchant's server can integrate directly with the system to send transactions and receive responses.

The ADC Relay Response method will return an HTML form POST containing the following fields to a script written by the merchant to complete the purchasing process and/or generate an HTML page to be displayed to the customer. The URL of this script is designated using the x_ADC_URL field, and must be set as one of the Valid ADC or Receipt Link URLs in the URL Manager section of the Settings menu. This post will occur after the transaction is processed, and the response given by the merchant's script will be displayed to the customer as the result of the transaction. It is possible that none of the system's pages will ever be displayed using this method.

The ADC Direct Response method will return a simple comma delimited string (field1,field2,field3,etc.) containing the fields from the following table in the order indicated below. This format can be changed in the Automated Direct Connect (ADC) Settings section of the Settings menu. A developer would parse this string to obtain the desired information.

Position in Direct Response return

Field Name

Description

1

x_response_code

Indicates the result of the transaction.

1 = Approved,
2 = Declined,
3 = Error

2

x_response_subcode

A code used by the system for internal transaction tracking

3

x_response_reason_code

A code representing more details about the result of the transaction.

4

x_response_reason_text

Brief description of result, which corresponds with the Response Reason Code

5

x_auth_code

6 digit approval code

6

x_avs_code

Indicates the result of Address Verification System (AVS) checks.

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 = 9 digit ZIP matches, Address (Street) does not
X = Address (Street) and 9 digit ZIP match
Y = Address (Street) and 5 digit ZIP match
Z = 5 digit ZIP matches, Address (Street) does not

7

x_trans_id

This number identifies the transaction in the system, and can be used to submit a modification of this transaction at a later time via HTML form POST (such as voiding the transaction, or capturing an Auth Only transaction).

8

x_invoice_num

echoed from form input values

9

x_description

echoed from form input values

10

x_amount

echoed from form input values

11

x_method

echoed from form input values

12

x_type

echoed from form input values

13

x_cust_id

echoed from form input values

14

x_first_name

echoed from form input values

15

x_last_name

echoed from form input values

16

x_company

echoed from form input values

17

x_address

echoed from form input values

18

x_city

echoed from form input values

19

x_state

echoed from form input values

20

x_zip

echoed from form input values

21

x_country

echoed from form input values

22

x_phone

echoed from form input values

23

x_fax

echoed from form input values

24

x_email

echoed from form input values

25

x_ship_to_first_name

echoed from form input values

26

x_ship_to_last_name

echoed from form input values

27

x_ship_to_company

echoed from form input values

28

x_ship_to_address

echoed from form input values

29

x_ship_to_city

echoed from form input values

30

x_ship_to_state

echoed from form input values

31

x_ship_to_zip

echoed from form input values

32

x_ship_to_country

echoed from form input values

33

x_tax

echoed from form input values

34

x_duty

echoed from form input values

35

x_freight

echoed from form input values

36

x_tax_exempt

echoed from form input values

37

x_po_num

echoed from form input values

38

x_md5_hash

generated by the system and to be validated by merchant for added security

39

any merchant defined fields in the order the system received them

echoed from form input values

Last updated: Friday, May 18, 2001 12:36 PM MDT