On This Page
REST API

orderInformation.invoiceDetails. taxable

Flag that indicates whether an order is taxable.
This field is supported only for
FDMS Nashville
,
FDMS South
,
Visa Platform Connect
, and
RBS WorldPay Atlanta
.
Possible values:
  • true
    : Order is taxable
  • false
    : Order is not taxable
OmniPay Direct
This field is a flag that indicates whether tax is included in the total purchase amount.
Possible values:
  • true
    : Tax is included
  • false
    : Tax is not included
RBS WorldPay Atlanta
This field is required for Level II Mastercard and Visa transactions. If
orderInformation.lineItems[].taxAmount
 =
0
, set this field to
false
N
. If
orderInformation.lineItems[].taxAmount
 > 0, set this field to
true
Y
.
Visa Platform Connect
This value must be
Y
 if the the
orderInformation.lineItems[].taxAmount
 value > 0.
If you do not include any
orderInformation.lineItems[].taxAmount
 values in your request, the
orderInformation.invoiceDetails.taxable
 field value is not included in the request.
Worldpay VAP
This field is required if
orderInformation.lineItems[].taxAmount
 = 0. This field is optional if
orderInformation.lineItems[].taxAmount
 > 0.

Specifications

  • Data Type:
     Boolean
  • Data Length:
     1

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.taxable
  • SCMP API Field:
    tax_indicator
  • Simple Order API Field:
    invoiceHeader_taxable

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:
  • FDMS Nashville
    : not applicable
  • FDMS South
    : not applicable
  • OmniPay Direct
    : Detail Tax Amount Indicator
  • RBS WorldPay Atlanta
    : Tax Exempt
  • Visa Platform Connect
    : localTaxIncluded
  • Worldpay VAP
    : taxExempt