Tax Fields

Credit card billing country. Use the two-character ISO Standard Country Codes. When

shipTo_country

is not provided,

billTo_country

is used in its place. When

billTo_country

is set to

US

or

CA

,

billTo_postalCode

and

billTo_state

are also required. It is your responsibility to determine whether a field is required for the transaction you are requesting.

String (15)

—

String (5)

—

—

Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday.

String (8)

—

—

Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the

show_tax_per_offer

field is set to

yes

.

String (15)

Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the

show_tax_per_offer

field is set to

yes

.

String (15)

Line Amount total.

String (15)

—

String (15)

Merchant ID. Use the same merchant ID for evaluation, testing, and production.

String (30)

Merchant-generated order reference or tracking number.

String (50)

This item-level field overrides the corresponding request-level field. This field is not used unless the

item_#_orderAcceptanceState

and

item_#_orderAcceptanceCountry

fields are present.

String (50)

This item-level field overrides the corresponding request-level field. This field is not used unless the

item_#_ orderAcceptanceState

and

item_#_ orderAcceptanceCity

fields are present. Use the two-character ISO Standard Country Codes.

String (2)

Order acceptance ZIP/Postal Code.

String (10)

This item-level field overrides the corresponding request-level field. This field is not used unless the

item_#_orderAcceptanceCity

and

item_#_orderAcceptanceCountry

fields are present. Use the State, Province, and Territory Codes for the United States and Canada.

String (2)

Order origin city. This field is not used unless the

taxService_orderOriginState

and

taxService_orderOriginCountry

fields are present.

String (50)

This item-level field overrides the corresponding request-level field. This field is not used unless the

item_#_orderAcceptanceState

and

item_#_orderAcceptanceCity

fields are present. Use the two-character ISO Standard Country Codes.

String (2)

Order origin postal code. This field is not used unless the

taxService_orderOriginCity

,

taxService_orderOriginState

, and

taxService_orderOriginCountry

fields are present.

String (10)

Order origin state. This field is not used unless the

taxService_orderOriginCity

and

taxService_orderOriginCountry

fields are present. Use the State, Province, and Territory Codes for the United States and Canada.

String (2)

Type of product. This value is used to determine the product category: electronic, handling, physical, service, or shipping. The default value is default. To use the tax calculation service, use values listed in the Tax Product Code Guide. For information about this document, contact Customer Support.

String (20)

Name of the product. Some services use this value for communication with the customer, so the name should clearly represent the product. For

ccAuthService

and

ccCaptureService

, required if

item_#_productCode

is not default or one of the values related to shipping and handling.

String (30)

Product’s identifier code. For

ccAuthService

and

ccCaptureService

, required if

item_#_productCode

is not default or one of the values related to shipping and handling.

String (30)

Quantity of the product being purchased.

String (20)

Jurisdiction tax rate for the item.

String (15)

Reporting date of any committed transaction. Defaults to current date if not provided. Also the default Tax Calculation Date unless a different date is specified in

invoiceHeader_invoiceDate

.

String (8)

Identifier for the request.

String (26)

City from which the order is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This field is used only when

shipFrom_state

and

shipFrom_country

are present.

String (50)

Country from which the product is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This item-level field overrides the corresponding request-level field. Use the two character ISO Standard Country Codes.

String (2)

Postal code from which the product is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This item-level field overrides the corresponding request-level field.

String (10)

State from which the order is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This field is used only when

shipFrom_city

and

shipFrom_country

are present. Use the State, Province, and Territory Codes for the United States and Canada.

String (2)

City of the shipping address. This field is used only when the

shipTo_state

and

shipTo_country

fields are present.

String (50)

Country of the shipping address. Use the two-character ISO Standard Country Codes. This field is used only when the

ship_to_city

and

ship_to_state

fields are present.

String (2)

Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the shipping country is the US, the 9-digit postal code must follow this format:

String (10)

State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. The default value for

shipTo_state

is

billTo_state

. This field is used only when the

shipTo_city

and

shipTo_country

fields are present.

String (2)

Street of the shipping address.

—

This item-level field overrides the corresponding request-level field. This field is not used unless the

item_#_orderOriginCity

and

item_#_orderOriginCountry

fields are present.

String (15)

—

—

Total tax for all items.

String (15)

Name of the jurisdiction tax for the item. For example, CA State Tax.

String (15)

Sale/Refund. Based on refund indicator (refund or not).

—

Per-item price of the product. This value cannot be negative.

String (15)