Fields are name/value pairs with the syntax:
x_name_of_field = value of the field&.
FIELD NAME |
REQUIRED |
VALUE |
FORMAT |
NOTES |
x_version |
Required |
The merchant's transaction version |
3.0, 3.1 |
Indicates to the system the set of fields that will be included in the response: 3.0 is the default version. 3.1 allows the merchant to utilize the Card Code feature, and is the current standard version.
It is highly recommended that you submit this field on a per-transaction basis to be sure that the formats of transaction requests and the responses you receive are consistent.
For more information, see the Appendix A Fields by Transaction Type topic. |
x_type |
Optional |
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_method |
Optional |
The payment method |
CC or ECHECK |
The method of payment for the transaction, CC (credit card) or ECHECK (electronic check). If this field is not submitted or is blank, the value defaults to CC.
For more information about eCheck.Net transaction requirements, see the Transaction Data Requirements for eCheck.Net topic of the eCheck.Net Developer Guide. |
x_recurring_billing |
Optional |
The recurring billing status |
TRUE, FALSE,T, F, YES, NO, Y, N, 1, 0 |
Indicating marker used by merchant account providers to identify transactions which originate from merchant hosted recurring billing applications. This value is not affiliated with Automated Recurring Billing. |
x_amount |
Required |
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. The amount can either be hard-coded or posted to a script. |
x_card_num |
Required |
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 |
Required |
The customer's credit card expiration date |
MMYY, |
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_card_code |
Optional |
The customer's card code |
Numeric |
The three- or four-digit number on the back of a credit card (on the front for American Express).
This field is required if the merchant would like to use the Card Code Verification (CCV) security feature. For more information, please see the Merchant Integration Guide.
Cardholder information must be stored securely and in accordance with the Payment Card Industry (PCI) Data Security Standard.
Please see the Developer Security Best Practices White Paper for more information. |
x_trans_id |
Conditional
Required only for CREDIT, PRIOR_ AUTH_ CAPTURE, and VOID transactions |
The payment gateway assigned transaction ID of an original transaction |
|
For more information about transaction types, see the Credit Card Transaction Types topic. |
x_auth_code |
Conditional
Required only for CAPTURE_ ONLY transactions |
The authorization code of an original transaction not authorized on the payment gateway |
6 characters |
See the Credit Card Transaction Types topic. |
x_test_request |
Optional |
The request to process test transactions |
TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0 |
Indicates whether the transaction should be processed as a test transaction.
See the Test Transactions topic for more information. |
x_duplicate_window |
Optional |
The window of time after the submission of a transaction that a duplicate transaction can not be submitted |
Any value between 0 and 28800 (no comma) |
Indicates the window of time, in seconds, after a transaction is submitted during which the payment gateway checks for a duplicate transaction. The maximum time allowed is 8 hours (28800 seconds).
If a value less than 0 is sent, the payment gateway defaults to 0 seconds. If a value greater than 28800 is sent, the payment gateway defaults to 28800. If no value is sent, the payment gateway defaults to 2 minutes (120 seconds).
If this field is present in the request with or without a value, an enhanced duplicate transaction response is sent. See the Response for Duplicate Transactions topic for more information. |