Table 3 Offer-Level Fields for the SCMP API
Field Description Req/Opt
for U.S. &
amount Per-item price of the product.
You can include a decimal point (.) in this field, but you cannot include any other special characters. The amount will be truncated at the request level to the correct number of decimal places.
Required Required Decimal (15)
buyer_registration Buyer’s VAT registration number. N/A Optional String (25) city_override_amount Overrides the calculated city tax amount. Optional N/A Decimal
(15) city_override_rate Overrides the calculated city tax rate.
This value must be greater than or equal to 0 and less than 1. For example, for a rate of 1.5%, enter the value 0.015.
Optional N/A Decimal
(15)
country_override_amount Overrides the calculated country tax amount, or the calculated Canadian GST amount.
Optional N/A Decimal
(15)
country_override_rate Overrides the calculated country tax rate, or the calculated Canadian GST rate.
This value must be greater than or equal to 0 and less than 1. For example, for a rate of 1.5%, enter the value 0.015.
Optional N/A Decimal
(15)
county_override_amount Overrides the calculated district tax amount.
Optional N/A Decimal
(15) county_override_rate Overrides the calculated district tax rate.
This value must be greater than or equal to 0 and less than 1. For example, for a rate of 1.5%, enter the value 0.015.
Optional N/A Decimal
(15)
merchant_product_sku Product’s identifier code.
For ics_auth and ics_bill, required if product_code is not default or one of the values related to shipping and
Optional N/A String (30)
Appendix A Fields for the SCMP API
order_acceptance_city The order_acceptance_city at the offer level overrides the corresponding request-level field. This field is not used unless the order_acceptance_state and order_acceptance_country fields are present.
Optional N/A String (50)
order_acceptance_country The order_acceptance_country at the offer level overrides the corresponding request-level field. This field is not used unless the order_acceptance_state and order_acceptance_city fields are present. Use the two-character ISO Standard Country Codes.
Optional N/A String (2)
order_acceptance_county The order_acceptance_county at the offer level overrides the corresponding request-level field. This field is forwarded to the third party tax calculation engine only if the following requirements are met:
Your CyberSource account is enabled for forwarding county information.
The corresponding country is the U.S.
or Canada.
The order_acceptance_city, order_
acceptance_state, and order_
acceptance_country fields are included in the request.
Optional N/A String (50)
order_acceptance_state The order_acceptance_state at the offer level overrides the corresponding request-level field. This field is not used unless the order_acceptance_city and order_acceptance_country fields are present. Use the State, Province, and Territory Codes for the United States and Canada.
Optional N/A String (2)
order_acceptance_zip The order_acceptance_zip at the offer level overrides the corresponding request-level field. This field is not used unless the order_acceptance_city, order_acceptance_state, and order_
Optional N/A String (10) Table 3 Offer-Level Fields for the SCMP API (Continued)
Field Description Req/Opt
for U.S. &
Appendix A Fields for the SCMP API
order_origin_city The order_origin_city at the offer level overrides the corresponding request-level field. This field is not used unless the order_origin_state and order_
origin_country fields are present.
Optional N/A String (50)
order_origin_country The order_origin_country at the offer level overrides the corresponding request-level field. This field is not used unless the order_origin_state and order_origin_city fields are present.
Use the two-character ISO Standard Country Codes.
Optional N/A String (2)
order_origin_county The order_origin_county at the offer level overrides the corresponding request-level field. This field is forwarded to the third party tax calculation engine only if the following requirements are met:
Your CyberSource account is enabled for forwarding county information.
The corresponding country is the U.S.
or Canada.
The order_origin_city, order_origin_
state, and order_origin_country fields are included in the request.
Optional N/A String (50)
order_origin_state The order_origin_state at the offer level overrides the corresponding request-level field. This field is not used unless the order_origin_city and order_
origin_country fields are present. Use the State, Province, and Territory Codes for the United States and Canada.
Optional N/A String (2)
order_origin_zip The order_origin_zip at the offer level overrides the corresponding request-level field. This field is not used unless the order_origin_city, order_origin_
state, and order_origin_country fields
Optional N/A String (10) Table 3 Offer-Level Fields for the SCMP API (Continued)
Field Description Req/Opt
for U.S. &
Appendix A Fields for the SCMP API
point_of_title_transfer Point of title transfer for the item. Either use one of these basic values:
D: Destination
O: Origin
I: In transit
Or use one of these Incoterms:
EXW: Ex Works
FCA: Free Carrier
FAS: Free Alongside Ship
FOB: Free On Board
CFR: Cost and Freight
CIF: Cost, Insurance, and Freight
CPT: Carriage Paid To
CIP: Carriage and Insurance Paid to
DAF: Delivered At Frontier
DES: Delivered Ex Ship
DEQ: Delivered Ex Quay
DDU: Delivered Duty Unpaid
DDP: Delivered Duty Paid
N/A Optional String (3) Table 3 Offer-Level Fields for the SCMP API (Continued)
Field Description Req/Opt
for U.S. &
Canada
Req/
Opt for VAT
Data Type
& Length
Appendix A Fields for the SCMP API
product_code Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. To use the tax calculation service, use values listed in the
Commodity Code column from one of the following documents:
European Union Tax Product Code Guide (PDF | .xls)
U.S. Tax Product Code Guide (PDF|.xlsx)
See "Product Codes," page 13, for more information. The default value is default.
For ics_auth, if you set this to a value other than default or any of the other values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. See the information about offers and grand totals in Getting Started with CyberSource Advanced for the SCMP API.
Optional Optional String (20)
product_name Name of the product.
For ics_auth and ics_bill, required if product_code is not default or one of the values related to shipping and handling.
Optional Optional String (30)
quantity Quantity of the product being purchased.
For ics_auth and ics_bill, required if product_code is not default or one of the values related to shipping and handling.
Optional Optional Non-negative integer (10)
seller_registration0...N VAT seller registration number. Only applicable if including multiple VAT seller registration numbers in the request.
N/A Required
for VAT
String (25) Table 3 Offer-Level Fields for the SCMP API (Continued)
Field Description Req/Opt
for U.S. &
Appendix A Fields for the SCMP API
seller_registration VAT seller registration number. Only applicable if including one VAT seller registration number in the request.
Note There is also an Request-level field named seller_registration0...N.
See "Request-Level Fields," page 23.
N/A Required
for VAT
String (25)
ship_from_city City where the product is shipped from, which is used to determine nexus.
Optional N/A String (50)
ship_from_country Country where the product is shipped from, which is used to determine nexus.
Use the two-character ISO Standard Country Codes.
Optional Optional String (2)
ship_from_county County from where the product is shipped. This field is forwarded to the third party tax calculation engine only if the following requirements are met:
Your CyberSource account is enabled for forwarding county information.
The corresponding country is the U.S.
or Canada.
The ship_from_city, ship_from_
state, and ship_from_country fields are included in the request.
Optional Optional String (50)
ship_from_state State where the product is shipped from, which is used to determine nexus. Use the State, Province, and Territory Codes for the United States and Canada.
Optional N/A String (2)
ship_from_zip Postal code for the merchant shipping address. The postal code must consist of 5 to 9 digits.
If the shipping country is the U.S., the 9-digit postal code must follow this format:
[5 digits][dash][4 digits]
Example: 12345-6789
If the shipping country is Canada, the 6-digit postal code must follow this format:
[alpha][numeric][alpha]
[space][numeric][alpha]
[numeric]
Optional N/A String (10) Table 3 Offer-Level Fields for the SCMP API (Continued)
Field Description Req/Opt
for U.S. &
Appendix A Fields for the SCMP API