Fields are name/value pairs with the syntax of:
x_name_of_field = value of the field&.
|
FIELD NAME |
REQUIRED? |
VALUE |
FORMAT |
NOTES |
|
x_first_name |
Optional |
The first name associated with the customer's billing address |
Up to 50 characters (no symbols) |
|
|
x_last_name |
Optional |
The last name associated with the customer's billing address |
Up to 50 characters (no symbols) |
|
|
x_company |
Optional |
The company associated with the customer's billing address |
Up to 50 characters (no symbols) |
|
|
x_address |
Optional |
The customer's billing address |
Up to 60 characters (no symbols) |
Required if the merchant would like to use the Address Verification Service security feature.
For more information on AVS, see the Merchant Integration Guide. |
|
x_city |
Optional |
The city of the customer's billing address |
Up to 40 characters (no symbols) |
|
|
x_state |
Optional |
The state of the customer's billing address |
Up to 40 characters (no symbols) or a valid two-character state code |
|
|
x_zip |
Optional |
The ZIP code of the customer's billing address |
Up to 20 characters (no symbols) |
Required if the merchant would like to use the Address Verification Service security feature.
For more information on AVS, see the Merchant Integration Guide. |
|
x_country |
Optional |
The country of the customer's billing address |
Up to 60 characters (no symbols) |
|
|
x_phone |
Optional |
The phone number associated with the customer's billing address |
Up to 25 digits (no letters)
Ex. (123)123-1234 |
|
|
x_fax |
Optional |
The fax number associated with the customer's billing address |
Up to 25 digits (no letters)
Ex. (123)123-1234 |
|
|
x_email |
Optional |
The customer's valid email address |
Up to 255 characters
Ex. janedoe@customer.com |
The email address to which the customer's copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
For more information about Email Receipts, please see the Merchant Integration Guide. |
|
x_cust_id |
Optional |
The merchant assigned customer ID |
Up to 20 characters (no symbols) |
The unique identifier to represent the customer associated with the transaction.
The customer ID must be created dynamically on the merchant server or provided on a per-transaction basis. The payment gateway does not perform this function. |
|
x_customer_ip |
Optional |
The customer's IP address |
Up to 15 characters (no letters)
Ex. 255.255.255.255 |
IP address of the customer initiating the transaction. If this value is not passed, it defaults to 255.255.255.255.
This field is required when using the Fraud Detection Suite⢠(FDS) IP Address Blocking tool. For more information about FDS, see the Merchant Integration Guide. |