On This Page
REST API
orderInformation. lineItems[].taxAmount
Total tax to apply to the product.
This field is supported only for
American Express Direct
, Chase Paymentech Solutions
, Elavon Americas
, FDC Compass
,
FDMS South
, FDC Nashville Global
, FDMS Nashville
,
GPN
, , OmniPay Direct
,
RBS WorldPay Atlanta
, TSYS Acquiring Solutions
, , and
Worldpay VAP
.When you include this field, the Tax Calculation service does not calculate tax for the
offer. Instead, it returns the value of
orderInformation.lineItems.taxAmount
in the reply field
orderInformation.lineItems[].taxAmount
.This value cannot be negative. The tax amount and the
unit
price
must be in the same currency.The tax amount value is additive as shown in the following example.
Example:
This example uses a two-exponent currency such as USD:- You include the followingoffersin your request:orderInformation.lineItems[0].unitPrice=10.00 orderInformation.lineItems[0].quantity=1 orderInformation.lineItems[0].taxAmount=0.80 orderInformation.lineItems[1].unitPrice=20.00 orderInformation.lineItems[1].quantity=1 orderInformation.lineItems[1].taxAmount=1.60
- The total authorized amount is 32.40, not 30.00 with 2.40 of tax included.
Airline Processing
Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s).
Format: English characters only. Optional request field for a line item.
Tax Calculation
Optional field for U.S., Canadian, international tax, and value-added taxes.
When you want to include
orderInformation.lineItems[].taxAmount
and also request the tax service, see
the tax calculation service guide.Specifications
- Data Type:String
- Data Length:15
Mapping Information
- REST API Field:orderInformation.lineItems.taxAmount
- SCMP API Field:tax_amount
- Simple Order API Field:item_#_taxAmount
Processor Field Names
This list provides the Level II/Level III
processor field name for each processor that supports Level II or Level III data. - not applicableAmerican Express Direct:
- Tax AmountChase Paymentech Solutions:
- VAT / Tax AmountElavon Americas:
- Tax AmountFDC Compass:
- Local Tax AmountFDC Nashville Global:
- not applicableFDMS Nashville:
- not applicableFDMS South:
- GPN:
- Level II: Amount 2
- Level III: Tax Amount N
- Tax Amount / Total Tax AmountOmniPay Direct:
- Tax AmountRBS WorldPay Atlanta:
- TSYS Acquiring Solutions:
- Mastercard: Tax Amount
- Visa: VAT / Tax Amount
- localTax AmountVisa Platform Connect:
- taxAmountWorldpay VAP: