Additional Shipping Information (Level 2 Data)

Fields are name/value pairs with the syntax of:

 

x_name_of_field = value of the field&.

 

FIELD NAME

REQUIRED?

VALUE

FORMAT

NOTES

x_tax

Optional

The valid tax amount OR delimited tax information

When submitting delimited tax information, values must be delimited by a bracketed pipe <|>

The tax amount charged OR when submitting this information via the transaction request string, delimited tax information including the sales tax name, description, and amount is also allowed.

 

The total amount of the transaction in x_amount must include this amount.

tax item name<|>

 

The tax item name.

tax description<|>

 

The tax item description.

tax amount

The dollar sign ($) is not allowed when submitting delimited information.

The tax item amount.

 

The total amount of the transaction in x_amount must include this amount.

Example:

x_tax=Tax1<|>state tax<|>0.0625&

x_freight

Optional

The valid freight amount OR delimited freight information

When submitting delimited freight information, values must be delimited by a bracketed pipe <|>

The freight amount charged OR when submitting this information via the transaction request string, delimited freight information including the freight name, description, and amount is also allowed.

 

The total amount of the transaction in x_amount must include this amount.

freight item name<|>

 

The freight item name.

freight description<|>

 

The freight item description.

freight amount

The dollar sign ($) is not allowed when submitting delimited information.

The freight amount.

 

The total amount of the transaction in x_amount must include this amount.

Example:

x_freight=Freight<|>ground overnight<|>12.95&

x_duty

Optional

The valid duty amount OR delimited duty information

When submitting delimited duty information, values must be delimited by a pipe <|>

The duty amount charged OR when submitting this information via the transaction request string, delimited duty information including the duty name, description, and amount is also allowed.

 

The total amount of the transaction in x_amount must include this amount.

duty item name<|>

 

The duty item name.

duty description<|>

 

The duty item description.

duty amount

The dollar sign ($) is not allowed when submitting delimited information.

The duty amount.

 

The total amount of the transaction in x_amount must include this amount.

Example:

x_duty=Duty1<|>export<|>15.00&

x_tax_exempt

Optional

The tax exempt status

TRUE, FALSE,

T, F,

YES, NO,

Y, N,

1, 0

Indicates whether the transaction is tax exempt.

x_po_num

Optional

The merchant assigned purchase order number

Up to 25 characters (no symbols)

The purchase order number must be created dynamically on the merchant server or provided on a per-transaction basis. The payment gateway does not perform this function.

Note: Delimited duty, freight, and tax information are not returned in the transaction response or in the merchant confirmation email. This information is displayed only on the Transaction Detail page in the Merchant Interface.

 

Related Topics