On This Page
REST API

orderInformation. lineItems[].taxDetails[].rate

Alternative tax rate applied to the item.
FDC Nashville Global
For Mastercard, this is the rate for a special tax.
For Visa, this is a VAT tax or other tax rate.
OmniPay Direct
This rate is used to generate the value of the
orderInformation.lineItems[].taxDetails[].amount
Line item
 field.
When you include the
orderInformation.lineItems[].taxDetails[].amount
Line item
 field or the
orderInformation.amountDetails.taxDetails[].amount
 request field, do not include the
orderInformation.lineItems[].taxDetails[].rate
 field. The
orderInformation.amountDetails.taxDetails[].amount
 request field rate will be set using the following equation:
orderInformation.amountDetails.taxDetails[].amount
 /
orderInformation.lineItems[].unitPrice
 field.
For Visa, this is a VAT tax or other tax rate.

Specifications

  • Data Type:
     String
  • Data Length:
    • OmniPay Direct
      :
       4
    • Worldpay VAP
      :
       8
    • All other processors:
       5

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxDetails[].rate
  • SCMP API Fields:
    • alternate_tax_amount
    • vat_rate
  • Simple Order API Fields:
    • item_#_alternateTaxRate
    • item_#_vatRate

Processor Field Names

The following list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:
  • FDC Nashville Global
    : Item Tax Rate Applied
  • FDMS South
    : not applicable
  • GPN
    : Tax Rate N
  • OmniPay Direct
    : VAT / TAx Rate (Freight or Shipping)
  • Worldpay VAP
    : taxRate