Fields by Transaction Type
This 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 API.
“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 if 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 Merchant plus gateway transactions.
AUTHORIZATION AND CAPTURE | AUTHORIZATION ONLY | PRIOR AUTHORIZATION AND CAPTURE | 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 |
Transaction Information | x_method = CC x_type = AUTH_CAPTURE | x_method = CC x_type = AUTH_ONLY | x_method = CC x_type = PRIOR_AUTH_CAPTURE x_trans_id | x_method = CC x_type =CREDIT x_trans_id | x_method = CC x_type = VOID x_trans_id |
Payment Information | x_amount x_card_num x_exp_date | x_amount x_card_num x_exp_date | N/A | N/A | N/A |
Required Fields for Additional AIM Features
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 Response | x_delim_data = TRUE x_delim_char x_encap_char | x_delim_data = TRUE x_delim_char x_encap_char | x_delim_data = TRUE x_delim_char x_encap_char | x_delim_ data = TRUE x_delim_ char x_encap_ char | x_delim_ data = TRUE x_delim_ char x_encap_ char |