The following table lists the minimum fields required for submitting a credit card transaction request to the payment gateway using AIM. The data fields are name/value pairs with the following syntax:
x_name_of_field=value of field&.
|
FIELD NAME |
FORMAT |
VALUE |
NOTES |
|---|---|---|---|
|
x_login |
The merchant's unique API Login ID |
Up to 20 characters |
The merchant API Login ID is provided in the Merchant Interface and must be stored securely. The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway. See the Merchant Integration Guide for more information. |
|
x_tran_key |
The merchant's unique Transaction Key |
16 characters |
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely. The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway. See the Merchant Integration Guide for more information. |
|
x_type |
The type of credit card transaction |
AUTH_CAPTURE (default), AUTH_ONLY, CAPTURE_ONLY, CREDIT, PRIOR_AUTH_CAPTURE, VOID |
If the value submitted does not match a supported value, the transaction is rejected. If this field is not submitted or the value is blank, the payment gateway will process the transaction as an AUTH_CAPTURE. |
|
x_amount |
The amount of the transaction |
Up to 15 digits with a decimal point (no dollar symbol) Ex. 8.95 |
This is the total amount and must include tax, shipping, and any other charges. |
|
x_card_num |
The customer's credit card number |
Between 13 and 16 digits without spaces When x_type=CREDIT, only the last four digits are required. |
This is sensitive cardholder information and must be stored securely and in accordance with the Payment Card Industry (PCI) Data Security Standard. For more information about PCI, please see the Developer Security Best Practices White Paper. |
|
x_exp_date |
The customer's credit card expiration date |
MMYY, MM/YY, MM-YY, MMYYYY, MM/YYYY, MM-YYYY |
This is sensitive cardholder information and must be stored securely and in accordance with the Payment Card Industry (PCI) Data Security Standard. For more information about PCI, please see the Developer Security Best Practices White Paper. |
|
x_trans_id |
The payment gateway-assigned transaction ID of an original transaction |
|
Required only for CREDIT, PRIOR_AUTH_CAPTURE, and VOID transactions. Do not include this field if you are providing x_split_tender_id. For more information about transaction types, see the Credit Card Transaction Types topic. |
|
x_split_tender_id |
The payment gateway-assigned ID that links the current authorization request to the original authorization request. |
Numeric |
This value applies to partial authorization transactions only, and is returned in the reply message from the original authorization request. For more information, see Partial Authorization Transactions. |
|
x_auth_code |
The authorization code of an original transaction not authorized on the payment gateway |
6 characters |
Required only for CAPTURE_ONLY transactions. See the Credit Card Transaction Types topic. |
|
x_relay_response |
FALSE |
FALSE, F, NO, N, 0 |
SIM applications use relay response. Set this to false if you are using AIM. |
|
x_delim_data |
Indicates whether a delimited transaction response is required |
TRUE, T, YES, Y, 1 |
A value of TRUE indicates a request for delimited response from the payment gateway. Since all AIM transactions are direct response, a value of TRUE is required. It is recommended that you submit this field on a per-transaction basis to be sure that transaction responses are returned in the correct format. See Transaction Response for more about delimited response |