Appendix A - Fields by Transaction Type

This appendix provides a complete listing of all API fields that should be submitted for each transaction type supported for AIM. It is divided into the following sections:

the minimum fields required to submit a transaction,
additional fields that are required in order to configure advanced features of AIM
best practice fields, or fields that the payment gateway recommends should be submitted on a per-transaction basis in order to maintain a strong connection to the payment gateway—for example, to prevent possible conflicts in the event that integration settings in the Merchant Interface are inadvertently changed.

Minimum Required Fields

The following table provides a quick reference of all API fields that are required for each transaction type supported for AIM.

AUTHORIZATION AND CAPTURE

AUTHORIZATION ONLY

PRIOR AUTHORIZATION AND CAPTURE

CAPTURE ONLY

CREDIT

VOID

Merchant Information

x_login

x_tran_key

x_login

x_tran_key

x_login

x_tran_key

x_login

x_tran_key

x_login

x_tran_key

x_login

x_tran_key

Transaction Information

x_type =

AUTH_CAPTURE

x_type = AUTH_ONLY

x_type =

PRIOR_AUTH_

CAPTURE

x_trans_id

x_type =

CAPTURE_

ONLY

x_auth_code

x_type = CREDIT

x_trans_id*

x_type =

VOID

x_trans_id

Payment Information

x_amount

x_card_num

x_exp_date

x_amount

x_card_num

x_exp_date

x_amount

(required only when less than the original authorization amount)

x_amount

x_card_num

x_exp_date

x_amount

x_card_num

x_exp_date**

N/A

* For merchants enabled for expanded credit capabilities (ECC), a Transaction ID should NOT be submitted for Unlinked Credits. For more information, see Credit Card Transaction Types.

** The expiration date is only required for Unlinked Credits.

Required Fields for Additional AIM Features

The following table provides a quick reference of additional fields that are required for advanced features of AIM and that cannot be configured in the Merchant Interface. For example, if the merchant wants to submit itemized order information, you must submit fields in addition to the minimum required fields.

	AUTHORIZATION AND CAPTURE	AUTHORIZATION ONLY	PRIOR AUTHORIZATION AND CAPTURE	CAPTURE ONLY	CREDIT	VOID
Itemized Order Information	x_line_item x_tax¹ x_freight¹ x_duty¹	x_line_item x_tax¹ x_freight¹ x_duty¹	x_line_item x_tax¹ x_freight¹ x_duty¹	x_line_item x_tax¹ x_freight¹ x_duty¹	x_line_item x_tax¹ x_freight¹ x_duty¹	N/A
Cardholder Authentication	x_authentication_ indicator x_cardholder_authentication_ value	x_authentication_ indicator x_cardholder_authentication_ value	N/A	N/A	N/A	N/A
Fraud Detection Suite™ (FDS)	x_customer_ip (required only when the merchant is using the FDS IP blocking tool)	x_customer_ip (required only when the merchant is using the FDS IP blocking tool)	N/A	N/A	N/A	N/A

¹ These fields can support either a straight numeric value, or line item details similar to x_line_item.

Note: For Prior Authorization and Capture transactions, if line item information was submitted with the original transaction, adjusted information can be submitted in the event that the transaction changed. If no adjusted line item information is submitted, the information submitted with the original transaction will apply.

Best Practice Fields

The following table provides a quick reference of additional API fields that the payment gateway highly recommends should be submitted on a per-transaction basis in order to maintain a strong connection.

AUTHORIZATION AND CAPTURE

AUTHORIZATION ONLY

PRIOR AUTHORIZATION AND CAPTURE

CAPTURE ONLY

CREDIT

VOID

Transaction Information

x_version = 3.1

Transaction Response

x_delim_data = TRUE

x_delim_char

x_encap_char

x_relay_response = FALSE*

x_delim_data = TRUE

x_delim_char

x_encap_char

x_relay_response = FALSE*

x_delim_data = TRUE

x_delim_char

x_encap_char

x_relay_response = FALSE*

x_delim_ data = TRUE

x_delim_ char

x_encap_ char

x_relay_ response = FALSE*

x_delim_ data = TRUE

x_delim_

char

x_encap_

char

x_relay_ response = FALSE*

x_delim_ data = TRUE

x_delim_ char

x_encap_ char

x_relay_ response = FALSE*

* The x_relay_response field is not technically an AIM feature; however, it is recommended that you submit this field on a per-transaction basis with the value of “FALSE” as a best practice to further define the AIM transaction format.