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 SIM. 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 SIM, and
“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 SIM.

	AUTHORIZATION AND CAPTURE	AUTHORIZATION ONLY	PRIOR AUTHORIZATION AND CAPTURE	CREDIT	VOID
Merchant Information	x_login	x_login	x_login	x_login	x_login
Fingerprint Information	x_fp_hash x_fp_sequence x_fp_timestamp	x_fp_hash x_fp_sequence x_fp_timestamp	x_fp_hash x_fp_sequence x_fp_timestamp	x_fp_hash x_fp_sequence x_fp_timestamp	x_fp_hash x_fp_sequence x_fp_timestamp
Transaction Information	x_type = AUTH_CAPTURE	x_type = AUTH_ONLY	x_type = PRIOR_AUTH_ CAPTURE x_trans_id	x_type = CREDIT x_trans_id	x_type = VOID x_trans_id
Payment Information	x_amount	x_amount	x_amount (required only when less than the original authorization amount)	x_amount x_card_num (partial number only)	N/A
Payment Form Configuration	x_show_form = PAYMENT_FORM	x_show_form = PAYMENT_FORM	N/A	N/A	N/A

Required Fields for Additional SIM Features

The following table provides a quick reference of additional fields that are required for advanced features of SIM 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	CREDIT	VOID
Itemized Order Information	x_line_item	x_line_item	N/A	N/A	N/A
Relay Response Configuration	x_relay_response = TRUE x_relay_url	x_relay_response = TRUE x_relay_url	N/A	N/A	N/A
Fraud Detection Suite^TM (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

Best Practices 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	CREDIT	VOID
Transaction Information	x_version = 3.1	x_version = 3.1	x_version = 3.1	x_version = 3.1	x_version = 3.1
Payment Form Configuration	x_header_html_payment_ form x_footer_html_payment_ form	x_header_html_payment_ form x_footer_html_payment_ form	N/A	N/A	N/A
Receipt Page Configuration	x_receipt_link_method x_header_html_receipt x_footer_html_receipt	x_receipt_link_method x_header_html_receipt x_footer_html_receipt	N/A	N/A	N/A